< API Reference
POST
/allaccess/scans-and-alerts/custom-scanner?all_results={all_results}
Create your own market scans with fields and criteria of your choosing. Fields include implied and historical volatilities, price movement, volumes, order flow metrics, earnings, and more. Incorporate percent changes, ranks, averages, differences over time, and other useful functions. Scans return up to 50 fields and top 20 results(unless otherwise specified in request).

Example URI

Live (30 points)

https://api.livevol.com/v1/live/allaccess/scans-and-alerts/custom-scanner?all_results=True

Delayed (50 points)

https://api.livevol.com/v1/delayed/allaccess/scans-and-alerts/custom-scanner?all_results=True

Request Information

URI Parameters

Name Description Type Additional information
all_results

Returns all results if set to true.

 boolean

Default: False (returns top 20 results). If set to True, returns all results with live request = 150 points, delayed request = 250 points.

Body Parameters

Collection of ScanFieldParam

Name Description Type Additional information
formula

See Available Fields for list of fields which can be scanned on or returned.

See Available Operators for list of operations which can be performed.

string

Required

The value of this field is case sensitive
display_name

Field name or description to be displayed.

 string

The value of this field is case sensitive
include_in_resultset

If set to True, return field in response.

 boolean

Default value is: True
sort

Apply sorting on field.

 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>
  <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

Name Description Type Additional information
last_updated

date

None

Collection of ScanFieldParam

None

ScanFieldParam

Name Description Type Additional information
formula

See Available Fields for list of fields which can be scanned on or returned.

See Available Operators for list of operations which can be performed.

string

Required

The value of this field is case sensitive
display_name

Field name or description to be displayed.

 string

The value of this field is case sensitive
include_in_resultset

If set to True, return field in response.

 boolean

Default value is: True
sort

Apply sorting on field.

 string

Allowed values are [ asc, desc, none ]

Default value is: none

Collection of Object

None

Object

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
    }
  ]
}

application/xml, text/xml

Sample: 
<scan_result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <inputs>
    <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>
  </inputs>
  <last_updated>2018-01-01T12:00:00</last_updated>
  <output>
    <item>
      <fields>
        <field>
          <name>symbol</name>
          <value>NMBL</value>
        </field>
        <field>
          <name>company_name</name>
          <value>Nimble Storage Inc</value>
        </field>
        <field>
          <name>lastBelow50</name>
          <value>43.38</value>
        </field>
        <field>
          <name>iv30Above10</name>
          <value>16.22</value>
        </field>
      </fields>
    </item>
  </output>
</scan_result>