> For the complete documentation index, see [llms.txt](https://docs.tardis.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tardis.dev/faq/general.md).

# General

Common questions about exchanges, API access and infrastructure

## About Tardis.dev

### What is Tardis.dev and what is your unique value proposition?

Tardis.dev provides tick-level historical and real-time cryptocurrency market data from 50+ exchanges and offers:

* access to [high frequency historical data](/faq/data.md#what-does-high-frequency-historical-data-mean), including tick-level order book updates and trades for [derivatives and top spot cryptocurrency exchanges](#which-exchanges-instruments-and-currency-pairs-are-supported)
* [non-standard data types](/faq/data.md#what-data-types-do-you-support): historical funding, open interest, indexes, liquidations and more
* access via [API](/api/quickstart.md) and [downloadable CSV files](/downloadable-csv-files/overview.md)
* data [sourced from real-time WebSocket market data feeds](/faq/data.md#why-data-source-matters-websocket-feeds-vs-rest-endpoints), with documented [collection details](/historical-data-details.md#market-data-collection-overview)
* [exchange-native](/faq/data.md#what-is-a-difference-between-exchange-native-and-normalized-data-format) and [normalized data format](/faq/data.md#what-is-a-difference-between-exchange-native-and-normalized-data-format) support
* [time-machine market replay](#how-does-time-machine-market-replay-work) for reconstructing order book state at historical points in time
* [always available market data backup](#what-is-your-infrastructure-setup)
* [subscription types](/faq/billing-and-subscriptions.md#what-are-the-differences-between-subscription-types) for solo traders, small prop shops, businesses and academic researchers
* [consolidated real-time market data streaming](#do-you-support-consolidated-real-time-market-data-streaming) support via Tardis.dev open source libraries that connect directly to exchanges' public WebSocket APIs (no API key required)

**Data use cases**

* market microstructure and order book dynamics research
* trading execution optimization
* tick-level granularity market simulation
* liquidity and lead-lag analysis
* backtesting and optimization of trading strategies
* full historical order book reconstruction at any given point in time
* alpha generation
* designing quantitative models
* academic research
* data visualizations

### Why would I use your services if I can collect data by myself?

You can collect exchange market data directly, but doing it reliably is time-consuming and resource-intensive. It requires collection infrastructure, storage, distribution, monitoring, exchange API maintenance, new exchange integrations, and ongoing handling of connection drops, rate limits, latency spikes, and upstream API changes. Supported exchanges publish around 1 TB of new data per day.

We maintain that infrastructure so you can focus on trading and research instead of building an in-house data collection and distribution system. See our [data types](/faq/data.md#what-data-types-do-you-support), [data sourcing approach](/faq/data.md#why-data-source-matters-websocket-feeds-vs-rest-endpoints), and [subscription types](/faq/billing-and-subscriptions.md#what-are-the-differences-between-subscription-types) for details.

### Which exchanges, instruments and currency pairs are supported?

Over 50 000 distinct instruments & currency pairs across leading derivatives and spot cryptocurrency exchanges are supported. We collect and provide data for all instruments & currency pairs available on a given exchange, with some exceptions for spot exchanges where we collect high-cap currency pairs only (due to exchange API limitations).

{% hint style="info" %}
See [historical data details](/historical-data-details.md#per-exchange-historical-data-details) for each supported exchange.
{% endhint %}

* Binance
  * [Binance USDS-M Futures](/historical-data-details/binance-futures.md)
  * [Binance COIN Futures](/historical-data-details/binance-delivery.md)
  * [Binance European Options](/historical-data-details/binance-european-options.md)
  * [Binance Spot](/historical-data-details/binance.md)
  * [Binance US](/historical-data-details/binance-us.md)
* OKX
  * [OKX Futures](/historical-data-details/okex-futures.md)
  * [OKX Swap](/historical-data-details/okex-swap.md)
  * [OKX Options](/historical-data-details/okex-options.md)
  * [OKX Spot](/historical-data-details/okex.md)
  * [OKX Nitro Spreads](/historical-data-details/okex-spreads.md)
* Coinbase
  * [Coinbase Exchange](/historical-data-details/coinbase.md)
  * [Coinbase Derivatives](/historical-data-details/coinbase-derivatives.md)
* [Deribit](/historical-data-details/deribit.md)
* Bybit
  * [Bybit Derivatives](/historical-data-details/bybit.md)
  * [Bybit Spot](/historical-data-details/bybit-spot.md)
  * [Bybit Options](/historical-data-details/bybit-options.md)
  * [Bybit Spread](/historical-data-details/bybit-spread.md)
* [Kraken Futures](/historical-data-details/cryptofacilities.md)
* [Kraken](/historical-data-details/kraken.md)
* Bitfinex
  * [Bitfinex Derivatives](/historical-data-details/bitfinex-derivatives.md)
  * [Bitfinex](/historical-data-details/bitfinex.md)
* KuCoin
  * [KuCoin Futures](/historical-data-details/kucoin-futures.md)
  * [KuCoin Spot](/historical-data-details/kucoin.md)
* [Aster Futures](/historical-data-details/aster-futures.md)
* [Aster Spot](/historical-data-details/aster.md)
* [MEXC Spot](/historical-data-details/mexc.md)
* [MEXC Futures](/historical-data-details/mexc-futures.md)
* [Crypto.com](/historical-data-details/crypto-com.md)
* [Bitstamp](/historical-data-details/bitstamp.md)
* [Bitvavo](/historical-data-details/bitvavo.md)
* Bitget
  * [Bitget Futures](/historical-data-details/bitget-futures.md)
  * [Bitget Spot](/historical-data-details/bitget.md)
* Gate.io
  * [Gate.io Futures](/historical-data-details/gate-io-futures.md)
  * [Gate.io](/historical-data-details/gate-io.md)
* HTX
  * [HTX Coin-M Futures](/historical-data-details/huobi-dm.md)
  * [HTX Coin-M Perpetual](/historical-data-details/huobi-dm-swap.md)
  * [HTX USDT-M Contracts](/historical-data-details/huobi-dm-linear-swap.md)
  * [HTX Spot](/historical-data-details/huobi.md)
* [Gemini](/historical-data-details/gemini.md)
* [WOO X](/historical-data-details/woo-x.md)
* [Upbit](/historical-data-details/upbit.md)
* [Bithumb](/historical-data-details/bithumb.md)
* [Phemex](/historical-data-details/phemex.md)
* [Delta Exchange](/historical-data-details/delta.md)
* [Delta Exchange India](/historical-data-details/delta-india.md)
* [Blockchain.com](/historical-data-details/blockchain-com.md)
* [Bitnomial](/historical-data-details/bitnomial.md)
* [bitFlyer](/historical-data-details/bitflyer.md)
* [HitBTC](/historical-data-details/hitbtc.md)
* [Poloniex](/historical-data-details/poloniex.md)
* [Hyperliquid](/historical-data-details/hyperliquid.md)
* [Lighter](/historical-data-details/lighter.md)
* [Lighter RH](/historical-data-details/lighter-rh.md)
* [Polymarket](/historical-data-details/polymarket.md)
* [Bullish](/historical-data-details/bullish.md)
* [dYdX v4](/historical-data-details/dydx-v4.md)
* Delisted exchanges
  * [Coinbase International](/historical-data-details/coinbase-international.md)
  * [BitMEX](/historical-data-details/bitmex.md)
  * [FTX](/historical-data-details/ftx.md)
  * [FTX US](/historical-data-details/ftx-us.md)
  * [OKCoin](/historical-data-details/okcoin.md)
  * [AscendEX (BitMax)](/historical-data-details/ascendex.md)
  * [CoinFLEX](/historical-data-details/coinflex.md)
  * [Binance Jersey](/historical-data-details/binance-jersey.md)
  * [Binance DEX](/historical-data-details/binance-dex.md)
  * [HTX Options](/historical-data-details/huobi-dm-options.md)
  * [dYdX](/historical-data-details/dydx.md)
  * [Serum DEX](/historical-data-details/serum.md)
  * [Mango Markets DEX](/historical-data-details/mango.md)
  * [Star Atlas DEX](/historical-data-details/star-atlas.md)

### How far back is historical data available?

The earliest data is from **2019-03-30**. The table below shows the dates for each exchange.

| **exchange**                                                                     | **available since** | **available until** |
| -------------------------------------------------------------------------------- | ------------------- | ------------------- |
| [Binance USDS-M Futures](/historical-data-details/binance-futures.md)            | 2019-11-17          |                     |
| [Binance COIN Futures](/historical-data-details/binance-delivery.md)             | 2020-06-16          |                     |
| [Binance European Options](/historical-data-details/binance-european-options.md) | 2023-06-15          |                     |
| [Binance Spot](/historical-data-details/binance.md)                              | 2019-03-30          |                     |
| [Binance US](/historical-data-details/binance-us.md)                             | 2019-09-25          |                     |
| [OKX Futures](/historical-data-details/okex-futures.md)                          | 2019-03-30          |                     |
| [OKX Swap](/historical-data-details/okex-swap.md)                                | 2019-03-30          |                     |
| [OKX Options](/historical-data-details/okex-options.md)                          | 2020-02-01          |                     |
| [OKX Spot](/historical-data-details/okex.md)                                     | 2019-03-30          |                     |
| [OKX Nitro Spreads](/historical-data-details/okex-spreads.md)                    | 2023-12-22          |                     |
| [Coinbase Exchange](/historical-data-details/coinbase.md)                        | 2019-03-30          |                     |
| [Coinbase Derivatives](/historical-data-details/coinbase-derivatives.md)         | 2026-10-14          |                     |
| [Deribit](/historical-data-details/deribit.md)                                   | 2019-03-30          |                     |
| [Bybit Derivatives](/historical-data-details/bybit.md)                           | 2019-11-07          |                     |
| [Bybit Spot](/historical-data-details/bybit-spot.md)                             | 2021-12-04          |                     |
| [Bybit Options](/historical-data-details/bybit-options.md)                       | 2023-04-05          |                     |
| [Bybit Spread](/historical-data-details/bybit-spread.md)                         | 2026-10-07          |                     |
| [Kraken Futures](/historical-data-details/cryptofacilities.md)                   | 2019-03-30          |                     |
| [Kraken](/historical-data-details/kraken.md)                                     | 2019-06-04          |                     |
| [Bitfinex Derivatives](/historical-data-details/bitfinex-derivatives.md)         | 2019-09-14          |                     |
| [Bitfinex](/historical-data-details/bitfinex.md)                                 | 2019-05-23          |                     |
| [KuCoin Futures](/historical-data-details/kucoin-futures.md)                     | 2024-01-25          |                     |
| [KuCoin Spot](/historical-data-details/kucoin.md)                                | 2022-08-16          |                     |
| [Aster Futures](/historical-data-details/aster-futures.md)                       | 2026-08-23          |                     |
| [Aster Spot](/historical-data-details/aster.md)                                  | 2026-08-23          |                     |
| [MEXC Spot](/historical-data-details/mexc.md)                                    | 2026-06-25          |                     |
| [MEXC Futures](/historical-data-details/mexc-futures.md)                         | 2026-06-25          |                     |
| [Crypto.com](/historical-data-details/crypto-com.md)                             | 2022-06-01          |                     |
| [Bitstamp](/historical-data-details/bitstamp.md)                                 | 2019-03-30          |                     |
| [Bitvavo](/historical-data-details/bitvavo.md)                                   | 2026-09-23          |                     |
| [Bitget Futures](/historical-data-details/bitget-futures.md)                     | 2024-11-08          |                     |
| [Bitget Spot](/historical-data-details/bitget.md)                                | 2024-11-08          |                     |
| [Gate.io Futures](/historical-data-details/gate-io-futures.md)                   | 2020-07-01          |                     |
| [Gate.io](/historical-data-details/gate-io.md)                                   | 2020-07-01          |                     |
| [HTX Coin-M Futures](/historical-data-details/huobi-dm.md)                       | 2019-11-19          |                     |
| [HTX Coin-M Perpetual](/historical-data-details/huobi-dm-swap.md)                | 2020-03-28          |                     |
| [HTX USDT-M Contracts](/historical-data-details/huobi-dm-linear-swap.md)         | 2020-10-30          |                     |
| [HTX Spot](/historical-data-details/huobi.md)                                    | 2019-11-19          |                     |
| [Gemini](/historical-data-details/gemini.md)                                     | 2019-08-30          |                     |
| [WOO X](/historical-data-details/woo-x.md)                                       | 2023-01-20          |                     |
| [Upbit](/historical-data-details/upbit.md)                                       | 2021-03-03          |                     |
| [Bithumb](/historical-data-details/bithumb.md)                                   | 2026-09-23          |                     |
| [Phemex](/historical-data-details/phemex.md)                                     | 2020-03-17          |                     |
| [Delta Exchange](/historical-data-details/delta.md)                              | 2020-03-30          |                     |
| [Delta Exchange India](/historical-data-details/delta-india.md)                  | 2026-10-29          |                     |
| [Blockchain.com](/historical-data-details/blockchain-com.md)                     | 2023-02-23          |                     |
| [Bitnomial](/historical-data-details/bitnomial.md)                               | 2023-01-13          |                     |
| [bitFlyer](/historical-data-details/bitflyer.md)                                 | 2019-08-30          |                     |
| [HitBTC](/historical-data-details/hitbtc.md)                                     | 2019-11-19          |                     |
| [Poloniex](/historical-data-details/poloniex.md)                                 | 2020-07-01          |                     |
| [Hyperliquid](/historical-data-details/hyperliquid.md)                           | 2024-10-29          |                     |
| [Lighter](/historical-data-details/lighter.md)                                   | 2026-04-17          |                     |
| [Lighter RH](/historical-data-details/lighter-rh.md)                             | 2026-09-23          |                     |
| [Polymarket](/historical-data-details/polymarket.md)                             | 2026-05-25          |                     |
| [Bullish](/historical-data-details/bullish.md)                                   | 2026-04-29          |                     |
| [dYdX v4](/historical-data-details/dydx-v4.md)                                   | 2024-08-23          |                     |
| [Coinbase International](/historical-data-details/coinbase-international.md)     | 2024-10-31          | 2026-10-01          |
| [BitMEX](/historical-data-details/bitmex.md)                                     | 2019-03-30          | 2026-09-22          |
| [FTX](/historical-data-details/ftx.md)                                           | 2019-08-01          | 2022-11-13          |
| [FTX US](/historical-data-details/ftx-us.md)                                     | 2020-05-22          | 2022-11-13          |
| [OKCoin](/historical-data-details/okcoin.md)                                     | 2019-11-19          | 2025-10-01          |
| [AscendEX (BitMax)](/historical-data-details/ascendex.md)                        | 2021-03-28          | 2026-07-07          |
| [CoinFLEX](/historical-data-details/coinflex.md)                                 | 2020-07-14          | 2023-04-07          |
| [Binance Jersey](/historical-data-details/binance-jersey.md)                     | 2019-10-30          | 2020-11-10          |
| [Binance DEX](/historical-data-details/binance-dex.md)                           | 2019-06-04          | 2022-10-04          |
| [HTX Options](/historical-data-details/huobi-dm-options.md)                      | 2021-02-01          | 2021-06-26          |
| [dYdX](/historical-data-details/dydx.md)                                         | 2021-04-06          | 2024-10-30          |
| [Serum DEX](/historical-data-details/serum.md)                                   | 2021-06-23          | 2022-11-13          |
| [Mango Markets DEX](/historical-data-details/mango.md)                           | 2022-01-19          | 2022-10-14          |
| [Star Atlas DEX](/historical-data-details/star-atlas.md)                         | 2021-10-09          | 2022-09-05          |

### Do you provide historical market data in CSV flat files?

Yes, see [downloadable CSV files documentation](/downloadable-csv-files/overview.md) for more details.

## Using the data

### What can I use the data for?

For your own internal business, research, educational or personal use, such as backtesting, strategy development, trading and risk management, including work for your clients and quantitative models you build for your own use. You can't redistribute or resell the data, or use it to provide a product or service that gives others access to it, such as a data feed, an API or a backtesting platform.

You can share charts, statistics, research reports and papers made from the data, and aggregated results such as OHLCV candles of 10 minutes or longer, when the raw data can't be reconstructed from them; this doesn't apply to Coinbase data. You can store and process the data with cloud and IT providers that keep it confidential and don't use it for their own purposes.

### Can I keep using the data after my subscription ends?

Yes. Data you downloaded while you had access, including trial and free data, stays licensed to you after your subscription ends, under the same licence restrictions.

## Getting the data

### How can I download the data?

You can access historical market data via [API](/api/quickstart.md) which provides raw data in [exchange native format](/faq/data.md#what-is-a-difference-between-exchange-native-and-normalized-data-format) or download [CSV datasets](/downloadable-csv-files/overview.md) with [trades](/downloadable-csv-files/data-types.md#trades), [incremental order book L2 updates](/downloadable-csv-files/data-types.md#incremental_book_l2), order book snapshots ([top 25](/downloadable-csv-files/data-types.md#book_snapshot_25) and [top 5](/downloadable-csv-files/data-types.md#book_snapshot_5)), [options chains](/downloadable-csv-files/data-types.md#options_chain), [quotes](/downloadable-csv-files/data-types.md#quotes), [book tickers](/downloadable-csv-files/data-types.md#book_ticker), [derivative tickers](/downloadable-csv-files/data-types.md#derivative_ticker) (open interest, funding, mark price, index price) and [liquidations](/downloadable-csv-files/data-types.md#liquidations).

[Our client libs](/api/quickstart.md) provide data in [normalized format](/faq/data.md#what-is-a-difference-between-exchange-native-and-normalized-data-format) as well, which can be more flexible than CSV datasets for some use cases but also slower to download due to on-demand, client-side data normalization overhead in comparison to ready to download CSV files.

{% hint style="info" %}
**Replay API** supports custom time windows with minute precision (e.g., `2024-01-15T09:30:00.000Z` to `2024-01-15T16:00:00.000Z`). **CSV datasets** are available as daily files.
{% endhint %}

### What can affect CSV dataset download speed?

CSV dataset download speed depends mainly on the network path between your location and our primary cloud storage in the US East region. Longer cross-continent routes, local network conditions and temporary public Internet congestion can affect throughput. A single connection over a long route rarely uses all of your bandwidth, so parallel downloads help most there.

Very rarely, a cloud storage service may be temporarily slower or unavailable. We recommend using the latest [official Python or Node.js clients](/downloadable-csv-files/overview.md#download-via-client-libraries). They download several files at once, split large files into parallel parts and, after a transient network or storage error, retry only the part that failed. If you download with your own code, request large files in parallel parts with [`Range` requests](/downloadable-csv-files/api.md#datasets-api-reference) and stay within the [request limits](/api/rate-limits.md#request-limits).

### What programming languages are supported?

Any programming language that can communicate using HTTPS can communicate with our [HTTP API](/api/http-api-reference.md).

We provide official [Python](/python-client/quickstart.md) and [Node.js](/node-client/quickstart.md) clients for accessing tick-level historical market data.

Finally, our open source, locally runnable [tardis-machine](/tardis-machine/quickstart.md) server with built-in local data caching provides market data normalization, custom order book snapshot capabilities, and real-time market data streaming support that connects directly to exchanges' WebSocket APIs. It provides both streaming HTTP and WebSocket endpoints returning market data for whole time periods (in contrast to Tardis.dev [HTTP API](/api/http-api-reference.md), where a single call returns 1 to 10 minutes of data) and is available via npm and as a Docker image.

### What API protocols can be used to access market data?

Historical market data provided by [HTTP API](/api/http-api-reference.md) can be accessed via HTTPS.

Locally runnable [tardis-machine](/tardis-machine/quickstart.md) server provides both HTTP and WebSocket based APIs for accessing both historical and real-time market data.

### How does time-machine market replay work?

Exchange WebSocket APIs are built for real-time feeds, not historical replay. Locally runnable [Tardis Machine](/tardis-machine/replaying-historical-data.md#websocket-ws-replay-exchange-exchange-and-from-fromdate-and-to-todate) bridges that gap by replaying historical exchange-native data through a WebSocket API with the same subscribe-style flow as exchange real-time APIs. In many cases, an existing exchange WebSocket client can replay a historical date range by changing the endpoint URL.

### Do you support consolidated real-time market data streaming?

We do not provide a hosted real-time market data API. Exchanges already provide public real-time WebSocket feeds directly, and a hosted Tardis.dev real-time API would add latency and another dependency.

Use the [open source clients and locally runnable Tardis Machine](/api/quickstart.md) for consolidated real-time streaming. They are self-hosted, free to use, and connect directly to exchange WebSocket APIs without a Tardis.dev Data API key.

### Are there any rate-limits for the API?

Yes. See [API Rate Limits](/api/rate-limits.md) for account-level API request and data transfer limits.

## Data API keys

### How do I obtain my Data API key?

Ask an [AI agent](/agents-and-ai.md), or choose **Create Data API key** in your [account](https://tardis.dev/account#api-keys). The key gives access to the data in your [subscription](https://tardis.dev/#order) or [free trial](/faq/billing-and-subscriptions.md#how-do-free-trials-work). Copy the key when it's shown, because you won't see it again.

### How can I rotate or reset my Data API key?

Ask an [AI agent](/agents-and-ai.md), or choose **Rotate** next to the key in your [account](https://tardis.dev/account#api-keys). You get a new key at once, and the old one keeps working for an hour so you can switch over. If your subscription allows one key, you can rotate again when the old key stops working: after that hour, or right away if you revoke it. An account can rotate keys up to 3 times in 24 hours. If a key was compromised, choose **Revoke** to stop it immediately.

### Why doesn't my Data API key work?

The error message says why:

* "This account does not have access to…": the exchange or date you requested is outside your subscription's [data plan](/faq/billing-and-subscriptions.md#how-does-subscription-based-access-work) or [historical data range](/faq/billing-and-subscriptions.md#how-much-historical-data-does-my-subscription-include), or outside a [free trial's](/faq/billing-and-subscriptions.md#how-do-free-trials-work) days 1–10 of the previous month. Solo and Academic subscriptions include CSV files only.
* "This account does not currently have access to market data": the account has no active trial or subscription. A subscription paid by bank transfer starts when the payment arrives; after a failed renewal, see [What happens if a renewal payment fails?](/faq/billing-and-subscriptions.md#what-happens-if-a-renewal-payment-fails)
* "This Data API key is already active from another IP address": except with Business subscriptions, a key works from [one IP address at a time](/api/rate-limits.md#data-api-key-usage). Another IP address can use it 15 minutes after the last request from the first one.
* "This account has reached its data transfer limit": see your usage and reset date in your account and the [data transfer limits](/api/rate-limits.md#data-transfer-limits).
* "This account has used the data transfer included in its free trial": the [free trial's](/faq/billing-and-subscriptions.md#how-do-free-trials-work) 20 GB of data transfer is used up and doesn't reset. Choose a subscription to continue.
* "This account is sending requests too quickly": retry after the seconds in the `retry-after` header, and see the [request limits](/api/rate-limits.md#request-limits).
* "For unauthorized requests, only…": the request has no Data API key, or the key is mistyped. Send it as `Authorization: Bearer YOUR_API_KEY`.
* "Unauthorized": the key was revoked, or was rotated more than an hour ago.

## Support and infrastructure

### What are the email support response targets?

We aim to send an initial response to support emails within:

| Subscription type | Initial response target |
| ----------------- | ----------------------- |
| Academic          | 5 days                  |
| Solo              | 3 days                  |
| Professional      | 24 hours                |
| Business          | 12 hours                |

### Can we schedule a call?

No, we don't do calls. [Contact us](https://tardis.dev/#contact) with your questions and we'll answer them by email.

### Do you provide an SLA?

No, we don't offer an SLA.

### How do you keep the API secure?

We continuously monitor our API for security issues.

### What is your infrastructure setup?

#### Market data collection

Highly available [Google Cloud Platform Kubernetes Clusters](https://cloud.google.com/kubernetes-engine/) located in London, UK (europe-west2 region) and Tokyo, Japan (asia-northeast1 region)

#### Market data storage

Two independent, geo-redundant, highly durable storage services

#### Market data distribution

High performance API servers deployed across network of data centers around the globe

### What is premium connectivity?

For Professional and Business subscriptions, API traffic uses premium connectivity: [Cloudflare Argo Smart Routing](https://www.cloudflare.com/application-services/products/argo-smart-routing/) routes it through Cloudflare's private backbone instead of the public internet. This reduces latency, routes around congestion and outages, and gives more predictable response times wherever you are.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.tardis.dev/faq/general.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.