Special Options Classifications API

getSpecialOptionsClassification

The getSpecialOptionsClassifications API from Barchart OnDemand provides the classification for weekly and special options by commodity.

View All APIs

First Name^*

Last Name^*

Email Address^*

Phone^*

Company^*

Role^*

Industry^*

Country^*

What you are looking for?^*

Please provide as much information as possible (e.g. exchanges, markets or other data sources), the APIs you are interested in (e.g. getQuote, getHistory, getChart, getCorporateActions, etc.), and your use case.

Here are some examples: Example #1, Example #2, Example #3.

By submitting this form you are opting in to receive email communications from Barchart for related product, service or company information, updates and announcements. You can unsubscribe at anytime. View our Privacy Policy.

Inputs

root^optional

Commodity root code for which the classification is requested. Multiple roots can be passed, separated by a comma.

Type

list (A comma or semi-colon delimited string.)

Example

ZC

category^optional

The category classification of the special option

Type

string (A sequence of characters. (example: GOOG))

Outputs

root
always returned

The code that identifies a commodity.

enum
A type which includes a list of valid possible values.

category
always returned

The category classification of the special option

enum
A type which includes a list of valid possible values.

Status Code Responses

200

Success

400

Bad Request

The request was invalid, please see the message for more information.

500

Internal Server Error

Something is not working correctly, please contact support.

JSON

GET

GET https://ondemand.websol.barchart.com/getSpecialOptionsClassification.json?apikey=YOUR_API_KEY&root=ZC
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getSpecialOptionsClassification.json
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&root=ZC

Response

{
    "status": {
        "code": 200,
        "message": "Success."
    },
    "results": [
        {
            "root": "ZC",
            "category": [
                {
                    "categoryName": "Short Dated New Crop Options",
                    "data": {
                        "symbol": "BCD",
                        "name": "Corn Short Dated New Crop Options"
                    }
                },
                {
                    "categoryName": "Calendar Spread Options",
                    "sub-categories": [
                        {
                            "subCategoryName": "Consecutive",
                            "data": {
                                "symbol": "BZC",
                                "name": "Corn CSO Consecutive"
                            }
                        },
                        {
                            "subCategoryName": "Jul-Dec",
                            "data": {
                                "symbol": "BZ6",
                                "name": "Corn CSO Jul-Dec"
                            }
                        },
                        {
                            "subCategoryName": "Dec-Jul",
                            "data": {
                                "symbol": "BZ8",
                                "name": "Corn CSO Dec-Jul"
                            }
                        },
                        {
                            "subCategoryName": "Dec-Dec",
                            "data": {
                                "symbol": "BZ2",
                                "name": "Corn CSO Dec-Dec"
                            }
                        },
                        {
                            "subCategoryName": "Mar-Jul",
                            "data": {
                                "symbol": "BZ7",
                                "name": "Corn CSO Mar-Jul"
                            }
                        },
                        {
                            "subCategoryName": "Mar-Dec",
                            "data": {
                                "symbol": "BZ3",
                                "name": "Corn CSO Mar-Dec"
                            }
                        }
                    ]
                },
                {
                    "categoryName": "Friday Weekly Options",
                    "sub-categories": [
                        {
                            "subCategoryName": "Week 1",
                            "data": {
                                "symbol": "BC1",
                                "name": "Corn Week 1 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 2",
                            "data": {
                                "symbol": "BC2",
                                "name": "Corn Week 2 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 3",
                            "data": {
                                "symbol": "BC3",
                                "name": "Corn Week 3 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 4",
                            "data": {
                                "symbol": "BC4",
                                "name": "Corn Week 4 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 5",
                            "data": {
                                "symbol": "BC5",
                                "name": "Corn Week 5 Options"
                            }
                        }
                    ]
                },
                {
                    "categoryName": "Monday Weekly Options",
                    "sub-categories": [
                        {
                            "subCategoryName": "Week 1",
                            "data": {
                                "symbol": "BI1",
                                "name": "Corn Week 1 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 2",
                            "data": {
                                "symbol": "BI2",
                                "name": "Corn Week 2 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 3",
                            "data": {
                                "symbol": "BI3",
                                "name": "Corn Week 3 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 4",
                            "data": {
                                "symbol": "BI4",
                                "name": "Corn Week 4 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 5",
                            "data": {
                                "symbol": "BI5",
                                "name": "Corn Week 5 Options"
                            }
                        }
                    ]
                },
                {
                    "categoryName": "Tuesday Weekly Options",
                    "sub-categories": [
                        {
                            "subCategoryName": "Week 1",
                            "data": {
                                "symbol": "BI6",
                                "name": "Corn Week 1 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 2",
                            "data": {
                                "symbol": "BI7",
                                "name": "Corn Week 2 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 3",
                            "data": {
                                "symbol": "BI8",
                                "name": "Corn Week 3 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 4",
                            "data": {
                                "symbol": "BI9",
                                "name": "Corn Week 4 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 5",
                            "data": {
                                "symbol": "BI0",
                                "name": "Corn Week 5 Options"
                            }
                        }
                    ]
                },
                {
                    "categoryName": "Wednesday Weekly Options",
                    "sub-categories": [
                        {
                            "subCategoryName": "Week 1",
                            "data": {
                                "symbol": "BIA",
                                "name": "Corn Week 1 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 2",
                            "data": {
                                "symbol": "BIB",
                                "name": "Corn Week 2 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 3",
                            "data": {
                                "symbol": "BIC",
                                "name": "Corn Week 3 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 4",
                            "data": {
                                "symbol": "BID",
                                "name": "Corn Week 4 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 5",
                            "data": {
                                "symbol": "BIE",
                                "name": "Corn Week 5 Options"
                            }
                        }
                    ]
                },
                {
                    "categoryName": "Thursday Weekly Options",
                    "sub-categories": [
                        {
                            "subCategoryName": "Week 1",
                            "data": {
                                "symbol": "BIF",
                                "name": "Corn Week 1 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 2",
                            "data": {
                                "symbol": "BIG",
                                "name": "Corn Week 2 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 3",
                            "data": {
                                "symbol": "BIH",
                                "name": "Corn Week 3 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 4",
                            "data": {
                                "symbol": "BII",
                                "name": "Corn Week 4 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 5",
                            "data": {
                                "symbol": "BIJ",
                                "name": "Corn Week 5 Options"
                            }
                        }
                    ]
                },
                {
                    "categoryName": "New Crop Friday Weekly Options",
                    "sub-categories": [
                        {
                            "subCategoryName": "Week 1",
                            "data": {
                                "symbol": "BC6",
                                "name": "Corn New Crop Week 1 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 2",
                            "data": {
                                "symbol": "BC7",
                                "name": "Corn New Crop Week 2 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 3",
                            "data": {
                                "symbol": "BC8",
                                "name": "Corn New Crop Week 3 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 4",
                            "data": {
                                "symbol": "BC9",
                                "name": "Corn New Crop Week 4 Options"
                            }
                        },
                        {
                            "subCategoryName": "Week 5",
                            "data": {
                                "symbol": "BC0",
                                "name": "Corn New Crop Week 5 Options"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

XML

GET

GET https://ondemand.websol.barchart.com/getSpecialOptionsClassification.xml?apikey=YOUR_API_KEY&root=ZC
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getSpecialOptionsClassification.xml
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&root=ZC

Response

<?xml version="1.0" encoding="utf-8"?>
<getSpecialOptionsClassification>
  <status>
    <code>200</code>
    <message>Success.</message>
  </status>
  <item>
    <root>ZC</root>
    <category>
      <categoryName>Short Dated New Crop Options</categoryName>
      <data>
        <symbol>BCD</symbol>
        <name>Corn Short Dated New Crop Options</name>
      </data>
      <categoryName>Calendar Spread Options</categoryName>
      <sub-categories>
        <subCategoryName>Consecutive</subCategoryName>
        <data>
          <symbol>BZC</symbol>
          <name>Corn CSO Consecutive</name>
        </data>
        <subCategoryName>Jul-Dec</subCategoryName>
        <data>
          <symbol>BZ6</symbol>
          <name>Corn CSO Jul-Dec</name>
        </data>
        <subCategoryName>Dec-Jul</subCategoryName>
        <data>
          <symbol>BZ8</symbol>
          <name>Corn CSO Dec-Jul</name>
        </data>
        <subCategoryName>Dec-Dec</subCategoryName>
        <data>
          <symbol>BZ2</symbol>
          <name>Corn CSO Dec-Dec</name>
        </data>
        <subCategoryName>Mar-Jul</subCategoryName>
        <data>
          <symbol>BZ7</symbol>
          <name>Corn CSO Mar-Jul</name>
        </data>
        <subCategoryName>Mar-Dec</subCategoryName>
        <data>
          <symbol>BZ3</symbol>
          <name>Corn CSO Mar-Dec</name>
        </data>
      </sub-categories>
      <categoryName>Friday Weekly Options</categoryName>
      <sub-categories>
        <subCategoryName>Week 1</subCategoryName>
        <data>
          <symbol>BC1</symbol>
          <name>Corn Week 1 Options</name>
        </data>
        <subCategoryName>Week 2</subCategoryName>
        <data>
          <symbol>BC2</symbol>
          <name>Corn Week 2 Options</name>
        </data>
        <subCategoryName>Week 3</subCategoryName>
        <data>
          <symbol>BC3</symbol>
          <name>Corn Week 3 Options</name>
        </data>
        <subCategoryName>Week 4</subCategoryName>
        <data>
          <symbol>BC4</symbol>
          <name>Corn Week 4 Options</name>
        </data>
        <subCategoryName>Week 5</subCategoryName>
        <data>
          <symbol>BC5</symbol>
          <name>Corn Week 5 Options</name>
        </data>
      </sub-categories>
      <categoryName>Monday Weekly Options</categoryName>
      <sub-categories>
        <subCategoryName>Week 1</subCategoryName>
        <data>
          <symbol>BI1</symbol>
          <name>Corn Week 1 Options</name>
        </data>
        <subCategoryName>Week 2</subCategoryName>
        <data>
          <symbol>BI2</symbol>
          <name>Corn Week 2 Options</name>
        </data>
        <subCategoryName>Week 3</subCategoryName>
        <data>
          <symbol>BI3</symbol>
          <name>Corn Week 3 Options</name>
        </data>
        <subCategoryName>Week 4</subCategoryName>
        <data>
          <symbol>BI4</symbol>
          <name>Corn Week 4 Options</name>
        </data>
        <subCategoryName>Week 5</subCategoryName>
        <data>
          <symbol>BI5</symbol>
          <name>Corn Week 5 Options</name>
        </data>
      </sub-categories>
      <categoryName>Tuesday Weekly Options</categoryName>
      <sub-categories>
        <subCategoryName>Week 1</subCategoryName>
        <data>
          <symbol>BI6</symbol>
          <name>Corn Week 1 Options</name>
        </data>
        <subCategoryName>Week 2</subCategoryName>
        <data>
          <symbol>BI7</symbol>
          <name>Corn Week 2 Options</name>
        </data>
        <subCategoryName>Week 3</subCategoryName>
        <data>
          <symbol>BI8</symbol>
          <name>Corn Week 3 Options</name>
        </data>
        <subCategoryName>Week 4</subCategoryName>
        <data>
          <symbol>BI9</symbol>
          <name>Corn Week 4 Options</name>
        </data>
        <subCategoryName>Week 5</subCategoryName>
        <data>
          <symbol>BI0</symbol>
          <name>Corn Week 5 Options</name>
        </data>
      </sub-categories>
      <categoryName>Wednesday Weekly Options</categoryName>
      <sub-categories>
        <subCategoryName>Week 1</subCategoryName>
        <data>
          <symbol>BIA</symbol>
          <name>Corn Week 1 Options</name>
        </data>
        <subCategoryName>Week 2</subCategoryName>
        <data>
          <symbol>BIB</symbol>
          <name>Corn Week 2 Options</name>
        </data>
        <subCategoryName>Week 3</subCategoryName>
        <data>
          <symbol>BIC</symbol>
          <name>Corn Week 3 Options</name>
        </data>
        <subCategoryName>Week 4</subCategoryName>
        <data>
          <symbol>BID</symbol>
          <name>Corn Week 4 Options</name>
        </data>
        <subCategoryName>Week 5</subCategoryName>
        <data>
          <symbol>BIE</symbol>
          <name>Corn Week 5 Options</name>
        </data>
      </sub-categories>
      <categoryName>Thursday Weekly Options</categoryName>
      <sub-categories>
        <subCategoryName>Week 1</subCategoryName>
        <data>
          <symbol>BIF</symbol>
          <name>Corn Week 1 Options</name>
        </data>
        <subCategoryName>Week 2</subCategoryName>
        <data>
          <symbol>BIG</symbol>
          <name>Corn Week 2 Options</name>
        </data>
        <subCategoryName>Week 3</subCategoryName>
        <data>
          <symbol>BIH</symbol>
          <name>Corn Week 3 Options</name>
        </data>
        <subCategoryName>Week 4</subCategoryName>
        <data>
          <symbol>BII</symbol>
          <name>Corn Week 4 Options</name>
        </data>
        <subCategoryName>Week 5</subCategoryName>
        <data>
          <symbol>BIJ</symbol>
          <name>Corn Week 5 Options</name>
        </data>
      </sub-categories>
      <categoryName>New Crop Friday Weekly Options</categoryName>
      <sub-categories>
        <subCategoryName>Week 1</subCategoryName>
        <data>
          <symbol>BC6</symbol>
          <name>Corn New Crop Week 1 Options</name>
        </data>
        <subCategoryName>Week 2</subCategoryName>
        <data>
          <symbol>BC7</symbol>
          <name>Corn New Crop Week 2 Options</name>
        </data>
        <subCategoryName>Week 3</subCategoryName>
        <data>
          <symbol>BC8</symbol>
          <name>Corn New Crop Week 3 Options</name>
        </data>
        <subCategoryName>Week 4</subCategoryName>
        <data>
          <symbol>BC9</symbol>
          <name>Corn New Crop Week 4 Options</name>
        </data>
        <subCategoryName>Week 5</subCategoryName>
        <data>
          <symbol>BC0</symbol>
          <name>Corn New Crop Week 5 Options</name>
        </data>
      </sub-categories>
    </category>
  </item>
</getSpecialOptionsClassification>

CSV

GET

GET https://ondemand.websol.barchart.com/getSpecialOptionsClassification.csv?apikey=YOUR_API_KEY&root=ZC
Host: ondemand.websol.barchart.com

POST

POST https://ondemand.websol.barchart.com/getSpecialOptionsClassification.csv
Host: ondemand.websol.barchart.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

apikey=YOUR_API_KEY&root=ZC

Response

root,parent
"ZC"
"New Crop Friday Weekly Options",""
"Week 5","BC0","Corn New Crop Week 5 Options","New Crop Friday Weekly Options"
"Week 4","BC9","Corn New Crop Week 4 Options","New Crop Friday Weekly Options"
"Week 3","BC8","Corn New Crop Week 3 Options","New Crop Friday Weekly Options"
"Week 2","BC7","Corn New Crop Week 2 Options","New Crop Friday Weekly Options"
"Week 1","BC6","Corn New Crop Week 1 Options","New Crop Friday Weekly Options"
"Thursday Weekly Options",""
"Week 5","BIJ","Corn Week 5 Options","Thursday Weekly Options"
"Week 4","BII","Corn Week 4 Options","Thursday Weekly Options"
"Week 3","BIH","Corn Week 3 Options","Thursday Weekly Options"
"Week 2","BIG","Corn Week 2 Options","Thursday Weekly Options"
"Week 1","BIF","Corn Week 1 Options","Thursday Weekly Options"
"Wednesday Weekly Options",""
"Week 5","BIE","Corn Week 5 Options","Wednesday Weekly Options"
"Week 4","BID","Corn Week 4 Options","Wednesday Weekly Options"
"Week 3","BIC","Corn Week 3 Options","Wednesday Weekly Options"
"Week 2","BIB","Corn Week 2 Options","Wednesday Weekly Options"
"Week 1","BIA","Corn Week 1 Options","Wednesday Weekly Options"
"Tuesday Weekly Options",""

PHP

<?php

$ondemand = new SoapClient('https://ondemand.websol.barchart.com/service?wsdl');

$params = [
    'apikey' => 'YOUR_API_KEY',
    'root' => 'ZC',
];

$result = $ondemand->getSpecialOptionsClassification($params);
var_dump($result);

Classic ASP

Dim ondemand
Dim result

Set ondemand = Server.CreateObject("MSSOAP.SoapClient30")
ondemand.ClientProperty("ServerHTTPRequest") = True
ondemand.MSSoapInit("https://ondemand.websol.barchart.com/service?wsdl")

Set result = ondemand.getSpecialOptionsClassification("YOUR_API_KEY", "ZC")

Perl

use SOAP::Lite;
use SOAP::WSDL;

my $ondemand = SOAP::Lite
    -> service('https://ondemand.websol.barchart.com/service?wsdl');

my $result = $ondemand->getSpecialOptionsClassification('YOUR_API_KEY', 'ZC');

print $result;

Python

from suds.client import Client
ondemand = Client('https://ondemand.websol.barchart.com/service?wsdl')

result = ondemand.service.getSpecialOptionsClassification('YOUR_API_KEY', 'ZC')

print(result)

Ruby

require 'savon'

ondemand = Savon.client(wsdl: 'https://ondemand.websol.barchart.com/service?wsdl')

response = ondemand.call(
    :getSpecialOptionsClassification,
    message: {
        apikey: 'YOUR_API_KEY',
        root: 'ZC',
    }
)

response.body