getFuturesOptionsEOD API

getFuturesOptionsEOD

The getFuturesOptionsEOD API provides end-of-day options data such as strike price, closing price, expiration date, volume, volatility etc on futures contracts.

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

A symbol or code that identifies an option root.

Type

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

Example

ZC

contract^optional

A symbol or code that identifies an options contract.

Type

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

Example

ZCN18

symbols^optional

A symbol or code that identifies an option. Multiple symbols separated by a comma may be used.

Type

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

Example

ZCK210C,ZCK210P

type^optional

The type of option desired, Call or Put.

Type

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

Example

Call

expirationMonth^optional

The numeric representation of the expiration month.

Type

int (A numeric type defining a whole number. (example: 2))

Example

11

expirationDay^optional

The numeric date for of the expiration day.

Type

int (A numeric type defining a whole number. (example: 2))

Example

21

fields^optional

Additional fields requested.

Type

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

Example

premium,openInterest

Outputs

symbol
always returned

A symbol or code that identifies the futures contract.

string
A sequence of characters. (example: GOOG)

root
always returned

The root symbol for the future.

string
A sequence of characters. (example: GOOG)

contract
always returned

The symbol for the futures contract.

string
A sequence of characters. (example: GOOG)

underlyingFuture
always returned

The symbol for the underlying futures contract.

string
A sequence of characters. (example: GOOG)

contractName
always returned

The name of the futures contract.

string
A sequence of characters. (example: GOOG)

contractMonth
always returned

The month code for this option's contract.

string
A sequence of characters. (example: GOOG)

exchange
always returned

The name of the exchange the instrument belongs to.

string
A sequence of characters. (example: GOOG)

type
always returned

Either Call or Put.

string
A sequence of characters. (example: GOOG)

strike
always returned

The option's strike price.

double
A numeric type defining a number with fractional parts. (example: 2.14)

expirationDate
always returned

The expiration date.

date
A date in the format of YYYY-MM-DD.

date
always returned

The price date.

date
A date in the format of YYYY-MM-DD.

impliedVolatility
always returned

The estimated volatility of a security's price.

double
A numeric type defining a number with fractional parts. (example: 2.14)

delta
always returned

The option's delta value.

double
A numeric type defining a number with fractional parts. (example: 2.14)

gamma
always returned

The option's gamma value.

double
A numeric type defining a number with fractional parts. (example: 2.14)

theta
always returned

The option's theta value.

double
A numeric type defining a number with fractional parts. (example: 2.14)

vega
always returned

The option's vega value.

double
A numeric type defining a number with fractional parts. (example: 2.14)

open
always returned

The opening (first) price for the session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

high
always returned

The highest traded price for the session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

low
always returned

The lowest traded price for the session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

last
always returned

The last price the instrument traded.

double
A numeric type defining a number with fractional parts. (example: 2.14)

previousClose
always returned

The last price the instrument traded.

double
A numeric type defining a number with fractional parts. (example: 2.14)

change
always returned

The difference between the last traded price and the previous close.

double
A numeric type defining a number with fractional parts. (example: 2.14)

percentChange
always returned

The percent difference between the last traded price and the previous close.

double
A numeric type defining a number with fractional parts. (example: 2.14)

premium
as requested

The option's premium.

double
A numeric type defining a number with fractional parts. (example: 2.14)

volume
always returned

The trade volume of the option.

int
A numeric type defining a whole number. (example: 2)

openInterest
as requested

Start of the day Open Interest of the option symbol

int
A numeric type defining a whole number. (example: 2)

settlement
as requested

The settlement price determined by the exchange.

double
A numeric type defining a number with fractional parts. (example: 2.14)

previousSettlement
as requested

The settlement price for the previous session.

double
A numeric type defining a number with fractional parts. (example: 2.14)

extendedSymbol
as requested

The new barchart options symbol.

string
A sequence of characters. (example: GOOG)

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/getFuturesOptionsEOD.json?apikey=YOUR_API_KEY&root=ZC&contract=ZCN18&symbols=ZCK210C%2CZCK210P&type=Call&fields=premium%2CopenInterest
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY&root=ZC&contract=ZCN18&symbols=ZCK210C%2CZCK210P&type=Call&fields=premium%2CopenInterest

Response

{
    "status": {
        "code": 204,
        "message": "Success, but no content to return."
    },
    "results": []
}

XML

GET

GET https://ondemand.websol.barchart.com/getFuturesOptionsEOD.xml?apikey=YOUR_API_KEY&root=ZC&contract=ZCN18&symbols=ZCK210C%2CZCK210P&type=Call&fields=premium%2CopenInterest
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY&root=ZC&contract=ZCN18&symbols=ZCK210C%2CZCK210P&type=Call&fields=premium%2CopenInterest

Response

<?xml version="1.0" encoding="utf-8"?>
<getFuturesOptionsEOD>
  <status>
    <code>204</code>
    <message>Success, but no content to return.</message>
  </status>
</getFuturesOptionsEOD>

CSV

GET

GET https://ondemand.websol.barchart.com/getFuturesOptionsEOD.csv?apikey=YOUR_API_KEY&root=ZC&contract=ZCN18&symbols=ZCK210C%2CZCK210P&type=Call&fields=premium%2CopenInterest
Host: ondemand.websol.barchart.com

POST

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

apikey=YOUR_API_KEY&root=ZC&contract=ZCN18&symbols=ZCK210C%2CZCK210P&type=Call&fields=premium%2CopenInterest

Response

PHP

<?php

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

$params = [
    'apikey' => 'YOUR_API_KEY',
    'root' => 'ZC',
    'contract' => 'ZCN18',
    'symbols' => 'ZCK210C,ZCK210P',
    'type' => 'Call',
    'fields' => 'premium,openInterest',
];

$result = $ondemand->getFuturesOptionsEOD($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.getFuturesOptionsEOD("YOUR_API_KEY", "ZC", "ZCN18", "ZCK210C,ZCK210P", "Call", "premium,openInterest")

Perl

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

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

my $result = $ondemand->getFuturesOptionsEOD('YOUR_API_KEY', 'ZC', 'ZCN18', 'ZCK210C,ZCK210P', 'Call', 'premium,openInterest');

print $result;

Python

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

result = ondemand.service.getFuturesOptionsEOD('YOUR_API_KEY', 'ZC', 'ZCN18', 'ZCK210C,ZCK210P', 'Call', 'premium,openInterest')

print(result)

Ruby

require 'savon'

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

response = ondemand.call(
    :getFuturesOptionsEOD,
    message: {
        apikey: 'YOUR_API_KEY',
        root: 'ZC',
        contract: 'ZCN18',
        symbols: 'ZCK210C,ZCK210P',
        type: 'Call',
        fields: 'premium,openInterest',
    }
)

response.body