Tardis.dev Documentation
Search…
OKEx Spot
OKEx Spot historical market data details - currency pairs, data coverage and data collection specifics
OKEx historical data for spot high caps currency pairs is available since 2019-03-30, data for all spot currency pairs is available since 2021-03-11.
https://api.tardis.dev/v1/exchanges/okex
api.tardis.dev
See OKEx Spot historical data coverage: available symbols, channels, date ranges and incidents
​
Downloadable CSV files
Historical CSV datasets for the first day of each month are available to download without API key.
See downloadable CSV files documentation.
data type
symbol
date
​
​
How to download all OKEx datasets for all instruments
Python
Node.js
cURL
1
# requires Python >=3.6
2
# pip install tardis-dev
3
​
4
from tardis_dev import datasets, get_exchange_details
5
import logging
6
​
7
# optionally enable debug logs
8
# logging.basicConfig(level=logging.DEBUG)
9
​
10
exchange = 'okex'
11
exchange_details = get_exchange_details(exchange)
12
​
13
# iterate over and download all data for every symbol
14
for symbol in exchange_details["datasets"]["symbols"]:
15
# alternatively specify datatypes explicitly ['trades', 'incremental_book_L2', 'quotes'] etc
16
# see available options https://docs.tardis.dev/downloadable-csv-files#data-types
17
data_types = symbol["dataTypes"]
18
symbol_id = symbol["id"]
19
from_date = symbol["availableSince"]
20
to_date = symbol["availableTo"]
21
​
22
# skip groupped symbols
23
if symbol_id in ['PERPETUALS', 'SPOT', 'FUTURES']:
24
continue
25
​
26
print(f"Downloading {exchange} {data_types} for {symbol_id} from {from_date} to {to_date}")
27
​
28
# each CSV dataset format is documented at https://docs.tardis.dev/downloadable-csv-files#data-types
29
# see https://docs.tardis.dev/downloadable-csv-files#download-via-client-libraries for full options docs
30
datasets.download(
31
exchange = exchange,
32
data_types = data_types,
33
from_date = from_date,
34
to_date = to_date,
35
symbols = [symbol_id],
36
# TODO set your API key here
37
api_key = "YOUR_API_KEY",
38
# path where CSV data will be downloaded into
39
download_dir = "./datasets",
40
)
Copied!
See docs that shows all available download options (download path customization, filenames conventions and more).
1
// npm install tardis-dev
2
// requires node version >=12
3
const { downloadDatasets, getExchangeDetails } = require('tardis-dev')
4
​
5
;(async () => {
6
const exchange = 'okex'
7
const exchangeDetails = await getExchangeDetails(exchange)
8
​
9
// iterate over and download all data for every symbol
10
for (const symbol of exchangeDetails.datasets.symbols) {
11
// alternatively specify dataTypes explicitly ['trades', 'incremental_book_L2', 'quotes'] etc
12
// see available options https://docs.tardis.dev/downloadable-csv-files#data-types
13
const dataTypes = symbol.dataTypes
14
const symbolId = symbol.id
15
​
16
const from = symbol.availableSince
17
const to = symbol.availableTo
18
​
19
// skip groupped symbols
20
if (['PERPETUALS', 'SPOT', 'FUTURES'].includes(symbolId)) {
21
continue
22
}
23
​
24
console.log(`Downloading ${exchange} ${dataTypes} for ${symbolId} from ${from} to ${to}`)
25
​
26
// each CSV dataset format is documented at https://docs.tardis.dev/downloadable-csv-files#data-types
27
// see https://docs.tardis.dev/downloadable-csv-files#download-via-client-libraries for full options docs
28
await downloadDatasets({
29
exchange,
30
dataTypes,
31
from,
32
to,
33
symbols: [symbolId],
34
// TODO: set your API key here
35
apiKey: 'YOUR_API_KEY',
36
// path where CSV data will be downloaded into
37
downloadDir: './datasets'
38
})
39
}
40
})()
Copied!
See docs that shows all available download options (download path customization, filenames conventions and more).
1
curl -o okex_trades_2019-11-01_BTC-USD.csv.gz https://datasets.tardis.dev/v1/okex/trades/2019/11/01/BTC-USD.csv.gz
Copied!
​
​
API Access and data format
Historical data format is the same as provided by real-time OKEx WebSocket v3 API with addition of local timestamps. If you'd like to work with normalized data format instead (same format for each exchange) see downloadable CSV files or official client libs that can perform data normalization client-side.
Python
Node.js
cURL & HTTP API
cURL & tardis-machine
1
# pip install tardis-client
2
import asyncio
3
from tardis_client import TardisClient, Channel
4
tardis_client = TardisClient(api_key="YOUR_API_KEY")
5
​
6
async def replay():
7
# replay method returns Async Generator
8
messages = tardis_client.replay(
9
exchange="okex",
10
from_date="2020-01-01",
11
to_date="2020-01-02",
12
filters=[Channel(name="spot/trade", symbols=[])]
13
)
14
​
15
# messages as provided by OKEx real-time stream
16
async for local_timestamp, message in messages:
17
print(message)
18
​
19
​
20
asyncio.run(replay())
Copied!
1
// npm install tardis-dev
2
const { replay } = require('tardis-dev');
3
​
4
async function run() {
5
try {
6
const messages = replay({
7
exchange: 'okex',
8
from: '2020-01-01',
9
to: '2020-01-02',
10
filters: [{ channel: 'spot/trade', symbols: [] }],
11
apiKey: 'YOUR_API_KEY'
12
});
13
​
14
// messages as provided by OKEx real-time stream
15
for await (const { localTimestamp, message } of messages) {
16
console.log(localTimestamp, message);
17
}
18
} catch (e) {
19
console.error(e);
20
}
21
}
22
​
23
run();
Copied!
1
curl -g 'https://api.tardis.dev/v1/data-feeds/okex?from=2020-01-01&filters=[{"channel":"spot/trade","symbols":[]}]&offset=0'
Copied!
https://api.tardis.dev/v1/data-feeds/okex?from=2020-01-01&filters=[{%22channel%22:%22spot/trade%22,%22symbols%22:[]}]&offset=0
api.tardis.dev
Example API response for OKEx Spot historical market data request
1
curl -g 'localhost:8000/replay?options={"exchange":"okex","filters":[{"channel":"spot/trade","symbols":[]}],"from":"2020-01-01","to":"2020-01-02"}'
Copied!
​Tardis-machine is a locally runnable server that exposes API allowing efficiently requesting historical market data for whole time periods in contrast to HTTP API that provides data only in minute by minute slices.
​
Captured real-time channels
OKEx API guide | OKEx technical support | OKEx
See OKEx Spot WebSocket API docs providing documentation for each captured channel's format
​
​
Market data collection details
​Market data collection infrastructure for OKEx Spot since 2020-05-15 is located in GCP asia-northeast1 (Tokyo, Japan), before that it was located in GCP europe-west2 region (London, UK).
Real-time market data is captured via multiple WebSocket connections.
​
OKEx servers are located in Alibaba Cloud cn-hongkong region (Hong Kong, China).
​
​
Last modified 1mo ago