< API Reference
POST
/market/scans/stocks/custom-scan-builder
STOCKS
Processes custom scan request and returns result set with dynamic list of columns.

Example URI

Delayed

https://sandbox.livevol.com/api/v1/delayed/market/scans/stocks/custom-scan-builder

Request Information

Body Parameters

Collection of ScanParam

NameDescriptionTypeAdditional information
formula

string

Required

The value of this field is case sensitive

display_name

string

The value of this field is case sensitive

include_in_resultset

boolean

Default value is: True

sort

string

Allowed values are [ asc, desc, none ]

Default value is: none

Request Formats

application/json, text/json

Sample:
[
  {
    "formula": "last<50",
    "display_name": "lastBelow50",
    "include_in_resultset": true,
    "sort": "asc"
  },
  {
    "formula": "iv30>10",
    "display_name": "iv30Above10",
    "include_in_resultset": true,
    "sort": "none"
  }
]

application/xml, text/xml

Sample:
<scan_params xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <scan_param>
    <display_name>lastBelow50</display_name>
    <formula>last&lt;50</formula>
    <include_in_resultset>true</include_in_resultset>
    <sort>asc</sort>
  </scan_param>
  <scan_param>
    <display_name>iv30Above10</display_name>
    <formula>iv30&gt;10</formula>
    <include_in_resultset>true</include_in_resultset>
    <sort>none</sort>
  </scan_param>
</scan_params>

Response Information

Resource Description

ScanResult

NameDescriptionTypeAdditional information
last_updated

date

None.

inputs

Collection of ScanParam

None.

output

Collection of Object

None.

Response Formats

application/json, text/json

Sample:
{
  "last_updated": "2018-01-01T12:00:00",
  "inputs": [
    {
      "formula": "last<50",
      "display_name": "lastBelow50",
      "include_in_resultset": true,
      "sort": "asc"
    },
    {
      "formula": "iv30>10",
      "display_name": "iv30Above10",
      "include_in_resultset": true,
      "sort": "none"
    }
  ],
  "output": [
    {
      "symbol": "NMBL",
      "company_name": "Nimble Storage Inc",
      "lastBelow50": 43.38,
      "iv30Above10": 16.22
    }
  ]
}