GET
/market/scans/stocks
STOCKS
Get list of available stock scans

Example URI

Live

https://api.livevol.com/v1/live/market/scans/stocks

Delayed

https://api.livevol.com/v1/delayed/market/scans/stocks

Response Information

Resource Description

Collection of ScanEntity

Name Description Type Additional information SIP Provider
url

string

None

None

name

string

None

None

description

string

None

None

category

string

None

None

Collection of FieldEntity

None

None

FieldEntity

Name Description Type Additional information SIP Provider
field

string

None

None

display_name

string

None

None

display_order

integer

None

None

Response Formats

application/json, text/json

Sample:
[
  {
    "url": "market/scans/stocks/post-earnings-iv30-gain",
    "name": "Post Earnings IV30 Gain",
    "description": "Symbols where IV30 Rose Post Earnings (Min. 200 contracts today; Earnings Max. 5 days ago)",
    "category": "Earnings",
    "fields": [
      {
        "field": "sample string 1",
        "display_name": "sample string 2",
        "display_order": 3
      },
      {
        "field": "sample string 1",
        "display_name": "sample string 2",
        "display_order": 3
      }
    ]
  },
  {
    "url": "market/scans/stocks/imploding-iv30",
    "name": "Imploding IV30s",
    "description": "Symbols where the IV30 has fallen 30% in the last week",
    "category": "Implied Volatility",
    "fields": [
      {
        "field": "sample string 1",
        "display_name": "sample string 2",
        "display_order": 3
      },
      {
        "field": "sample string 1",
        "display_name": "sample string 2",
        "display_order": 3
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfscan xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <scan>
    <category>Earnings</category>
    <description>Symbols where IV30 Rose Post Earnings (Min. 200 contracts today; Earnings Max. 5 days ago)</description>
    <fields>
      <field>
        <display_name>sample string 2</display_name>
        <display_order>3</display_order>
        <field>sample string 1</field>
      </field>
      <field>
        <display_name>sample string 2</display_name>
        <display_order>3</display_order>
        <field>sample string 1</field>
      </field>
    </fields>
    <name>Post Earnings IV30 Gain</name>
    <url>market/scans/stocks/post-earnings-iv30-gain</url>
  </scan>
  <scan>
    <category>Implied Volatility</category>
    <description>Symbols where the IV30 has fallen 30% in the last week</description>
    <fields>
      <field>
        <display_name>sample string 2</display_name>
        <display_order>3</display_order>
        <field>sample string 1</field>
      </field>
      <field>
        <display_name>sample string 2</display_name>
        <display_order>3</display_order>
        <field>sample string 1</field>
      </field>
    </fields>
    <name>Imploding IV30s</name>
    <url>market/scans/stocks/imploding-iv30</url>
  </scan>
</ArrayOfscan>