# WOO X

WOO X exchange historical data for **all its instruments** is available since **2023-01-20**.

{% embed url="<https://api.tardis.dev/v1/exchanges/woo-x>" %}
See WOO X historical data coverage: available symbols, channels, date ranges and incidents
{% endembed %}

### 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](https://docs.tardis.dev/downloadable-csv-files/overview).

| data type             | symbol          | date       |                                                                                                             |
| --------------------- | --------------- | ---------- | ----------------------------------------------------------------------------------------------------------- |
| incremental\_book\_L2 | SPOT\_BTC\_USDT | 2023-02-01 | [Download sample](https://datasets.tardis.dev/v1/woo-x/incremental_book_L2/2023/02/01/SPOT_BTC_USDT.csv.gz) |
| trades                | SPOT\_BTC\_USDT | 2023-02-01 | [Download sample](https://datasets.tardis.dev/v1/woo-x/trades/2023/02/01/SPOT_BTC_USDT.csv.gz)              |
| derivative\_ticker    | PERP\_BTC\_USDT | 2023-02-01 | [Download sample](https://datasets.tardis.dev/v1/woo-x/derivative_ticker/2023/02/01/PERP_BTC_USDT.csv.gz)   |

### API Access and data format

Historical data format is the same as provided by real-time WOO X WebSocket **Market Data API v2** (<wss://wss.woo.org/ws/stream>) 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](https://docs.tardis.dev/downloadable-csv-files/overview) or official [client libs](https://docs.tardis.dev/api/quickstart) that can perform data normalization client-side.

{% tabs %}
{% tab title="Python" %}

```python
# pip install tardis-dev
import asyncio
from tardis_dev import Channel, replay

async def main():
    async for local_timestamp, message in replay(
        exchange="woo-x",
        from_date="2024-01-01",
        to_date="2024-01-02",
        filters=[Channel(name="orderbook", symbols=["PERP_BTC_USDT"])],
        api_key="YOUR_API_KEY",
    ):
        # messages as provided by WOO X real-time stream
        print(message)

asyncio.run(main())
```

See [Python client docs](https://docs.tardis.dev/python-client/quickstart).
{% endtab %}

{% tab title="Node.js" %}

```javascript
// npm install tardis-dev
import { replay } from 'tardis-dev';

const messages = replay({
  exchange: 'woo-x',
  from: '2024-01-01',
  to: '2024-01-02',
  filters: [{ channel: 'orderbook', symbols: ['PERP_BTC_USDT'] }],
  apiKey: 'YOUR_API_KEY'
});

// messages as provided by WOO X real-time stream
for await (const { localTimestamp, message } of messages) {
  console.log(localTimestamp, message);
}
```

See [Node.js client docs](https://docs.tardis.dev/node-client/quickstart).
{% endtab %}

{% tab title="cURL & HTTP API" %}

```bash
curl --compressed -g 'https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01&filters=[{"channel":"orderbook","symbols":["PERP_BTC_USDT"]}]&offset=0'
```

{% embed url="<https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01&filters=[{%22channel%22:%22orderbook%22,%22symbols%22:[%22PERP_BTC_USDT%22]}]&offset=0>" %}
Example API response for Woo X historical market data request
{% endembed %}

See [HTTP API docs](https://docs.tardis.dev/api/http-api-reference).
{% endtab %}

{% tab title="cURL & tardis-machine" %}

```bash
curl -g 'localhost:8000/replay?options={"exchange":"woo-x","filters":[{"channel":"orderbook","symbols":["PERP_BTC_USDT"]}],"from":"2024-01-01","to":"2024-01-02"}'
```

[Tardis-machine](https://docs.tardis.dev/tardis-machine/quickstart) is a locally runnable server that exposes API allowing efficiently requesting historical market data for whole time periods in contrast to [HTTP API](https://docs.tardis.dev/api/http-api-reference) that provides data only in minute by minute slices.

See [tardis-machine](https://docs.tardis.dev/tardis-machine/quickstart) docs.
{% endtab %}
{% endtabs %}

### Captured real-time channels

{% embed url="<https://docs.woox.io/#websocket-api-v2>" %}
See WOO X WebSocket v2 API docs providing documentation for each captured channel's format
{% endembed %}

{% hint style="info" %}
Click any channel below to see [HTTP API](https://docs.tardis.dev/api/http-api-reference#data-feeds-exchange) response with historical data recorded for it.
{% endhint %}

* [trade](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22trade%22}]) Public trade executions stream
* [orderbook](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22orderbook%22}]) — generated channel Initial order book snapshots from REST API used to bootstrap orderbookupdate stream. Uses request order book API to get it <https://docs.woox.io/#request-orderbook>
* [orderbookupdate](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22orderbookupdate%22}]) Order book incremental updates
* [bbo](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22bbo%22}]) Best bid and ask updates
* [indexprice](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22indexprice%22}]) Index price updates
* [markprice](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22markprice%22}]) Mark price updates
* [openinterest](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22openinterest%22}]) Open interest updates
* [estfundingrate](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22estfundingrate%22}]) Estimated funding rate updates
* [ticker](https://api.tardis.dev/v1/data-feeds/woo-x?from=2024-01-01\&filters=\[{%22channel%22:%22ticker%22}]) 24h spot ticker updates

### Market data collection details

[Market data collection infrastructure](https://docs.tardis.dev/faq/general#what-is-your-infrastructure-setup) for WOO X is located in GCP asia-northeast1 (Tokyo, Japan).

Real-time market data is captured via **multiple WebSocket connections** to `wss://wss.woo.org/ws/stream`.

{% hint style="info" %}
WOO X servers are located in GCP asia-northeast1 (Tokyo, Japan).
{% endhint %}
