< API Reference
GET
/market/scans/stocks/custom-scan-builder
STOCKS
Get list of available fields and operations for building customs scans

Example URI

Delayed

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

Response Information

Resource Description

ScansMetadata

NameDescriptionTypeAdditional information
fields

Collection of ScanField

None.

operations

Collection of ScanOperation

None.

Response Formats

application/json, text/json

Sample:
{
  "fields": [
    {
      "name": "last",
      "display_name": "Last Stock Price",
      "description": "Last Stock Price",
      "category": "Price"
    },
    {
      "name": "iv30",
      "display_name": "IV30",
      "description": "IV30 is a measure of the volatility of the hypothetical 30-day (calendar days) option...",
      "category": "Volatility"
    }
  ],
  "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>
      <description>Last Stock Price</description>
      <display_name>Last Stock Price</display_name>
      <name>last</name>
    </field>
    <field>
      <category>Volatility</category>
      <description>IV30 is a measure of the volatility of the hypothetical 30-day (calendar days) option...</description>
      <display_name>IV30</display_name>
      <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>