Download OpenAPI specification:Download
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.
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.
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.
Returns a list of assets metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/assets?api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "full_name": "Bitcoin"
}, - {
- "asset": "etc",
- "full_name": "Ethereum Classic"
}
], - "next_page_token": "ZXRo",
}
Returns a list of exchanges metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/exchanges?api_key=<your_key>"
{- "data": [
- {
- "exchange": "binance",
- "full_name": "Binance"
}, - {
- "exchange": "bittrex",
- "full_name": "Bittrex"
}
], - "next_page_token": "YnliaXQ",
}
Returns a list of markets metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/markets?api_key=<your_key>"
{- "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",
}
Returns a list of indexes metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/indexes?api_key=<your_key>"
{- "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",
}
Returns a list of pairs metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/pair-metrics?api_key=<your_key>"
{- "data": [
- {
- "pair": "btc-eur",
- "full_name": "Bitcoin - Euro"
}, - {
- "pair": "btc-usdt",
- "full_name": "Bitcoin - Tether"
}
], - "next_page_token": "ZXRoLXVzZHQ",
}
Returns a list of asset metrics metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/asset-metrics?api_key=<your_key>"
{- "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",
}, - {
- "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",
}
], - "next_page_token": "QWRyQWN0Q250",
}
Returns a list of exchange metrics metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/exchange-metrics?api_key=<your_key>"
{- "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",
}, - {
- "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",
}
], - "next_page_token": "bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0",
}
Returns a list of exchange asset metrics metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/exchange-asset-metrics?api_key=<your_key>"
{- "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",
}, - {
- "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",
}
], - "next_page_token": "YmFzaXNfYW5udWFsaXplZF82MGRfZXhw",
}
Returns a list of pair metrics metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/pair-metrics?api_key=<your_key>"
{- "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",
}, - {
- "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",
}
], - "next_page_token": "bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0",
}
Returns a list of institution metrics metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/institution-metrics?api_key=<your_key>"
{- "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",
}, - {
- "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",
}
], - "next_page_token": "YmF0X25ldF9hc3NldF92YWx1ZQ",
}
Returns a list of market metrics metadata.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/reference-data/market-metrics?api_key=<your_key>"
{- "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",
}, - {
- "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",
}
], - "next_page_token": "bGlxdWlkYXRpb25zX3JlcG9ydGVkX2Z1dHVyZV9idXlfdW5pdHNfNW0",
}
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.
assets |
Array of strings
Comma separated list of asset ids. |
full_names |
Array of strings
Comma separated list of asset full names. |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/profile/assets?api_key=<your_key>"
{- "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.",
- "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.",
- "consensus_mechanism": "Proof-of-Stake",
- "creation_date": "2015-07-30"
}
], - "next_page_token": "c29s",
}
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.
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 |
classification_start_time |
string
Start time of taxonomy asset classification. |
classification_end_time |
string
End time of taxonomy asset classification. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/taxonomy/assets?api_key=<your_key>"
{- "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",
}
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.
version |
string
Taxonomy version. Defaults to |
start_time |
string
Start time of taxonomy version. |
end_time |
string
End time of taxonomy version. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
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. |
curl --compressed "https://api.xft.io/v4/taxonomy-metadata/assets?api_key=<your_key>"
{- "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",
}
Catalog of available for your api_key
data.
Use the Full
catalog endpoints for the full list of supported by XFT data.
Returns a list of available assets along with information for them like metrics, markets, exchanges and time ranges of available data.
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
|
exclude |
Array of strings
Comma separated list of fields to exclude from response. Supported values are
|
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (AssetInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/assets?pretty=true&api_key=<your_key>"
{- "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"
]
}
]
}
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.
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. |
required
|
Array of objects (CatalogMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of available asset metrics along with information for them like description, category and assets for which a metric is available.
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. |
required
|
Array of objects (CatalogAssetMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/asset-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of available exchange metrics along with information for them like description, category and exchanges for which a metric is available.
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. |
required
|
Array of objects (CatalogExchangeMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/exchange-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
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.
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. |
required
|
Array of objects
(CatalogExchangeAssetMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/exchange-asset-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of available pair metrics along with information for them like description, category and pairs for which a metric is available.
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. |
required
|
Array of objects (CatalogPairMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/pair-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of available institution metrics along with information for them like description, category and institutions for which a metric is available.
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. |
required
|
Array of objects
(CatalogInstitutionMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/institution-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of available exchanges along with available markets for them.
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. |
required
|
Array of objects (ExchangeInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/exchanges?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of available exchange-asset pairs along with information for them like metrics and time ranges of available data.
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. |
required
|
Array of objects (ExchangeAssetInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/exchange-assets?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
]
}
Returns a list of available asset pairs along with information for them like metrics and time ranges of available data.
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. |
required
|
Array of objects (PairInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/pairs?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
]
}
Returns a list of available asset pair candles along with the time ranges of available data per candle duration.
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. |
required
|
Array of objects (CatalogPairCandlesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/pair-candles?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
Returns a list of available institutions along with information for them like metrics and time ranges of available data.
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. |
required
|
Array of objects (InstitutionInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/institutions?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
]
}
Returns a list of available markets along with time ranges of available data.
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
|
exclude |
Array of strings
Comma separated list of fields to exclude from response. Supported values are
|
format |
string
Default: "json"
Format of the response. Supported values are |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (MarketInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/markets?pretty=true&api_key=<your_key>"
{- "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
}
]
}
Returns a list of markets with trades support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketTradesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-trades?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of markets with candles support along with the time ranges of available data per candle duration.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketCandlesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-candles?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
]
}
Returns a list of markets with orderbooks support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketOrderbooksInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-orderbooks?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
]
}
Returns a list of markets with quotes support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketQuotesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-quotes?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of markets with funding rates support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketFundingRatesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-funding-rates?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of contract prices for option market.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketContractPricesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-contract-prices?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of implied volatility for option market.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketImpliedVolatilityInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-implied-volatility?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of greeks for option market.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketGreeksInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-greeks?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of markets with open interest support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketOpeninterestInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-openinterest?pretty=true&limit=100&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:30:43.271000000Z",
- "max_time": "2022-04-11T08:51:00.000000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:00.000000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-10T13:00:58.123000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}
]
}
Returns a list of markets with liquidations support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketLiquidationsInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-liquidations?pretty=true&limit=100&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:46:28.290000000Z",
- "max_time": "2022-04-11T03:40:00.193000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:32.286000000Z",
- "max_time": "2022-07-04T12:25:16.559000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-11T23:00:17.729000000Z",
- "max_time": "2022-07-04T13:35:00.567000000Z"
}
]
}
Returns a list of markets with metrics support along with the time ranges of available data per metric.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketMetricsInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/market-metrics?pretty=true&limit=100&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2020-01-01T01:25:00.000000000Z",
- "max_time": "2022-01-21T00:30:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2020-01-01T01:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2020-01-01T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}, - {
- "market": "bybit-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2021-04-30T12:35:00.000000000Z",
- "max_time": "2022-01-21T00:25:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2021-04-30T12:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2021-04-30T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}
]
}
Returns a list of available indexes along with time ranges of available data.
indexes |
Array of strings
Comma separated list of indexes. By default all indexes are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (IndexInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/indexes?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CMBI10",
- "full_name": "CMBI 10 Index",
- "description": "An index consisting of the 10 largest cryptoassets, weighted by their free float market capitalization.",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2020-06-08T20:12:40.000000000Z",
- "max_time": "2020-06-08T20:29:30.000000000Z"
}
]
}, - {
- "index": "CMBIBTC",
- "full_name": "CMBI Bitcoin Index",
- "description": "A single asset index measuring the performance an investor would expect from purchasing and holding Bitcoin.",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2010-07-18T20:00:00.000000000Z",
- "max_time": "2020-06-08T20:29:45.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2010-07-19T00:00:00.000000000Z",
- "max_time": "2020-06-08T00:00:00.000000000Z"
}, - {
- "frequency": "1d-ny-close",
- "min_time": "2010-07-18T20:00:00.000000000Z",
- "max_time": "2020-06-08T20:00:00.000000000Z"
}, - {
- "frequency": "1d-sg-close",
- "min_time": "2010-07-19T08:00:00.000000000Z",
- "max_time": "2020-06-08T08:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2010-07-18T20:00:00.000000000Z",
- "max_time": "2020-06-08T20:00:00.000000000Z"
}
]
}
]
}
Returns a list of available index candles along with the time ranges of available data per candle duration.
indexes |
Array of strings
Comma separated list of indexes. By default all indexes are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogIndexCandlesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/index-candles?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CMBIBTC",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2022-06-28T13:51:00.000000000Z",
- "max_time": "2022-07-15T15:55:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:50:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:40:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2022-06-28T13:45:00.000000000Z",
- "max_time": "2022-07-15T15:30:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2022-06-28T13:30:00.000000000Z",
- "max_time": "2022-07-15T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-28T13:00:00.000000000Z",
- "max_time": "2022-07-15T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2022-06-28T12:00:00.000000000Z",
- "max_time": "2022-07-15T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-28T00:00:00.000000000Z",
- "max_time": "2022-07-14T00:00:00.000000000Z"
}
]
}, - {
- "index": "CMBIETHT",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2022-06-28T13:51:00.000000000Z",
- "max_time": "2022-07-15T15:55:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:50:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:40:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2022-06-28T13:45:00.000000000Z",
- "max_time": "2022-07-15T15:30:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2022-06-28T13:30:00.000000000Z",
- "max_time": "2022-07-15T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-28T13:00:00.000000000Z",
- "max_time": "2022-07-15T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2022-06-28T12:00:00.000000000Z",
- "max_time": "2022-07-15T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-28T00:00:00.000000000Z",
- "max_time": "2022-07-14T00:00:00.000000000Z"
}
]
}
]
}
Returns a list of available asset alerts along with their descriptions, thresholds and constituents.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
alerts |
Array of strings
Comma separated list of asset alert names. By default all asset alerts are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (AssetAlertRuleInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/asset-alerts?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "name": "block_count_empty_6b_hi",
- "conditions": [
- {
- "description": "The last 4 blocks were empty.",
- "threshold": "4",
- "constituents": [
- "block_count_empty_6b"
]
}
]
}
]
}
Returns a list of available assets for the asset-chains endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogAssetChainsInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/asset-chains?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2021-08-09T10:34:38.290000000Z",
- "max_time": "2023-03-30T17:24:20.193000000Z"
}, - {
- "asset": "eth",
- "min_time": "2022-02-16T09:10:20.286000000Z",
- "max_time": "2023-03-30T18:18:23.559000000Z"
}
]
}
Returns a list of available assets for the mempool-feerates endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMempoolFeeratesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/mempool-feerates?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-03-27T21:14:00.000000000Z",
- "max_time": "2023-04-03T21:22:00.000000000Z"
}
]
}
Returns a list of available assets for the mining-pool-tips-summary endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMiningPoolTipsSummaryInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/mining-pool-tips-summary?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2021-08-09T10:34:38.290000000Z",
- "max_time": "2023-03-30T17:24:20.193000000Z"
}
]
}
Returns a list of available assets for the transaction-tracker endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogTransactionTrackerInfo)
|
curl --compressed "https://api.xft.io/v4/catalog/transaction-tracker?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2021-08-09T10:34:38.290000000Z",
- "max_time": "2023-03-30T17:24:20.193000000Z"
}, - {
- "asset": "eth",
- "min_time": "2022-02-16T09:10:20.286000000Z",
- "max_time": "2023-03-30T18:18:23.559000000Z"
}
]
}
The Full catalog returns the full range of data that is supported by XFT across all our products.
If you are a client looking to understand the data that is available for your API key and data license,
please use the Catalog endpoint.
Returns a list of all supported assets along with information for them like metrics, markets, exchanges and time ranges of available data.
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
|
exclude |
Array of strings
Comma separated list of fields to exclude from response. Supported values are
|
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (AssetInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/assets?pretty=true&api_key=<your_key>"
{- "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"
]
}
]
}
Returns a list of all supported metrics along with information for them like description, category and assets for which a metric is available.This endpoint is deprecated, please use /catalog-all/asset-metrics instead.
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. |
required
|
Array of objects (CatalogMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all supported asset metrics along with information for them like description, category and assets for which a metric is available.
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. |
required
|
Array of objects (CatalogAssetMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/asset-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all supported exchange metrics along with information for them like description, category and exchanges for which a metric is available.
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. |
required
|
Array of objects (CatalogExchangeMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/exchange-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all supported exchange-asset metrics along with information for them like description, category and exchange-asset pairs for which a metric is available.
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. |
required
|
Array of objects
(CatalogExchangeAssetMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/exchange-asset-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all supported pair metrics along with information for them like description, category and pairs for which a metric is available.
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. |
required
|
Array of objects (CatalogPairMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/pair-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all supported institution metrics along with information for them like description, category and institutions for which a metric is available.
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. |
required
|
Array of objects
(CatalogInstitutionMetricInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/institution-metrics?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all supported exchanges along with available markets for them.
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. |
required
|
Array of objects (ExchangeInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/exchanges?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all supported exchange-asset pairs along with information for them like metrics and time ranges of available data.
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. |
required
|
Array of objects (ExchangeAssetInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/exchange-assets?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
]
}
Returns a list of all supported asset pairs along with information for them like metrics and time ranges of available data.
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. |
required
|
Array of objects (PairInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/pairs?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
]
}
Returns a list of all supported asset pair candles along with the time ranges of available data per candle duration.
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. |
required
|
Array of objects (CatalogPairCandlesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/pair-candles?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
Returns a list of all support institutions along with information for them like metrics and time ranges of available data.
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. |
required
|
Array of objects (InstitutionInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/institutions?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
]
}
]
}
Returns a list of all supported markets along with time ranges of available data.
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
|
exclude |
Array of strings
Comma separated list of fields to exclude from response. Supported values are
|
format |
string
Default: "json"
Format of the response. Supported values are |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (MarketInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/markets?pretty=true&api_key=<your_key>"
{- "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
}
]
}
Returns a list of all markets with trades support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketTradesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-trades?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all markets with candles support along with time ranges of available data per candle duration.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketCandlesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-candles?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
]
}
Returns a list of all markets with orderbooks support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketOrderbooksInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-orderbooks?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
]
}
Returns a list of all markets with quotes support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketQuotesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-quotes?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all markets with funding rates support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketFundingRatesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-funding-rates?pretty=true&limit=100&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all market contract prices for option market.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketContractPricesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-contract-prices?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all market implied volatility for option market.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketImpliedVolatilityInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-implied-volatility?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all market greeks for option market.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketGreeksInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-greeks?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
Returns a list of all markets with open interest support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketOpeninterestInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-openinterest?pretty=true&limit=100&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:30:43.271000000Z",
- "max_time": "2022-04-11T08:51:00.000000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:00.000000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-10T13:00:58.123000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}
]
}
Returns a list of all markets with liquidations support along with the time ranges of available data.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMarketLiquidationsInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-liquidations?pretty=true&limit=100&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:46:28.290000000Z",
- "max_time": "2022-04-11T03:40:00.193000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:32.286000000Z",
- "max_time": "2022-07-04T12:25:16.559000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-11T23:00:17.729000000Z",
- "max_time": "2022-07-04T13:35:00.567000000Z"
}
]
}
Returns a list of all markets with market metrics support along with time ranges of available data per metric.
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 |
limit |
string
Default: "none"
Limit of response items. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogMarketMetricsInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/market-metrics?pretty=true&limit=100&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2020-01-01T01:25:00.000000000Z",
- "max_time": "2022-01-21T00:30:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2020-01-01T01:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2020-01-01T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}, - {
- "market": "bybit-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2021-04-30T12:35:00.000000000Z",
- "max_time": "2022-01-21T00:25:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2021-04-30T12:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2021-04-30T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}
]
}
Returns a list of all supported indexes along with time ranges of available data.
indexes |
Array of strings
Comma separated list of indexes. By default all indexes are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (IndexInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/indexes?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CMBI10",
- "full_name": "CMBI 10 Index",
- "description": "An index consisting of the 10 largest cryptoassets, weighted by their free float market capitalization.",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2020-06-08T20:12:40.000000000Z",
- "max_time": "2020-06-08T20:29:30.000000000Z"
}
]
}, - {
- "index": "CMBIBTC",
- "full_name": "CMBI Bitcoin Index",
- "description": "A single asset index measuring the performance an investor would expect from purchasing and holding Bitcoin.",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2010-07-18T20:00:00.000000000Z",
- "max_time": "2020-06-08T20:29:45.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2010-07-19T00:00:00.000000000Z",
- "max_time": "2020-06-08T00:00:00.000000000Z"
}, - {
- "frequency": "1d-ny-close",
- "min_time": "2010-07-18T20:00:00.000000000Z",
- "max_time": "2020-06-08T20:00:00.000000000Z"
}, - {
- "frequency": "1d-sg-close",
- "min_time": "2010-07-19T08:00:00.000000000Z",
- "max_time": "2020-06-08T08:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2010-07-18T20:00:00.000000000Z",
- "max_time": "2020-06-08T20:00:00.000000000Z"
}
]
}
]
}
Returns a list of all supported index candles along with the time ranges of available data per candle duration.
indexes |
Array of strings
Comma separated list of indexes. By default all indexes are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogIndexCandlesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/index-candles?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CMBIBTC",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2022-06-28T13:51:00.000000000Z",
- "max_time": "2022-07-15T15:55:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:50:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:40:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2022-06-28T13:45:00.000000000Z",
- "max_time": "2022-07-15T15:30:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2022-06-28T13:30:00.000000000Z",
- "max_time": "2022-07-15T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-28T13:00:00.000000000Z",
- "max_time": "2022-07-15T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2022-06-28T12:00:00.000000000Z",
- "max_time": "2022-07-15T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-28T00:00:00.000000000Z",
- "max_time": "2022-07-14T00:00:00.000000000Z"
}
]
}, - {
- "index": "CMBIETHT",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2022-06-28T13:51:00.000000000Z",
- "max_time": "2022-07-15T15:55:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:50:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2022-06-28T13:50:00.000000000Z",
- "max_time": "2022-07-15T15:40:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2022-06-28T13:45:00.000000000Z",
- "max_time": "2022-07-15T15:30:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2022-06-28T13:30:00.000000000Z",
- "max_time": "2022-07-15T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-28T13:00:00.000000000Z",
- "max_time": "2022-07-15T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2022-06-28T12:00:00.000000000Z",
- "max_time": "2022-07-15T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-28T00:00:00.000000000Z",
- "max_time": "2022-07-14T00:00:00.000000000Z"
}
]
}
]
}
Returns a list of all supported asset alerts along with their descriptions, thresholds and constituents.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
alerts |
Array of strings
Comma separated list of asset alert names. By default all asset alerts are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (AssetAlertRuleInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/asset-alerts?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "name": "block_count_empty_6b_hi",
- "conditions": [
- {
- "description": "The last 4 blocks were empty.",
- "threshold": "4",
- "constituents": [
- "block_count_empty_6b"
]
}
]
}
]
}
Returns a list of supported assets for the asset-chains endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogAssetChainsInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/asset-chains?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2021-08-09T10:34:38.290000000Z",
- "max_time": "2023-03-30T17:24:20.193000000Z"
}, - {
- "asset": "eth",
- "min_time": "2022-02-16T09:10:20.286000000Z",
- "max_time": "2023-03-30T18:18:23.559000000Z"
}
]
}
Returns a list of supported assets for the mempool-feerates endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMempoolFeeratesInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/mempool-feerates?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-03-27T21:14:00.000000000Z",
- "max_time": "2023-04-03T21:22:00.000000000Z"
}
]
}
Returns a list of supported assets for the mining-pool-tips-summary endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMiningPoolTipsSummaryInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/mining-pool-tips-summary?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2021-08-09T10:34:38.290000000Z",
- "max_time": "2023-03-30T17:24:20.193000000Z"
}
]
}
Returns a list of supported assets for the transaction-tracker endpoint along with time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogTransactionTrackerInfo)
|
curl --compressed "https://api.xft.io/v4/catalog-all/transaction-tracker?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2021-08-09T10:34:38.290000000Z",
- "max_time": "2023-03-30T17:24:20.193000000Z"
}, - {
- "asset": "eth",
- "min_time": "2022-02-16T09:10:20.286000000Z",
- "max_time": "2023-03-30T18:18:23.559000000Z"
}
]
}
Catalog of available for your api_key
data.
Use the Full catalog V2 endpoints for the full list of supported by XFT data.
Returns a list of available asset metrics along with the time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogV2AssetMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/asset-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "metrics": [
- {
- "metric": "AdrActCnt",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "2009-01-03T18:15:05.000000000Z",
- "max_time": "2023-05-11T14:40:34.000000000Z",
- "min_height": "0",
- "max_height": "789270",
- "min_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
- "max_hash": "000000000000000000048a29c1b3374cfaac726ee4e7774d6884699ae5cff7a9"
}, - {
- "frequency": "1d",
- "min_time": "2009-01-03T00:00:00.000000000Z",
- "max_time": "2023-05-10T00:00:00.000000000Z",
- "community": true
}
]
}, - {
- "metric": "FlowInBFXUSD",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "2009-01-03T18:15:05.000000000Z",
- "max_time": "2023-05-11T14:40:34.000000000Z",
- "min_height": "0",
- "max_height": "789270",
- "min_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
- "max_hash": "000000000000000000048a29c1b3374cfaac726ee4e7774d6884699ae5cff7a9"
}, - {
- "frequency": "1d",
- "min_time": "2010-07-18T00:00:00.000000000Z",
- "max_time": "2023-05-10T00:00:00.000000000Z"
}
]
}
]
}, - {
- "asset": "eth",
- "metrics": [
- {
- "metric": "BlkSizeByte",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "1970-01-01T00:00:00.000000000Z",
- "max_time": "2023-05-11T16:18:47.000000000Z",
- "min_height": "0",
- "max_height": "17238243",
- "min_hash": "d4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
- "max_hash": "dfefa28d80fe8f6926ca8d161df8bc2819c30e17b176e166123325391ac8bb0b"
}, - {
- "frequency": "1d",
- "min_time": "2015-07-30T00:00:00.000000000Z",
- "max_time": "2023-05-10T00:00:00.000000000Z"
}
]
}, - {
- "metric": "FlowInBFXUSD",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "1970-01-01T00:00:00.000000000Z",
- "max_time": "2023-05-11T16:18:47.000000000Z",
- "min_height": "0",
- "max_height": "17238243",
- "min_hash": "d4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
- "max_hash": "dfefa28d80fe8f6926ca8d161df8bc2819c30e17b176e166123325391ac8bb0b"
}, - {
- "frequency": "1d",
- "min_time": "2015-08-08T00:00:00.000000000Z",
- "max_time": "2023-06-29T00:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "cGVycA",
}
Returns a list of available exchange metrics along with the time ranges of available data.
exchanges |
Array of strings
Comma separated list of exchanges. By default all exchanges are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogV2ExchangeMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/exchange-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "exchange": "bibox",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}, - {
- "exchange": "binance",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2023-04-09T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2023-04-09T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "YmluYW5jZS51cw",
}
Returns a list of available exchange-asset metrics along with the time ranges of available data.
exchange_assets |
Array of strings
Comma separated list of exchange-assets. By default, all exchange-assets pairs are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogV2ExchangeAssetMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/exchange-asset-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "exchange_asset": "bibox-1inch",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}, - {
- "exchange_asset": "bibox-aave",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "Ymlib3gtYWNz",
}
Returns a list of available pair metrics along with the time ranges of available data.
pairs |
Array of strings
Comma separated list of asset pairs. By default, all asset pairs are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogV2PairMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/pair-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "pair": "1inch-btc",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}, - {
- "pair": "1inch-busd",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "MWluY2gtZGFp",
}
Returns a list of available institution metrics along with the time ranges of available data.
institutions |
Array of strings
Comma separated list of institutions. By default, all institutions are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogV2InstitutionMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/institution-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "institution": "grayscale",
- "metrics": [
- {
- "metric": "bat_coin_per_share",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-10-31T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "bat_market_price",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-10-31T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}
]
}
]
}
Returns a list of markets with trades support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketTradesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-trades?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of markets with candles support along with the time ranges of available data per candle duration.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketCandlesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-candles?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of markets with orderbooks support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogV2MarketOrderbooksInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-orderbooks?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "depths": [
- {
- "depth": "30000",
- "min_time": "2022-01-26T03:00:00.000000000Z",
- "max_time": "2022-04-11T08:00:00.000000000Z"
}
]
}, - {
- "market": "binance-1000FLOKIUSDT-future",
- "depths": [
- {
- "depth": "30000",
- "min_time": "2023-05-06T16:00:00.000000000Z",
- "max_time": "2023-09-08T11:00:00.000000000Z"
}
]
}
], - "next_page_token": "YmluYW5jZS0xMDAwTFVOQ0JVU0QtZnV0dXJl",
}
Returns a list of markets with quotes support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketQuotesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-quotes?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of markets with funding rates support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketFundingRatesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-funding-rates?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of markets with predicted funding rates support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketFundingRatesPredictedInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-funding-rates-predicted?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "bybit-1000000VINUUSDT-future",
- "min_time": "2023-11-28T10:09:00.000000000Z",
- "max_time": "2024-01-30T13:17:00.000000000Z"
}, - {
- "market": "bybit-10000LADYSUSDT-future",
- "min_time": "2023-05-11T13:08:00.000000000Z",
- "max_time": "2024-01-30T13:17:00.000000000Z"
}, - {
- "market": "bybit-10000NFTUSDT-future",
- "min_time": "2023-01-27T21:22:00.000000000Z",
- "max_time": "2024-01-30T13:17:00.000000000Z"
}
]
}
Returns a list of contract prices for option market.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketContractPricesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-contract-prices?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of implied volatility for option market.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketImpliedVolatilityInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-implied-volatility?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of greeks for option market.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketGreeksInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-greeks?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of markets with open interest support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketOpeninterestInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-openinterest?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:30:43.271000000Z",
- "max_time": "2022-04-11T08:51:00.000000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:00.000000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-10T13:00:58.123000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of markets with liquidations support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketLiquidationsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-liquidations?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:46:28.290000000Z",
- "max_time": "2022-04-11T03:40:00.193000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:32.286000000Z",
- "max_time": "2022-07-04T12:25:16.559000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-11T23:00:17.729000000Z",
- "max_time": "2022-07-04T13:35:00.567000000Z"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of markets with metrics support along with the time ranges of available data per metric.
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. |
metrics |
Array of strings
Comma separated list of metrics. By default all metrics are returned. |
format |
string
Default: "json"
Format of the response. Supported values are |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/market-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2020-01-01T01:25:00.000000000Z",
- "max_time": "2022-01-21T00:30:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2020-01-01T01:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2020-01-01T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}, - {
- "market": "bybit-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2021-04-30T12:35:00.000000000Z",
- "max_time": "2022-01-21T00:25:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2021-04-30T12:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2021-04-30T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of available asset pair candles along with the time ranges of available data per candle duration.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogPairCandlesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/pair-candles?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
], - "next_page_token": "Q01CSTEw",
}
Returns a list of available index levels along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogV2IndexInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/index-levels?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CMBI10",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2022-06-06T15:17:15.000000000Z",
- "max_time": "2023-09-11T11:56:45.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-07T00:00:00.000000000Z",
- "max_time": "2023-09-11T00:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-06T14:00:00.000000000Z",
- "max_time": "2023-09-11T11:00:00.000000000Z"
}, - {
- "frequency": "1d-ny-close",
- "min_time": "2022-06-06T20:00:00.000000000Z",
- "max_time": "2023-09-10T20:00:00.000000000Z"
}, - {
- "frequency": "1d-sg-close",
- "min_time": "2022-06-07T08:00:00.000000000Z",
- "max_time": "2023-09-11T08:00:00.000000000Z"
}
]
}, - {
- "index": "CMBI10E",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2022-06-06T15:17:15.000000000Z",
- "max_time": "2023-09-11T11:56:45.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-07T00:00:00.000000000Z",
- "max_time": "2023-09-11T00:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-06T14:00:00.000000000Z",
- "max_time": "2023-09-11T11:00:00.000000000Z"
}, - {
- "frequency": "1d-ny-close",
- "min_time": "2022-06-06T20:00:00.000000000Z",
- "max_time": "2023-09-10T20:00:00.000000000Z"
}, - {
- "frequency": "1d-sg-close",
- "min_time": "2022-06-07T08:00:00.000000000Z",
- "max_time": "2023-09-11T08:00:00.000000000Z"
}
]
}
], - "next_page_token": "Q01CSTEwRVg",
}
Returns a list of available index candles along with the time ranges of available data per candle duration.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogIndexCandlesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/index-candles?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CBTCED",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:32:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:25:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:20:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:15:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2023-06-08T04:00:00.000000000Z",
- "max_time": "2023-08-24T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2023-06-08T00:00:00.000000000Z",
- "max_time": "2023-08-23T00:00:00.000000000Z"
}
]
}, - {
- "index": "CBTCRT",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:32:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:25:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:20:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:15:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2023-06-08T04:00:00.000000000Z",
- "max_time": "2023-08-24T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2023-06-08T00:00:00.000000000Z",
- "max_time": "2023-08-23T00:00:00.000000000Z"
}
]
}
], - "next_page_token": "Q01CSTEw",
}
Returns a list of available assets for the asset-chains endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogAssetChainsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/asset-chains?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
Returns a list of available assets for the mempool-feerates endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMempoolFeeratesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/mempool-feerates?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
Returns a list of available assets for the mining-pool-tips-summary endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMiningPoolTipsSummaryInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/mining-pool-tips-summary?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
Returns a list of available assets for the transaction-tracker endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogTransactionTrackerInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-v2/transaction-tracker?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
The Full catalog returns the full range of data that is supported by XFT across all our products.
If you are a client looking to understand the data that is available for your API key and data license,
please use the Catalog endpoint.
Returns a list of all supported asset metrics along with the time ranges of available data.
assets |
Array of strings
Comma separated list of assets. By default all assets are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogV2AssetMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/asset-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "metrics": [
- {
- "metric": "AdrActCnt",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "2009-01-03T18:15:05.000000000Z",
- "max_time": "2023-05-11T14:40:34.000000000Z",
- "min_height": "0",
- "max_height": "789270",
- "min_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
- "max_hash": "000000000000000000048a29c1b3374cfaac726ee4e7774d6884699ae5cff7a9"
}, - {
- "frequency": "1d",
- "min_time": "2009-01-03T00:00:00.000000000Z",
- "max_time": "2023-05-10T00:00:00.000000000Z",
- "community": true
}
]
}, - {
- "metric": "FlowInBFXUSD",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "2009-01-03T18:15:05.000000000Z",
- "max_time": "2023-05-11T14:40:34.000000000Z",
- "min_height": "0",
- "max_height": "789270",
- "min_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
- "max_hash": "000000000000000000048a29c1b3374cfaac726ee4e7774d6884699ae5cff7a9"
}, - {
- "frequency": "1d",
- "min_time": "2010-07-18T00:00:00.000000000Z",
- "max_time": "2023-05-10T00:00:00.000000000Z"
}
]
}
]
}, - {
- "asset": "eth",
- "metrics": [
- {
- "metric": "BlkSizeByte",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "1970-01-01T00:00:00.000000000Z",
- "max_time": "2023-05-11T16:18:47.000000000Z",
- "min_height": "0",
- "max_height": "17238243",
- "min_hash": "d4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
- "max_hash": "dfefa28d80fe8f6926ca8d161df8bc2819c30e17b176e166123325391ac8bb0b"
}, - {
- "frequency": "1d",
- "min_time": "2015-07-30T00:00:00.000000000Z",
- "max_time": "2023-05-10T00:00:00.000000000Z"
}
]
}, - {
- "metric": "FlowInBFXUSD",
- "frequencies": [
- {
- "frequency": "1b",
- "min_time": "1970-01-01T00:00:00.000000000Z",
- "max_time": "2023-05-11T16:18:47.000000000Z",
- "min_height": "0",
- "max_height": "17238243",
- "min_hash": "d4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3",
- "max_hash": "dfefa28d80fe8f6926ca8d161df8bc2819c30e17b176e166123325391ac8bb0b"
}, - {
- "frequency": "1d",
- "min_time": "2015-08-08T00:00:00.000000000Z",
- "max_time": "2023-06-29T00:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "cGVycA",
}
Returns a list of all supported exchange metrics along with the time ranges of available data.
exchanges |
Array of strings
Comma separated list of exchanges. By default all exchanges are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogV2ExchangeMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/exchange-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "exchange": "bibox",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}, - {
- "exchange": "binance",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2023-04-09T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2023-04-09T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "YmluYW5jZS51cw",
}
Returns a list of all supported exchange-asset metrics along with the time ranges of available data.
exchange_assets |
Array of strings
Comma separated list of exchange-assets. By default, all exchange-assets pairs are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogV2ExchangeAssetMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/exchange-asset-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "exchange_asset": "bibox-1inch",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}, - {
- "exchange_asset": "bibox-aave",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "Ymlib3gtYWNz",
}
Returns a list of all supported pair metrics along with the time ranges of available data.
pairs |
Array of strings
Comma separated list of asset pairs. By default, all asset pairs are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogV2PairMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/pair-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "pair": "1inch-btc",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}, - {
- "pair": "1inch-busd",
- "metrics": [
- {
- "metric": "volume_reported_spot_usd_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-06-06T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "volume_reported_spot_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2022-06-06T23:00:00.000000000Z",
- "max_time": "2023-08-09T10:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "MWluY2gtZGFp",
}
Returns a list of all supported institution metrics along with the time ranges of available data.
institutions |
Array of strings
Comma separated list of institutions. By default, all institutions are returned. |
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogV2InstitutionMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/institution-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "institution": "grayscale",
- "metrics": [
- {
- "metric": "bat_coin_per_share",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-10-31T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}, - {
- "metric": "bat_market_price",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2022-10-31T00:00:00.000000000Z",
- "max_time": "2023-08-08T00:00:00.000000000Z"
}
]
}
]
}
]
}
Returns a list of all markets with trades support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketTradesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-trades?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all markets with candles support along with time ranges of available data per candle duration.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketCandlesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-candles?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all markets with orderbooks support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogV2MarketOrderbooksInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-orderbooks?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "depths": [
- {
- "depth": "30000",
- "min_time": "2022-01-26T03:00:00.000000000Z",
- "max_time": "2022-04-11T08:00:00.000000000Z"
}
]
}, - {
- "market": "binance-1000FLOKIUSDT-future",
- "depths": [
- {
- "depth": "30000",
- "min_time": "2023-05-06T16:00:00.000000000Z",
- "max_time": "2023-09-08T11:00:00.000000000Z"
}
]
}
], - "next_page_token": "YmluYW5jZS0xMDAwTFVOQ0JVU0QtZnV0dXJl",
}
Returns a list of all markets with quotes support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketQuotesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-quotes?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all markets with funding rates support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketFundingRatesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-funding-rates?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all markets with predicted funding rates support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketFundingRatesPredictedInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-funding-rates-predicted?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "bybit-1000000VINUUSDT-future",
- "min_time": "2023-11-28T10:09:00.000000000Z",
- "max_time": "2024-01-30T13:17:00.000000000Z"
}, - {
- "market": "bybit-10000LADYSUSDT-future",
- "min_time": "2023-05-11T13:08:00.000000000Z",
- "max_time": "2024-01-30T13:17:00.000000000Z"
}, - {
- "market": "bybit-10000NFTUSDT-future",
- "min_time": "2023-01-27T21:22:00.000000000Z",
- "max_time": "2024-01-30T13:17:00.000000000Z"
}
]
}
Returns a list of all market contract prices for option market.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketContractPricesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-contract-prices?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all market implied volatility for option market.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketImpliedVolatilityInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-implied-volatility?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all market greeks for option market.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketGreeksInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-greeks?pretty=true&api_key=<your_key>"
{- "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"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all markets with open interest support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketOpeninterestInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-openinterest?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:30:43.271000000Z",
- "max_time": "2022-04-11T08:51:00.000000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:00.000000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-10T13:00:58.123000000Z",
- "max_time": "2022-07-04T13:53:00.000000000Z"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all markets with liquidations support along with the time ranges of available data.
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 |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(CatalogMarketLiquidationsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-liquidations?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000BTTCUSDT-future",
- "min_time": "2022-01-26T03:46:28.290000000Z",
- "max_time": "2022-04-11T03:40:00.193000000Z"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "min_time": "2022-05-31T02:45:32.286000000Z",
- "max_time": "2022-07-04T12:25:16.559000000Z"
}, - {
- "market": "binance-1000SHIBUSDT-future",
- "min_time": "2021-05-11T23:00:17.729000000Z",
- "max_time": "2022-07-04T13:35:00.567000000Z"
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all markets with market metrics support along with time ranges of available data per metric.
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. |
metrics |
Array of strings
Comma separated list of metrics. By default all metrics are returned. |
format |
string
Default: "json"
Format of the response. Supported values are |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (CatalogMarketMetricsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/market-metrics?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2020-01-01T01:25:00.000000000Z",
- "max_time": "2022-01-21T00:30:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2020-01-01T01:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2020-01-01T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}, - {
- "market": "bybit-BTCUSDT-future",
- "metrics": [
- {
- "metric": "liquidations_reported_future_buy_usd_5m",
- "frequencies": [
- {
- "frequency": "5m",
- "min_time": "2021-04-30T12:35:00.000000000Z",
- "max_time": "2022-01-21T00:25:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_usd_1h",
- "frequencies": [
- {
- "frequency": "1h",
- "min_time": "2021-04-30T12:00:00.000000000Z",
- "max_time": "2022-01-20T23:00:00.000000000Z"
}
]
}, - {
- "metric": "liquidations_reported_future_buy_units_1d",
- "frequencies": [
- {
- "frequency": "1d",
- "min_time": "2021-04-30T00:00:00.000000000Z",
- "max_time": "2022-01-20T00:00:00.000000000Z"
}
]
}
]
}
], - "next_page_token": "Ymlib3gtYWF2ZS1ldGgtc3BvdA",
}
Returns a list of all supported asset pair candles along with the time ranges of available data per candle duration.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogPairCandlesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/pair-candles?pretty=true&api_key=<your_key>"
{- "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"
}
]
}
], - "next_page_token": "Q01CSTEw",
}
Returns a list of all supported index levels along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogV2IndexInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/index-levels?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CMBI10",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2022-06-06T15:17:15.000000000Z",
- "max_time": "2023-09-11T11:56:45.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-07T00:00:00.000000000Z",
- "max_time": "2023-09-11T00:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-06T14:00:00.000000000Z",
- "max_time": "2023-09-11T11:00:00.000000000Z"
}, - {
- "frequency": "1d-ny-close",
- "min_time": "2022-06-06T20:00:00.000000000Z",
- "max_time": "2023-09-10T20:00:00.000000000Z"
}, - {
- "frequency": "1d-sg-close",
- "min_time": "2022-06-07T08:00:00.000000000Z",
- "max_time": "2023-09-11T08:00:00.000000000Z"
}
]
}, - {
- "index": "CMBI10E",
- "frequencies": [
- {
- "frequency": "15s",
- "min_time": "2022-06-06T15:17:15.000000000Z",
- "max_time": "2023-09-11T11:56:45.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2022-06-07T00:00:00.000000000Z",
- "max_time": "2023-09-11T00:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2022-06-06T14:00:00.000000000Z",
- "max_time": "2023-09-11T11:00:00.000000000Z"
}, - {
- "frequency": "1d-ny-close",
- "min_time": "2022-06-06T20:00:00.000000000Z",
- "max_time": "2023-09-10T20:00:00.000000000Z"
}, - {
- "frequency": "1d-sg-close",
- "min_time": "2022-06-07T08:00:00.000000000Z",
- "max_time": "2023-09-11T08:00:00.000000000Z"
}
]
}
], - "next_page_token": "Q01CSTEwRVg",
}
Returns a list of all supported index candles along with the time ranges of available data per candle duration.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogIndexCandlesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/index-candles?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CBTCED",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:32:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:25:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:20:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:15:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2023-06-08T04:00:00.000000000Z",
- "max_time": "2023-08-24T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2023-06-08T00:00:00.000000000Z",
- "max_time": "2023-08-23T00:00:00.000000000Z"
}
]
}, - {
- "index": "CBTCRT",
- "frequencies": [
- {
- "frequency": "1m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:32:00.000000000Z"
}, - {
- "frequency": "5m",
- "min_time": "2023-06-08T07:05:00.000000000Z",
- "max_time": "2023-08-24T15:25:00.000000000Z"
}, - {
- "frequency": "10m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:20:00.000000000Z"
}, - {
- "frequency": "15m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:15:00.000000000Z"
}, - {
- "frequency": "30m",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T15:00:00.000000000Z"
}, - {
- "frequency": "1h",
- "min_time": "2023-06-08T07:00:00.000000000Z",
- "max_time": "2023-08-24T14:00:00.000000000Z"
}, - {
- "frequency": "4h",
- "min_time": "2023-06-08T04:00:00.000000000Z",
- "max_time": "2023-08-24T08:00:00.000000000Z"
}, - {
- "frequency": "1d",
- "min_time": "2023-06-08T00:00:00.000000000Z",
- "max_time": "2023-08-23T00:00:00.000000000Z"
}
]
}
], - "next_page_token": "Q01CSTEw",
}
Returns a list of all supported assets for the asset-chains endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (CatalogAssetChainsInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/asset-chains?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
Returns a list of all supported assets for the mempool-feerates endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMempoolFeeratesInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/mempool-feerates?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
Returns a list of all supported assets for the mining-pool-tips-summary endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogMiningPoolTipsSummaryInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/mining-pool-tips-summary?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
Returns a list of all supported assets for the transaction-tracker endpoint along with time ranges of available data.
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. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
format |
string
Default: "json"
Format of the response. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
(CatalogTransactionTrackerInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/catalog-all-v2/transaction-tracker?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "min_time": "2023-08-17T14:58:45.614000000Z",
- "max_time": "2023-08-24T15:29:26.235000000Z"
}
], - "next_page_token": "ZXRo",
}
Returns requested metrics for specified assets.
Results for block by block metrics
(1b
frequency) are ordered by tuple (asset, height, block_hash)
, all other
metrics are ordered by tuple (asset, time)
. You can change the sorting using
sort
query parameter.
Supported output formats are json
(default) and csv
, use format
query parameter to override it.
To
fetch the next page of results use next_page_url
JSON response field or
x-next-page-url
CSV HTTP header if present.
If multiple metrics are
requested in the same time the strict policy for partially available metrics among requested ones is
applied:
null
value of the metric means "no data in the database" while some other
requested metrics have data.assets
required
|
Array of strings
Comma separated list of assets. |
metrics
required
|
Array of strings
Example: metrics=AdrActCnt,BlkHgt
Comma separated metrics to request time series data for. |
frequency |
string
Default: "1d"
Example: frequency=1b
Frequency of the metrics. Supported values are |
status |
string
Default: "all"
Enum: "all" "flash" "reviewed" "revised"
Which metric values do you want to see. Applicable only for "reviewable"
metrics. You can find them in the |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_hash |
string
The start hash indicates the beginning block height for the set of data that are
returned. |
end_hash |
string
The end hash indicates the ending block height for the set of data that are
returned. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
min_confirmations |
integer <int32>
[ 0 .. 99 ]
Specifies how many blocks behind the chain tip block by block metrics ( |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
sort |
string
Default: "asset"
Enum: "asset" "height" "time"
How results will be sorted. Metrics with |
limit_per_asset |
integer <int32>
How many entries per asset result should contain. For example, this combination of
parameters |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
null_as_zero |
boolean
Default: false
Nulls are represented as zeros in the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
ignore_forbidden_errors |
boolean
Default: false
Ignore HTTP 403 Forbidden errors |
ignore_unsupported_errors |
boolean
Default: false
Ignore errors for unsupported assets, metrics or frequencies. |
required
|
Array of objects
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/asset-metrics?assets=btc&metrics=PriceUSD,FlowInGEMUSD&frequency=1d&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "time": "2020-02-29T00:00:00.000000000Z",
- "PriceUSD": "8582.09029964933",
- "SplyBMXNtv": "283220.10827406",
- "SplyBMXNtv-status": "reviewed",
- "SplyBMXNtv-status-time": "2020-03-01T09:59:13.847251000Z"
}, - {
- "asset": "btc",
- "time": "2020-03-01T00:00:00.000000000Z",
- "PriceUSD": "8541.77389392169",
- "SplyBMXNtv": "284691.32323907",
- "SplyBMXNtv-status": "reviewed",
- "SplyBMXNtv-status-time": "2020-03-02T14:00:02.622168000Z"
}
], - "next_page_token": "0.MjAyMC0wNi0wN1QwMDowMDowMFo,MjAyMC0wNi0wN1QwMDowMDowMFo",
}
Returns metrics for specified exchanges.
Results are ordered by tuple
(exchange, time)
.
To fetch the next page of results use
next_page_url
JSON response field.
exchanges
required
|
Array of strings Examples:
Comma separated list of exchange names or asterisk (*) for all supported exchanges. |
metrics
required
|
Array of strings
Example: metrics=open_interest_reported_future_usd,volume_reported_spot_usd_1d
Comma separated metrics to request time series data for. |
frequency |
string
Default: "1d"
Frequency of the exchange metrics. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
sort |
string
Default: "exchange"
Enum: "exchange" "time"
How results will be sorted. Metrics are sorted by |
limit_per_exchange |
integer <int32>
How many entries per institution result should contain. For example, this combination
of parameters
|
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/exchange-metrics?exchanges=binance&metrics=volume_reported_spot_usd_1d&frequency=1d&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "exchange": "binance",
- "time": "2022-01-01T00:00:00.000000000Z",
- "volume_reported_spot_usd_1d": "8988114373.91716"
}, - {
- "exchange": "binance",
- "time": "2022-01-02T00:00:00.000000000Z",
- "volume_reported_spot_usd_1d": "9686610104.12659"
}, - {
- "exchange": "binance",
- "time": "2022-01-03T00:00:00.000000000Z",
- "volume_reported_spot_usd_1d": "13513437237.6032"
}, - {
- "exchange": "binance",
- "time": "2022-01-04T00:00:00.000000000Z",
- "volume_reported_spot_usd_1d": "15006844836.1782"
}
]
}
Returns metrics for specified exchange-asset.
Results are ordered by tuple
(exchange_asset, time)
.
To fetch the next page of results use
next_page_url
JSON response field.
exchange_assets
required
|
Array of strings
Comma separated list of exchange-asset pairs or patterns like |
metrics
required
|
Array of strings
Example: metrics=open_interest_reported_future_usd,volume_reported_spot_usd_1d
Comma separated metrics to request time series data for. |
frequency |
string
Default: "1d"
Frequency of the exchange-asset metrics. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
sort |
string
Default: "exchange_asset"
Enum: "exchange_asset" "time"
How results will be sorted. Metrics are sorted by |
limit_per_exchange_asset |
integer <int32>
How many entries per exchange_asset result should contain. For example, this
combination of parameters
|
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/exchange-asset-metrics?exchange_assets=binance-btc&metrics=volume_reported_spot_usd_1d&frequency=1d&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "exchange_asset": "binance-btc",
- "time": "2021-10-04T00:00:00.000000000Z",
- "open_interest_reported_future_usd": "3469621227.0258"
}, - {
- "exchange_asset": "binance-btc",
- "time": "2021-10-05T00:00:00.000000000Z",
- "open_interest_reported_future_usd": "3562791590.02995"
}, - {
- "exchange_asset": "binance-btc",
- "time": "2021-10-06T00:00:00.000000000Z",
- "open_interest_reported_future_usd": "3970248573.60142"
}, - {
- "exchange_asset": "binance-btc",
- "time": "2021-10-07T00:00:00.000000000Z",
- "open_interest_reported_future_usd": "4110308192.96416"
}
]
}
Returns metrics for specified markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
metrics
required
|
Array of strings
Example: metrics=liquidations_reported_future_buy_units_1d,liquidations_reported_future_sell_units_1d
Comma separated metrics to request time series data for. |
frequency |
string
Default: "1d"
Frequency of the market metrics. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
sort |
string
Default: "market"
Enum: "market" "time"
How results will be sorted. Metrics are sorted by |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-metrics?markets=binance-BTCUSDT-future&metrics=liquidations_reported_future_buy_usd_5m&frequency=5m&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-BTCUSDT-future",
- "time": "2022-01-19T20:00:00.000000000Z",
- "liquidations_reported_future_buy_usd_5m": "1298.36866"
}, - {
- "market": "binance-BTCUSDT-future",
- "time": "2022-01-19T20:10:00.000000000Z",
- "liquidations_reported_future_buy_usd_5m": "39713.60016"
}, - {
- "market": "binance-BTCUSDT-future",
- "time": "2022-01-19T20:30:00.000000000Z",
- "liquidations_reported_future_buy_usd_5m": "29084.10932"
}, - {
- "market": "binance-BTCUSDT-future",
- "time": "2022-01-19T21:00:00.000000000Z",
- "liquidations_reported_future_buy_usd_5m": "46294.99528"
}
]
}
Returns metrics for specified asset pairs.
Results are ordered by tuple
(pair, time)
.
To fetch the next page of results use next_page_url
JSON response field.
pairs
required
|
Array of strings
Comma separated list of asset pairs or patterns like |
metrics
required
|
Array of strings
Example: metrics=volume_trusted_spot_usd_1h,volume_trusted_spot_usd_1d
Comma separated metrics to request time series data for. |
frequency |
string
Default: "1d"
Frequency of the pair metrics. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
sort |
string
Default: "pair"
Enum: "pair" "time"
How results will be sorted. Metrics are sorted by |
limit_per_pair |
integer <int32>
How many entries per pair result should contain. For example, this combination of
parameters
|
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/pair-metrics?pairs=btc-usd&metrics=volume_trusted_spot_usd_1d&frequency=1d&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "pair": "btc-usd",
- "time": "2020-09-28T00:00:00.000000000Z",
- "volume_trusted_spot_usd_1d": "317000178.776577"
}, - {
- "pair": "btc-usd",
- "time": "2020-09-29T00:00:00.000000000Z",
- "volume_trusted_spot_usd_1d": "246153685.485477"
}, - {
- "pair": "btc-usd",
- "time": "2020-09-30T00:00:00.000000000Z",
- "volume_trusted_spot_usd_1d": "217972373.240482"
}, - {
- "pair": "btc-usd",
- "time": "2020-10-01T00:00:00.000000000Z",
- "volume_trusted_spot_usd_1d": "492203699.871197"
}
]
}
Returns candles for specified asset pairs.
Results are ordered by tuple
(pair, time)
.
To fetch the next page of results use next_page_url
JSON response field.
pairs
required
|
Array of strings
Comma separated list of asset pairs or patterns like |
frequency |
string
Default: "1d"
Example: frequency=5m
Candle duration. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_pair |
integer <int32>
How many entries per pair result should contain. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (PairCandle)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/pair-candles?pairs=btc-usd&frequency=1d&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "pair": "btc-usd",
- "time": "2022-06-27T00:00:00.000000000Z",
- "price_open": "21027.92",
- "price_close": "20722.93",
- "price_high": "21510.66",
- "price_low": "20505.5"
}, - {
- "pair": "btc-usd",
- "time": "2022-06-28T00:00:00.000000000Z",
- "price_open": "20722.93",
- "price_close": "20252.89",
- "price_high": "21185.14",
- "price_low": "20177.31"
}
]
}
Returns metrics for specified institutions.
Results are ordered by tuple
(institution, time)
.
To fetch the next page of results use
next_page_url
JSON response field.
institutions
required
|
Array of strings
Comma separated list of institutions, or wildcard (*) for all supported
institutions. |
metrics
required
|
Array of strings
Example: metrics=btc_total_assets,btc_shares_outstanding
Comma separated metrics to request time series data for. |
frequency |
string
Default: "1d"
Frequency of the institution metrics. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
sort |
string
Default: "institution"
Enum: "institution" "time"
How results will be sorted. Metrics are sorted by |
limit_per_institution |
integer <int32>
How many entries per institution result should contain. For example, this combination
of parameters
|
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/institution-metrics?institutions=grayscale&metrics=btc_total_assets&frequency=1d&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "institution": "institution1",
- "time": "2020-09-28T00:00:00.000000000Z",
- "total_assets": "317000178.776577"
}, - {
- "institution": "institution1",
- "time": "2020-09-29T00:00:00.000000000Z",
- "total_assets": "246153685.485477"
}, - {
- "institution": "institution1",
- "time": "2020-09-30T00:00:00.000000000Z",
- "total_assets": "217972373.240482"
}, - {
- "institution": "institution1",
- "time": "2020-10-01T00:00:00.000000000Z",
- "total_assets": "492203699.871197"
}
]
}
Returns trades for specified markets.
Results are ordered by tuple
(market, time, coin_metrics_id)
.
To fetch the next page of results use
next_page_url
JSON response field.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
min_confirmations |
integer <int32>
[ 0 .. 99 ]
Default: 2
Specifies how many blocks behind the chain tip trades are based on. Default is
|
required
|
Array of objects (MarketTradesDataArray)
Time series of market trades. |
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-trades?start_time=2020-01-01&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "time": "2015-01-08T20:55:00.028749000Z",
- "market": "coinbase-btc-usd-spot",
- "coin_metrics_id": "100",
- "amount": "1000.01",
- "price": "10.61",
- "database_time": "2016-06-08T20:55:00.256754000Z",
- "side": "buy"
}, - {
- "time": "2021-06-08T20:55:00.758178000Z",
- "market": "coinbase-btc-usd-spot",
- "coin_metrics_id": "200000000",
- "amount": "1000.01",
- "price": "1000000.61",
- "database_time": "2021-06-08T20:55:01.053472000Z",
- "side": "sell"
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMTowMzowNi40OTM1OTZafDk0MjMzMjAz",
}
Returns open interest for specified futures markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field. Keep in mind that spot markets are not supported by this endpoint.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
granularity |
string
Default: "raw"
Enum: "raw" "1m" "1h" "1d"
Downsampling granularity of market open interest. Supported values are
|
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(MarketOpenInterestDataArray)
Time series of market open interest. |
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-openinterest?start_time=2020-01-01&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-BTCUSDT-future",
- "time": "2020-08-05T23:04:50.421035000Z",
- "contract_count": "35074.075",
- "value_usd": "408810440.79225",
- "database_time": "2020-08-05T23:04:50.606185000Z",
- "exchange_time": "2020-08-05T23:03:59.417000000Z"
}, - {
- "market": "binance-BTCUSDT-future",
- "time": "2020-08-05T23:19:10.016074000Z",
- "contract_count": "35061.142",
- "value_usd": "409113039.09552",
- "database_time": "2020-08-05T23:19:10.749665000Z",
- "exchange_time": "2020-08-05T23:19:00.458000000Z"
}
]
}
Returns liquidations for specified futures markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field. Keep in mind that spot markets are not supported by this endpoint.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(MarketLiquidationsDataArray)
Time series of market liquidations. |
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-liquidations?start_time=2020-01-01&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-BTCUSDT-future",
- "time": "2020-10-10T15:44:42.105000000Z",
- "coin_metrics_id": "1602344682105000000",
- "amount": "0.045",
- "price": "11380.39",
- "type": "trade",
- "database_time": "2020-10-10T15:44:45.109122000Z",
- "side": "buy"
}, - {
- "market": "binance-BTCUSDT-future",
- "time": "2020-10-10T15:45:37.067000000Z",
- "coin_metrics_id": "1602344737067000000",
- "amount": "0.004",
- "price": "11386",
- "type": "trade",
- "database_time": "2020-10-10T15:45:39.329348000Z",
- "side": "buy"
}
]
}
Returns funding rates for specified futures markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field. Keep in mind that spot markets are not supported by this endpoint.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(MarketFundingRatesDataArray)
Time series of market funding rates. |
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-funding-rates?start_time=2020-01-01&paging_from=start&markets=bitmex-XBTUSD-future&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "bitmex-XBTUSD-future",
- "time": "2020-11-11T18:00:00.000000000Z",
- "rate": "-0.000007",
- "period": "08:00:00",
- "interval": "01:00:00",
- "database_time": "2020-12-02T10:49:31.262231000Z"
}, - {
- "market": "bitmex-XBTUSD-future",
- "time": "2020-11-11T19:00:00.000000000Z",
- "rate": "0.2123",
- "period": "08:00:00",
- "interval": "01:00:00",
- "database_time": "2020-12-02T10:49:31.262231000Z"
}
]
}
Returns predicted funding rates for specified futures markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field. Keep in mind that spot markets are not supported by this endpoint.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(MarketFundingRatesPredictedDataArray)
Time series of predicted market funding rates. |
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-funding-rates-predicted?start_time=2023-01-01&paging_from=start&markets=deribit-XRP_USDC-PERPETUAL-future&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "deribit-XRP_USDC-PERPETUAL-future",
- "time": "2024-01-30T13:36:00.000000000Z",
- "database_time": "2024-01-30T13:36:16.493351000Z",
- "rate_predicted": "0.00013059"
}, - {
- "market": "deribit-XRP_USDC-PERPETUAL-future",
- "time": "2024-01-30T13:37:00.000000000Z",
- "database_time": "2024-01-30T13:37:16.500723000Z",
- "rate_predicted": "0.00013016"
}
]
}
Returns orderbooks for specified markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
granularity |
string
Default: "raw"
Enum: "raw" "1m" "1h" "1d"
Downsampling granularity of market order books and quotes. Supported values are
|
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. Maximum value for unlimited order books is
100. |
depth_limit |
string
Default: 100
Book depth limit. Supported values are between 1 and 30000,
|
format |
string
Default: "json"
Format of the response. Supported values are |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (MarketOrderBook)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-orderbooks?start_time=2020-01-01&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "time": "2020-06-08T21:01:23.283083000Z",
- "market": "coinbase-btc-usd-spot",
- "coin_metrics_id": "1591479594286046-27268420",
- "asks": [
- {
- "price": "9701.48",
- "size": "2.65178241"
}, - {
- "price": "9701.49",
- "size": "0.10941481"
}
], - "bids": [
- {
- "price": "9701.4",
- "size": "4.43779413"
}, - {
- "price": "9699.94",
- "size": "0.041"
}
]
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMTowMToyMy4yODMwODNafDE1OTE0Nzk1OTQyODYwNDY",
}
Returns quotes for specified markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
granularity |
string
Default: "raw"
Enum: "raw" "1m" "1h" "1d"
Downsampling granularity of market order books and quotes. Supported values are
|
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
format |
string
Default: "json"
Format of the response. Supported values are |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
include_one_sided |
boolean
Default: false
Include one-side and empty books in quotes response. |
required
|
Array of objects (MarketQuote)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-quotes?start_time=2020-01-01&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "time": "2020-06-08T21:14:48.215145000Z",
- "market": "coinbase-btc-usd-spot",
- "coin_metrics_id": "1591479594286046-27326992",
- "ask_price": "9685.02",
- "ask_size": "0.04340557",
- "bid_price": "9685.01",
- "bid_size": "0.00484254"
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMToxNDo0OC4yMTUxNDVafDE1OTE0Nzk1OTQyODYwNDY",
}
Returns candles for specified markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field.
XFT derives candles directly from trades. Candles are only generated if
there are trades in the underlying interval. Therefore, gaps in candles data through time are normal
and to be expected. To construct gapless candles, the client should fill forward candles through
time, setting the open, high, low, and close to the close of the previous candle, setting the vwap
to the vwap of the previous candle, and setting the volume to zero.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
frequency |
string
Default: "1d"
Example: frequency=5m
Candle duration. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (MarketCandle)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-candles?start_time=2020-01-01&paging_from=start&markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "time": "2020-06-08T20:45:00.000000000Z",
- "market": "coinbase-btc-usd-spot",
- "price_open": "9705.07999999999993",
- "price_close": "9705.01000000000022",
- "price_high": "9706.19000000000051",
- "price_low": "9705",
- "vwap": "9705.1686505895068",
- "volume": "16.8066639099999975",
- "candle_usd_volume": "16.8066639099999975",
- "candle_trades_count": "212"
}, - {
- "time": "2020-06-08T20:50:00.000000000Z",
- "market": "coinbase-btc-usd-spot",
- "price_open": "9705",
- "price_close": "9696.27000000000044",
- "price_high": "9705",
- "price_low": "9695.71999999999935",
- "vwap": "9698.38894423754937",
- "volume": "14.7672128699999963",
- "candle_usd_volume": "14.7672128699999963",
- "candle_trades_count": "215"
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMDo0NTowMFo",
}
Returns contract prices for specified markets. This includes index price and mark price that are
used by the exchange for settlement and risk management purposes.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
granularity |
string
Default: "raw"
Enum: "raw" "1m" "1h" "1d"
Downsampling granularity of market contract prices. Supported values are
|
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (MarketContractPrices)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-contract-prices?start_time=2020-01-01&paging_from=start&markets=deribit-ETH-25MAR22-1200-P-option&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "deribit-ETH-25MAR22-1200-P-option",
- "time": "2021-09-01T13:24:00.000000000Z",
- "mark_price": "0.02126",
- "index_price": "3529.34",
- "database_time": "2021-09-01T13:24:41.266168000Z",
- "exchange_time": "2021-09-01T13:24:00.000000000Z"
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMDo0NTowMFo",
}
Returns implied volatility for specified markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field.
Implied volatility is calculated using an options pricing model. It
represents the market's expectation of future volatility and is the value, when input to an
options pricing model, that makes the actual options price equal to its theoretical price.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
granularity |
string
Default: "raw"
Enum: "raw" "1m" "1h" "1d"
Downsampling granularity of market implied volatility. Supported values are
|
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (MarketImpliedVolatility)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-implied-volatility?start_time=2020-01-01&paging_from=start&markets=deribit-ETH-25MAR22-1200-P-option&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "deribit-ETH-10SEP21-3200-P-option",
- "time": "2021-09-05T13:26:00.000000000Z",
- "database_time": "2021-09-05T13:26:37.808731000Z",
- "exchange_time": "2021-09-05T13:26:36.642000000Z",
- "iv_bid": "1.0086",
- "iv_ask": "1.1132",
- "iv_mark": "1.0616"
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMDo0NTowMFo",
}
Returns greeks for option markets.
Results are ordered by tuple
(market, time)
.
To fetch the next page of results use next_page_url
JSON response field.
Option greeks represent the sensitivity of the price of an options
contract with respect to changes in its underlying parameters. Greeks are used in risk management
and hedging so that market participants can achieve their desired exposure.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_market |
integer <int32>
How many entries per market result should contain. It is useful when multiple markets are requested. |
granularity |
string
Default: "raw"
Enum: "raw" "1m" "1h" "1d"
Downsampling granularity of market greeks. Supported values are |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (MarketGreeks)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/market-greeks?start_time=2020-01-01&paging_from=start&markets=deribit-ETH-25MAR22-1200-P-option&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "deribit-ETH-25MAR22-1200-P-option",
- "time": "2021-09-01T13:24:00.000000000Z",
- "database_time": "2021-09-01T13:24:41.266168000Z",
- "exchange_time": "2021-09-01T13:24:00.000000000Z",
- "vega": "2.47772",
- "theta": "-0.70691",
- "rho": "-1.31245",
- "delta": "-0.04137",
- "gamma": "0.00003"
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMDo0NTowMFo",
}
Returns candles for specified indexes.
Results are ordered by tuple
(index, time)
.
To fetch the next page of results use next_page_url
JSON response field.
indexes
required
|
Array of strings
Example: indexes=CMBIBE
Comma separated list of indexes, or patterns like |
frequency |
string
Default: "1d"
Example: frequency=5m
Candle duration. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_index |
integer <int32>
How many entries per index result should contain. It is useful when multiple indexes are requested. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (IndexCandle)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/index-candles?start_time=2022-06-28&paging_from=start&indexes=CMBIBTC&frequency=1d&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "index": "CMBIBTC",
- "time": "2022-06-28T00:00:00.000000000Z",
- "price_open": "21072.8899999999994",
- "price_close": "20248.47",
- "price_high": "21086.7200000000012",
- "price_low": "20184.6",
- "candle_trades_count": "116028440"
}, - {
- "index": "CMBIBTC",
- "time": "2022-06-29T00:00:00.000000000Z",
- "price_open": "20252.89",
- "price_close": "20089.0299999999988",
- "price_high": "20402.8100000000013",
- "price_low": "19867.9399999999987",
- "candle_trades_count": "228458314"
}, - {
- "index": "CMBIBTC",
- "time": "2022-06-30T00:00:00.000000000Z",
- "price_open": "20093.1800000000003",
- "price_close": "19900.6",
- "price_high": "20130",
- "price_low": "18655.1500000000015",
- "candle_trades_count": "252868227"
}
]
}
Returns levels for specified indexes.
Results are ordered by tuple
(index, time)
.
To fetch the next page of results use next_page_url
JSON response field.
indexes
required
|
Array of strings
Example: indexes=CMBIBE
Comma separated list of indexes, or patterns like |
frequency |
string
Default: "1d"
Frequency of the index. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
limit_per_index |
integer <int32>
How many entries per index result should contain. It is useful when multiple indexes are requested. |
include_verification |
boolean
Default: false
If set to true, includes information about verification. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (IndexLevel)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/index-levels?start_time=2020-01-01&paging_from=start&indexes=CMBIBTC&frequency=1d-ny-close&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "time": "2017-05-22T00:00:00.000000000Z",
- "index": "CMBIWORK",
- "level": "389473805.713838875"
}, - {
- "time": "2017-05-23T00:00:00.000000000Z",
- "index": "CMBIWORK",
- "level": "362701474.775819778"
}
], - "next_page_token": "0.MjAxNy0wNS0yMlQwMDowMDowMFo",
}
Returns constituents and weights for specified indexes.
Results are ordered by tuple
(index, time)
.
To fetch the next page of results use next_page_url
JSON response field.
indexes
required
|
Array of strings
Example: indexes=CMBIBE
Comma separated list of indexes, or patterns like |
frequency |
string
Frequency of index constituents. Supported values are |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (IndexConstituents)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/index-constituents?start_time=2020-01-01&paging_from=start&indexes=CMBIBTC&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "time": "2020-05-01T22:00:00.000000000Z",
- "index": "CMBI10",
- "constituents": [
- {
- "asset": "bch",
- "weight": "0.01887429752681492"
}, - {
- "asset": "bsv",
- "weight": "0.01343767932475944"
}, - {
- "asset": "btc",
- "weight": "0.747355794635124"
}, - {
- "asset": "etc",
- "weight": "0.004565578678797349"
}, - {
- "asset": "eth",
- "weight": "0.1351998514006912"
}, - {
- "asset": "ltc",
- "weight": "0.01756776057810796"
}, - {
- "asset": "xlm",
- "weight": "0.008757017272583251"
}, - {
- "asset": "xmr",
- "weight": "0.006442672327610681"
}, - {
- "asset": "xrp",
- "weight": "0.03769069726575187"
}, - {
- "asset": "xtz",
- "weight": "0.01010865098975933"
}
]
}
], - "next_page_token": "0.MjAyMC0wNS0wMVQyMjowMDowMFo",
}
Returns mining pool tips summaries for the specified assets.
Lists last tips that we saw in
all mining pools that were active during the past hour.
A new summary is created when we
detect any change in current tips across all mining pools.
This endpoint is useful for those
who want to track forks and reorgs by visualizing the distribution of currently active tips between
mining pools.
Results are ordered by tuple (asset, time)
.
To fetch the next
page of results use next_page_url
JSON response field.
assets
required
|
Array of strings
Comma separated list of assets. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (MiningPoolTipsSummary)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/mining-pool-tips-summary?assets=btc&page_size=3&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "btc",
- "time": "2021-04-20T15:38:35.378090000Z",
- "tips_count": "2",
- "block_hashes_at_tip": "1",
- "tips": [
- {
- "last_time": "2021-04-20T15:26:21.615787000Z",
- "height": "679916",
- "hash": "0000000000000000000b014cad322db899c4fcffc2bdbe1968c6fa85217308a2",
- "pool_count": "2"
}, - {
- "last_time": "2021-04-20T15:38:35.378090000Z",
- "height": "679917",
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033a0",
- "pool_count": "10"
}
]
}, - {
- "asset": "btc",
- "time": "2021-04-20T15:38:35.543325000Z",
- "tips_count": "2",
- "block_hashes_at_tip": "1",
- "tips": [
- {
- "last_time": "2021-04-20T15:26:21.351310000Z",
- "height": "679916",
- "hash": "0000000000000000000b014cad322db899c4fcffc2bdbe1968c6fa85217308a2",
- "pool_count": "1"
}, - {
- "last_time": "2021-04-20T15:38:35.543325000Z",
- "height": "679917",
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033a0",
- "pool_count": "11"
}
]
}, - {
- "asset": "btc",
- "time": "2021-04-20T15:38:35.744213000Z",
- "tips_count": "1",
- "block_hashes_at_tip": "1",
- "tips": [
- {
- "last_time": "2021-04-20T15:38:35.744213000Z",
- "height": "679917",
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033a0",
- "pool_count": "12"
}
]
}
], - "next_page_token": "0.MjAyMS0wNC0yMFQxNTozODozNS4zNzgwOTBa",
}
Returns the chains of blocks for the specified assets.
Lists all the chains that were active
in the blockchain during the time that's enough to produce the number of blocks considered as an
industry-standard number of confirmations.
A new entry is created when we detect any new block
anywhere in the chain.
This endpoint is useful for those who want to quickly detect
reorganizations or visualize currently active chains.
If there are two or more active chains,
then the response will contain the chain fragments starting from their common ancestor block.
Otherwise, if there is a single active chain - only the blockchain tip is returned.
The
reorganization depth is measured as a number of consecutive blocks that were disconnected from the
common ancestor block.
Results are ordered by tuple (asset, time)
.
To fetch
the next page of results use next_page_url
JSON response field.
assets
required
|
Array of strings
Comma separated list of assets. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (AssetChains)
|
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. |
{- "data": [
- {
- "asset": "btc",
- "time": "2021-01-01T15:30:00.000000000Z",
- "chains_count": "2",
- "blocks_count_at_tip": "1",
- "reorg": "true",
- "reorg_depth": "1",
- "chains": [
- [
- {
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033aa",
- "height": "679917",
- "time": "2021-01-01T15:00:00.000000000Z"
}, - {
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033ac",
- "height": "679918",
- "time": "2021-01-01T15:20:00.000000000Z"
}, - {
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033ad",
- "height": "679919",
- "time": "2021-01-01T15:30:00.000000000Z"
}
], - [
- {
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033aa",
- "height": "679917",
- "time": "2021-01-01T15:00:00.000000000Z"
}, - {
- "hash": "000000000000000000004035d600016c2005b4238acb2750625126542b8033ab",
- "height": "679918",
- "time": "2021-01-01T15:10:00.000000000Z"
}
]
]
}
], - "next_page_token": "0.MjAyMS0wNC0yMFQxNTozODozNS4zNzgwOTBa",
}
Returns mempool feerates for the specified assets.
This endpoint is useful for those who want
to explore the history of the feerate distribution and potentially select the time period with the
lowest commissions.
Results are ordered by (asset, time)
.
To fetch the next
page of results use the next_page_url
JSON response field.
assets
required
|
Array of strings
Comma separated list of assets. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 200 ]
Default: 10
Number of mempool feerate snapshots per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (MempoolFeerates)
|
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. |
{- "data": [
- {
- "asset": "btc",
- "time": "2021-06-08T11:48:21.000000000Z",
- "feerates": [
- {
- "feerate": "1",
- "count": "123",
- "consensus_size": "512",
- "physical_size": "128",
- "fees": "0.09"
}, - {
- "feerate": "3",
- "count": "12",
- "consensus_size": "2048",
- "physical_size": "1152",
- "fees": "0.003"
}
]
}
], - "next_page_token": "MjAyMS0wNi0wOFQxMDo0MTo1NS4zOTZafEJMZER2Q1JSd3FqSi16dTVSdDVPc1RCYVRBeFJfWG9DN2xsMS0wenM5Tm8",
}
Returns asset alerts for the specified assets.
This endpoint is useful for those who wants to
track the breaches in the particular asset's Key Risk Indicator thresholds.
An asset alert
is issued once an alerting metric value either breaches it's Key Risk Indicator threshold or
returns back to normal for a predefined period of time.
Results are ordered by
(asset, time, alert)
.
To fetch the next page of results use the
next_page_url
JSON response field.
assets
required
|
Array of strings
Comma separated list of assets. |
alerts
required
|
Array of strings
Comma separated list of asset alert names. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
include_heartbeats |
boolean
Default: false
If set to true, includes information about most recent time asset was successfully evaluated. |
Array of objects (AssetAlertHeartbeats)
|
|
required
|
Array of objects (AssetAlerts)
|
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. |
{- "data": [
- {
- "asset": "btc",
- "time": "2021-06-08T11:48:21.000000000Z",
- "alert": "mempool_count_empty_5m",
- "value": "0",
- "threshold": "0",
- "status": "active"
}, - {
- "asset": "btc",
- "time": "2021-06-08T12:48:21.000000000Z",
- "alert": "mempool_vsize_hi",
- "value": "323",
- "threshold": "300",
- "status": "active"
}, - {
- "asset": "btc",
- "time": "2021-06-08T13:48:21.000000000Z",
- "alert": "mempool_count_empty_5m",
- "value": "1",
- "threshold": "0",
- "status": "inactive"
}
], - "next_page_token": "MjAyMS0wNi0wOFQxMDo0MTo1NS4zOTZafEJMZER2Q1JSd3FqSi16dTVSdDVPc1RCYVRBeFJfWG9DN2xsMS0wenM5Tm8",
}
Returns Defi Balance Sheet records for specified DeFi protocols. The data is being updated on
an end-of-day frequency. Results are ordered by tuple (defi_protocol
,
block_height
). To fetch the next page of results use the
next_page_url
JSON response field.
defi_protocols
required
|
Array of strings
Comma separated list of DeFi protocols like |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (DefiBalanceSheets)
|
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. |
curl --compressed "https://api.xft.io/v4/timeseries/defi-balance-sheets?defi_protocols=aave_v2_eth&api_key=<your_key>"
{- "data": [
- {
- "defi_protocol": "aave_v2_eth",
- "block_height": "15656731",
- "time": "2022-10-02T00:00:00.000000000Z",
- "assets_total_usd": "5457689622.84",
- "assets_total_count": "34",
- "assets": [
- {
- "asset": "1inch",
- "balance_units": "16674724.15",
- "balance_usd": "9580408.36",
- "share": "0.001755"
}, - {
- "asset": "aave",
- "balance_units": "1743338.27",
- "balance_usd": "129832512.22",
- "share": "0.023789"
}
], - "liabilities_total_usd": "5458419619.21",
- "liabilities_total_count": "34",
- "liabilities": [
- {
- "asset": "1inch",
- "balance_units": "16674705.4",
- "balance_usd": "9580397.58",
- "share": "0.001755"
}, - {
- "asset": "aave",
- "balance_units": "1743338.27",
- "balance_usd": "129832512.22",
- "share": "0.023786"
}
], - "loans_lent_total_usd": "1531826827.01",
- "tvl_total_usd": "3925862795.83",
- "net_working_capital": "-1532556823.38",
- "protocol_utilization_ratio": "0.28",
- "liquid_supply_ratio": "0.72",
- "current_ratio": "0.72",
- "debt_to_assets_ratio": "1"
}
], - "next_page_token": "0.MTUwMjYyMzI",
}
WebSocket endpoints for getting a real-time stream of metrics, market data, indexes and other time series data.
Returns a WebSocket stream of metrics for specified assets.
Endpoint supports only block by
block (1b
frequency), per second (1s
frequency), and sub-second
(200ms
frequency) metrics.
Different sets of metrics may come in different
messages.
If you are falling behind (slow client) you will get warning
message
first, then error
message and disconnection will happen.
assets
required
|
Array of strings
Comma separated list of assets. |
metrics
required
|
Array of strings
Example: metrics=AdrActCnt,BlkHgt
Comma separated metrics to request time series data for. |
frequency |
string
Default: "1b"
Example: frequency=1s
Frequency of the metrics. Supported values are |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
// This is getting Reference Rates for Bitcoin and Ethereum at a frequency of 1 second ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/asset-metrics?assets=btc,eth&metrics=ReferenceRate&frequency=1s&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "time": "2020-06-08T20:54:04.000000000Z",
- "asset": "eth",
- "height": "10227376",
- "hash": "54c517db6ae6e9e0466db43fccccac137b9a75cfdab70cac0272654348ad76aa",
- "parent_hash": "64f4c0126d63335a552dca030129e2f48a2c636cc88530ba168c2902d65dbcf2",
- "type": "new_block",
- "AdrActCnt": "255",
- "FlowInBFXUSD": "0",
- "PriceUSD": "242.28",
- "cm_sequence_id": "0"
}
Returns a WebSocket stream of trades for specified markets.
If you are falling behind (slow
client) you will get warning
message first, then error
message and
disconnection will happen.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/market-trades?markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "time": "2020-06-08T21:00:06.138932000Z",
- "market": "coinbase-btc-usd-spot",
- "coin_metrics_id": "94233007",
- "amount": "0.0197263",
- "price": "9702",
- "collect_time": "2020-06-08T21:00:06.203893000Z",
- "side": "buy",
- "cm_sequence_id": "0"
}
Returns a WebSocket stream of liquidations for specified markets.
If you are falling behind
(slow client) you will get warning
message first, then error
message and
disconnection will happen.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/market-liquidations?markets=coinbase-BTCUSDT-future&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "market": "binance-LEVERUSDT-future",
- "time": "2023-10-12T12:44:33.663000000Z",
- "coin_metrics_id": "1697114673663000000",
- "amount": "377748",
- "price": "0.001381",
- "type": "trade",
- "side": "sell",
- "cm_sequence_id": "45"
}
Returns a WebSocket stream of open interests for specified markets.
If you are falling behind
(slow client) you will get warning
message first, then error
message and
disconnection will happen.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/market-openinterest?markets=binance-BTCUSDT-future&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "error": {
- "type": "unauthorized",
- "message": "Requested resource requires authorization."
}
}
Returns a WebSocket stream of orderbooks for specified markets.
Orderbooks are delivered
using a sequence of snapshot
and update
messages.
Zero value of the
size
response field for asks
or bids
means negative
update
.
If you are falling behind (slow client) you will get warning
message first, then error
message and disconnection will happen.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
depth_limit |
string
Default: 100
Enum: 100 "full_book"
Book depth limit. |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/market-orderbooks?markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "time": "2020-06-08T21:07:27.015507000Z",
- "market": "coinbase-btc-usd-spot",
- "coin_metrics_id": "1591540219445728-16126985",
- "asks": [
- {
- "price": "9695.09",
- "size": "1.58265903"
}, - {
- "price": "9695.1",
- "size": "0.01056118"
}, - {
- "price": "9695.14",
- "size": "0.0257"
}
], - "bids": [
- {
- "price": "9695.07",
- "size": "0.97684462"
}, - {
- "price": "9694.38",
- "size": "0.14852787"
}, - {
- "price": "9694.37",
- "size": "0.90808736"
}, - {
- "price": "9693.24",
- "size": "0.46738235"
}, - {
- "price": "9693",
- "size": "0.0023"
}
], - "type": "snapshot",
- "collect_time": "2020-06-08T21:07:27.082612000Z",
- "cm_sequence_id": "0"
}
Returns a stream of quotes for specified markets.
If you are falling behind (slow client) you
will get warning
message first, then error
message and disconnection will
happen.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
include_one_sided |
boolean
Default: false
Include one-side and empty books in quotes response. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/market-quotes?markets=coinbase-btc-usd-spot&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "time": "2020-06-08T21:15:45.771742000Z",
- "market": "coinbase-btc-usd-spot",
- "coin_metrics_id": "1591540219445728-16162629",
- "ask_price": "9685.01",
- "ask_size": "2.42779345",
- "bid_price": "9685",
- "bid_size": "0.43939159",
- "cm_sequence_id": "1"
}
Returns a stream of quotes for specified assets.
If you are falling behind (slow client) you
will get warning
message first, then error
message and disconnection will
happen.
assets
required
|
Array of strings
Comma separated list of assets. |
aggregation_method |
string
Default: "aggregated_spread"
The method to use for aggregation. |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/asset-quotes?assets=btc&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "time": "2020-06-08T21:15:45.771742000Z",
- "pair": "btc-usd",
- "ask_price": "24343.725954328216",
- "ask_size": "2.96375165",
- "bid_price": "24342.036360171896",
- "bid_size": "12.00588437",
- "mid_price": "24342.881157250056",
- "spread": "0.0000694081421754166",
- "cm_sequence_id": "0"
}
Returns a stream of quotes for specified pairs.
If you are falling behind (slow client) you
will get warning
message first, then error
message and disconnection will
happen.
pairs
required
|
Array of strings
Comma separated list of asset pairs or patterns like |
aggregation_method |
string
Default: "aggregated_spread"
The method to use for aggregation. |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/pair-quotes?pairs=btc-usd&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "time": "2020-06-08T21:15:45.771742000Z",
- "pair": "btc-usd",
- "ask_price": "24343.725954328216",
- "ask_size": "2.96375165",
- "bid_price": "24342.036360171896",
- "bid_size": "12.00588437",
- "mid_price": "24342.881157250056",
- "spread": "0.0000694081421754166",
- "cm_sequence_id": "0"
}
Returns a stream of candles for specified markets.
If you are falling behind (slow client)
you will get warning
message first, then error
message and disconnection
will happen.
markets
required
|
Array of strings
Comma separated list of markets or market patterns like |
frequency |
string
Default: "1m"
Example: frequency=1m
Candle duration. Supported values are |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
market
required
|
string (MarketId)
Unique name of the market. |
time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
price_open
required
|
string (CandlePriceOpen)
The opening price of the candle. |
price_close
required
|
string (CandlePriceClose)
The closing price of the candle. |
price_high
required
|
string (CandlePriceHigh)
The high price of the candle. |
price_low
required
|
string (CandlePriceLow)
The low price of the candle. |
vwap
required
|
string (CandleVwap)
The volume-weighted average price of the candle. |
volume
required
|
string (CandleVolume)
The volume of the candle in units of the base asset. |
candle_usd_volume
required
|
string (CandleUsdVolume)
The volume of the candle in USD. |
candle_trades_count
required
|
string (CandleTradesCount)
The number of trades used for candle calculation. |
cm_sequence_id
required
|
string (cmSequenceId)
The monotonically increasing message number, resets on disconnection. |
ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/market-candles?markets=bitstamp-btc-usd-spot&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "market": "bitstamp-btc-usd-spot",
- "time": "2022-05-17T09:00:00.000000000Z",
- "price_open": "30547.68",
- "price_close": "30558.65",
- "price_high": "30563.59",
- "price_low": "30547.68",
- "vwap": "30553.973252816509",
- "volume": "1.908",
- "candle_usd_volume": "58296.980966373899172",
- "candle_trades_count": "10",
- "cm_sequence_id": "0"
}
Returns a stream of levels for specified indexes.
If you are falling behind (slow client) you
will get warning
message first, then error
message and disconnect will
happen.
indexes
required
|
Array of strings
Example: indexes=CMBIBE
Comma separated list of indexes. |
include_verification |
boolean
Default: false
If set to true, includes information about verification. |
backfill |
string
Default: "latest"
Enum: "latest" "none"
What data should be sent upon a connection. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
index
required
|
string (Index)
Name of the index. |
time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
level
required
|
string (IndexLevelValue)
The value of the index. |
object (Verification)
Information about verification. |
|
cm_sequence_id
required
|
string (cmSequenceId)
The monotonically increasing message number, resets on disconnection. |
// Streams the levels for CMBIBTC index ws = new WebSocket("wss://api.xft.io/v4/timeseries-stream/index-levels?indexes=CMBIBTC&pretty=true&api_key=<your_key>") ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")
{- "index": "CMBIWORK",
- "level": "389473805.713838875",
- "time": "2017-05-22T00:00:00.000000000Z",
- "cm_sequence_id": "0"
}
Returns a list of blockchain blocks metadata.
Results are ordered by tuple
(height, block_hash)
.
To fetch the next page of results use
next_page_url
JSON response field.
asset
required
|
string
Asset name. |
block_hashes |
Array of strings
Optional comma separated list of block hashes to filter a response. |
heights |
Array of strings
Optional comma separated list of block heights to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (BlockchainBlockInfo)
|
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. |
# Gets list of blocks for Ethereum curl --compressed "https://api.xft.io/v4/blockchain/eth/blocks?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "block_hash": "0000000000000000012f06e7f91af28343003454a2c547e51265d73f26474221",
- "height": "469182",
- "consensus_time": "2017-06-01T07:13:26.000000000Z",
- "miner_time": "2017-06-01T08:09:13.000000000Z",
- "n_transactions": "818",
- "n_balance_updates": "8194",
- "parent_block_hash": "000000000000000000ef3d76fe9c94e864af9d15f4174b3d77dc11eb03819320",
- "difficulty": "595921917085.416016",
- "physical_size": "998218",
- "consensus_size": "3992872",
- "consensus_size_limit": "4000000"
}, - {
- "block_hash": "00000000000000000159f3fc5e0dc5fb63aaa7a6f9c9b5e41f1741793b2ff909",
- "height": "469183",
- "consensus_time": "2017-06-01T07:18:04.000000000Z",
- "miner_time": "2017-06-01T08:32:54.000000000Z",
- "n_transactions": "2271",
- "n_balance_updates": "12522",
- "parent_block_hash": "0000000000000000012f06e7f91af28343003454a2c547e51265d73f26474221",
- "difficulty": "595921917085.416016",
- "physical_size": "998049",
- "consensus_size": "3992196",
- "consensus_size_limit": "4000000"
}
], - "next_page_token": "NDY5MTgyfDAwMDAwMDAwMDAwMDAwMDAwMTJmMDZlN2Y5MWFmMjgzNDMwMDM0NTRhMmM1NDdlNTEyNjVkNzNmMjY0NzQyMjE",
}
Returns a list of blockchain accounts with their balances.
Results are ordered by tuple
(creation_chain_sequence_number, account)
.
To fetch the next page of results use
next_page_url
JSON response field.
asset
required
|
string
Asset name. |
accounts |
Array of strings
Optional comma separated list of accounts to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_chain_sequence_number |
integer <int64>
>= 0
Start of the |
end_chain_sequence_number |
integer <int64>
>= 0
End of the |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
# Gets list of accounts for Ethereum curl --compressed "https://api.xft.io/v4/blockchain/eth/accounts?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "account": "1K3tdQx5P1bj2FhvSCWAigJwo42iva6jDX",
- "balance": "0.00000001",
- "n_debits": "1",
- "n_credits": "2",
- "creation_height": "199999",
- "creation_time": "2012-09-22T09:50:47.000000000Z",
- "creation_chain_sequence_number": "38456668",
- "last_chain_sequence_number": "38456708",
- "last_debit_height": "199999",
- "last_credit_height": "199999"
}, - {
- "account": "1EJDRgN6vyHSxjVuGX5RKFCCdFv2Fdkrd7",
- "balance": "6.42088303",
- "n_debits": "0",
- "n_credits": "1",
- "creation_height": "199999",
- "creation_time": "2012-09-22T09:50:47.000000000Z",
- "creation_chain_sequence_number": "38456688",
- "last_chain_sequence_number": "38456688",
- "last_credit_height": "199999"
}
], - "next_page_token": "Mzg0NTY2Njh8MUszdGRReDVQMWJqMkZodlNDV0FpZ0p3bzQyaXZhNmpEWA",
}
Returns a list of blockchain transactions metadata.
Results are ordered by tuple
(min_chain_sequence_number, transaction_hash)
.
To fetch the next page of results
use next_page_url
JSON response field.
asset
required
|
string
Asset name. |
transaction_hashes |
Array of strings
Optional comma separated list of transaction hashes to filter a response. |
block_hashes |
Array of strings
Optional comma separated list of block hashes to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (BlockchainTransactionInfo)
|
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. |
# Gets list of transactions on Cardano curl --compressed "https://api.xft.io/v4/blockchain/ada/transactions?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "block_hash": "00000000000003a20def7a05a77361b9657ff954b2f2080e135ea6f5970da215",
- "height": "199999",
- "transaction_hash": "055fcc87bff4be000ab68cf5b1d8e5cad13964fcabcc982cb1e602ed9f648250",
- "consensus_time": "2012-09-22T09:50:47.000000000Z",
- "min_chain_sequence_number": "38456704",
- "max_chain_sequence_number": "38456707",
- "n_balance_updates": "4",
- "amount": "0.009018"
}, - {
- "block_hash": "00000000000003a20def7a05a77361b9657ff954b2f2080e135ea6f5970da215",
- "height": "199999",
- "transaction_hash": "e9acb03dbe3216ef19ecd0b96ec707508b8941df0cab26760f115402c8012f1a",
- "consensus_time": "2012-09-22T09:50:47.000000000Z",
- "min_chain_sequence_number": "38456708",
- "max_chain_sequence_number": "38456711",
- "n_balance_updates": "4",
- "amount": "0.007803"
}
], - "next_page_token": "Mzg0NTY3MDR8MDU1ZmNjODdiZmY0YmUwMDBhYjY4Y2Y1YjFkOGU1Y2FkMTM5NjRmY2FiY2M5ODJjYjFlNjAyZWQ5ZjY0ODI1MA",
}
Returns a list of blockchain accounts balance updates.
Results are ordered by tuple
(chain_sequence_number, block_hash)
.
To fetch the next page of results use
next_page_url
JSON response field.
asset
required
|
string
Asset name. |
accounts |
Array of strings
Optional comma separated list of accounts to filter a response. |
transaction_hashes |
Array of strings
Optional comma separated list of transaction hashes to filter a response. |
block_hashes |
Array of strings
Optional comma separated list of block hashes to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_chain_sequence_number |
integer <int64>
>= 0
Start of the |
end_chain_sequence_number |
integer <int64>
>= 0
End of the |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (BlockchainBalanceUpdates)
|
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. |
# Gets balance updates for Bitcoin accounts curl --compressed "https://api.xft.io/v4/blockchain/btc/balance-updates?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "block_hash": "00000000000003a20def7a05a77361b9657ff954b2f2080e135ea6f5970da215",
- "height": "199999",
- "consensus_time": "2012-09-22T09:50:47.000000000Z",
- "chain_sequence_number": "38456710",
- "account": "FEES",
- "account_creation_height": "0",
- "change": "0.0005",
- "previous_balance": "-0.0005",
- "new_balance": "0",
- "transaction_sequence_number": "0",
- "previous_n_debits": "80653",
- "previous_n_credits": "7235654",
- "transaction_hash": "e9acb03dbe3216ef19ecd0b96ec707508b8941df0cab26760f115402c8012f1a",
- "previous_debit_height": "199999",
- "previous_credit_height": "199999",
- "previous_chain_sequence_number": "38456706"
}, - {
- "block_hash": "00000000000003a20def7a05a77361b9657ff954b2f2080e135ea6f5970da215",
- "height": "199999",
- "consensus_time": "2012-09-22T09:50:47.000000000Z",
- "chain_sequence_number": "38456711",
- "account": "1dice6YgEVBf88erBFra9BHf6ZMoyvG88",
- "account_creation_height": "176812",
- "change": "-0.007803",
- "previous_balance": "0.007803",
- "new_balance": "0",
- "transaction_sequence_number": "0",
- "previous_n_debits": "83295",
- "previous_n_credits": "83296",
- "transaction_hash": "e9acb03dbe3216ef19ecd0b96ec707508b8941df0cab26760f115402c8012f1a",
- "previous_debit_height": "199999",
- "previous_credit_height": "199999",
- "previous_chain_sequence_number": "38456694"
}
], - "next_page_token": "Mzg0NTY3MTB8MDAwMDAwMDAwMDAwMDNhMjBkZWY3YTA1YTc3MzYxYjk2NTdmZjk1NGIyZjIwODBlMTM1ZWE2ZjU5NzBkYTIxNQ",
}
Returns a full blockchain block with all transactions and balance updates.
asset
required
|
string
Asset name. |
block_hash
required
|
string
Block hash. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
block_hash
required
|
string (BlockchainBlockHash)
Hash of the block. |
parent_block_hash |
string (BlockchainBlockHash)
Hash of the block. |
height
required
|
string (BlockchainBlockHeight)
Height of the block. |
consensus_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
miner_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
n_transactions
required
|
string
(BlockchainNumberOfTransactions)
Number of transactions. |
n_balance_updates
required
|
string
(BlockchainNumberOfBalanceUpdates)
Number of balance updates. |
difficulty |
string (BlockchainBlockDifficulty)
Difficulty of the block. |
physical_size |
string
(BlockchainBlockPhysicalSize)
Physical size of the block, bytes. |
consensus_size |
string
(BlockchainBlockConsensusSize)
Consensus size of the block. |
consensus_size_limit |
string
(BlockchainBlockConsensusSizeLimit)
Consensus size limit of the block. |
Array of objects
(BlockchainFullTransactions)
|
|
Array of objects
(BlockchainTransactionBalanceUpdates)
|
# Gets block data for a specific Ethereum block, specified by the hash of the block curl --compressed "https://api.xft.io/v4/blockchain/eth/blocks/0x27a2bd0fd3b3298dd8004c18aaad83374bdc5dbd36eac46bfe00772d88dba7cf?pretty=true&api_key=<your_key>"
{- "block_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
- "height": "0",
- "consensus_time": "2009-01-03T18:15:05.000000000Z",
- "miner_time": "2009-01-03T18:15:05.000000000Z",
- "n_transactions": "1",
- "n_balance_updates": "3",
- "transactions": [
- {
- "transaction_hash": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
- "consensus_time": "2009-01-03T18:15:05.000000000Z",
- "min_chain_sequence_number": "0",
- "max_chain_sequence_number": "2",
- "n_balance_updates": "3",
- "amount": "50",
- "balance_updates": [
- {
- "chain_sequence_number": "0",
- "account": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
- "account_creation_height": "0",
- "change": "50",
- "previous_balance": "0",
- "new_balance": "50",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}, - {
- "chain_sequence_number": "1",
- "account": "FEES",
- "account_creation_height": "0",
- "change": "0",
- "previous_balance": "0",
- "new_balance": "0",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}, - {
- "chain_sequence_number": "2",
- "account": "ISSUANCE",
- "account_creation_height": "0",
- "change": "-50",
- "previous_balance": "0",
- "new_balance": "-50",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}
]
}
], - "balance_updates": [ ],
- "difficulty": "1",
- "physical_size": "285",
- "consensus_size": "816",
- "consensus_size_limit": "4000000"
}
Returns a full blockchain transaction with all balance updates.
asset
required
|
string
Asset name. |
txid
required
|
string
Transaction identifier (txid). |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
transaction_hash
required
|
string (BlockchainTransactionHash)
Hash of the transaction. |
consensus_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
min_chain_sequence_number
required
|
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
max_chain_sequence_number
required
|
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
n_balance_updates
required
|
string
(BlockchainNumberOfBalanceUpdates)
Number of balance updates. |
amount
required
|
string
(BlockchainTransactionAmount)
Sum of all debits in the transaction. |
stale |
string (BlockchainStaleBlock)
This field is set to true if the corresponding block is stale. Otherwise omitted. |
block_hash
required
|
string (BlockchainBlockHash)
Hash of the block. |
height
required
|
string (BlockchainBlockHeight)
Height of the block. |
Array of objects
(BlockchainTransactionBalanceUpdates)
|
# Gets transaction data for a specific Bitcoin transaction curl --compressed "https://api.xft.io/v4/blockchain/btc/transactions/29d401526b06d55749034c10c3ee7ffd9ecab942c9b6852c963fa61103552729?pretty=true&api_key=<your_key>"
{- "transaction_hash": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
- "consensus_time": "2009-01-03T18:15:05.000000000Z",
- "min_chain_sequence_number": "0",
- "max_chain_sequence_number": "2",
- "n_balance_updates": "3",
- "amount": "50",
- "block_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
- "height": "0",
- "balance_updates": [
- {
- "chain_sequence_number": "0",
- "account": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
- "account_creation_height": "0",
- "change": "50",
- "previous_balance": "0",
- "new_balance": "50",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}, - {
- "chain_sequence_number": "1",
- "account": "FEES",
- "account_creation_height": "0",
- "change": "0",
- "previous_balance": "0",
- "new_balance": "0",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}, - {
- "chain_sequence_number": "2",
- "account": "ISSUANCE",
- "account_creation_height": "0",
- "change": "-50",
- "previous_balance": "0",
- "new_balance": "-50",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}
]
}
Returns a full blockchain transaction with all balance updates for a specific block.
asset
required
|
string
Asset name. |
block_hash
required
|
string
Block hash. |
txid
required
|
string
Transaction identifier (txid). |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
transaction_hash
required
|
string (BlockchainTransactionHash)
Hash of the transaction. |
consensus_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
min_chain_sequence_number
required
|
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
max_chain_sequence_number
required
|
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
n_balance_updates
required
|
string
(BlockchainNumberOfBalanceUpdates)
Number of balance updates. |
amount
required
|
string
(BlockchainTransactionAmount)
Sum of all debits in the transaction. |
stale |
string (BlockchainStaleBlock)
This field is set to true if the corresponding block is stale. Otherwise omitted. |
block_hash
required
|
string (BlockchainBlockHash)
Hash of the block. |
height
required
|
string (BlockchainBlockHeight)
Height of the block. |
Array of objects
(BlockchainTransactionBalanceUpdates)
|
# Gets full transaction data for a specific Bitcoin transaction in a block curl --compressed "https://api.xft.io/v4/blockchain/btc/blocks/0000000000000000000334e8637314d72d86a533c71f48da23e85e70a82cd38a/transactions/29d401526b06d55749034c10c3ee7ffd9ecab942c9b6852c963fa61103552729?pretty=true&api_key=<your_key>"
{- "transaction_hash": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b",
- "consensus_time": "2009-01-03T18:15:05.000000000Z",
- "min_chain_sequence_number": "0",
- "max_chain_sequence_number": "2",
- "n_balance_updates": "3",
- "amount": "50",
- "block_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
- "height": "0",
- "balance_updates": [
- {
- "chain_sequence_number": "0",
- "account": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
- "account_creation_height": "0",
- "change": "50",
- "previous_balance": "0",
- "new_balance": "50",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}, - {
- "chain_sequence_number": "1",
- "account": "FEES",
- "account_creation_height": "0",
- "change": "0",
- "previous_balance": "0",
- "new_balance": "0",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}, - {
- "chain_sequence_number": "2",
- "account": "ISSUANCE",
- "account_creation_height": "0",
- "change": "-50",
- "previous_balance": "0",
- "new_balance": "-50",
- "transaction_sequence_number": "0",
- "previous_n_debits": "0",
- "previous_n_credits": "0"
}
]
}
Returns a list of blockchain blocks metadata.
Results are ordered by tuple
(height, block_hash)
.
To fetch the next page of results use
next_page_url
JSON response field.
Results are limited to the last 30 days for
Community users.
asset
required
|
string
Asset name. |
block_hashes |
Array of strings
Optional comma separated list of block hashes to filter a response. |
heights |
Array of strings
Optional comma separated list of block heights to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
chain |
string
Default: "main"
Chain type. Supported values are |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (BlockchainBlockInfoV2)
|
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. |
object (WarningObject)
|
# Gets list of blocks for Litecoin curl --compressed "https://api.xft.io/v4/blockchain-v2/ltc/blocks?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "block_hash": "0000000071966c2b1d065fd446b1e485b2c9d9594acd2007ccbd5441cfc89444",
- "height": "7",
- "consensus_time": "2009-01-09T03:16:28.000000000Z",
- "miner_time": "2009-01-09T03:39:29.000000000Z",
- "n_transactions": "1",
- "n_balance_updates": "3",
- "parent_block_hash": "000000003031a0e73735690c5a1ff2a4be82553b2a12b776fbd3a215dc8f778d",
- "nonce": "39a59c86",
- "extra_data": "04ffff001d012b",
- "version": "1",
- "difficulty": "1",
- "physical_size": "215",
- "consensus_size": "860",
- "consensus_size_limit": "4000000"
}, - {
- "block_hash": "00000000408c48f847aa786c2268fc3e6ec2af68e8468a34a28c61b7f1de0dc6",
- "height": "8",
- "consensus_time": "2009-01-09T03:16:28.000000000Z",
- "miner_time": "2009-01-09T03:45:43.000000000Z",
- "n_transactions": "1",
- "n_balance_updates": "3",
- "parent_block_hash": "0000000071966c2b1d065fd446b1e485b2c9d9594acd2007ccbd5441cfc89444",
- "nonce": "1c4b5666",
- "extra_data": "04ffff001d012c",
- "version": "1",
- "difficulty": "1",
- "physical_size": "215",
- "consensus_size": "860",
- "consensus_size_limit": "4000000"
}
], - "next_page_token": "N3wwMDAwMDAwMDcxOTY2YzJiMWQwNjVmZDQ0NmIxZTQ4NWIyYzlkOTU5NGFjZDIwMDdjY2JkNTQ0MWNmYzg5NDQ0",
}
Returns a list of blockchain accounts with their balances.
Results are ordered by tuple
(creation_chain_sequence_number, account)
.
To fetch the next page of results use
next_page_url
JSON response field.
asset
required
|
string
Asset name. |
accounts |
Array of strings
Optional comma separated list of accounts to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_chain_sequence_number |
integer <int64>
>= 0
Start of the |
end_chain_sequence_number |
integer <int64>
>= 0
End of the |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
# Gets list of accounts for USDC curl --compressed "https://api.xft.io/v4/blockchain-v2/usdc/accounts?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "account": "112jmDkNGHSbhhY17JGpxU3sMA9ZExG7b2",
- "type": "UTXO",
- "balance": "0.0000583",
- "n_debits": "3",
- "n_credits": "4",
- "creation_height": "470920",
- "creation_block_hash": "0000000000000000002c7505ef2272e0677fa53d68d633f8e076ed42dd3380e6",
- "creation_time": "2017-06-12T06:50:36.000000000Z",
- "creation_chain_sequence_number": "2022585999040108",
- "last_chain_sequence_number": "2054987232324222",
- "last_debit_height": "474496",
- "last_credit_height": "478464"
}, - {
- "account": "112dtXeVfH3QgRJJwCiQe1FuRAKBqWfY3U",
- "type": "UTXO",
- "balance": "0",
- "n_debits": "6",
- "n_credits": "6",
- "creation_height": "480777",
- "creation_block_hash": "0000000000000000000e7d28b7c2a37e42278e5d34c8a64a05d227e3608feac8",
- "creation_time": "2017-08-16T12:34:59.000000000Z",
- "creation_chain_sequence_number": "2064921491679245",
- "last_chain_sequence_number": "2207213758185607",
- "last_debit_height": "513907",
- "last_credit_height": "513892"
}
], - "next_page_token": "MzA1MDYxMjE5MTE1MDIxNXxiYzFxeDlydnhzZTU2M3NsdTRuM3gzNHFkY3RzYWFxa21wbnNmN240MDM",
}
Returns a list of blockchain sub-accounts.
Results are ordered by tuple
(creation_chain_sequence_number, account)
.
To fetch the next page of results use
next_page_url
JSON response field.
asset
required
|
string
Asset name. |
accounts |
Array of strings
Optional comma separated list of accounts to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_chain_sequence_number |
integer <int64>
>= 0
Start of the |
end_chain_sequence_number |
integer <int64>
>= 0
End of the |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
|
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. |
# Gets list of sub accounts for Litecoin curl --compressed "https://api.xft.io/v4/blockchain-v2/ltc/sub-accounts?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "sub_account": "b4d1e49d6e18f3b811a79d58c1c3af234e53c8721568cc2a865cec2d6b13a2e8-0",
- "account": "12wmLv9BrJrpFF1Txeyqc1AAj1dX34k8Y8",
- "type": "UTXO",
- "creation_height": "92067",
- "creation_time": "2010-11-15T22:06:47.000000000Z",
- "creation_chain_sequence_number": "395424754041356",
- "creation_block_hash": "000000000006f9b809365a295225ec109b1e76fcb16f040bed626211ce9ce7c8",
- "balance": "1.57"
}, - {
- "sub_account": "b5cb830ba0c5ea696709121530357a2ab0154bbb95add2393f34eb662eb828df-0",
- "account": "12wmLv9BrJrpFF1Txeyqc1AAj1dX34k8Y8",
- "type": "UTXO",
- "creation_height": "92068",
- "creation_time": "2010-11-15T22:22:30.000000000Z",
- "creation_chain_sequence_number": "395429049008526",
- "creation_block_hash": "00000000000c10491f16d464f138e9ca3fd335ac97e0e7e1bae94cd1eb9b6e66",
- "balance": "3.09"
}
], - "next_page_token": "Mzk1NDI5MDQ5MDA4NTI2fDEyd21MdjlCckpycEZGMVR4ZXlxYzFBQWoxZFgzNGs4WTg",
}
Returns a list of blockchain transactions metadata.
Results are ordered by tuple
(tx_position, txid)
.
To fetch the next page of results use
next_page_url
JSON response field.
Results are limited to the last 30 days for
Community users.
asset
required
|
string
Asset name. |
txids |
Array of strings
Optional comma separated list of transaction identifiers (txid) to filter a
response. |
block_hashes |
Array of strings
Optional comma separated list of block hashes to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
chain |
string
Default: "main"
Chain type. Supported values are |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(BlockchainTransactionInfoV2)
|
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. |
object (WarningObject)
|
# Gets list of transactions for Ethereum classic curl --compressed "https://api.xft.io/v4/blockchain-v2/etc/transactions?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "block_hash": "749e49620fcbdbb474a067f6eb350bee5cf67e4d76e624e63b9680824e6b15a7",
- "height": "1720841",
- "txid": "55a25f64dc6f0d8d71b0ac733ccea1017d300da329be0790d905957e91913d50",
- "consensus_time": "2019-10-17T10:00:43.000000000Z",
- "miner_time": "2019-10-17T10:00:43.000000000Z",
- "tx_position": "7390955816615984",
- "n_balance_updates": "4",
- "amount": "0.85215625",
- "version": "2",
- "physical_size": "248",
- "consensus_size": "662",
- "fee": "0.00000232",
- "min_chain_sequence_number": "7390955816616149",
- "max_chain_sequence_number": "7390955816616152"
}, - {
- "block_hash": "749e49620fcbdbb474a067f6eb350bee5cf67e4d76e624e63b9680824e6b15a7",
- "height": "1720841",
- "txid": "468d5c24de3008250974cd0447249a1ae2e36af36d26159f0b448ef16b8329da",
- "consensus_time": "2019-10-17T10:00:43.000000000Z",
- "miner_time": "2019-10-17T10:00:43.000000000Z",
- "tx_position": "7390955816615985",
- "n_balance_updates": "4",
- "amount": "0.85175575",
- "version": "2",
- "physical_size": "248",
- "consensus_size": "662",
- "fee": "0.00000232",
- "min_chain_sequence_number": "7390955816616153",
- "max_chain_sequence_number": "7390955816616156"
}
], - "next_page_token": "MTUwNTY4NjY4NDk1ODcyfGI5NDg3YTM3MzY2OWRlMDAzNGFkM2Q2NmI5OWY1ZGZlMTRkNGIyMTBkZjQ2MTExNTFjM2Y0YjM0OTc0MTM2Y2M",
- "next_page_url": "https://api.xft.io/v4/blockchain-v2/btc/transactions?api_key=<your key>&start_height=35055&page_size=2&next_page_token=MTUwNTY4NjY4NDk1ODcyfGI5NDg3YTM3MzY2OWRlMDAzNGFkM2Q2NmI5OWY1ZGZlMTRkNGIyMTBkZjQ2MTExNTFjM2Y0YjM0OTc0MTM2Y2M"
}
Returns a list of blockchain accounts balance updates.
Results are ordered by tuple
(chain_sequence_number, block_hash)
.
To fetch the next page of results use
next_page_url
JSON response field.
Results are limited to the last 30 days for
Community users.
asset
required
|
string
Asset name. |
accounts |
Array of strings
Optional comma separated list of accounts to filter a response. |
limit_per_account |
integer <int32>
How many entries per account the result should contain. It is applicable when multiple
accounts are requested. |
sub_accounts |
Array of strings
Optional comma separated list of sub-accounts to filter a response. |
txids |
Array of strings
Optional comma separated list of transaction identifiers (txid) to filter a
response. |
block_hashes |
Array of strings
Optional comma separated list of block hashes to filter a response. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_chain_sequence_number |
integer <int64>
>= 0
Start of the |
end_chain_sequence_number |
integer <int64>
>= 0
End of the |
include_sub_accounts |
boolean
Default: false
Boolean indicating if the response should contain sub-accounts. |
chain |
string
Default: "main"
Chain type. Supported values are |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(BlockchainBalanceUpdatesV2)
|
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. |
object (WarningObject)
|
# Gets list of balance-updates for USDC curl --compressed "https://api.xft.io/v4/blockchain-v2/usdc/balance-updates?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "block_hash": "0000000000000000000439ea9434c8b20e5e30459022865a7a7fd31e4233538b",
- "height": "649240",
- "consensus_time": "2020-09-20T16:49:48.000000000Z",
- "credit": false,
- "total_received": "0.03823664",
- "total_sent": "0.03632737",
- "chain_sequence_number": "2788464567269277",
- "account": "112dvb4DogEpcp3yUR59HQuN1LFJbPErAT",
- "account_creation_height": "645045",
- "change": "-0.00195697",
- "previous_balance": "0.00386624",
- "new_balance": "0.00190927",
- "transaction_sequence_number": "0",
- "txid": "379580cd4910e3ce306ee2129fd1a29ef0a6f86e984d1e7f26c181b4cb83ba51",
- "sub_account": {
- "previous_balance": "0.00195697",
- "new_balance": "0",
- "sub_account": "d5633404739f275af7af6012f4e03e32235857751e382a420d1683582a09afb1-1161",
- "n_debits": "1",
- "n_credits": "1",
- "previous_credit_height": "648382",
- "previous_chain_sequence_number": "2784779485328037",
- "total_received": "0.00195697",
- "total_sent": "0.00195697",
- "creation_height": "648382"
}, - "n_debits": "5",
- "n_credits": "6",
- "previous_debit_height": "649240",
- "previous_credit_height": "649073",
- "previous_chain_sequence_number": "2788464567269275"
}, - {
- "block_hash": "0000000000000000000439ea9434c8b20e5e30459022865a7a7fd31e4233538b",
- "height": "649240",
- "consensus_time": "2020-09-20T16:49:48.000000000Z",
- "credit": false,
- "total_received": "0.03823664",
- "total_sent": "0.03823664",
- "chain_sequence_number": "2788464567269279",
- "account": "112dvb4DogEpcp3yUR59HQuN1LFJbPErAT",
- "account_creation_height": "645045",
- "change": "-0.00190927",
- "previous_balance": "0.00190927",
- "new_balance": "0",
- "transaction_sequence_number": "0",
- "txid": "379580cd4910e3ce306ee2129fd1a29ef0a6f86e984d1e7f26c181b4cb83ba51",
- "sub_account": {
- "previous_balance": "0.00190927",
- "new_balance": "0",
- "sub_account": "468effb920e280e966a993918acde9a37118c0daf16d5fc067b1522661e1bab9-1259",
- "n_debits": "1",
- "n_credits": "1",
- "previous_credit_height": "648906",
- "previous_chain_sequence_number": "2787030048192699",
- "total_received": "0.00190927",
- "total_sent": "0.00190927",
- "creation_height": "648906"
}, - "n_debits": "6",
- "n_credits": "6",
- "previous_debit_height": "649240",
- "previous_credit_height": "649073",
- "previous_chain_sequence_number": "2788464567269277"
}
], - "next_page_token": "Mjc4ODQ2NDU2NzI2OTI3N3wwMDAwMDAwMDAwMDAwMDAwMDAwNDM5ZWE5NDM0YzhiMjBlNWUzMDQ1OTAyMjg2NWE3YTdmZDMxZTQyMzM1Mzhi",
}
Returns a list of blockchain balance updates for a specific account.
Results are ordered by
tuple (chain_sequence_number, block_hash)
.
To fetch the next page of results use
next_page_url
JSON response field.
asset
required
|
string
Asset name. |
account
required
|
string
Account id. |
txids |
Array of strings
Optional comma separated list of transaction identifiers (txid) to filter a
response. |
block_hashes |
Array of strings
Optional comma separated list of block hashes to filter a response. |
include_counterparties |
boolean
Default: false
Include information about the counterparties balance updates. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_height |
integer <int64>
>= 0
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
>= 0
The end height indicates the ending block height for the set of data that are
returned. |
start_chain_sequence_number |
integer <int64>
>= 0
Start of the |
end_chain_sequence_number |
integer <int64>
>= 0
End of the |
include_sub_accounts |
boolean
Default: false
Boolean indicating if the response should contain sub-accounts. |
chain |
string
Default: "main"
Chain type. Supported values are |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(BlockchainBalanceUpdatesV2)
|
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. |
object (WarningObject)
|
# Gets list of balance-updates for a BTC account curl --compressed "https://api.xft.io/v4/blockchain-v2/btc/accounts/112jmDkNGHSbhhY17JGpxU3sMA9ZExG7b2/balance-updates?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "block_hash": "0000000000000000000439ea9434c8b20e5e30459022865a7a7fd31e4233538b",
- "height": "649240",
- "consensus_time": "2020-09-20T16:49:48.000000000Z",
- "credit": false,
- "total_received": "0.03823664",
- "total_sent": "0.03632737",
- "chain_sequence_number": "2788464567269277",
- "account": "112dvb4DogEpcp3yUR59HQuN1LFJbPErAT",
- "account_creation_height": "645045",
- "change": "-0.00195697",
- "previous_balance": "0.00386624",
- "new_balance": "0.00190927",
- "transaction_sequence_number": "0",
- "txid": "379580cd4910e3ce306ee2129fd1a29ef0a6f86e984d1e7f26c181b4cb83ba51",
- "sub_account": {
- "previous_balance": "0.00195697",
- "new_balance": "0",
- "sub_account": "d5633404739f275af7af6012f4e03e32235857751e382a420d1683582a09afb1-1161",
- "n_debits": "1",
- "n_credits": "1",
- "previous_credit_height": "648382",
- "previous_chain_sequence_number": "2784779485328037",
- "total_received": "0.00195697",
- "total_sent": "0.00195697",
- "creation_height": "648382"
}, - "n_debits": "5",
- "n_credits": "6",
- "previous_debit_height": "649240",
- "previous_credit_height": "649073",
- "previous_chain_sequence_number": "2788464567269275"
}, - {
- "block_hash": "0000000000000000000439ea9434c8b20e5e30459022865a7a7fd31e4233538b",
- "height": "649240",
- "consensus_time": "2020-09-20T16:49:48.000000000Z",
- "credit": false,
- "total_received": "0.03823664",
- "total_sent": "0.03823664",
- "chain_sequence_number": "2788464567269279",
- "account": "112dvb4DogEpcp3yUR59HQuN1LFJbPErAT",
- "account_creation_height": "645045",
- "change": "-0.00190927",
- "previous_balance": "0.00190927",
- "new_balance": "0",
- "transaction_sequence_number": "0",
- "txid": "379580cd4910e3ce306ee2129fd1a29ef0a6f86e984d1e7f26c181b4cb83ba51",
- "sub_account": {
- "previous_balance": "0.00190927",
- "new_balance": "0",
- "sub_account": "468effb920e280e966a993918acde9a37118c0daf16d5fc067b1522661e1bab9-1259",
- "n_debits": "1",
- "n_credits": "1",
- "previous_credit_height": "648906",
- "previous_chain_sequence_number": "2787030048192699",
- "total_received": "0.00190927",
- "total_sent": "0.00190927",
- "creation_height": "648906"
}, - "n_debits": "6",
- "n_credits": "6",
- "previous_debit_height": "649240",
- "previous_credit_height": "649073",
- "previous_chain_sequence_number": "2788464567269277"
}
], - "next_page_token": "Mjc4ODQ2NDU2NzI2OTI3N3wwMDAwMDAwMDAwMDAwMDAwMDAwNDM5ZWE5NDM0YzhiMjBlNWUzMDQ1OTAyMjg2NWE3YTdmZDMxZTQyMzM1Mzhi",
}
Returns a full blockchain block with all transactions and balance updates.
Results are
limited to the last 30 days for Community users.
asset
required
|
string
Asset name. |
block_hash
required
|
string
Block hash. |
include_sub_accounts |
boolean
Default: false
Boolean indicating if the response should contain sub-accounts. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
block_hash
required
|
string (BlockchainBlockHash)
Hash of the block. |
parent_block_hash |
string (BlockchainBlockHash)
Hash of the block. |
height
required
|
string (BlockchainBlockHeight)
Height of the block. |
consensus_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
miner_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
nonce |
string (BlockchainBlockNonce)
Nonce of the block, hex-encoded. |
extra_data |
string (BlockchainBlockExtraData)
Extra data of the block, hex-encoded. |
n_transactions
required
|
string
(BlockchainNumberOfTransactions)
Number of transactions. |
n_balance_updates
required
|
string
(BlockchainNumberOfBalanceUpdates)
Number of balance updates. |
version |
string (BlockchainBlockVersion)
Version of the block. |
difficulty |
string (BlockchainBlockDifficulty)
Difficulty of the block. |
physical_size |
string
(BlockchainBlockPhysicalSize)
Physical size of the block, bytes. |
consensus_size |
string
(BlockchainBlockConsensusSize)
Consensus size of the block. |
consensus_size_limit |
string
(BlockchainBlockConsensusSizeLimit)
Consensus size limit of the block. |
stale |
string (BlockchainStaleBlock)
This field is set to true if the corresponding block is stale. Otherwise omitted. |
Array of objects
(BlockchainFullTransactionsV2)
|
|
Array of objects
(BlockchainTransactionBalanceUpdatesV2)
|
# Gets block data for a specific Litecoin block, specified by the hash of the block curl --compressed "https://api.xft.io/v4/blockchain-v2/ltc/blocks/885f0ba526e9a683f64c8fdb83c5e8cbc0d6e74fb93f2351941ee409a924b7a8?pretty=true&api_key=<your_key>"
{- "block_hash": "0000000000000000000079fca9c54dd7532d139ed258f02e3d1368e7006157d9",
- "height": "758506",
- "consensus_time": "2022-10-13T18:27:09.000000000Z",
- "miner_time": "2022-10-13T18:57:56.000000000Z",
- "n_transactions": "469",
- "n_balance_updates": "7425",
- "transactions": [
- {
- "txid": "232687100669217c7335d2b2b6f5e7ae61cc6d4c79b8b1b1c7a1fa21938422b9",
- "consensus_time": "2022-10-13T18:27:09.000000000Z",
- "tx_position": "3257758463819776",
- "n_balance_updates": "4",
- "amount": "6.34186444",
- "balance_updates": [
- {
- "chain_sequence_number": "3257758463819776",
- "account": "FEES",
- "account_creation_height": "0",
- "change": "-0.09186444",
- "previous_balance": "0",
- "new_balance": "-0.09186444",
- "transaction_sequence_number": "0",
- "n_debits": "758507",
- "n_credits": "771183299",
- "previous_debit_height": "758505",
- "previous_credit_height": "758505",
- "previous_chain_sequence_number": "3257754168874991"
}, - {
- "chain_sequence_number": "3257758463819777",
- "account": "ISSUANCE",
- "account_creation_height": "0",
- "change": "-6.25",
- "previous_balance": "-19178133.54497096",
- "new_balance": "-19178139.79497096",
- "transaction_sequence_number": "0",
- "n_debits": "758507",
- "n_credits": "0",
- "previous_debit_height": "758505",
- "previous_chain_sequence_number": "3257754168852481"
}
], - "min_chain_sequence_number": "3257758463819776",
- "max_chain_sequence_number": "3257758463819779"
}
], - "balance_updates": [ ],
- "parent_block_hash": "000000000000000000079a2d36f1308ea00fd26fda92fe12c5dd4e1a5b0c15e7",
- "difficulty": "35610794164371.65",
- "physical_size": "1075674",
- "consensus_size": "3993099",
- "consensus_size_limit": "4000000"
}
Returns a full blockchain transaction with all balance updates.
Results are limited to the
last 30 days for Community users.
asset
required
|
string
Asset name. |
txid
required
|
string
Transaction identifier (txid). |
include_sub_accounts |
boolean
Default: false
Boolean indicating if the response should contain sub-accounts. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
txid
required
|
string (BlockchainTransactionId)
Identifier (txid) of the transaction. |
consensus_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
miner_time |
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
tx_position
required
|
string
(BlockchainTransactionPosition)
Transaction position. |
min_chain_sequence_number |
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
max_chain_sequence_number |
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
n_balance_updates
required
|
string
(BlockchainNumberOfBalanceUpdates)
Number of balance updates. |
amount
required
|
string
(BlockchainTransactionAmount)
Sum of all debits in the transaction. |
stale |
string
This field is set to true if the corresponding block is stale. Otherwise omitted. |
block_hash
required
|
string (BlockchainBlockHash)
Hash of the block. |
height
required
|
string (BlockchainBlockHeight)
Height of the block. |
version |
string
(BlockchainTransactionVersion)
Version of the transaction. |
physical_size |
string
(BlockchainTransactionPhysicalSize)
Physical size of the transaction, bytes. |
consensus_size |
string
(BlockchainTransactionConsensusSize)
Consensus size of the transaction. |
fee |
string (BlockchainTransactionFee)
Fee of the transaction. |
Array of objects
(BlockchainTransactionBalanceUpdatesV2)
|
# Gets block data for a specific Litecoin transaction, specified by the hash of the block curl --compressed "https://api.xft.io/v4/blockchain-v2/ltc/transactions/3345cbbcc53b8a0113951b69f98a72a84b5a094af84842b46ed931c242c09597?pretty=true&api_key=<your_key>"
{- "txid": "16262dacdac04f41b50dd4174d3bd0d133916a325e5244b3febcb760a8d3975f",
- "consensus_time": "2022-10-14T04:17:24.000000000Z",
- "miner_time": "2022-10-14T04:17:24.000000000Z",
- "tx_position": "10095861795127296",
- "n_balance_updates": "4",
- "amount": "12.5480776",
- "block_hash": "b5f4f41003c656a8cf7deaa8555e3240bfd24244672397b3c544bd8bd9bed036",
- "height": "2350626",
- "min_chain_sequence_number": "10095861795127296",
- "max_chain_sequence_number": "10095861795127299",
- "balance_updates": [
- {
- "chain_sequence_number": "10095861795127296",
- "account": "FEES",
- "account_creation_height": "0",
- "change": "-0.0480776",
- "previous_balance": "0",
- "new_balance": "-0.0480776",
- "transaction_sequence_number": "0",
- "n_debits": "2350627",
- "n_credits": "128653555",
- "previous_debit_height": "2350625",
- "previous_credit_height": "2350625",
- "previous_chain_sequence_number": "10095857500165790"
}, - {
- "chain_sequence_number": "10095861795127297",
- "account": "ISSUANCE",
- "account_creation_height": "0",
- "change": "-12.5",
- "previous_balance": "-71380870.73347135",
- "new_balance": "-71380883.23347135",
- "transaction_sequence_number": "0",
- "n_debits": "2350627",
- "n_credits": "0",
- "previous_debit_height": "2350625",
- "previous_chain_sequence_number": "10095857500160001"
}, - {
- "chain_sequence_number": "10095861795127299",
- "account": "LaYPLuQEanVCYM9TztR9FuT3ZbTJM6wHEZ",
- "account_creation_height": "1785846",
- "change": "12.5480776",
- "previous_balance": "588.96230971",
- "new_balance": "601.51038731",
- "transaction_sequence_number": "0",
- "n_debits": "10123",
- "n_credits": "10171",
- "previous_debit_height": "2348134",
- "previous_credit_height": "2350581",
- "previous_chain_sequence_number": "10095668521598979"
}
]
}
Returns a full blockchain transaction with all balance updates for a specific block.
Results
are limited to the last 30 days for Community users.
asset
required
|
string
Asset name. |
block_hash
required
|
string
Block hash. |
txid
required
|
string
Transaction identifier (txid). |
include_sub_accounts |
boolean
Default: false
Boolean indicating if the response should contain sub-accounts. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
txid
required
|
string (BlockchainTransactionId)
Identifier (txid) of the transaction. |
consensus_time
required
|
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
miner_time |
string (Time)
The time in ISO 8601 date-time format. Always with nanoseconds precision. |
tx_position
required
|
string
(BlockchainTransactionPosition)
Transaction position. |
min_chain_sequence_number |
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
max_chain_sequence_number |
string
(BlockchainChainSequenceNumber)
Chain sequence number. |
n_balance_updates
required
|
string
(BlockchainNumberOfBalanceUpdates)
Number of balance updates. |
amount
required
|
string
(BlockchainTransactionAmount)
Sum of all debits in the transaction. |
stale |
string
This field is set to true if the corresponding block is stale. Otherwise omitted. |
block_hash
required
|
string (BlockchainBlockHash)
Hash of the block. |
height
required
|
string (BlockchainBlockHeight)
Height of the block. |
version |
string
(BlockchainTransactionVersion)
Version of the transaction. |
physical_size |
string
(BlockchainTransactionPhysicalSize)
Physical size of the transaction, bytes. |
consensus_size |
string
(BlockchainTransactionConsensusSize)
Consensus size of the transaction. |
fee |
string (BlockchainTransactionFee)
Fee of the transaction. |
Array of objects
(BlockchainTransactionBalanceUpdatesV2)
|
# Gets block data and balance updates for a specific Litecoin block, specified by the hash of the block curl --compressed "https://api.xft.io/v4/blockchain-v2/ltc/blocks/885f0ba526e9a683f64c8fdb83c5e8cbc0d6e74fb93f2351941ee409a924b7a8/transactions/3345cbbcc53b8a0113951b69f98a72a84b5a094af84842b46ed931c242c09597?pretty=true&api_key=<your_key>"
{- "txid": "16262dacdac04f41b50dd4174d3bd0d133916a325e5244b3febcb760a8d3975f",
- "consensus_time": "2022-10-14T04:17:24.000000000Z",
- "miner_time": "2022-10-14T04:17:24.000000000Z",
- "tx_position": "10095861795127296",
- "n_balance_updates": "4",
- "amount": "12.5480776",
- "block_hash": "b5f4f41003c656a8cf7deaa8555e3240bfd24244672397b3c544bd8bd9bed036",
- "height": "2350626",
- "min_chain_sequence_number": "10095861795127296",
- "max_chain_sequence_number": "10095861795127299",
- "balance_updates": [
- {
- "chain_sequence_number": "10095861795127296",
- "account": "FEES",
- "account_creation_height": "0",
- "change": "-0.0480776",
- "previous_balance": "0",
- "new_balance": "-0.0480776",
- "transaction_sequence_number": "0",
- "n_debits": "2350627",
- "n_credits": "128653555",
- "previous_debit_height": "2350625",
- "previous_credit_height": "2350625",
- "previous_chain_sequence_number": "10095857500165790"
}, - {
- "chain_sequence_number": "10095861795127297",
- "account": "ISSUANCE",
- "account_creation_height": "0",
- "change": "-12.5",
- "previous_balance": "-71380870.73347135",
- "new_balance": "-71380883.23347135",
- "transaction_sequence_number": "0",
- "n_debits": "2350627",
- "n_credits": "0",
- "previous_debit_height": "2350625",
- "previous_chain_sequence_number": "10095857500160001"
}, - {
- "chain_sequence_number": "10095861795127299",
- "account": "LaYPLuQEanVCYM9TztR9FuT3ZbTJM6wHEZ",
- "account_creation_height": "1785846",
- "change": "12.5480776",
- "previous_balance": "588.96230971",
- "new_balance": "601.51038731",
- "transaction_sequence_number": "0",
- "n_debits": "10123",
- "n_credits": "10171",
- "previous_debit_height": "2348134",
- "previous_credit_height": "2350581",
- "previous_chain_sequence_number": "10095668521598979"
}
]
}
Creates asynchronous job for retrieving account balances data.
Use the /jobs endpoint to poll job's status.
assets
required
|
Array of strings (AssetsIds)
List of asset names. |
accounts
required
|
Array of strings (BlockchainAccounts)
Account ids. |
at_time
required
|
string (BlockchainJobAtTime)
Multiple formats of ISO 8601 are supported: |
job_id
required
|
string
Job ID. |
job_url
required
|
string
Job URL. |
curl -X PUT --compressed "https://api.xft.io/v4/blockchain-job/account-balances?api_key=<your_key>" \ --header "Content-Type: application/x-www-form-urlencoded" \ --data-urlencode "assets=sol" \ --data-urlencode "accounts=account1,account2" \ --data-urlencode "at_time=2024-07-04T00:00:00.000000000Z"
{- "job_id": "ZjRjZDE2N2EtYzljYy00MjQ5LTk4ZWYtOTlkZDljZTE1ZDU3OjgzNTZkODQyLTA5ODMtNGM2NC1hMGE5LWY5MzBhZTMxODFiZg",
}
Creates asynchronous job for retrieving balance updates data. Both start_*
and
end_*
parameters must be specified (time or height).
Use the /jobs endpoint to poll job's status.
assets
required
|
Array of strings (AssetsIds)
List of asset names. |
accounts
required
|
Array of strings (BlockchainAccounts)
Account ids. |
start_time |
string (BlockchainJobStartTime)
Start of the time interval. |
end_time |
string (BlockchainJobEndTime)
End of the time interval. |
start_height |
integer <int64>
(BlockchainJobStartHeight)
The start height indicates the beginning block height for the set of data that are
returned. |
end_height |
integer <int64>
(BlockchainJobEndHeight)
The end height indicates the ending block height for the set of data that are
returned. |
job_id
required
|
string
Job ID. |
job_url
required
|
string
Job URL. |
curl -X PUT --compressed "https://api.xft.io/v4/blockchain-job/balance-updates?api_key=<your_key>" \ --header "Content-Type: application/x-www-form-urlencoded" \ --data-urlencode "assets=sol" \ --data-urlencode "accounts=account1,account2" \ --data-urlencode "start_time=2023-07-04T00:00:00.000000000Z" \ --data-urlencode "end_time=2024-07-04T00:00:00.000000000Z"
{- "job_id": "ZjRjZDE2N2EtYzljYy00MjQ5LTk4ZWYtOTlkZDljZTE1ZDU3OjgzNTZkODQyLTA5ODMtNGM2NC1hMGE5LWY5MzBhZTMxODFiZg",
}
Creates asynchronous job for retrieving transactions data.
Use the /jobs endpoint to poll job's status.
assets
required
|
Array of strings (AssetsIds)
List of asset names. |
txids
required
|
Array of strings (BlockchainTransactionIds)
Transactions ids. |
job_id
required
|
string
Job ID. |
job_url
required
|
string
Job URL. |
curl -X PUT --compressed "https://api.xft.io/v4/blockchain-job/transactions?api_key=<your_key>" \ --header "Content-Type: application/x-www-form-urlencoded" \ --data-urlencode "assets=sol" \ --data-urlencode "txids=txid1,txid2"
{- "job_id": "ZjRjZDE2N2EtYzljYy00MjQ5LTk4ZWYtOTlkZDljZTE1ZDU3OjgzNTZkODQyLTA5ODMtNGM2NC1hMGE5LWY5MzBhZTMxODFiZg",
}
Returns status updates for the specified or all transactions.
This endpoint can be helpful to
track transaction settlement.
The transaction tracker keeps the history of the transaction
updates for one month since the last update.
asset
required
|
string
Asset name. |
txids |
Array of strings
Comma separated list of transaction identifiers (txid) to track. |
replacements_for_txids |
Array of strings
BTC asset only. |
replacements_only |
boolean
BTC asset only. |
addresses |
Array of strings
BTC asset only. |
unconfirmed_only |
boolean
BTC asset only. |
start_time |
string
Start of the time interval. |
end_time |
string
End of the time interval. |
start_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
end_inclusive |
boolean
Default: true
Inclusive or exclusive corresponding |
timezone |
string
Default: "UTC"
Example: timezone=America/New_York
Timezone name for |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (TxTrackerTransactions)
|
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. |
# Gets data on the status of the most recent bitcoin transactions curl --compressed "https://api.xft.io/v4/blockchain/btc/transaction-tracker?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "txid": "04b743bc2451c2a8c9fb3bb946de4eb1305a4c0c51fd7a02ee5975fb4cecf4da",
- "time": "2021-06-08T11:48:21.000000000Z",
- "first_seen_time": "2021-06-08T10:41:55.396000000Z",
- "status": "CONFIRMED",
- "status_update_time": "2021-06-08T10:44:38.224000000Z",
- "status_updates": [
- {
- "time": "2021-06-08T10:41:57.421000000Z",
- "status": "UNCONFIRMED"
}, - {
- "time": "2021-06-08T10:44:38.224000000Z",
- "status": "CONFIRMED",
- "block_hash": "000000000000000000003eee54fd5f1ae769400e66b3cd9475b5fd6255de1834",
- "height": "686786"
}
], - "details": {
- "version": "1",
- "amount": "0.10302613",
- "replace_by_fee_supported": false,
- "fee": "0.0009",
- "feerate": "473.6842",
- "mempool_feerate_mean_at_first_seen_time": "25.5569",
- "mempool_feerate_min_at_first_seen_time": "1",
- "consensus_size": "760",
- "physical_size": "380"
}, - "block_hash": "000000000000000000003eee54fd5f1ae769400e66b3cd9475b5fd6255de1834",
- "height": "686786",
- "n_confirmations": "1"
}
], - "inputs": [
- {
- "address": "112dvb4DogEpcp3yUR59HQuN1LFJbPErAT"
}, - {
- "address": "112duuEvfsJDVsuVn7Xe27bpxtq5mnuvtX"
}
], - "outputs": [
- {
- "address": "112jmDkNGHSbhhY17JGpxU3sMA9ZExG7b2"
}, - {
- "address": "112dtXeVfH3QgRJJwCiQe1FuRAKBqWfY3U"
}
], - "next_page_token": "MjAyMS0wNi0wOFQxMDo0MTo1NS4zOTZafEJMZER2Q1JSd3FqSi16dTVSdDVPc1RCYVRBeFJfWG9DN2xsMS0wenM5Tm8",
}
Returns all the assets and their metadata in security master.
assets |
Array of strings
Comma-separated list of assets to query. Mutually exclusive with |
codes |
Array of strings
Comma-separated list of ten-digit alphanumeric identifying codes. Mutually exclusive
with |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (SecurityMasterAssets)
|
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. |
# Gets a metadata for btc and eth assets curl --compressed "https://api.xft.io/v4/security-master/assets?assets=btc,eth&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "asset": "audio",
- "code": "CB568F357F",
- "decimals": "18",
- "creation_date": "2020-10-22",
- "type": "erc20",
- "parent_asset": "eth",
- "erc20_token_contract": "18aaa7115705e8be94bffebde57af9bfc265b998"
}, - {
- "asset": "badger",
- "code": "C9E3139EE9",
- "decimals": "18",
- "creation_date": "2020-11-28",
- "type": "erc20",
- "parent_asset": "eth",
- "erc20_token_contract": "3472a5a71965499acd81997a54bba8d852c6e53d"
}
], - "next_page_token": "Mg",
}
Returns metadata on all the markets offered (spot, options, futures), sorted alphabetically by market.
type |
string
Enum: "spot" "future" "option"
Type of markets. |
markets |
Array of strings
List of markets. |
symbol |
string
Symbol of derivative markets, full instrument name. |
exchange |
string
Unique name of an exchange. |
base |
string
Base asset of markets. |
quote |
string
Quote asset of markets. |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "start"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (SecurityMasterMarkets)
|
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. |
# Gets a list of spot markets curl --compressed "https://api.xft.io/v4/security-master/markets?type=spot&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "market": "binance-1000FLOKIUSDT-future",
- "exchange": "binance",
- "type": "future",
- "code": "C7101DFDBB",
- "pair": "floki-usdt",
- "base": "floki",
- "quote": "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",
- "price_open": "0.02221",
- "price_close": "0.02229",
- "price_high": "0.0229",
- "price_low": "0.02209",
- "vwap": "0.02241939522043145",
- "volume": "469491373",
- "candle_usd_volume": "10527753.918885918819449634",
- "candle_trades_count": "58244"
}, - {
- "market": "binance-1000LUNCBUSD-future",
- "exchange": "binance",
- "type": "future",
- "code": "C314D2136A",
- "pair": "luna-busd",
- "base": "luna",
- "quote": "busd",
- "symbol": "1000LUNCBUSD",
- "size_asset": "luna",
- "margin_asset": "busd",
- "contract_size": "1000",
- "tick_size": "0.00001",
- "listing": "2022-05-30T07:00:00.000000000Z",
- "order_amount_increment": "1",
- "order_amount_min": "1",
- "order_amount_max": "10000000",
- "order_price_increment": "0.0000100",
- "order_price_min": "0.0001000",
- "order_price_max": "200",
- "order_size_min": "5.0",
- "price_open": "0.09374",
- "price_close": "0.09329",
- "price_high": "0.09499",
- "price_low": "0.09151",
- "vwap": "0.09285032139768002",
- "volume": "121883176",
- "candle_usd_volume": "11325203.70835771043391917",
- "candle_trades_count": "49781"
}
], - "next_page_token": "0.MTUwMjYyMzI",
}
Returns snapshots of asset metric constituents.
Results are sorted by tuple (time
,
constituent_name
), where constituent_name
depends on a target metric.
E.g., the volume_trusted_spot_usd_1d
metric constituents are exchanges,
i.e. the output will be sorted by (time
, exchange
).
metric
required
|
string
Target metric name. |
at_time |
string
Returns constituents at a specified date. |
end_time |
string
Start of the time interval, inclusive. |
start_time |
string
End of the time interval, inclusive. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
|
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. |
# Gets snapshots of asset metric constituents curl --compressed "https://api.xft.io/v4/constituent-snapshots/asset-metrics?metric=volume_trusted_spot_usd_1d&api_key=<your_key>"
{- "data": [
- {
- "time": "2023-09-01T00:00:00.000000000Z",
- "exchange": "coinbase"
}, - {
- "time": "2023-09-01T00:00:00.000000000Z",
- "exchange": "binance"
}, - {
- "time": "2023-09-01T00:00:00.000000000Z",
- "exchange": "binance.us"
}
], - "next_page_token": "0.MjAxNy0wNS0yMlQwMDowMDowMFo",
}
Returns timeframes of asset metric constituents.
Results are sorted by tuple
(start_time
, constituent_name
), where constituent depends on a target
metric.
E.g., the volume_trusted_spot_usd_1d
metric constituents are exchanges,
i.e. the output will be sorted by (start_time
, exchange
).
metric
required
|
string
Target metric name. |
constituents |
Array of strings
Comma separated list of constituents. By default all constituents are returned.
Different asset metrics may have different constituents.
For example, constituents for |
end_time |
string
Start of the time interval, inclusive. |
start_time |
string
End of the time interval, inclusive. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
paging_from |
string
Default: "end"
Enum: "start" "end"
Where does the first page start, at the start of the interval or at the end. |
format |
string
Default: "json"
Enum: "json" "csv"
Format of the response. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects
|
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. |
# Gets timeframes of asset metric constituents curl --compressed "https://api.xft.io/v4/constituent-timeframes/asset-metrics?metric=volume_trusted_spot_usd_1d&api_key=<your_key>"
{- "data": [
- {
- "exchange": "gemini",
- "start_time": "2023-10-12T00:00:00.000000000Z",
- "end_time": null
}, - {
- "exchange": "kraken",
- "start_time": "2023-10-12T00:00:00.000000000Z",
- "end_time": null
}, - {
- "exchange": "binance",
- "start_time": "2023-04-01T00:00:00.000000000Z",
- "end_time": "2023-10-12T00:00:00.000000000Z"
}, - {
- "exchange": "binance.us",
- "start_time": "2023-04-01T00:00:00.000000000Z",
- "end_time": "2023-10-12T00:00:00.000000000Z"
}, - {
- "exchange": "bitstamp",
- "start_time": "2023-04-01T00:00:00.000000000Z",
- "end_time": "2023-10-12T00:00:00.000000000Z"
}
], - "next_page_token": "0.MjAxNy0wNS0yMlQwMDowMDowMFo",
}
Returns a list of all available tags along with their descriptions.
type |
string
The type of a tag. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects (BlockchainMetadataTagInfo)
|
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. |
curl --compressed "https://api.xft.io/v4/blockchain-metadata/tags?pretty=true&api_key=<your_key>"
{- "data": [
- {
- "tag": "ADDRESS_IS_COLD_WALLET",
- "type": "ENTITY",
- "description": "Tag the ADDRESS as COLD wallet."
}, - {
- "tag": "ADDRESS_IS_EXCHANGE",
- "type": "ENTITY",
- "description": "Tag the ADDRESS as EXCHANGE."
}
]
}
Returns a list of all entities associated with provided tags.
tags |
Array of strings
Comma separated list of tags. Mutually exclusive with |
entities |
Array of strings
Comma separated list of entities. Mutually exclusive with |
locations |
Array of strings
Comma separated list of entity locations (asset representation where the entity has been tagged). Currently a single entity location is allowed per each request. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
page_size |
integer <int32>
[ 1 .. 10000
]
Default: 100
Number of items per single page of results. |
next_page_token |
string
Token for receiving the results from the next page of a query. |
required
|
Array of objects
(BlockchainMetadataTaggedEntity)
|
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. |
curl --compressed "https://api.xft.io/v4/blockchain-metadata/tagged-entities?tags=ADDRESS_IS_CONTRACT,ADDRESS_IS_SWAPPER&pretty=true&api_key=<your_key>"
{- "data": [
- {
- "entity": "00000000000003441d59dde9a90bffb1cd3fabf1",
- "tag": "ADDRESS_IS_CONTRACT",
- "location": "eth",
- "type": "ADDRESS",
- "tagger_type": "COINMETRICS",
- "tagger_method": "DETERMINISTIC",
- "start_time": "2021-04-24T09:23:53.000000000Z",
- "start_block_height": "12302098",
- "start_block_hash": "3f18d476b03fca40a128b3a715f2f6da1056cf4dcc9ec24500f7a53acee4733b"
}, - {
- "entity": "00000000000006b2ab6decbc6fc7ec6bd2fbc720",
- "tag": "ADDRESS_IS_CONTRACT",
- "location": "eth",
- "type": "ADDRESS",
- "tagger_type": "COINMETRICS",
- "tagger_method": "DETERMINISTIC",
- "start_time": "2023-10-12T21:50:47.000000000Z",
- "start_block_height": "18337128",
- "start_block_hash": "5184d01e7ba0c8769553342bdf66b4a5aabb096ad4f5c754429733613a155ae5"
}
], - "next_page_token": "0.MjAyMC0wNi0wOFQyMTowM",
}
Returns job details by job ID. If job is not found empty result is returned.
ids
required
|
string
Job identifier. |
pretty |
boolean
Default: false
Human-readable formatting of JSON responses. |
required
|
Array of objects (JobsDetails)
|
# Gets job details by ID curl --compressed "https://api.xft.io/v4/jobs?ids=ZjRjZDE2N2EtYzljYy00MjQ5LTk4ZWYtOTlkZDljZTE1ZDU3OjgzNTZkODQyLTA5ODMtNGM2NC1hMGE5LWY5MzBhZTMxODFiZg&api_key=<your_key>"
{- "data": [
- {
- "id": "ZjRjZDE2N2EtYzljYy00MjQ5LTk4ZWYtOTlkZDljZTE1ZDU3OjgzNTZkODQyLTA5ODMtNGM2NC1hMGE5LWY5MzBhZTMxODFiZg",
- "status": "completed",
- "results": [
], - "creation_time": "2023-01-04T00:00:00.000000000Z",
- "completion_time": "2023-01-05T00:00:00.000000000Z",
- "expiration_time": "2023-01-06T00:00:00.000000000Z"
}
]
}