API Documentation


Example Queries

Find assets filtered by asset type
Assets can be filtered by their asset type. The asset type is an Enum that indicates if an asset represents a coin, token, fiat currency, etc. To find a list of assets which belong to Index, ETF or Fiat types use the following query.
Try me!
Find assets filtered by current supply
Assets can be filtered by their current supply. To find a list of assets which have a supply greater than 1,000,000 use the following example.
Try me!
Find assets filtered by market cap
Assets can be filtered by their market cap in USD. To find a list of assets which have a market cap greater than 1,000,000 USD use the following example.
Try me!
Find assets filtered by market cap rank
Assets can be filtered by their market cap rank. Use the following example to find the list of top 10 assets with the lowest market cap rank (meaning the highest value since rank 1 is worth the most) sorted by their market cap.
Try me!
Find assets filtered by name
To find many assets by their name, we can use the assetName filter option. To filter assets with the suffix of "coin", use the following example. (The percent character (%) is a wildcard)
Try me!
Find assets filtered by symbol
To find a list of assets by their symbol use the following example
Try me!
Find assets filtered by total supply
Assets can be filtered by their total supply, that is, the maximum number of units of an asset that will ever be available. To find a list of assets which have a total supply greater than 1,000,000 use the following example.
Try me!
Find assets using complex filter "and"
Assets can be filtered with complex, nested queries. The "_and" operator returns only assets that match all of the filters inside of the _and array. For example, to find a list of assets which have the string "coin" in the name AND have a market cap greater than 1,000,000 USD, use the following query.
Try me!
Find assets using complex filter "or"
Assets can be filtered with complex, nested queries. The "_or" operator returns assets that match any of the filters inside of the _or array. For example, to write a query that acts as a simple asset name or symbol search we could use the following query
Try me!
Find exchange by country
How to find exchanges by country
Try me!
Find exchange by exchange name
How to find exchanges by their exchange symbol
Try me!
Find exchange by exchange symbol
How to find exchanges by their exchange symbol
Try me!
Find exchange by funding deposit type
How to find exchanges by their funding deposit type.
Try me!
Find exchange by funding withdrawal type
How to find exchanges by their funding withdrawal type.
Try me!
Find exchange by spot fee discount type
How to find exchanges by how they offer discounts on spot trading
Try me!
Find exchange by spot fee type
How to find exchanges by how they chart for spot fee trading
Try me!
Find market by base symbol
To filter a market by base symbol, use the following example.
Try me!
Find market by exchange
To filter a market by it's exchange, use the following example.
Try me!
Find market by market open timestamp
Markets can be filtered by the unix timestamp at which they were opened. The timestamp is an integer and can use the standard integer filters such as _lt, _gt, and _eq.
Try me!
Find market by market symbol
To filter a market by it's symbol, use the following example.
Try me!
Find market by market type
To filter a market by it's type, use the following example.
Try me!
Find market by quote symbol
To filter a market by base symbol, use the following example.
Try me!
Find market by symbol
Find a single market by it's symbol. Market symbol is in the form of "Exchange:BASE/QUOTE" and will only return spot markets.
Try me!
Find market with base asset filtering
Markets can be filtered by their base assets. Any asset filter can be used. The baseAsset filter has an implicit _and so you can include several filters easily at once.
Try me!
Find market with quote asset filtering
Markets can be filtered by their quote assets. Any asset filter can be used. The quoteAsset filter has an implicit _and so you can include several filters easily at once.
Try me!
Find markets by their complete market symbols
Markets can be found using a complete market symbol. Market symbol is in the form of "Exchange:BASE/QUOTE" and will only return spot markets.
Try me!
Find markets by their partial symbol (no base asset)
Markets can be found using a partial market symbol. Market symbol is in the form of "Exchange:BASE/QUOTE" and will only return spot markets. If the base asset is replaced with a wildcard, all markets that match the exchange and quote will be returned.
Try me!
Find markets by their partial symbol (no exchange or base asset)
Markets can be found using a partial market symbol. Market symbol is in the form of "Exchange:BASE/QUOTE" and will only return spot markets. If the exchange and base asset are replaced with a wildcard, all markets that match the quote asset will be returned.
Try me!
Find markets by their partial symbol (no exchange or quote asset)
Markets can be found using a partial market symbol. Market symbol is in the form of "Exchange:BASE/QUOTE" and will only return spot markets. If the exchange and quote asset are replaced with a wildcard, all markets that match the base asset will be returned.
Try me!
Find markets by their partial symbol (no quote asset)
Markets can be found using a partial market symbol. Market symbol is in the form of "Exchange:BASE/QUOTE" and will only return spot markets. If the quote asset is replaced with a wildcard, all markets that match the exchange and base will be returned.
Try me!
Find markets by their partial symbol (no quote or base asset)
Markets can be found using a partial market symbol. Market symbol is in the form of "Exchange:BASE/QUOTE" and will only return spot markets. If the quote and base asset are replaced with a wildcard, all markets that match the exchange will be returned.
Try me!
Find single asset
Find information for a single asset. An asset can be found using it's assetSymbol.
Try me!
Limit
Limit the number of total timeseries items returned with the limit argument. The following example will return 5 minutes worth of information.
Try me!
Paging
It may be useful at times to limit the number of exchanges being requested in a single query (eg: pagination). Use a page filter to limit and skip a number of exchanges.
Try me!
Paging assets
It may be useful at times to limit the number of assets being requested in a single query (eg: pagination). Use a page filter to limit and skip a number of assets.
Try me!
Resolution
Timeseries items represent a period of time. Thus a resolution of how much time each timeseries item contains data for must be provided. To return blocks where each period represents a single minute we can pass a resolution of _1m.
Try me!
Return an exchanges country
To return an exchanges country, use the following example
Try me!
Return an exchanges funding information
Blocktap has information on exchange's funding scheme. How they charge for deposits, withdrawals, spot fees, and spot fee discount type.
Try me!
Return an exchanges market count
To return the number of markets in an exchange, use the following example
Try me!
Return an exchanges markets
Markets can be accessed by exchange. Any standard market information and filtering, sorting, and paging can be used.
Try me!
Return an exchanges symbol and name
To return the name and symbol of an exchange, use the following example
Try me!
Return asset current and total supply
How to return an assets current and total supply
Try me!
Return asset market cap and rank
How to return an assets market cap and rank
Try me!
Return asset markets
How to return markets an asset is traded on. Standard market filters can be applied
Try me!
Return asset name, symbol
How to return an assets name and symbol
Try me!
Return asset target block time
How to return an assets target block time
Try me!
Return asset type
How to return an assets type
Try me!
Return market candle OHLCV history
How to return candle information for a market. Candles are returned as an array of arrays where each inner array represents a candle in the form of... 0: Unix timestamp in seconds 1: Open price+ 2: High price 3: Low price 4: Close price 5: Total volume
Try me!
Return market current order book depth
How to view a snapshot of the current order book depth of a market.
Try me!
Return market current ticker
How to return a markets current ticker with current price, last price, low price, high price, base volume, and quote volume.
Try me!
Return market exchange, base, and quote symbol
How to return a markets exchange, base, and quote symbol
Try me!
Return market open date and unix timestamp
How to return a markets open date and unix timestamp
Try me!
Return market remote ID
How to return a markets remote ID
Try me!
Return market type and symbol
How to return a markets type and symbol
Try me!
Return recent trades for a market
How to return the [n] most recent trades from a market
Try me!
Return single exchange
How to return a single exchange
Try me!
Sort
The order timeseries items are returned can be sorted by new first or old first.
Try me!
Sorting
Exchanges may be sorted by a number of fields. To sort by the exchange name, use the following query.
Try me!
Sorting assets
Assets may be sorted by a number of fields at the same time. To sort first by the type of asset in a descending order, then by the market cap rank in an ascending order, use the following query.
Try me!
Start and end date
To request a predefined chunk of time, one can use startDate and endDate. This will return as many time slices as it takes at the defined resolution to fill out data until the specified endDate. If a limit is provided it will return the number in limit or go to endDate whichever is less.
Try me!
Start and end unix
To request a predefined chunk of time, one can use startUnix and endUnix and supply unix timestamps. This will return as many time slices as it takes at the defined resolution to fill out data until the specified endUnix. If a limit is provided it will return the number in limit or go to endUnix whichever is less.
Try me!