Downloading Data
Read Downloaded Data
Request
The /data/read
API accepts requests in the following format:
DataDownloadRequest Model - Request for a link to downloadable data. | |
---|---|
format | object Format for returning data, link or download. |
ticker | string /. |
type | string Enum Type of tradable security / underlying asset. Options : ['Base', 'Equity', 'Option', 'Commodity', 'Forex', 'Future', 'Cfd', 'Crypto'] |
resolution | string Enum Resolution of data requested. Options : ['Tick', 'Second', 'Minute', 'Hour', 'Daily'] |
market | string Enum Fungible market of the underlying security. Options : ['usa', 'oanda', 'fxcm', 'dukascopy', 'bitfinex', 'cmeglobex', 'nymex', 'cbot', 'ice', 'cboe', 'nse', 'comex', 'cme', 'sgx', 'hkfe', 'coinbase', 'kraken', 'bitstamp', 'okcoin', 'bithumb', 'binance', 'poloniex', 'coinone', 'hitbtc', 'bittrex'] |
date | string Date of the data requested yyyyMMdd. |
Example |
{ "format": "link", "ticker": "string", "type": "Base", "resolution": "Tick", "market": "usa", "date": "yyyyMMdd" } |
SecurityType Model - Type of tradable security / underlying asset. | |
---|---|
SecurityType | string Enum Type of tradable security / underlying asset. Options : ['Base', 'Equity', 'Option', 'Commodity', 'Forex', 'Future', 'Cfd', 'Crypto'] |
Example |
{ "SecurityType": "Base" } |
Resolution Model - Resolution of data requested. | |
---|---|
Resolution | string Enum Resolution of data requested. Options : ['Tick', 'Second', 'Minute', 'Hour', 'Daily'] |
Example |
{ "Resolution": "Tick" } |
Market Model - Fungible market of the underlying security. | |
---|---|
Market | string Enum Fungible market of the underlying security. Options : ['usa', 'oanda', 'fxcm', 'dukascopy', 'bitfinex', 'cmeglobex', 'nymex', 'cbot', 'ice', 'cboe', 'nse', 'comex', 'cme', 'sgx', 'hkfe', 'coinbase', 'kraken', 'bitstamp', 'okcoin', 'bithumb', 'binance', 'poloniex', 'coinone', 'hitbtc', 'bittrex'] |
Example |
{ "Market": "usa" } |
Responses
The /data/read
API provides a response in the following format:
200 Success
ReadDataLinkResponse Model - Response from reading purchased data. | |
---|---|
link | string Link to the data. |
success | boolean Indicate if the API request was successful. |
errors | string Array List of errors with the API call. |
Example |
{ "link": "string", "success": true, "errors": [ "string" ] } |
401 Authentication Error
UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash. | |
---|---|
www_authenticate | string Header |