coinmetrics.api_client¶
CoinMetricsClient Objects¶
class CoinMetricsClient()
catalog_assets¶
| catalog_assets(assets: Optional[Union[List[str], str]] = None) -> CatalogAssetsData
Returns meta information about available assets.
Arguments:
assets(list(str), str): A single asset or a list of assets to return info for. If no assets provided, all available assets are returned.
Returns:
list(dict(str, any)): Information that is available for requested assets, like: Full name, metrics and available frequencies, markets, exchanges, etc.
catalog_asset_alerts¶
| catalog_asset_alerts(assets: Optional[Union[List[str], str]] = None, alerts: Optional[Union[List[str], str]] = None) -> CatalogAssetAlertsData
Returns meta information about available assets.
Arguments:
assets(list(str), str): A single asset or a list of assets to return info for. If no assets provided, all available assets are returned.alerts(list(str), str): A single alert or alert name to return info for. If no alerts provided, all available alerts are returned.
Returns:
list(dict(str, any)): Information that is available for requested assets alerts.
catalog_asset_pairs¶
| catalog_asset_pairs(asset_pairs: Optional[Union[List[str], str]] = None) -> CatalogAssetPairsData
Returns meta information about available asset-asset pairs
Arguments:
asset_pairs(list(str), str): A single asset-asset pair (e.g. "btc-eth") or a list of asset-asset pairs to return info for. If none are provided, all available pairs are returned.
Returns:
list(dict(str, any)): Information that is available for requested asset-asset pair like metrics and their respective frequencies and time ranges
catalog_exchanges¶
| catalog_exchanges(exchanges: Optional[Union[List[str], str]] = None) -> CatalogExchangesData
Returns meta information about exchanges.
Arguments:
exchanges(list(str), str): A single exchange name or a list of exchanges to return info for. If no exchanges provided, all available exchanges are returned.
Returns:
list(dict(str, any)): Information that is available for requested exchanges, like: markets, min and max time available.
catalog_exchange_assets¶
| catalog_exchange_assets(exchange_assets: Optional[Union[List[str], str]] = None) -> CatalogExchangeAssetsData
Returns meta information about available exchange-asset pairs
Arguments:
exchange_assets(list(str), str): A single exchange-asset pair (e.g. "binance-btc") or a list of exchange-asset pairs to return info for. If none are provided, all available pairs are returned.
Returns:
list(dict(str, any)): Information that is available for requested exchange-asset pair like metrics and their respective frequencies and time ranges
catalog_indexes¶
| catalog_indexes(indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData
Returns meta information about available indexes.
Arguments:
indexes(list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all available indexes are returned.
Returns:
list(dict(str, any)): Information that is available for requested indexes, like: Full name, and available frequencies.
catalog_institutions¶
| catalog_institutions(institutions: Optional[Union[List[str], str]] = None) -> CatalogInstitutionsData
Returns meta information about available institutions
Arguments:
institutions(list(str), str): A single institution (e.g. "grayscale") or a list of institutions to return info for. If none are provided, all available pairs are returned.
Returns:
list(dict(str, any)): Information that is available for requested institution like metrics and their respective frequencies and time ranges.
catalog_markets¶
| catalog_markets(markets: Optional[Union[List[str], str]] = None, market_type: Optional[str] = None, exchange: Optional[str] = None, base: Optional[str] = None, quote: Optional[str] = None, asset: Optional[str] = None, symbol: Optional[str] = None) -> CatalogMarketsData
Returns list of available markets that correspond to a filter. If no filter is set, returns all available assets.
Arguments:
markets(list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'market_type(str): Type of market: "spot", "future", "option"exchange(str): name of the exchangebase(str): name of base assetquote(str): name of quote assetasset(str): name of either base or quote assetsymbol(str): name of a symbol. Usually used for futures contracts.
Returns:
list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.
catalog_metrics¶
| catalog_metrics(metrics: Optional[Union[List[str], str]] = None, reviewable: Optional[bool] = None) -> CatalogMetricsData
Returns list of available metrics along with information for them like description, category, precision and assets for which a metric is available.
Arguments:
metrics(list(str), str): A single metric name or a list of metrics to return info for. If no metrics provided, all available metrics are returned.reviewable(bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.
Returns:
list(dict(str, any)): Information about metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is available.
catalog_market_metrics¶
| catalog_market_metrics(markets: Optional[Union[List[str], str]] = None, market_type: Optional[str] = None, exchange: Optional[str] = None, base: Optional[str] = None, quote: Optional[str] = None, asset: Optional[str] = None, symbol: Optional[str] = None) -> CatalogMarketMetricsData
Returns list of available markets with metrics support along woth time ranges of available data per metric.
Arguments:
markets(list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'market_type(str): Type of market: "spot", "future", "option"exchange(str): name of the exchangebase(str): name of base assetquote(str): name of quote assetasset(str): name of either base or quote assetsymbol(str): name of a symbol. Usually used for futures contracts.
Returns:
list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.
catalog_market_candles¶
| catalog_market_candles(markets: Optional[Union[List[str], str]] = None, market_type: Optional[str] = None, exchange: Optional[str] = None, base: Optional[str] = None, quote: Optional[str] = None, asset: Optional[str] = None, symbol: Optional[str] = None) -> CatalogMarketCandlesData
Returns list of available markets with candles support along woth time ranges of available data per metric.
Arguments:
markets(list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'market_type(str): Type of market: "spot", "future", "option"exchange(str): name of the exchangebase(str): name of base assetquote(str): name of quote assetasset(str): name of either base or quote assetsymbol(str): name of a symbol. Usually used for futures contracts.
Returns:
list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.
catalog_full_assets¶
| catalog_full_assets(assets: Optional[Union[List[str], str]] = None) -> CatalogAssetsData
Returns meta information about supported assets.
Arguments:
assets(list(str), str): A single asset or a list of assets to return info for. If no assets provided, all supported assets are returned.
Returns:
list(dict(str, any)): Information that is supported for requested assets, like: Full name, metrics and supported frequencies, markets, exchanges, etc.
catalog_full_asset_alerts¶
| catalog_full_asset_alerts(assets: Optional[Union[List[str], str]] = None, alerts: Optional[Union[List[str], str]] = None) -> CatalogAssetAlertsData
Returns meta information about supported assets.
Arguments:
assets(list(str), str): A single asset or a list of assets to return info for. If no assets provided, all available assets are returned.alerts(list(str), str): A single alert or alert name to return info for. If no alerts provided, all available alerts are returned.
Returns:
list(dict(str, any)): Information that is available for requested assets alerts.
catalog_full_asset_pairs¶
| catalog_full_asset_pairs(asset_pairs: Optional[Union[List[str], str]] = None) -> CatalogAssetPairsData
Returns meta information about supported asset-asset pairs
Arguments:
asset_pairs(list(str), str): A single asset-asset pair (e.g. "btc-eth") or a list of asset-asset pairs to return info for. If none are provided, all supported pairs are returned.
Returns:
list(dict(str, any)): Information that is supported for requested asset-asset pair like metrics and their respective frequencies and time ranges
catalog_full_exchanges¶
| catalog_full_exchanges(exchanges: Optional[Union[List[str], str]] = None) -> CatalogExchangesData
Returns meta information about exchanges.
Arguments:
exchanges(list(str), str): A single exchange name or a list of exchanges to return info for. If no exchanges provided, all supported exchanges are returned.
Returns:
list(dict(str, any)): Information that is supported for requested exchanges, like: markets, min and max time supported.
catalog_full_exchange_assets¶
| catalog_full_exchange_assets(exchange_assets: Optional[Union[List[str], str]] = None) -> CatalogExchangeAssetsData
Returns meta information about supported exchange-asset pairs
Arguments:
exchange_assets(list(str), str): A single exchange-asset pair (e.g. "binance-btc") or a list of exchange-asset pairs to return info for. If none are provided, all supported pairs are returned.
Returns:
list(dict(str, any)): Information that is supported for requested exchange-asset pair like metrics and their respective frequencies and time ranges
catalog_full_indexes¶
| catalog_full_indexes(indexes: Optional[Union[List[str], str]] = None) -> CatalogIndexesData
Returns meta information about supported indexes.
Arguments:
indexes(list(str), str): A single index name or a list of indexes to return info for. If no indexes provided, all supported indexes are returned.
Returns:
list(dict(str, any)): Information that is supported for requested indexes, like: Full name, and supported frequencies.
catalog_full_institutions¶
| catalog_full_institutions(institutions: Optional[Union[List[str], str]] = None) -> CatalogInstitutionsData
Returns meta information about supported institutions
Arguments:
institutions(list(str), str): A single institution (e.g. "grayscale") or a list of institutions to return info for. If none are provided, all supported pairs are returned.
Returns:
list(dict(str, any)): Information that is supported for requested institution like metrics and their respective frequencies and time ranges.
catalog_full_markets¶
| catalog_full_markets(markets: Optional[Union[List[str], str]] = None, market_type: Optional[str] = None, exchange: Optional[str] = None, base: Optional[str] = None, quote: Optional[str] = None, asset: Optional[str] = None, symbol: Optional[str] = None) -> CatalogMarketsData
Returns list of supported markets that correspond to a filter. If no filter is set, returns all supported assets.
Arguments:
markets(list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'market_type(str): Type of market: "spot", "future", "option"exchange(str): name of the exchangebase(str): name of base assetquote(str): name of quote assetasset(str): name of either base or quote assetsymbol(str): name of a symbol. Usually used for futures contracts.
Returns:
list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max supported time frames.
catalog_full_metrics¶
| catalog_full_metrics(metrics: Optional[Union[List[str], str]] = None, reviewable: Optional[bool] = None) -> CatalogMetricsData
Returns list of supported metrics along with information for them like description, category, precision and assets for which a metric is supported.
Arguments:
metrics(list(str), str): A single metric name or a list of metrics to return info for. If no metrics provided, all supported metrics are returned.reviewable(bool): Show only reviewable or non-reviewable by human metrics. By default all metrics are shown.
Returns:
list(dict(str, any)): Information about metrics that correspond to a filter along with meta information like: description, category, precision and assets for which a metric is supported.
catalog_full_market_metrics¶
| catalog_full_market_metrics(markets: Optional[Union[List[str], str]] = None, market_type: Optional[str] = None, exchange: Optional[str] = None, base: Optional[str] = None, quote: Optional[str] = None, asset: Optional[str] = None, symbol: Optional[str] = None) -> CatalogMarketMetricsData
Returns list of supported markets with metrics support along woth time ranges of available data per metric.
Arguments:
markets(list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'market_type(str): Type of market: "spot", "future", "option"exchange(str): name of the exchangebase(str): name of base assetquote(str): name of quote assetasset(str): name of either base or quote assetsymbol(str): name of a symbol. Usually used for futures contracts.
Returns:
list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.
catalog_full_market_candles¶
| catalog_full_market_candles(markets: Optional[Union[List[str], str]] = None, market_type: Optional[str] = None, exchange: Optional[str] = None, base: Optional[str] = None, quote: Optional[str] = None, asset: Optional[str] = None, symbol: Optional[str] = None) -> CatalogMarketCandlesData
Returns list of available markets with candles support along woth time ranges of available data per metric.
Arguments:
markets(list(str), str): list of market names, e.g. 'coinbase-btc-usd-spot'market_type(str): Type of market: "spot", "future", "option"exchange(str): name of the exchangebase(str): name of base assetquote(str): name of quote assetasset(str): name of either base or quote assetsymbol(str): name of a symbol. Usually used for futures contracts.
Returns:
list(dict(str, any)): Information about markets that correspond to a filter along with meta information like: type of market and min and max available time frames.
get_asset_alerts¶
| get_asset_alerts(assets: Union[List[str], str], alerts: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns asset alerts for the specified assets.
Arguments:
assets(list(str), str): list of asset names, e.g. 'btc'alerts(list(str), str): list of asset alert namespage_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: Asset alerts timeseries.
get_asset_chains¶
| get_asset_chains(assets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns the chains of blocks for the specified assets.
Arguments:
assets(list(str), str): list of asset names, e.g. 'btc'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: Asset chains timeseries.
get_asset_metrics¶
| get_asset_metrics(assets: Union[List[str], str], metrics: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, sort: Optional[str] = None, limit_per_asset: Optional[int] = None) -> DataCollection
Returns requested metrics for specified assets.
Arguments:
assets(list(str), str): list of asset names, e.g. 'btc'metrics(list(str), str): list of asset-specific metric names, e.g. 'PriceUSD'frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): Start block of the timeseries (only applicable when querying with frequency 1b).end_height(int): End block of the timeseries (only applicable when querying with frequency 1b).start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.sort(str): How results will be sorted, e.g. "asset", "height", or "time". Default is "asset". Metrics with 1b frequency are sorted by (asset, height, block_hash) tuples by default. Metrics with other frequencies are sorted by (asset, time) by default. If you want to sort 1d metrics by (time, asset) you should choose time as value for the sort parameter. Sorting by time is useful if you request metrics for a set of assets.limit_per_asset(int): How many entries per asset the result should contain.
Returns:
DataCollection: Asset Metrics timeseries.
get_exchange_metrics¶
| get_exchange_metrics(exchanges: Union[List[str], str], metrics: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, sort: Optional[str] = None, limit_per_exchange: Optional[int] = None) -> DataCollection
Returns metrics for specified exchanges.
Arguments:
exchanges(list(str), str): A single exchange name or a list of exchanges to return info for.metrics(list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, callclient.catalog_exchanges()frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): Start block of the timeseries (only applicable when querying with frequency 1b).end_height(int): End block of the timeseries (only applicable when querying with frequency 1b).start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.sort(str): How results will be sorted, e.g. 'exchange', 'time'. Metrics are sorted by 'exchange' by default.limit_per_exchange(int): How many entries per exchange the result should contain.
Returns:
DataCollection: Asset Metrics timeseries.
get_exchange_asset_metrics¶
| get_exchange_asset_metrics(exchange_assets: Union[List[str], str], metrics: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, sort: Optional[str] = None, limit_per_exchange_asset: Optional[int] = None) -> DataCollection
Returns metrics for specified exchange-asset.
Arguments:
exchange_assets(list(str), str): A single exchange-asset pairs (e.g. "binance-btc" or a list of exchange-asset-pair to return info for.metrics(list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, callclient.catalog_exchanges()frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): Start block of the timeseries (only applicable when querying with frequency 1b).end_height(int): End block of the timeseries (only applicable when querying with frequency 1b).start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.sort(str): How results will be sorted, e.g. "exchange_asset", "time". Default is "exchange_asset".limit_per_exchange_asset(int): How many entries per exchange-asset the result should contain.
Returns:
DataCollection: Exchange-Asset Metrics timeseries.
get_pair_metrics¶
| get_pair_metrics(pairs: Union[List[str], str], metrics: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, sort: Optional[str] = None, limit_per_pair: Optional[int] = None) -> DataCollection
Returns metrics books for specified asset-asset pairs.
Arguments:
pairs(list(str), str): A single asset-asset pairs (e.g. "btc-usd") or a list of asset-asset-pairs to return info for.metrics(list(str), str): list of exchange-specific metric names, e.g. 'open_interest_reported_future_usd'. To find a list of available metrics for a given exchange, callclient.catalog_exchanges()frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): Start block of the timeseries (only applicable when querying with frequency 1b).end_height(int): End block of the timeseries (only applicable when querying with frequency 1b).start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.sort(str): How results will be sorted, e.g."pair", "time". "pair" by defaultlimit_per_pair(int): How many entries per asset pair the result should contain.
Returns:
DataCollection: Exchange-Asset Metrics timeseries.
get_institution_metrics¶
| get_institution_metrics(institutions: Union[List[str], str], metrics: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, sort: Optional[str] = None, limit_per_institution: Optional[int] = None) -> DataCollection
Returns metrics for specified institutions.
Arguments:
institutions(list(str), str): A single institution name or a list of institutions to return info for.metrics(list(str), str): list of institution-specific metric names, e.g. 'gbtc_total_assets'frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): Start block of the timeseries (only applicable when querying with frequency 1b).end_height(int): End block of the timeseries (only applicable when querying with frequency 1b).start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.sort(str): How results will be sorted, e.g. "institution", or "time". Default is "institution".limit_per_institution(int): How many entries per institution the result should contain.
Returns:
DataCollection: Asset Metrics timeseries.
get_index_levels¶
| get_index_levels(indexes: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_index: Optional[int] = None) -> DataCollection
Returns index levels for specified indexes and date range.
Arguments:
indexes(list(str), str): list of index names, e.g. 'CMBI10'frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_index(int): How many entries per index the result should contain.
Returns:
DataCollection: Index Levels timeseries.
get_index_constituents¶
| get_index_constituents(indexes: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns index constituents for specified indexes and date range.
Arguments:
indexes(list(str), str): list of index names, e.g. 'CMBI10'frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: Index Constituents timeseries.
get_market_metrics¶
| get_market_metrics(markets: Union[List[str], str], metrics: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market metrics for specified markets, frequency and date range. For more information on market metrics, see: https://docs.coinmetrics.io/api/v4#operation/getTimeseriesMarketMetrics
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'metrics(list(str), str): list of metrics, i.e. 'liquidations_reported_future_buy_units_1d'. See market metrics catalog for a list of supported metrics: https://docs.coinmetrics.io/api/v4#operation/getCatalogMarketMetricsfrequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Candles timeseries.
get_market_candles¶
| get_market_candles(markets: Union[List[str], str], frequency: Optional[str] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market candles for specified markets, frequency and date range. For more information on market candles, see: https://docs.coinmetrics.io/info/markets/candles
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Candles timeseries.
get_market_trades¶
| get_market_trades(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market trades for specified markets and date range. For more information on market trades, see: https://docs.coinmetrics.io/info/markets/trades
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Trades timeseries.
get_market_open_interest¶
| get_market_open_interest(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market open interest for specified markets and date range. For more information on open interest, see: https://docs.coinmetrics.io/info/markets/openinterest
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Open Interest timeseries.
get_market_liquidations¶
| get_market_liquidations(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market liquidations for specified markets and date range. For more information on liquidations, see: https://docs.coinmetrics.io/info/markets/liquidations
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Liquidations timeseries.
get_market_funding_rates¶
| get_market_funding_rates(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market funding rates for specified markets and date range. For more information on funding rates, see: https://docs.coinmetrics.io/info/markets/fundingrates
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Funding Rates timeseries.
get_market_orderbooks¶
| get_market_orderbooks(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, depth_limit: Optional[str] = "100", timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market order books for specified markets and date range. For more information on order books, see: https://docs.coinmetrics.io/info/markets/orderbook
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.depth_limit(str): book depth limit, 100 levels max or full book that is not limited and provided as is from the exchange. Full book snapshots are collected once per hourtimezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Order Books timeseries.
get_market_quotes¶
| get_market_quotes(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns market quotes for specified markets and date range. For more information on quotes, see: https://docs.coinmetrics.io/info/markets/quotes
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Quotes timeseries.
get_market_contract_prices¶
| get_market_contract_prices(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
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.
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Contract Prices timeseries.
get_market_implied_volatility¶
| get_market_implied_volatility(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns implied volatility for specified markets.
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Volatility timeseries.
get_market_greeks¶
| get_market_greeks(markets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None, limit_per_market: Optional[int] = None) -> DataCollection
Returns greeks for option markets.
Arguments:
markets(list(str), str): list of market ids. Market ids use the following naming convention:exchangeName-baseAsset-quoteAsset-spotfor spot markets,exchangeName-futuresSymbol-futurefor futures markets, andexchangeName-optionsSymbol-optionfor options markets. e.g.,'coinbase-btc-usd-spot','bitmex-XBTUSD-future', 'deribit-ETH-25MAR22-1200-P-option'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.limit_per_market(int): How many entries per market the result should contain.
Returns:
DataCollection: Market Volatility timeseries.
get_mining_pool_tips_summary¶
| get_mining_pool_tips_summary(assets: Union[List[str], str], page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns mining pool tips summaries for specified assets.
Arguments:
assets(list(str), str): list of asset names, e.g. 'btc'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: Mining Pool Tips timeseries.
get_mempool_feerates¶
| get_mempool_feerates(assets: Union[List[str], str], page_size: Optional[int] = 200, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns mempool feerates for the specified assets. Note: for this method, page_size must be <= 200.
Arguments:
assets(list(str), str): list of asset names, e.g. 'btc'page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: Mempool Fee Rates timeseries.
get_stream_asset_metrics¶
| get_stream_asset_metrics(assets: Union[List[str], str], metrics: Union[List[str], str], frequency: Optional[str] = None, backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
Returns timeseries stream of metrics for specified assets.
Arguments:
assets(list(str), str): list of asset names, e.g. 'btc'metrics(list(str), str): list of asset-specific metric names, e.g. 'PriceUSD'frequency(str): frequency of the returned timeseries, e.g 15s, 1d, etc.backfill(str): What data should be sent upon a connection ("latest" or "none"). By default the latest values are sent just before real-time data.
Returns:
CmStream: Asset Metrics timeseries stream.
get_stream_market_trades¶
| get_stream_market_trades(markets: Union[List[str], str], backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
Returns timeseries stream of market trades.
Arguments:
markets(list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.backfill(str): What data should be sent upon a connection ("latest" or "none"). By default the latest values are sent just before real-time data.
Returns:
CmStream: Market Trades timeseries stream.
get_stream_market_orderbooks¶
| get_stream_market_orderbooks(markets: Union[List[str], str], backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
Returns timeseries stream of market orderbooks.
Arguments:
markets(list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.backfill(str): What data should be sent upon a connection ("latest" or "none"). By default the latest values are sent just before real-time data.
Returns:
CmStream: Market Orderbooks timeseries stream.
get_stream_market_quotes¶
| get_stream_market_quotes(markets: Union[List[str], str], backfill: Union[Backfill, str] = Backfill.LATEST) -> CmStream
Returns timeseries stream of market quotes.
Arguments:
markets(list(str), str): list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.backfill(str): What data should be sent upon a connection ("latest" or "none"). By default the latest values are sent just before real-time data.
Returns:
CmStream: Market Quotes timeseries stream.
get_list_of_blocks¶
| get_list_of_blocks(asset: str, block_hashes: Optional[Union[List[str], str]] = None, heights: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain blocks metadata.
Arguments:
asset(str): Asset nameblock_hashes(str, list(str)): Optional comma separated list of block hashes to filter a response.heights(str, list(str)): Optional comma separated list of block heights to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of blockchain blocks metadata
get_list_of_accounts¶
| get_list_of_accounts(asset: str, accounts: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_chain_sequence_number: Optional[int] = None, end_chain_sequence_number: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain accounts with their balances.
Arguments:
asset(str): Asset nameaccounts(str, list(str)): Optional comma separated list of accounts to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_chain_sequence_number(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_chain_sequence_number(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of blockchain accounts metadata
get_list_of_transactions¶
| get_list_of_transactions(asset: str, transaction_hashes: Optional[Union[List[str], str]] = None, block_hashes: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain transactions metadata.
Arguments:
asset(str): Asset nametransaction_hashes(str, list(str)): Optional comma separated list of transaction hashes to filter a response.block_hashes(str, list(str)): Optional comma separated list of block hashes to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of transaction metadata
get_list_of_balance_updates¶
| get_list_of_balance_updates(asset: str, accounts: Optional[Union[List[str], str]] = None, transaction_hashes: Optional[Union[List[str], str]] = None, block_hashes: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_chain_sequence_number: Optional[int] = None, end_chain_sequence_number: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain accounts balance updates.
Arguments:
asset(str): Asset nameaccounts(str, list(str)): Optional comma separated list of accounts to filter a response.transaction_hashes(str, list(str)): Optional comma separated list of transaction hashes to filter a response.block_hashes(str, list(str)): Optional comma separated list of block hashes to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_chain_sequence_number(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_chain_sequence_number(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of balance updates
get_list_of_blocks_v2¶
| get_list_of_blocks_v2(asset: str, block_hashes: Optional[Union[List[str], str]] = None, heights: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain blocks metadata.
Arguments:
asset(str): Asset nameblock_hashes(str, list(str)): Optional comma separated list of block hashes to filter a response.heights(str, list(str)): Optional comma separated list of block heights to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of blockchain blocks metadata
get_list_of_accounts_v2¶
| get_list_of_accounts_v2(asset: str, accounts: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_chain_sequence_number: Optional[int] = None, end_chain_sequence_number: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain accounts with their balances.
Arguments:
asset(str): Asset nameaccounts(str, list(str)): Optional comma separated list of accounts to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_chain_sequence_number(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_chain_sequence_number(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of blockchain accounts metadata
get_list_of_sub_accounts_v2¶
| get_list_of_sub_accounts_v2(asset: str, accounts: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_chain_sequence_number: Optional[int] = None, end_chain_sequence_number: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain sub-accounts with their balances.
Arguments:
asset(str): Asset nameaccounts(str, list(str)): Optional comma separated list of accounts to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_chain_sequence_number(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_chain_sequence_number(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of blockchain accounts metadata
get_list_of_transactions_v2¶
| get_list_of_transactions_v2(asset: str, transaction_hashes: Optional[Union[List[str], str]] = None, block_hashes: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain transactions metadata.
Arguments:
asset(str): Asset nametransaction_hashes(str, list(str)): Optional comma separated list of transaction hashes to filter a response.block_hashes(str, list(str)): Optional comma separated list of block hashes to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of transaction metadata
get_list_of_balance_updates_v2¶
| get_list_of_balance_updates_v2(asset: str, accounts: Optional[Union[List[str], str]] = None, transaction_hashes: Optional[Union[List[str], str]] = None, block_hashes: Optional[Union[List[str], str]] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_height: Optional[int] = None, end_height: Optional[int] = None, start_chain_sequence_number: Optional[int] = None, end_chain_sequence_number: Optional[int] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns a list of blockchain accounts balance updates.
Arguments:
asset(str): Asset nameaccounts(str, list(str)): Optional comma separated list of accounts to filter a response.transaction_hashes(str, list(str)): Optional comma separated list of transaction hashes to filter a response.block_hashes(str, list(str)): Optional comma separated list of block hashes to filter a response.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_height(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_height(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_chain_sequence_number(int): The start height indicates the beginning block height for the set of data that are returned. Mutually exclusive with start_timeend_chain_sequence_number(int): The end height indicates the beginning block height for the set of data that are returned. Mutually exclusive with end_timestart_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: list of balance updates
get_full_block¶
| get_full_block(asset: str, block_hash: str) -> List[Dict[str, Any]]
Returns a full blockchain block with all transactions and balance updates.
Arguments:
asset(str): Asset nameblock_hash(str): block hash
Returns:
list(dict(str), any): blockchain block data
get_full_transaction¶
| get_full_transaction(asset: str, transaction_hash: str) -> List[Dict[str, Any]]
Returns a full blockchain transaction with all balance updates.
Arguments:
asset(str): Asset nametransaction_hash(str): transaction hash
Returns:
list(dict(str), any): block transaction data
get_full_transaction_for_block¶
| get_full_transaction_for_block(asset: str, block_hash: str, transaction_hash: str) -> List[Dict[str, Any]]
Returns a full blockchain transaction with all balance updates for a specific block.
Arguments:
asset(str): Asset nameblock_hash(str): block hashtransaction_hash(str): transaction hash
Returns:
list(dict(str, Any)): block transaction data with balance updates
get_full_block_v2¶
| get_full_block_v2(asset: str, block_hash: str, include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]
Returns a full blockchain block with all transactions and balance updates.
Arguments:
asset(str): Asset nameblock_hash(str): block hashinclude_sub_accounts(bool): Boolean indicating if the response should contain sub-accounts
Returns:
list(dict(str), any): blockchain block data
get_full_transaction_v2¶
| get_full_transaction_v2(asset: str, txid: str, include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]
Returns a full blockchain transaction with all balance updates.
Arguments:
asset(str): Asset nametxid(str): transaction identifierinclude_sub_accounts(bool): Boolean indicating if the response should contain sub-accounts
Returns:
list(dict(str), any): block transaction data
get_full_transaction_for_block_v2¶
| get_full_transaction_for_block_v2(asset: str, block_hash: str, txid: str, include_sub_accounts: Optional[bool]) -> List[Dict[str, Any]]
Returns a full blockchain transaction with all balance updates for a specific block.
Arguments:
asset(str): Asset nameblock_hash(str): block hashtxid(str): transaction identifierinclude_sub_accounts(bool): Boolean indicating if the response should contain sub-accounts
Returns:
list(dict(str, Any)): block transaction data with balance updates
get_transaction_tracker¶
| get_transaction_tracker(asset: str, txids: Optional[Union[List[str], str]] = None, replacements_for_txids: Optional[Union[List[str], str]] = None, replacements_only: Optional[bool] = None, page_size: Optional[int] = None, paging_from: Optional[Union[PagingFrom, str]] = 'start', start_time: Optional[Union[datetime, date, str]] = None, end_time: Optional[Union[datetime, date, str]] = None, start_inclusive: Optional[bool] = None, end_inclusive: Optional[bool] = None, timezone: Optional[str] = None) -> DataCollection
Returns status updates for the specified or all transactions.
Arguments:
asset(str): Asset nametxids(str, list(str)): Optional comma separated list of transaction identifiers (txid) to track.replacements_for_txids(str, list(str)): Optional comma separated list of transaction identifiers (txid) to get the corresponding replacement transactions for. Mutually exclusive with txids.replacements_only(bool): Boolean indicating if the response should contain only the replacement transactions.page_size(int): number of items returned per page when calling the API. If the request times out, try using a smaller number.paging_from(PagingFrom, str): Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.start_time(datetime, date, str): Start time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120end_time(datetime, date, str): End time of the timeseries. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120start_inclusive(bool): Flag to define if start timestamp must be included in the timeseries if present. True by default.end_inclusive(bool): Flag to define if end timestamp must be included in the timeseries if present. True by default.timezone(str): timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.
Returns:
DataCollection: status updates for the specified or all transactions.