Subcription API Frequently Asked Questions (FAQ)


getFuturesByExchange
getEquitiesByExchange
getFuturesOptions
getEquitiesOptions
getHistory
getSECFilings
getFuturesSpecifications



getFuturesByExchange

The closing price for all commodities will be blank on an end of day permissioned feed. In the flag field, if it equals ā€œsā€ then the market is settled and the settlement is passed down in the lastPrice field.

Intraday data may be delayed by up to 20 minutes as we cache the results.




getEquitiesByExchange

Intraday data may be delayed by up to 20 minutes as we cache the results. getEquitiesByExchange only lists equities that have traded on the day. Equities that have not traded will not be available in the query return.




getFuturesOptions

When using root= parameter, futures options will update at the below times of day:12am, 1am, 6am, 8am, 10am, and 11pm

Use contract= parameter for intraday futures options if you are permissioned for delayed data on any of the futures exchanges.




getEquitiesOptions

Symbology:

Example: AAPL150213P00075000

The new OCC option symbol consists of 4 parts

1. the root symbol of the underlying stock or ETF, padded with spaces to 6 characters

2. the expiration date, 6 digits in the format yymmdd

3. option type, either P or C, for put or call

4. strike price, as the price x 1000, front padded with 0s to 8 digits

options symbology


getHistory

Records are limited to 1000 unless including maxRecords > 1000 parameter

If using the interval=parameter, data returned will not include the settlement/close price at the end of the market session.


Definition of Nearby and Continuous Contracts:

For Daily Nearest / Weekly Nearest / Monthly Nearest / Quarterly Nearest / Yearly Nearest: Builds a historical chart using the nearest contract. The nearest contract is the closest unexpired contract for the underlying commodity, where every chart bar represents the front month at that point in history.

For Daily Continue / Weekly Continue / Monthly Continue / Quarterly Continue / Yearly Continue: Builds a historical chart using the same month specified for the original contract. For example, if the symbol is ZSX13 (Soybeans November 2013), the chart is built using all previous November contracts for Soybeans (ZSX13, ZSX12, ZSX11, ZSX10 etc).




getSECFilings

Records are automatically limited to 20 enteries unless you include maxRecords parameter: http://ondemand.websol.barchart.com/getSECFilings.xml?apikey=YOUR_API_KEY&symbols=AAPL&filingType=Allex&startDate=2016-01-05&maxRecords=100




getFuturesSpecifications

http://ondemand.websol.barchart.com/getFuturesSpecifications.xml?apikey=YOUR_API_KEY&symbols=ZCH8

Margin field shows two values:

First is initial margin value

Second is maintenance margin value