< API Reference
GET
/allaccess/scans-and-alerts/custom-scanner
Get list of available fields and operations for building custom scans

Example URI

Live

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

Delayed

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

Response Information

Resource Description

ScansMetadata

Name Description Type Additional information SIP Provider

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

Collection of ScanField

None

None

ScanField

Name Description Type Additional information SIP Provider
name

string

None

None

display_name

string

None

None

description

string

None

None

category

string

None

None

data_type

string

None

None

may_contain_null

boolean

None

None

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

Collection of ScanOperation

None

None

ScanOperation

Name Description Type Additional information SIP Provider
name

string

None

None

description

string

None

None

Response Formats

application/json, text/json

Sample:
{
  "fields": [
    {
      "name": "last",
      "display_name": "Last Stock Price",
      "description": "Last Stock Price",
      "category": "Price",
      "data_type": "decimal",
      "may_contain_null": false
    },
    {
      "name": "iv30",
      "display_name": "IV30",
      "description": "IV30 is a measure of the volatility of the hypothetical 30-day (calendar days) option...",
      "category": "Volatility",
      "data_type": "decimal",
      "may_contain_null": true
    }
  ],
  "operations": [
    {
      "name": "<",
      "description": "Less Than"
    },
    {
      "name": "<=",
      "description": "Less Than Or Equal To"
    }
  ]
}

application/xml, text/xml

Sample:
<scans_metadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <fields>
    <field>
      <category>Price</category>
      <data_type>decimal</data_type>
      <description>Last Stock Price</description>
      <display_name>Last Stock Price</display_name>
      <may_contain_null>false</may_contain_null>
      <name>last</name>
    </field>
    <field>
      <category>Volatility</category>
      <data_type>decimal</data_type>
      <description>IV30 is a measure of the volatility of the hypothetical 30-day (calendar days) option...</description>
      <display_name>IV30</display_name>
      <may_contain_null>true</may_contain_null>
      <name>iv30</name>
    </field>
  </fields>
  <operations>
    <operation>
      <description>Less Than</description>
      <name>&lt;</name>
    </operation>
    <operation>
      <description>Less Than Or Equal To</description>
      <name>&lt;=</name>
    </operation>
  </operations>
</scans_metadata>