# bitFlyer

bitFlyer historical data for **all its instruments** is available since **2019-08-30**.

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

{% hint style="warning" %}
Real-time market data provided by bitFlyer exchange isn't always the most reliable and clean, especially during market volatility periods (crossed order books, delayed trade data).
{% endhint %}

### 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 | FX\_BTC\_JPY | 2020-01-01 | [Download sample](https://datasets.tardis.dev/v1/bitflyer/incremental_book_L2/2020/01/01/FX_BTC_JPY.csv.gz) |
| trades                | FX\_BTC\_JPY | 2020-01-01 | [Download sample](https://datasets.tardis.dev/v1/bitflyer/trades/2020/01/01/FX_BTC_JPY.csv.gz)              |
| quotes                | FX\_BTC\_JPY | 2020-01-01 | [Download sample](https://datasets.tardis.dev/v1/bitflyer/quotes/2020/01/01/FX_BTC_JPY.csv.gz)              |

### API Access and data format

Historical data format is the same as provided by real-time bitFlyer **lightning** **JSON-RPC 2.0 over WebSocket** 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](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="bitflyer",
        from_date="2023-03-01",
        to_date="2023-03-02",
        filters=[Channel(name="lightning_board", symbols=["FX_BTC_JPY"])],
        api_key="YOUR_API_KEY",
    ):
        # messages as provided by bitFlyer 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: 'bitflyer',
  from: '2023-03-01',
  to: '2023-03-02',
  filters: [{ channel: 'lightning_board', symbols: ['FX_BTC_JPY'] }],
  apiKey: 'YOUR_API_KEY'
});

// messages as provided by bitFlyer 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/bitflyer?from=2023-03-01&filters=[{"channel":"lightning_board","symbols":["FX_BTC_JPY"]}]&offset=0'
```

{% embed url="<https://api.tardis.dev/v1/data-feeds/bitflyer?from=2023-03-01&filters=[{%22channel%22:%22lightning_board%22,%22symbols%22:[%22FX_BTC_JPY%22]}]&offset=0>" %}
Example API response for bitFlyer 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":"bitflyer","filters":[{"channel":"lightning_board","symbols":["FX_BTC_JPY"]}],"from":"2023-03-01","to":"2023-03-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://lightning.bitflyer.com/docs?lang=en#json-rpc-2.0-over-websocket>" %}
See bitFlyer WebSocket 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 %}

* [lightning\_executions](https://api.tardis.dev/v1/data-feeds/bitflyer?from=2024-01-01\&filters=\[{%22channel%22:%22lightning_executions%22}]) Trade executions stream
* [lightning\_board\_snapshot](https://api.tardis.dev/v1/data-feeds/bitflyer?from=2024-01-01\&filters=\[{%22channel%22:%22lightning_board_snapshot%22}]) — **generated** Generated initial order book snapshot stream used for order book bootstrap
* [lightning\_board](https://api.tardis.dev/v1/data-feeds/bitflyer?from=2024-01-01\&filters=\[{%22channel%22:%22lightning_board%22}]) Order book snapshots and updates stream
* [lightning\_ticker](https://api.tardis.dev/v1/data-feeds/bitflyer?from=2024-01-01\&filters=\[{%22channel%22:%22lightning_ticker%22}]) Best bid/ask, last price and 24h stats stream. Docs state delivery frequency is throttled but do not specify interval.

### Market data collection details

[Market data collection infrastructure](https://docs.tardis.dev/faq/general#what-is-your-infrastructure-setup) for bitFlyer **since 2020-05-28** 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 **single WebSocket connection** to `wss://ws.lightstream.bitflyer.com/json-rpc`.

{% hint style="info" %}
bitFlyer servers are located in AWS ap-northeast-1 region (Tokyo, Japan).
{% endhint %}