XFT API v4 (4.0.0)

Download OpenAPI specification:Download

XFT Support: [email protected] URL: https://linktr.ee/xft.reed License: Apache 2.0 Terms of Service

XFT Homepage
API Backward Compatibility Policy
Python API Client

HTTP API root endpoint URL is https://api.xft.io/v4. XFT' paid product.
WebSocket API root endpoint is wss://api.xft.io/v4. XFT' paid product.

The Community HTTP API root endpoint URL is https://community-api.xft.io/v4. API key is not required when accessing community endpoints. Available to the community under the Creative Commons license.

Authentication

api_key

XFT API key can be specified as ?api_key= query parameter.

Security Scheme Type: API Key

Query parameter name: api_key

Response headers

Note that XFT API responses have a CF-RAY HTTP header e.g. 88a6ec1d2f930774-IAD which can be used for diagnostic purposes. When raising Support requests, please ensure to provide the value of this header.

Rate limits

To ensure the quality of XFT services, API is subject to rate limiting.
The community version of API has the limit of 10 requests per 6 seconds sliding window for an IP address.
The trial version of API has the limit of 10 requests per 6 seconds sliding window for an API key.
The paid version of API has the limit of 6000 requests per 20 seconds sliding window for an API key.
The paid and community versions of the API have a limit of 10 parallel HTTP requests, after this limit is reached further parallel requests will be queued, so performance will be slower.
The paid version of API has a limit of 200 concurrent websocket connections for an API Key.
If you reach the request-per-second limit, API starts to return 429 Too Many Requests HTTP response status.
API also provides X-RateLimit-* response headers formatted according to https://tools.ietf.org/html/draft-polli-ratelimit-headers-03.

Reference Data

Metadata information of entities supported by XFT.

Assets

Returns a list of assets metadata.

Authorizations:

API Key: api_key

query Parameters

assets	Array of strings Comma separated list of assets. By default all assets are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataAssetInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/assets?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"asset": "btc",
"full_name": "Bitcoin"
},
{"asset": "etc",
"full_name": "Ethereum Classic"
}
],
"next_page_token": "ZXRo",
"next_page_url": "https://api.xft.io/v4/reference-data/assets?api_key=<your_key>&page_size=2&next_page_token=ZXRo"
}

Exchanges

Returns a list of exchanges metadata.

Authorizations:

API Key: api_key

query Parameters

exchanges	Array of strings Comma separated list of exchanges. By default all exchanges are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataExchangeInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/exchanges?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"exchange": "binance",
"full_name": "Binance"
},
{"exchange": "bittrex",
"full_name": "Bittrex"
}
],
"next_page_token": "YnliaXQ",
"next_page_url": "https://api.xft.io/v4/reference-data/exchanges?api_key=<your_key>&page_size=2&next_page_token=YnliaXQ"
}

Markets

Returns a list of markets metadata.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataMarketInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/markets?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"market": "binance-btc-usdt-spot",
"exchange": "binance",
"type": "spot",
"base": "btc",
"quote": "usdt",
"pair": "btc-usdt",
"symbol": "BTCUSDT"
},
{"market": "binance-1000FLOKIUSDT-future",
"exchange": "binance",
"type": "future",
"base": "floki",
"quote": "usdt",
"pair": "floki-usdt",
"symbol": "1000FLOKIUSDT",
"size_asset": "floki",
"margin_asset": "usdt",
"contract_size": "1000",
"tick_size": "0.00001",
"listing": "2023-05-06T00:00:00.000000000Z",
"order_amount_increment": "1",
"order_amount_min": "1",
"order_amount_max": "10000000",
"order_price_increment": "0.0000100",
"order_price_min": "0.0000100",
"order_price_max": "200",
"order_size_min": "5.0"
},
{"market": "deribit-BTC-10DEC22-17500-C-option",
"exchange": "deribit",
"type": "option",
"base": "btc",
"quote": "usd",
"pair": "btc-usd",
"symbol": "BTC-10DEC22-17500-C",
"size_asset": "btc",
"strike": "17500",
"option_contract_type": "call",
"is_european": true,
"contract_size": "1",
"listing": "2022-12-08T08:01:00.000000000Z",
"expiration": "2022-12-10T08:00:00.000000000Z",
"settlement_price": "17160.85",
"status": "offline",
"order_amount_min": "0.1",
"order_price_increment": "0.0005",
"order_taker_fee": "0.0003",
"order_maker_fee": "0.0003"
}
],
"next_page_token": "ZGVyaWJpdC1CVEMtMTBERUMyMi0xNzUwMC1QLW9wdGlvbg",
"next_page_url": "https://api.xft.io/v4/reference-data/markets?api_key=<your_key>&page_size=3&next_page_token=ZGVyaWJpdC1CVEMtMTBERUMyMi0xNzUwMC1QLW9wdGlvbg"
}

Indexes

Returns a list of indexes metadata.

Authorizations:

API Key: api_key

query Parameters

indexes	Array of strings Comma separated list of indexes. By default all indexes are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataIndexInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/indexes?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"index": "CMBIBTCT",
"full_name": "CMBI Bitcoin Total Return Index",
"description": "A single asset index measuring the performance an investor would expect from purchasing and holding Bitcoin as well as liquidating legitimate forked assets.",
"type": "single_asset"
},
{"index": "CMBIBTCV",
"full_name": "CMBI Bitcoin Index",
"description": "A single asset index measuring the performance an investor would expect from purchasing and holding Bitcoin."
}
],
"next_page_token": "Q01CSURFWEU",
"next_page_url": "https://api.xft.io/v4/reference-data/indexes?api_key=<your_key>&page_size=2&next_page_token=Q01CSURFWEU"
}

Pairs

Returns a list of pairs metadata.

Authorizations:

API Key: api_key

query Parameters

pairs	Array of strings Comma separated list of asset pairs. By default, all asset pairs are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataPairInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/pair-metrics?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"pair": "btc-eur",
"full_name": "Bitcoin - Euro"
},
{"pair": "btc-usdt",
"full_name": "Bitcoin - Tether"
}
],
"next_page_token": "ZXRoLXVzZHQ",
"next_page_url": "https://api.xft.io/v4/reference-data/pairs?api_key=<your_key>&page_size=2&next_page_token=ZXRoLXVzZHQ"
}

Asset metrics

Returns a list of asset metrics metadata.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
reviewable	boolean Limit to human-reviewable metrics. By default all metrics are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataMetricInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

https://api.xft.io/v4/reference-data/asset-metrics

https://community-api.xft.io/v4/reference-data/asset-metrics

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/asset-metrics?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "AdrAct30dCnt",
"full_name": "Addresses, active, monthly, count",
"description": "The sum count of unique addresses that were active in the network (either as a recipient or originator of a ledger change) in the trailing 30 days up to the end of that interval. All parties in a ledger change action (recipients and originators) are counted. Individual addresses are not double-counted if previously active.",
"product": "Network Data",
"category": "Addresses",
"subcategory": "Active",
"unit": "Addresses",
"data_type": "bigint",
"type": "Sum",
"display_name": "Active Monthly Addr Cnt",
"docs_url": "https://docs.coinmetrics.io/network-data/network-data-overview/addresses/active-addresses"
},
{"metric": "AdrAct7dCnt",
"full_name": "Addresses, active, weekly, count",
"description": "The sum count of unique addresses that were active in the network (either as a recipient or originator of a ledger change) in the trailing 7 days up to the end of that interval. All parties in a ledger change action (recipients and originators) are counted. Individual addresses are not double-counted if active several times in the considered interval.",
"product": "Network Data",
"category": "Addresses",
"subcategory": "Active",
"unit": "Addresses",
"data_type": "bigint",
"type": "Sum",
"display_name": "Active Weekly Addr Cnt",
"docs_url": "https://docs.coinmetrics.io/network-data/network-data-overview/addresses/active-addresses"
}
],
"next_page_token": "QWRyQWN0Q250",
"next_page_url": "https://api.xft.io/v4/reference-data/asset-metrics?api_key=<your_key>&page_size=2&next_page_token=QWRyQWN0Q250"
}

Exchange metrics

Returns a list of exchange metrics metadata.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataMetricInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

https://api.xft.io/v4/reference-data/exchange-metrics

https://community-api.xft.io/v4/reference-data/exchange-metrics

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/exchange-metrics?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "liquidations_reported_future_buy_units_1d",
"full_name": "Liquidations, reported, future, buys, native units, one day",
"description": "The sum of all buy liquidations from perpetual futures markets in native units of the underlying base asset.",
"product": "Market Data",
"category": "Liquidations",
"subcategory": "Futures",
"unit": "Native Units",
"data_type": "decimal",
"type": "Sum",
"display_name": "Reported Futures Buy Liquidations, native units",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/liquidations/"
},
{"metric": "liquidations_reported_future_buy_units_1h",
"full_name": "Liquidations, reported, future, buys, native units, one hour",
"description": "The sum of all buy liquidations from perpetual futures markets in native units of the underlying base asset.",
"product": "Market Data",
"category": "Liquidations",
"subcategory": "Futures",
"unit": "Native Units",
"data_type": "decimal",
"type": "Sum",
"display_name": "Reported Futures Buy Liquidations, native units",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/liquidations/"
}
],
"next_page_token": "bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0",
"next_page_url": "https://api.xft.io/v4/reference-data/exchange-metrics?api_key=<your_key>&page_size=2&next_page_token=bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0"
}

Exchange asset metrics

Returns a list of exchange asset metrics metadata.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataMetricInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

https://api.xft.io/v4/reference-data/exchange-asset-metrics

https://community-api.xft.io/v4/reference-data/exchange-asset-metrics

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/exchange-asset-metrics?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "basis_annualized_120d_exp",
"full_name": "Basis, annualized, 120 day expiration ",
"description": "The relative difference between the price of a futures contract that expires in 120 days and the price of its underlying spot market.",
"product": "Market Data",
"category": "Basis",
"subcategory": "Future",
"unit": "Dimensionless",
"data_type": "decimal",
"type": "Percentage",
"display_name": "Annualized Futures Basis, 120 day expiration",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/basis/"
},
{"metric": "basis_annualized_30d_exp",
"full_name": "Basis, annualized, 30 day expiration ",
"description": "The relative difference between the price of a futures contract that expires in 30 days and the price of its underlying spot market.",
"product": "Market Data",
"category": "Basis",
"subcategory": "Future",
"unit": "Dimensionless",
"data_type": "decimal",
"type": "Percentage",
"display_name": "Annualized Futures Basis, 30 day expiration",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/basis/"
}
],
"next_page_token": "YmFzaXNfYW5udWFsaXplZF82MGRfZXhw",
"next_page_url": "https://api.xft.io/v4/reference-data/exchange-asset-metrics?api_key=<your_key>&page_size=2&next_page_token=YmFzaXNfYW5udWFsaXplZF82MGRfZXhw"
}

Pair metrics

Returns a list of pair metrics metadata.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataMetricInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/pair-metrics?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "liquidations_reported_future_buy_units_1d",
"full_name": "Liquidations, reported, future, buys, native units, one day",
"description": "The sum of all buy liquidations from perpetual futures markets in native units of the underlying base asset.",
"product": "Market Data",
"category": "Liquidations",
"subcategory": "Futures",
"unit": "Native Units",
"data_type": "decimal",
"type": "Sum",
"display_name": "Reported Futures Buy Liquidations, native units",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/liquidations/"
},
{"metric": "liquidations_reported_future_buy_units_1h",
"full_name": "Liquidations, reported, future, buys, native units, one hour",
"description": "The sum of all buy liquidations from perpetual futures markets in native units of the underlying base asset.",
"product": "Market Data",
"category": "Liquidations",
"subcategory": "Futures",
"unit": "Native Units",
"data_type": "decimal",
"type": "Sum",
"display_name": "Reported Futures Buy Liquidations, native units",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/liquidations/"
}
],
"next_page_token": "bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0",
"next_page_url": "https://api.xft.io/v4/reference-data/pair-metrics?api_key=<your_key>&page_size=2&next_page_token=bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0"
}

Institution metrics

Returns a list of institution metrics metadata.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataMetricInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

https://api.xft.io/v4/reference-data/institution-metrics

https://community-api.xft.io/v4/reference-data/institution-metrics

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/institution-metrics?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "bat_coin_per_share",
"full_name": "Grayscale Basic Attention Token Trust, Native Units of Coin Per Share",
"description": "The number of native units of the coin per share of the Grayscale Basic Attention Token Trust.",
"product": "Market Data",
"category": "Institutions",
"subcategory": "Investment Products",
"unit": "Native Units",
"data_type": "decimal",
"type": "Ratio",
"display_name": "Grayscale Basic Attention Token Trust, Native Units of Coin Per Share",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/institution-metrics-overview/grayscale/coin-per-share"
},
{"metric": "bat_market_price",
"full_name": "Grayscale Basic Attention Token Trust, Market Price per Share, USD",
"description": "The market price per share in U.S. dollars of the Grayscale Basic Attention Token Trust.",
"product": "Market Data",
"category": "Institutions",
"subcategory": "Investment Products",
"unit": "USD",
"data_type": "decimal",
"type": "Ratio",
"display_name": "Grayscale Basic Attention Token Trust, Market Price per Share, USD",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/institution-metrics-overview/grayscale/market-price"
}
],
"next_page_token": "YmF0X25ldF9hc3NldF92YWx1ZQ",
"next_page_url": "https://api.xft.io/v4/reference-data/institution-metrics?api_key=<your_key>&page_size=2&next_page_token=YmF0X25ldF9hc3NldF92YWx1ZQ"
}

Market metrics

Returns a list of market metrics metadata.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (ReferenceDataMetricInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

https://api.xft.io/v4/reference-data/market-metrics

https://community-api.xft.io/v4/reference-data/market-metrics

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/reference-data/market-metrics?api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "liquidations_reported_future_buy_units_1d",
"full_name": "Liquidations, reported, future, buys, native units, one day",
"description": "The sum of all buy liquidations from perpetual futures markets in native units of the underlying base asset.",
"product": "Market Data",
"category": "Liquidations",
"subcategory": "Futures",
"unit": "Native Units",
"data_type": "decimal",
"type": "Sum",
"display_name": "Reported Futures Buy Liquidations, native units",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/liquidations/"
},
{"metric": "liquidations_reported_future_buy_units_1h",
"full_name": "Liquidations, reported, future, buys, native units, one hour",
"description": "The sum of all buy liquidations from perpetual futures markets in native units of the underlying base asset.",
"product": "Market Data",
"category": "Liquidations",
"subcategory": "Futures",
"unit": "Native Units",
"data_type": "decimal",
"type": "Sum",
"display_name": "Reported Futures Buy Liquidations, native units",
"docs_url": "https://docs.coinmetrics.io/market-data/market-data-overview/liquidations/"
}
],
"next_page_token": "bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0",
"next_page_url": "https://api.xft.io/v4/reference-data/market-metrics?api_key=<your_key>&page_size=2&next_page_token=bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0"
}

Profile

Profile endpoints

Asset profiles data (experimental)

Returns profile data for assets.
Results are ordered by asset.
To fetch the next page of results use next_page_url JSON response field.
If supply_cap is not present then the theoretical maximum supply is infinite for that asset.

Authorizations:

API Key: api_key

query Parameters

assets	Array of strings Comma separated list of asset ids. By default profile data for all assets is returned. Mutually exclusive with `full_names` parameter.
full_names	Array of strings Comma separated list of asset full names. By default profile data for all assets is returned. Mutually exclusive with `assets` parameter.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (AssetProfileInfo)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/profile/assets?api_key=<your_key>"

Response samples

200
401
403

Content type

application/json

{"data": [{"asset": "btc",
"full_name": "Bitcoin",
"description": "Bitcoin is a peer-to-peer network that facilitates transfers between network participants without any central authority.",
"overview": "Bitcoin is a peer-to-peer network that facilitates transfers between network participants without any central authority. Bitcoin utilizes blockchain technology to create a trusted distributed ledger storing transaction and account data. The Bitcoin blockchain consists of blocks, added roughly every 10 minutes, that contain information on recent transactions, active addresses, and a link to previous blocks, ultimately providing a complete record of all transactions on the network. To add a block to the chain, miners must find a particular nonce that when hashed meets the requirements presented by the network. When a passable nonce is discovered the miner broadcasts it to all the nodes on the network, who in turn make sure each transaction on the block is valid and add it to their copy of the chain. To incentivize mining, the miner that finds the correct nonce is rewarded a fixed amount of bitcoin ( the reward amount halves every 210,000 blocks) and any transaction fees included. This cryptographic process is referred to as proof of work. The difficulty of each block is controlled by the network, which scales difficulty as the total hashing power on the network increases. To access the bitcoin network, users have wallets that allow them to see their available balance and transact with others. Each account has two keys associated with it: a public key and a private key. The public key gets converted into an address to which people can send you funds and the private key allows a user to prove ownership of bitcoin. When sending a transaction a user inputs the address of the intended recipient and the amount being transferred, signs the transaction with their private key, and specifies a transaction fee. Transactions wait in the mempool until they are added to blocks. Generally, a user can get a transaction included in a block earlier by paying a higher transaction fee. Since its inception, multiple second-layer solutions have been developed on the Bitcoin protocol. One of these solutions is the Lightning Network, which provides instant and low-cost micropayments between users. To use the network, two users open a payment channel that operates off-chain. Funds transferred through this channel are only settled on the blockchain when the users close the channel.",
"website": "https://bitcoin.org/en/",
"whitepaper_url": "https://bitcoin.org/bitcoin.pdf",
"consensus_mechanism": "Proof-of-Work (SHA256d)",
"creation_date": "2009-01-01",
"supply_cap": "21000000"
},
{"asset": "eth",
"full_name": "Ethereum",
"description": "Ethereum is a decentralized computing platform that allows users to create, deploy and interact with programs known as smart contracts.",
"overview": "Ethereum is a decentralized computing platform that allows users to create, deploy and interact with programs known as smart contracts. Ethereum is a transaction based state machine, meaning that at any point in time the state of the Ethereum network is represented by a mapping of accounts to their associated balance or state. The state of the Ethereum network is updated every time a new block is added to the chain, roughly every 12 seconds. Each block contains information regarding new transactions and is linked to the previous block. The ETH 1.0 chain used a proof-of-work consensus protocol similar to the one implemented by Bitcoin. However, in September 2022 Ethereum transitioned to a new proof-of-stake consensus mechanism that will help reduce fees and increase speed. In a proof-of-stake network, validators stake ETH capital (32 ETH) in a smart contract as a deterrent to act dishonestly. Validators in the network are responsible for validating blocks sent into the network, and creating new blocks when directed. Ethereum also has the capability for users to create smart contracts that are written in a high level language, compiled into bytecode and sent to a contract. The Ethereum Virtual Machine handles all of the bytecode and imposes the coded logic. Smart contracts allow developers to impose logic and rules upon interactions, ultimately creating a product that provides value on the chain. Examples of products built on Ethereum include Aave, a lending platform, and Livepeer, a video streaming infrastructure. Ethereum also provides the framework to create many different types of assets with rules. Examples of popular smart contracts include ERC-20, a framework to create tokens on Ethereum, or ERC-721, a framework for NFTs. Users can interact with smart contracts once they have been deployed allowing for the creation of decentralized applications and additional use cases.",
"website": "https://ethereum.org/en/",
"whitepaper_url": "https://ethereum.org/en/whitepaper/#ethereum-whitepaper",
"consensus_mechanism": "Proof-of-Stake",
"creation_date": "2015-07-30"
}
],
"next_page_token": "c29s",
"next_page_url": "https://api.xft.io/v4/profile/assets?api_key=<your_key>&assets=btc,eth,sol&page_size=2&next_page_token=c29s"
}

Taxonomy

Taxonomy endpoints

Taxonomy for assets

Returns Taxonomy for assets.
Results are ordered by tuple (asset, classification_start_time).
To fetch the next page of results use next_page_url JSON response field.

Authorizations:

API Key: api_key

query Parameters

assets	Array of strings Comma separated list of assets.
class_ids	Array of strings Comma separated list of class identifiers.
sector_ids	Array of strings Comma separated list of sector identifiers.
subsector_ids	Array of strings Comma separated list of subsector identifiers.
version	string Taxonomy version. Defaults to `latest` when no `_time` parameters specified. Specify asterisk `` in order to get all versions.
classification_start_time	string Start time of taxonomy asset classification. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Inclusive by default.
classification_end_time	string End time of taxonomy asset classification. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Inclusive by default.
start_inclusive	boolean Default: true Inclusive or exclusive corresponding `start_*` parameters.
end_inclusive	boolean Default: true Inclusive or exclusive corresponding `end_*` parameters.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (TaxonomyAsset)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/taxonomy/assets?api_key=<your_key>"

Response samples

200
401
403

Content type

application/json

{"data": [{"asset": "asset1",
"full_name": "Asset 1",
"taxonomy_version": "1.0",
"updated_at_taxonomy_version": "1.0",
"classification_start_time": "2010-07-19",
"class_id": "20",
"class": "Application",
"sector_id": "2030",
"sector": "Metaverse",
"subsector_id": "203020",
"subsector": "Gaming",
"classification_end_time": "2021-06-12"
},
{"asset": "asset2",
"full_name": "Asset 2",
"taxonomy_version": "2.0",
"updated_at_taxonomy_version": "2.0",
"classification_start_time": "2022-06-13",
"class_id": "10",
"class": "Transaction",
"sector_id": "1010",
"sector": "Digital Currency (DC)",
"subsector_id": "101010",
"subsector": "General-Purpose Digital Currencies"
}
],
"next_page_token": "bHJjfDE2Njc0MzM2MDAwMDA",
"next_page_url": "https://api.xft.io/v4/taxonomy/assets?page_size=2&api_key=<your_key>&next_page_token=bHJjfDE2Njc0MzM2MDAwMDA"
}

Taxonomy Metadata

Taxonomy Metadata endpoints

Taxonomy metadata for assets

Returns Taxonomy metadata for assets.
Results are ordered by tuple version.
To fetch the next page of results use next_page_url JSON response field.

Authorizations:

API Key: api_key

query Parameters

version	string Taxonomy version. Defaults to `latest` when no `_time` parameters specified. Specify asterisk `` in order to get all versions.
start_time	string Start time of taxonomy version. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Inclusive by default.
end_time	string End time of taxonomy version. Multiple formats of ISO 8601 are supported: `2006-01-20T00:00:00Z`, `2006-01-20T00:00:00.000Z`, `2006-01-20T00:00:00.123456Z`, `2006-01-20T00:00:00.123456789Z`, `2006-01-20`, `20060120`. Inclusive by default.
start_inclusive	boolean Default: true Inclusive or exclusive corresponding `start_*` parameters.
end_inclusive	boolean Default: true Inclusive or exclusive corresponding `end_*` parameters.
page_size	integer <int32> [ 1 .. 10000 ] Default: 100 Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
paging_from	string Default: "start" Enum: "start" "end" Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.
next_page_token	string Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use `next_page_url` response field.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required	Array of objects (TaxonomyMetadataAsset)
next_page_token	string (NextPageToken) Token of the next page results for a given request.
next_page_url	string (NextPageUrl) URL of the next page results for a given request.

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/taxonomy-metadata/assets?api_key=<your_key>"

Response samples

200
401
403

Content type

application/json

{"data": [{"taxonomy_version": "1.1",
"taxonomy_start_time": "2021-06-13",
"subsectors": [{"class_id": "10",
"class": "Transaction",
"sector_id": "1010",
"sector": "Digital Currency (DC)",
"subsector_id": "101010",
"subsector": "Remittance Coins"
},
{"class_id": "10",
"class": "Transaction",
"sector_id": "1010",
"sector": "Digital Currency (DC)",
"subsector_id": "101020",
"subsector": "Meme Coins"
},
{"class_id": "10",
"class": "Transaction",
"sector_id": "1010",
"sector": "Digital Currency (DC)",
"subsector_id": "101040",
"subsector": "Remittance Coins"
}
],
"taxonomy_end_time": "2022-06-12"
}
],
"next_page_token": "Mi4w",
"next_page_url": "https://api.xft.io/v4/taxonomy-metadata/assets?paging_from=end&page_size=2&version=*&api_key=<your_key>&next_page_token=Mi4w"
}

Catalog

Catalog of available for your api_key data.
Use the Full catalog endpoints for the full list of supported by XFT data.

Available assets

Returns a list of available assets along with information for them like metrics, markets, exchanges and time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

assets	Array of strings Comma separated list of assets. By default all assets are returned.
include	Array of strings Comma separated list of fields to include in response. Supported values are `metrics`, `markets`, `exchanges`. Included by default if omitted.
exclude	Array of strings Comma separated list of fields to exclude from response. Supported values are `metrics`, `markets`, `exchanges`. Included by default if omitted.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (AssetInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/assets?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"asset": "btc",
"full_name": "Bitcoin",
"metrics": [{"metric": "AdrActCnt",
"frequencies": [{"frequency": "1b",
"min_time": "2009-01-03T18:15:05.000000000Z",
"max_time": "2020-06-08T20:22:17.000000000Z",
"min_height": "0",
"max_height": "633762",
"min_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
"max_hash": "0000000000000000001103d90edd76573342cf3e2ff2453f8acf4d02fe91a32a"
},
{"frequency": "1d",
"min_time": "2009-01-03T00:00:00.000000000Z",
"max_time": "2020-06-07T00:00:00.000000000Z",
"community": true
}
]
},
{"metric": "FlowInBFXUSD",
"frequencies": [{"frequency": "1b",
"min_time": "2009-01-03T18:15:05.000000000Z",
"max_time": "2020-06-08T20:37:31.000000000Z",
"min_height": "0",
"max_height": "633763",
"min_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
"max_hash": "000000000000000000111614e0f5305dd4b16ca75cf4be433f58836eecf76929"
},
{"frequency": "1d",
"min_time": "2010-07-18T00:00:00.000000000Z",
"max_time": "2020-06-07T00:00:00.000000000Z"
}
]
}
],
"exchanges": ["binance",
"coinbase",
"kraken"
],
"markets": ["binance-btc-usdt-spot",
"binance-eth-btc-spot",
"coinbase-btc-usd-spot",
"coinbase-eth-btc-spot",
"kraken-btc-usd-spot"
]
},
{"asset": "eth",
"full_name": "Ethereum",
"metrics": [{"metric": "BlkSizeByte",
"frequencies": [{"frequency": "1b",
"min_time": "1970-01-01T00:00:00.000000000Z",
"max_time": "2020-06-08T20:44:27.000000000Z",
"min_height": "0",
"max_height": "10227342",
"min_hash": "d4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
"max_hash": "9358a17c8fa0aab1fb0dca61052764d85f36ae645a614e4d8531f43fcf264025"
},
{"frequency": "1d",
"min_time": "2015-07-30T00:00:00.000000000Z",
"max_time": "2020-06-07T00:00:00.000000000Z",
"community": true
}
]
},
{"metric": "FlowInBFXUSD",
"frequencies": [{"frequency": "1b",
"min_time": "1970-01-01T00:00:00.000000000Z",
"max_time": "2020-06-08T20:44:27.000000000Z",
"min_height": "0",
"max_height": "10227342",
"min_hash": "d4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
"max_hash": "9358a17c8fa0aab1fb0dca61052764d85f36ae645a614e4d8531f43fcf264025"
},
{"frequency": "1d",
"min_time": "2015-08-08T00:00:00.000000000Z",
"max_time": "2020-06-07T00:00:00.000000000Z"
}
]
}
],
"exchanges": ["bitbank",
"coinbase",
"huobi",
"liquid"
],
"markets": ["bitbank-eth-btc-spot",
"huobi-eth-btc-spot",
"huobi-eth-usdt-spot",
"coinbase-eth-usd-spot",
"coinbase-bat-eth-spot",
"liquid-eth-usd-spot"
]
}
]
}

Available metrics (deprecated)

Returns a list of available metrics along with information for them like description, category and assets for which a metric is available.
This endpoint is deprecated, please use /catalog/asset-metrics instead.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
reviewable	boolean Limit to human-reviewable metrics. By default all metrics are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMetricInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/metrics?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "AdrActCnt",
"full_name": "Addresses, active, count",
"description": "The sum count of unique addresses that were active in the network (either as a recipient or originator of a ledger change) that interval. All parties in a ledger change action (recipients and originators) are counted. Individual addresses are not double-counted if previously active.",
"category": "Addresses",
"subcategory": "Active",
"unit": "Addresses",
"data_type": "bigint",
"type": "Sum",
"frequencies": [{"frequency": "1b",
"assets": ["btc",
"eth",
"sol"
]
},
{"frequency": "1d",
"assets": ["ada",
"btc"
]
}
],
"display_name": "Active Addr Cnt"
},
{"metric": "AdrActContCnt",
"full_name": "Addresses, active, contracts, count",
"description": "The sum count of unique smart contract addresses that were active in the network (either as a recipient or originator of a ledger change) that interval. All parties in a ledger change action (recipients and originators) are counted. Individual addresses are not double-counted if previously active.",
"category": "Addresses",
"subcategory": "Active",
"unit": "Addresses",
"data_type": "bigint",
"type": "Sum",
"frequencies": [{"frequency": "1d",
"assets": ["etc",
"eth",
"xtz"
]
}
],
"display_name": "Active Smart Contract Addr Cnt"
}
]
}

Available asset metrics

Returns a list of available asset metrics along with information for them like description, category and assets for which a metric is available.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
reviewable	boolean Limit to human-reviewable metrics. By default all metrics are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogAssetMetricInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/asset-metrics?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "AdrActCnt",
"full_name": "Addresses, active, count",
"description": "The sum count of unique addresses that were active in the network (either as a recipient or originator of a ledger change) that interval. All parties in a ledger change action (recipients and originators) are counted. Individual addresses are not double-counted if previously active.",
"product": "Network Data",
"category": "Addresses",
"subcategory": "Active",
"unit": "Addresses",
"data_type": "bigint",
"type": "Sum",
"frequencies": [{"frequency": "1b",
"assets": ["btc",
"eth",
"sol"
]
},
{"frequency": "1d",
"assets": ["ada",
"btc"
]
}
],
"display_name": "Active Addr Cnt"
},
{"metric": "AdrActContCnt",
"full_name": "Addresses, active, contracts, count",
"description": "The sum count of unique smart contract addresses that were active in the network (either as a recipient or originator of a ledger change) that interval. All parties in a ledger change action (recipients and originators) are counted. Individual addresses are not double-counted if previously active.",
"product": "Network Data",
"category": "Addresses",
"subcategory": "Active",
"unit": "Addresses",
"data_type": "bigint",
"type": "Sum",
"frequencies": [{"frequency": "1d",
"assets": ["etc",
"eth",
"xtz"
]
}
],
"display_name": "Active Smart Contract Addr Cnt"
}
]
}

Available exchange metrics

Returns a list of available exchange metrics along with information for them like description, category and exchanges for which a metric is available.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
reviewable	boolean Limit to human-reviewable metrics. By default all metrics are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogExchangeMetricInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/exchange-metrics?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "open_interest_reported_future_coin_margined_usd",
"full_name": "Open interest, reported, future, coin-margined, USD",
"description": "The sum of all reported open interest from futures markets where the margin asset is equivalent to the underlying base asset in units of U.S. dollars.",
"product": "Market Data",
"category": "Open Interest",
"subcategory": "Future",
"unit": "USD",
"data_type": "decimal",
"type": "Sum",
"frequencies": [{"frequency": "1h",
"exchanges": ["binance",
"bitmex",
"bybit",
"deribit",
"huobi",
"kraken",
"okex"
]
},
{"frequency": "1d",
"exchanges": ["binance",
"bitmex",
"bybit",
"deribit",
"huobi",
"kraken",
"okex"
]
}
],
"display_name": "Reported Coin-Margined Future Open Interest"
},
{"metric": "volume_reported_future_perpetual_usd_1d",
"full_name": "Volume, reported, future, perpetual, USD, one day",
"description": "The sum of all reported volume from perpetual futures markets in units of U.S. dollars.",
"product": "Market Data",
"category": "Volume",
"subcategory": "Future",
"unit": "USD",
"data_type": "decimal",
"type": "Sum",
"frequencies": [{"frequency": "1d",
"exchanges": ["binance",
"bitfinex",
"kraken",
"okex"
]
}
],
"display_name": "Reported Perpetual Future Volume"
}
]
}

Available exchange-asset metrics

Returns a list of available exchange-asset metrics along with information for them like description, category and exchange-asset pairs for which a metric is available.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
reviewable	boolean Limit to human-reviewable metrics. By default all metrics are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogExchangeAssetMetricInfo)

https://api.xft.io/v4/catalog/exchange-asset-metrics

https://community-api.xft.io/v4/catalog/exchange-asset-metrics

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/exchange-asset-metrics?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "open_interest_reported_future_nonperpetual_usd",
"full_name": "Open interest, reported, future, non-perpetual, USD",
"description": "The sum of all reported open interest from non-perpetual futures markets in units of U.S. dollars.",
"product": "Market Data",
"category": "Open Interest",
"subcategory": "Future",
"unit": "USD",
"data_type": "decimal",
"type": "Sum",
"frequencies": [{"frequency": "1h",
"exchange_assets": ["binance-1inch",
"binance-ada",
"binance-algo"
]
},
{"frequency": "1d",
"exchange_assets": ["binance-1inch",
"binance-ada",
"binance-algo"
]
}
],
"display_name": "Reported Non-Perpetual Future Open Interest"
},
{"metric": "open_interest_reported_future_tether_margined_usd",
"full_name": "Open interest, reported, future, tether-margined, USD",
"description": "The sum of all reported open interest from futures markets where the margin asset is Tether in units of U.S. dollars.",
"product": "Market Data",
"category": "Open Interest",
"subcategory": "Future",
"unit": "USD",
"data_type": "decimal",
"type": "Sum",
"frequencies": [{"frequency": "1h",
"exchange_assets": ["binance-1inch",
"binance-ada",
"binance-algo"
]
},
{"frequency": "1d",
"exchange_assets": ["binance-1inch",
"binance-ada",
"binance-algo"
]
}
],
"display_name": "Reported Tether-Margined Future Open Interest"
}
]
}

Available pair metrics

Returns a list of available pair metrics along with information for them like description, category and pairs for which a metric is available.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
reviewable	boolean Limit to human-reviewable metrics. By default all metrics are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogPairMetricInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/pair-metrics?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "open_interest_reported_future_coin_margined_usd",
"full_name": "Open interest, reported, future, coin-margined, USD",
"description": "The sum of all reported open interest from futures markets where the margin asset is equivalent to the underlying base asset in units of U.S. dollars.",
"product": "Market Data",
"category": "Open Interest",
"subcategory": "Future",
"unit": "USD",
"data_type": "decimal",
"type": "Sum",
"frequencies": [{"frequency": "1h",
"pairs": ["1inch-usd",
"ada-usd",
"algo-usd"
]
},
{"frequency": "1d",
"pairs": ["1inch-usdc",
"ada-usdc",
"algo-usdc"
]
}
],
"display_name": "Reported Coin-Margined Future Open Interest"
},
{"metric": "volume_reported_future_coin_margined_usd_1d",
"full_name": "Volume, reported, future, coin-margined, USD, one day",
"description": "The sum of all reported volume from futures markets where the margin asset is equivalent to the underlying base asset in units of U.S. dollars.",
"product": "Market Data",
"category": "Volume",
"subcategory": "Future",
"unit": "USD",
"data_type": "decimal",
"type": "Sum",
"frequencies": [{"frequency": "1d",
"pairs": ["1inch-usdc",
"ada-usdc",
"algo-usdc"
]
}
],
"display_name": "Reported Coin-Margined Future Volume"
}
]
}

Available institution metrics

Returns a list of available institution metrics along with information for them like description, category and institutions for which a metric is available.

Authorizations:

API Key: api_key

query Parameters

metrics	Array of strings Comma separated list of metrics. By default all metrics are returned.
reviewable	boolean Limit to human-reviewable metrics. By default all metrics are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogInstitutionMetricInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/institution-metrics?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"metric": "bat_coin_per_share",
"full_name": "Grayscale Basic Attention Token Trust, Native Units of Coin Per Share",
"description": "The number of native units of the coin per share of the Grayscale Basic Attention Token Trust.",
"product": "Market Data",
"category": "Institutions",
"subcategory": "Investment Products",
"unit": "Native Units",
"data_type": "decimal",
"type": "Ratio",
"frequencies": [{"frequency": "1d",
"institutions": ["grayscale"
]
}
],
"display_name": "Grayscale Basic Attention Token Trust, Native Units of Coin Per Share"
},
{"metric": "bat_market_price",
"full_name": "Grayscale Basic Attention Token Trust, Market Price per Share, USD",
"description": "The market price per share in U.S. dollars of the Grayscale Basic Attention Token Trust.",
"product": "Market Data",
"category": "Institutions",
"subcategory": "Investment Products",
"unit": "USD",
"data_type": "decimal",
"type": "Ratio",
"frequencies": [{"frequency": "1d",
"institutions": ["grayscale"
]
}
],
"display_name": "Grayscale Basic Attention Token Trust, Market Price per Share, USD"
}
]
}

Available exchanges

Returns a list of available exchanges along with available markets for them.

Authorizations:

API Key: api_key

query Parameters

exchanges	Array of strings Comma separated list of exchanges. By default all exchanges are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (ExchangeInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/exchanges?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"exchange": "bibox",
"markets": ["bibox-abt-btc-spot",
"bibox-etc-usdt-spot"
],
"min_time": "2019-04-24T11:09:59.000000000Z",
"max_time": "2019-05-18T16:06:10.927000000Z"
},
{"exchange": "binance",
"markets": ["binance-BTCUSDT-future",
"binance-LTCUSDT-future",
"binance-ada-bnb-spot",
"binance-btc-usdt-spot",
"binance-bcpt-btc-spot",
"binance-bcd-eth-spot"
],
"min_time": "2017-07-14T04:00:00.510000000Z",
"max_time": "2020-06-08T20:33:28.868000000Z"
}
]
}

Available exchange-asset pairs

Returns a list of available exchange-asset pairs along with information for them like metrics and time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

exchange_assets	Array of strings Comma separated list of exchange-assets. By default, all exchange-assets pairs are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (ExchangeAssetInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/exchange-assets?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"exchange_asset": "binance-btc",
"metrics": [{"metric": "volume_trusted_spot_usd_1d",
"frequencies": [{"frequency": "1d",
"min_time": "2020-10-16T00:00:00.000000000Z",
"max_time": "2021-01-05T00:00:00.000000000Z"
}
]
},
{"metric": "volume_trusted_spot_usd_1h",
"frequencies": [{"frequency": "1h",
"min_time": "2020-10-15T03:00:00.000000000Z",
"max_time": "2021-01-06T12:00:00.000000000Z"
}
]
}
]
},
{"exchange_asset": "coinbase-eth",
"metrics": [{"metric": "volume_trusted_spot_usd_1d",
"frequencies": [{"frequency": "1d",
"min_time": "2020-10-11T00:00:00.000000000Z",
"max_time": "2021-01-05T00:00:00.000000000Z"
}
]
},
{"metric": "volume_trusted_spot_usd_1h",
"frequencies": [{"frequency": "1h",
"min_time": "2020-10-10T19:00:00.000000000Z",
"max_time": "2021-01-06T12:00:00.000000000Z"
}
]
}
]
}
]
}

Available asset pairs

Returns a list of available asset pairs along with information for them like metrics and time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

pairs	Array of strings Comma separated list of asset pairs. By default, all asset pairs are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (PairInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/pairs?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"pair": "aave-bnb",
"full_name": "Aave - BNB",
"metrics": [{"metric": "volume_trusted_spot_usd_1d",
"frequencies": [{"frequency": "1d",
"min_time": "2020-10-16T00:00:00.000000000Z",
"max_time": "2021-01-05T00:00:00.000000000Z"
}
]
},
{"metric": "volume_trusted_spot_usd_1h",
"frequencies": [{"frequency": "1h",
"min_time": "2020-10-15T03:00:00.000000000Z",
"max_time": "2021-01-06T12:00:00.000000000Z"
}
]
}
]
},
{"pair": "aave-btc",
"full_name": "Aave - Bitcoin",
"metrics": [{"metric": "volume_trusted_spot_usd_1d",
"frequencies": [{"frequency": "1d",
"min_time": "2020-10-11T00:00:00.000000000Z",
"max_time": "2021-01-05T00:00:00.000000000Z"
}
]
},
{"metric": "volume_trusted_spot_usd_1h",
"frequencies": [{"frequency": "1h",
"min_time": "2020-10-10T19:00:00.000000000Z",
"max_time": "2021-01-06T12:00:00.000000000Z"
}
]
}
]
}
]
}

Available asset pair candles

Returns a list of available asset pair candles along with the time ranges of available data per candle duration.

Authorizations:

API Key: api_key

query Parameters

pairs	Array of strings Comma separated list of asset pairs. By default, all asset pairs are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogPairCandlesInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/pair-candles?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"pair": "btc-eur",
"frequencies": [{"frequency": "1m",
"min_time": "2011-08-28T18:26:00.000000000Z",
"max_time": "2022-06-29T23:25:00.000000000Z"
},
{"frequency": "5m",
"min_time": "2011-08-28T18:25:00.000000000Z",
"max_time": "2022-06-29T23:20:00.000000000Z"
},
{"frequency": "10m",
"min_time": "2011-08-28T18:20:00.000000000Z",
"max_time": "2022-06-29T23:10:00.000000000Z"
},
{"frequency": "15m",
"min_time": "2011-08-28T18:15:00.000000000Z",
"max_time": "2022-06-29T23:00:00.000000000Z"
},
{"frequency": "30m",
"min_time": "2011-08-28T18:00:00.000000000Z",
"max_time": "2022-06-29T22:30:00.000000000Z"
},
{"frequency": "1h",
"min_time": "2011-08-28T18:00:00.000000000Z",
"max_time": "2022-06-29T22:00:00.000000000Z"
},
{"frequency": "4h",
"min_time": "2011-08-28T16:00:00.000000000Z",
"max_time": "2022-06-29T16:00:00.000000000Z"
},
{"frequency": "1d",
"min_time": "2011-08-28T00:00:00.000000000Z",
"max_time": "2022-06-28T00:00:00.000000000Z"
}
]
},
{"pair": "btc-usd",
"frequencies": [{"frequency": "1m",
"min_time": "2010-07-18T03:43:00.000000000Z",
"max_time": "2022-06-29T23:25:00.000000000Z"
},
{"frequency": "5m",
"min_time": "2010-07-18T03:40:00.000000000Z",
"max_time": "2022-06-29T23:20:00.000000000Z"
},
{"frequency": "10m",
"min_time": "2010-07-18T03:40:00.000000000Z",
"max_time": "2022-06-29T23:10:00.000000000Z"
},
{"frequency": "15m",
"min_time": "2010-07-18T03:30:00.000000000Z",
"max_time": "2022-06-29T23:00:00.000000000Z"
},
{"frequency": "30m",
"min_time": "2010-07-18T03:30:00.000000000Z",
"max_time": "2022-06-29T22:30:00.000000000Z"
},
{"frequency": "1h",
"min_time": "2010-07-18T03:00:00.000000000Z",
"max_time": "2022-06-29T22:00:00.000000000Z"
},
{"frequency": "4h",
"min_time": "2010-07-18T00:00:00.000000000Z",
"max_time": "2022-06-29T16:00:00.000000000Z"
},
{"frequency": "1d",
"min_time": "2010-07-18T00:00:00.000000000Z",
"max_time": "2022-06-28T00:00:00.000000000Z"
}
]
}
]
}

Available institutions

Returns a list of available institutions along with information for them like metrics and time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

institutions	Array of strings Comma separated list of institutions. By default, all institutions are returned.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (InstitutionInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/institutions?pretty=true&api_key=<your_key>"

Response samples

200
400
401

Content type

application/json

{"data": [{"institution": "grayscale",
"metrics": [{"metric": "btc_total_assets",
"frequencies": [{"frequency": "1d",
"min_time": "2020-10-16T00:00:00.000000000Z",
"max_time": "2021-01-05T00:00:00.000000000Z"
}
]
},
{"metric": "btc_shares_outstanding",
"frequencies": [{"frequency": "1h",
"min_time": "2020-10-15T03:00:00.000000000Z",
"max_time": "2021-01-06T12:00:00.000000000Z"
}
]
}
]
}
]
}

Available markets

Returns a list of available markets along with time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
include	Array of strings Comma separated list of fields to include in response. Supported values are `trades`, `orderbooks`, `quotes`, `funding_rates`, `openinterest`, `liquidations`. Included by default if omitted.
exclude	Array of strings Comma separated list of fields to exclude from response. Supported values are `trades`, `orderbooks`, `quotes`, `funding_rates`, `openinterest`, `liquidations`. Included by default if omitted.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (MarketInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/markets?pretty=true&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "binance-btc-usdt-spot",
"min_time": "2017-08-17T04:00:32.285000000Z",
"max_time": "2022-08-22T14:19:01.239000000Z",
"exchange": "binance",
"type": "spot",
"trades": {"min_time": "2017-08-17T04:00:32.285000000Z",
"max_time": "2022-08-22T14:19:01.239000000Z"
},
"orderbooks": {"min_time": "2021-08-03T16:00:00.000000000Z",
"max_time": "2022-08-22T14:18:50.000000000Z"
},
"quotes": {"min_time": "2021-08-03T16:00:00.000000000Z",
"max_time": "2022-08-22T14:18:50.000000000Z"
},
"base": "btc",
"quote": "usdt",
"status": "online",
"order_amount_increment": "0.00000001",
"order_amount_size_min": "0.0001",
"order_amount_size_max": "100",
"order_price_increment": "0.01",
"order_price_min": "0.1",
"order_price_max": "100000",
"order_size_min": "0.0001",
"order_taker_fee": "0.002",
"order_maker_fee": "0.002",
"margin_trading_enabled": true
},
{"market": "bitfinex-btc-usdt-spot",
"min_time": "2019-03-11T10:05:37.974000000Z",
"max_time": "2022-08-22T14:18:50.000000000Z",
"exchange": "bitfinex",
"type": "spot",
"trades": {"min_time": "2019-03-11T10:05:37.974000000Z",
"max_time": "2022-08-22T14:18:46.665000000Z"
},
"orderbooks": {"min_time": "2021-08-20T13:00:00.000000000Z",
"max_time": "2022-08-22T14:18:50.000000000Z"
},
"quotes": {"min_time": "2021-08-20T13:00:00.000000000Z",
"max_time": "2022-08-22T14:18:50.000000000Z"
},
"base": "btc",
"quote": "usdt",
"status": "online",
"order_amount_increment": "0.00000001",
"order_amount_size_min": "0.0001",
"order_price_increment": "0.01",
"order_price_order_min": "0.1",
"order_size_min": "0.0001",
"order_taker_fee": "0.002",
"order_maker_fee": "0.002",
"margin_trading_enabled": false
}
]
}

Available market trades

Returns a list of markets with trades support along with the time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMarketTradesInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/market-trades?pretty=true&limit=100&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "bibox-1inch-usdt-spot",
"min_time": "2022-03-07T19:43:21.195000000Z",
"max_time": "2022-07-04T11:47:49.707000000Z"
},
{"market": "bibox-aaa-usdt-spot",
"min_time": "2021-12-01T11:11:20.656000000Z",
"max_time": "2022-03-01T18:14:06.507000000Z"
},
{"market": "bibox-aave-btc-spot",
"min_time": "2022-03-07T19:47:10.014000000Z",
"max_time": "2022-07-04T11:47:56.717000000Z"
}
]
}

Available market candles

Returns a list of markets with candles support along with the time ranges of available data per candle duration.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMarketCandlesInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/market-candles?pretty=true&limit=100&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "bitmex-XBTUSD-future",
"frequencies": [{"frequency": "5m",
"min_time": "2020-01-19T21:00:00.000001000Z",
"max_time": "2020-01-19T21:25:00.000000000Z"
},
{"frequency": "10m",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "15m",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "30m",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "1h",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "1d",
"min_time": "2010-07-19T00:00:00.000000000Z",
"max_time": "2019-12-25T00:00:00.000000000Z"
}
]
},
{"market": "bittrex-btc-usd-spot",
"frequencies": [{"frequency": "1m",
"min_time": "2020-01-19T21:00:00.000001000Z",
"max_time": "2020-01-19T21:00:00.000001000Z"
},
{"frequency": "5m",
"min_time": "2020-01-19T21:00:00.000001000Z",
"max_time": "2020-01-19T21:25:00.000000000Z"
},
{"frequency": "10m",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "15m",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "30m",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "1h",
"min_time": "2020-01-19T21:00:00.000000000Z",
"max_time": "2020-01-19T21:00:00.000000000Z"
},
{"frequency": "1d",
"min_time": "2010-07-19T00:00:00.000000000Z",
"max_time": "2019-12-25T00:00:00.000000000Z"
}
]
},
{"market": "cme-BTCQ1-future",
"frequencies": [{"frequency": "1d",
"min_time": "2019-12-25T00:00:00.000000000Z",
"max_time": "2019-12-25T00:00:00.000000000Z"
}
]
}
]
}

Available market orderbooks

Returns a list of markets with orderbooks support along with the time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMarketOrderbooksInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/market-orderbooks?pretty=true&limit=100&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "binance-1000BTTCUSDT-future",
"min_time": "2022-01-26T03:00:00.000000000Z",
"max_time": "2022-04-11T08:00:00.000000000Z",
"depths": [{"depth": "30000",
"min_time": "2022-01-26T03:00:00.000000000Z",
"max_time": "2022-04-11T08:00:00.000000000Z"
}
]
},
{"market": "binance-1000FLOKIUSDT-future",
"min_time": "2023-05-06T16:00:00.000000000Z",
"max_time": "2023-09-08T11:00:00.000000000Z",
"depths": [{"depth": "30000",
"min_time": "2023-05-06T16:00:00.000000000Z",
"max_time": "2023-09-08T11:00:00.000000000Z"
}
]
}
]
}

Available market quotes

Returns a list of markets with quotes support along with the time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMarketQuotesInfo)

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/market-quotes?pretty=true&limit=100&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "binance-1000BTTCUSDT-future",
"min_time": "2022-01-26T03:00:00.000000000Z",
"max_time": "2022-04-11T08:00:00.000000000Z"
},
{"market": "binance-1000LUNCBUSD-future",
"min_time": "2022-05-31T02:00:00.000000000Z",
"max_time": "2022-07-04T13:00:00.000000000Z"
},
{"market": "binance-1000SHIBUSDT-future",
"min_time": "2021-11-10T22:00:00.000000000Z",
"max_time": "2022-07-04T13:00:00.000000000Z"
}
]
}

Available market funding rates

Returns a list of markets with funding rates support along with the time ranges of available data.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMarketFundingRatesInfo)

https://api.xft.io/v4/catalog/market-funding-rates

https://community-api.xft.io/v4/catalog/market-funding-rates

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/market-funding-rates?pretty=true&limit=100&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "binance-1000BTTCUSDT-future",
"min_time": "2022-01-26T08:00:00.001000000Z",
"max_time": "2022-04-11T08:00:00.000000000Z"
},
{"market": "binance-1000LUNCBUSD-future",
"min_time": "2022-05-30T16:00:00.005000000Z",
"max_time": "2022-07-04T08:00:00.001000000Z"
},
{"market": "binance-1000SHIBUSDT-future",
"min_time": "2021-05-10T16:00:00.013000000Z",
"max_time": "2022-07-04T08:00:00.001000000Z"
}
]
}

Available market contract prices

Returns a list of contract prices for option market.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMarketContractPricesInfo)

https://api.xft.io/v4/catalog/market-contract-prices

https://community-api.xft.io/v4/catalog/market-contract-prices

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/market-contract-prices?pretty=true&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "deribit-BTC-15OCT21-60000-C-option",
"min_time": "2022-01-26T08:00:00.001000000Z",
"max_time": "2022-04-11T08:00:00.000000000Z"
},
{"market": "deribit-BTC-1OCT21-75000-C-option",
"min_time": "2022-05-30T16:00:00.005000000Z",
"max_time": "2022-07-04T08:00:00.001000000Z"
},
{"market": "deribit-BTC-26NOV21-60000-C-option",
"min_time": "2021-05-10T16:00:00.013000000Z",
"max_time": "2022-07-04T08:00:00.001000000Z"
}
]
}

Available market implied volatility

Returns a list of implied volatility for option market.

Authorizations:

API Key: api_key

query Parameters

markets	Array of strings Comma separated list of markets. By default all markets are returned.
exchange	string Unique name of an exchange.
type	string Enum: "spot" "future" "option" Type of markets.
base	string Base asset of markets.
quote	string Quote asset of markets.
asset	string Any asset of markets.
symbol	string Symbol of derivative markets, full instrument name.
format	string Default: "json" Format of the response. Supported values are `json`, `json_stream`.
limit	string Default: "none" Limit of response items. `none` means no limit. Maximum value is 100.
pretty	boolean Default: false Human-readable formatting of JSON responses.

Responses

Response Schema: application/json

required

Array of objects (CatalogMarketImpliedVolatilityInfo)

https://api.xft.io/v4/catalog/market-implied-volatility

https://community-api.xft.io/v4/catalog/market-implied-volatility

Request samples

Shell
Python

curl --compressed "https://api.xft.io/v4/catalog/market-implied-volatility?pretty=true&api_key=<your_key>"

Response samples

200
401

Content type

application/json

{"data": [{"market": "deribit-BTC-15OCT21-60000-C-option",
"min_time": "2022-01-26T08:00:00.001000000Z",
"max_time": "2022-04-11T08:00:00.000000000Z"
},
{"market": "deribit-BTC-1OCT21-75000-C-option",