< API Reference
GET
/market/scans/options
OPTIONS
Get options strategy scans meta information

Example URI

Delayed

https://sandbox.livevol.com/api/v1/delayed/market/scans/options

Response Information

Resource Description

Collection of OptionScan

NameDescriptionTypeAdditional information
name

Scan name

string

None.

url

API method for scan

string

None.

parameters

Collection of parameters for scan

Collection of OptionScanParameter

None.

result_fields

Collection of result fields meta information

Collection of OptionScanResultField

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "name": "Iron Condor",
    "url": "market/scans/options/iron-condor",
    "parameters": [
      {
        "name": "time_frame",
        "param_type": "enum",
        "display_name": "Time Frame (days)",
        "default_value": "middle",
        "description": "Filters the time until expiration into one of three pre-defined time periods",
        "allowed_values": [
          "short",
          "middle",
          "long"
        ]
      },
      {
        "name": "hv30",
        "param_type": "string",
        "display_name": "Low Strike (max %OTM)",
        "default_value": "50",
        "description": "The maximum percentage above where stock is trading that a strike may be to be considered for the scan",
        "allowed_values": [
          "short",
          "middle",
          "long"
        ]
      }
    ],
    "result_fields": [
      {
        "field_name": "symbol",
        "display_name": "Symbol",
        "order": 1,
        "field_type": "string"
      },
      {
        "field_name": "expiry",
        "display_name": "Expiry",
        "order": 2,
        "field_type": "date"
      }
    ]
  },
  {
    "name": "Protective Put",
    "url": "market/scans/options/protective-put",
    "parameters": [
      {
        "name": "time_frame",
        "param_type": "enum",
        "display_name": "Time Frame (days)",
        "default_value": "middle",
        "description": "Filters the time until expiration into one of three pre-defined time periods",
        "allowed_values": [
          "short",
          "middle",
          "long"
        ]
      },
      {
        "name": "hv30",
        "param_type": "string",
        "display_name": "Low Strike (max %OTM)",
        "default_value": "50",
        "description": "The maximum percentage above where stock is trading that a strike may be to be considered for the scan",
        "allowed_values": [
          "short",
          "middle",
          "long"
        ]
      }
    ],
    "result_fields": [
      {
        "field_name": "symbol",
        "display_name": "Symbol",
        "order": 1,
        "field_type": "string"
      },
      {
        "field_name": "expiry",
        "display_name": "Expiry",
        "order": 2,
        "field_type": "date"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfoption_scan xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <option_scan>
    <name>Iron Condor</name>
    <parameters>
      <scan_param>
        <allowed_values>
          <allowed_value>short</allowed_value>
          <allowed_value>middle</allowed_value>
          <allowed_value>long</allowed_value>
        </allowed_values>
        <default_value>middle</default_value>
        <description>Filters the time until expiration into one of three pre-defined time periods</description>
        <display_name>Time Frame (days)</display_name>
        <name>time_frame</name>
        <param_type>enum</param_type>
      </scan_param>
      <scan_param>
        <allowed_values>
          <allowed_value>short</allowed_value>
          <allowed_value>middle</allowed_value>
          <allowed_value>long</allowed_value>
        </allowed_values>
        <default_value>50</default_value>
        <description>The maximum percentage above where stock is trading that a strike may be to be considered for the scan</description>
        <display_name>Low Strike (max %OTM)</display_name>
        <name>hv30</name>
        <param_type>string</param_type>
      </scan_param>
    </parameters>
    <result_fields>
      <option_scan_result_field>
        <display_name>Symbol</display_name>
        <field_name>symbol</field_name>
        <field_type>string</field_type>
        <order>1</order>
      </option_scan_result_field>
      <option_scan_result_field>
        <display_name>Expiry</display_name>
        <field_name>expiry</field_name>
        <field_type>date</field_type>
        <order>2</order>
      </option_scan_result_field>
    </result_fields>
    <url>market/scans/options/iron-condor</url>
  </option_scan>
  <option_scan>
    <name>Protective Put</name>
    <parameters>
      <scan_param>
        <allowed_values>
          <allowed_value>short</allowed_value>
          <allowed_value>middle</allowed_value>
          <allowed_value>long</allowed_value>
        </allowed_values>
        <default_value>middle</default_value>
        <description>Filters the time until expiration into one of three pre-defined time periods</description>
        <display_name>Time Frame (days)</display_name>
        <name>time_frame</name>
        <param_type>enum</param_type>
      </scan_param>
      <scan_param>
        <allowed_values>
          <allowed_value>short</allowed_value>
          <allowed_value>middle</allowed_value>
          <allowed_value>long</allowed_value>
        </allowed_values>
        <default_value>50</default_value>
        <description>The maximum percentage above where stock is trading that a strike may be to be considered for the scan</description>
        <display_name>Low Strike (max %OTM)</display_name>
        <name>hv30</name>
        <param_type>string</param_type>
      </scan_param>
    </parameters>
    <result_fields>
      <option_scan_result_field>
        <display_name>Symbol</display_name>
        <field_name>symbol</field_name>
        <field_type>string</field_type>
        <order>1</order>
      </option_scan_result_field>
      <option_scan_result_field>
        <display_name>Expiry</display_name>
        <field_name>expiry</field_name>
        <field_type>date</field_type>
        <order>2</order>
      </option_scan_result_field>
    </result_fields>
    <url>market/scans/options/protective-put</url>
  </option_scan>
</ArrayOfoption_scan>