The identity and technical contract details declared by the specification.
ExchangeAssetsResponse
object
1 property
1 required
DefiFee
string
DeFi fee (in percents).
ExperimentalAssetMetric
boolean
Asset, metric, and frequency combination is experimental.
CatalogMetricInfo
object
Information about asset metric.
12 properties
9 required
AssetIdBase
string
Unique name of the base asset.
CatalogMarketQuotesResponse
object
List of market quotes statistics.
1 property
1 required
CatalogPairCandlesResponse
object
1 property
1 required
MarketMetricFrequencies
array
List of metric frequencies.
CatalogIndexCandlesInfo
object
Information about index and its supported candle durations.
2 properties
1 required
CatalogExchangeAssetMetricFrequencies
array
List of exchange-asset metric frequencies.
DisplayName
string
More detailed and human friendly name of a metric.
AssetId
string
Unique name of the asset.
CatalogExchangeMetricFrequency
object
2 properties
2 required
DerivativeContractListing
string
Derivative contract listing date.
OrderSizeMin
string
Minimum order size, where order size is amount price.
MarketType
string
Type of the market (spot, future).
Reviewable
boolean
Reviewable by human flag.
OrderAmountMin
string
Minimum amount size.
CatalogExchangeMetricFrequencies
array
List of exchange metric frequencies.
MarketInfo
object
Information about a market.
41 properties
5 required
CatalogMiningPoolTipsSummaryInfo
object
Information about mining pool tips summary.
3 properties
3 required
FutureTickSize
string
Futures tick size.
MarketId
string
Unique name of the market.
DerivativeContractSizeAsset
string
Name of the derivative contract size asset.
CatalogMetricsResponse
object
1 property
1 required
CatalogMarketOrderbookDataset
object
3 properties
3 required
PairMetricFrequency
object
3 properties
3 required
CatalogMarketGreeksResponse
object
List of greeks statistics.
1 property
1 required
CatalogMarketCandlesResponse
object
List of market candles statistics.
1 property
1 required
AssetAlertSubRules
array
Conditions that should be met in order for the corresponding asset alert to be produced.
AssetAlertSubRuleConstituents
array
Names of the alerting metrics that form an alerting value to be compared against the Key Risk Indicator threshold.
InstitutionMetricFrequencies
array
List of metric frequencies.
ExchangeAssetMetricFrequency
object
3 properties
3 required
AssetInfo
object
Information about asset.
7 properties
2 required
MinTime
string
Minimal available time for time series.
CatalogMarketOrderbookDatasets
array
Dataset-specific availability ranges for this order book depth.
PairMetricsIds
array
List of metrics.
PairMetricFrequencies
array
List of metric frequencies.
MarketTimeRange
object
Available time range for time series.
2 properties
2 required
CatalogMarketMetricsInfo
object
Information about market and its supported metrics.
2 properties
2 required
ExchangeAssetMetricInfo
object
Information about availability of metric for an exchange-asset.
2 properties
2 required
CatalogExchangeAssetMetricFrequency
object
2 properties
2 required
AssetAlertSubRuleThreshold
string
Asset alert's Key Risk Indicator triggering value. Omitted if asset alert condition depends on the variable metric threshold (this fact will be reflected in th…
ExchangeId
string
Unique name of the exchange.
OptionStrike
string
Strike price for option trade.
DefiBaseAddress
string
DeFi base address.
ExchangeMetricFrequencies
array
List of metric frequencies.
ExchangeMetricsIds
array
List of metrics.
CatalogCandleFrequencies
array
Frequencies of the candle.
AssetAlertSubRuleDescription
string
Description of the asset alert.
CatalogMarketOpeninterestInfo
object
Information about market and time range of its available open interest data.
3 properties
3 required
IndexId
string
Name of the index.
CatalogIndexFrequency
object
3 properties
3 required
DerivativeContractMarginAsset
string
Name of the derivative margin asset.
CatalogMarketImpliedVolatilityResponse
object
List of implied volatility statistics.
1 property
1 required
ExperimentalMarket
boolean
If set to true, indicates that market collection is under active development - there is a chance of temporary discrepancies in the served dataset.
CatalogInstitutionMetricsResponse
object
1 property
1 required
InstitutionMetricsIds
array
List of metrics.
ExchangeIds
array
List of exchange names.
CatalogMempoolFeeratesInfo
object
Information about mempool feerates.
3 properties
3 required
CatalogMarketOpeninterestResponse
object
List of market open interest statistics.
1 property
1 required
Product
string
Associated Product of the metric.
CatalogAssetMetricsResponse
object
1 property
1 required
CatalogMarketOrderbooksInfo
object
Information about market and time range of its available orderbooks data.
4 properties
4 required
CatalogExchangeAssetMetricInfo
object
Information about exchange-asset metric.
13 properties
10 required
InstitutionMetricInfo
object
Information about availability of metric for an institution.
2 properties
2 required
ExchangeAsset
string
Unique combination of the exchange and asset.
AssetsIds
array
List of asset names.
CatalogIndexCandlesResponse
object
1 property
1 required
PairId
string
Unique name of the pair.
MetricsIds
array
List of metrics.
MaxHash
string
Maximal available block hash for time series.
Category
string
Category of the metric.
CatalogMarketGreeksInfo
object
Information about market and time range of its available greeks data.
3 properties
3 required
ExchangesIds
array
List of exchange names.
Exchange
string
Name of the exchange.
Community
boolean
Indicates an availability of the metric in the community version of the API.
CatalogMarketContractPricesResponse
object
List of contract prices statistics.
1 property
1 required
AssetAtlas
boolean
If set to true, Atlas data is available for this asset.
DefiContractAddress
string
DeFi contract address.
OrderAmountMax
string
Maximum amount size.
CatalogPairCandlesInfo
object
Information about pair and its supported candle durations.
2 properties
1 required
ExchangeAssetInfo
object
Information about Exchange-asset combination.
2 properties
1 required
InstitutionMetricFrequency
object
3 properties
3 required
CatalogInstitutionMetricFrequencies
array
List of institution metric frequencies.
MinHash
string
Minimal available black hash for time series.
CatalogMarketOrderbooksResponse
object
List of market orderbooks statistics.
1 property
1 required
CatalogMarketLiquidationsResponse
object
List of market liquidations statistics.
1 property
1 required
CatalogAssetMetricInfo
object
Information about asset metric.
13 properties
10 required
CatalogExchangeMetricsResponse
object
1 property
1 required
MarketSymbol
string
Unique name of the derivative market symbol.
AssetAlertRuleInfo
object
Information about the asset alert.
3 properties
3 required
IndexType
string
Type of the index.
MarketMetricInfo
object
Information about availability of metric for a market.
2 properties
2 required
CatalogMarketImpliedVolatilityInfo
object
Information about market and time range of its available implied volatility data.
3 properties
3 required
OrderPriceIncrement
string
Price precision.
AssetMetricFrequencies
array
List of metric frequencies.
MarketMetricsIds
array
List of metrics.
OrderAmountIncrement
string
Volume precision.
CatalogMarketMetricsResponse
object
List of market metrics statistics.
1 property
1 required
ExchangeInfo
object
Information about an exchange.
5 properties
4 required
CatalogMarketContractPricesInfo
object
Information about market and time range of its available contract prices data.
3 properties
3 required
MarketMetricFrequency
object
3 properties
3 required
CatalogTransactionTrackerResponse
object
1 property
1 required
DefiPoolConfigId
string
DeFi pooling config ID.
CatalogMarketLiquidationsInfo
object
Information about market and time range of its available liquidations data.
3 properties
3 required
AssetIdQuote
string
Unique name of the quote asset.
IsEuropean
boolean
shows if the options contract is european or not.
CatalogPairMetricsResponse
object
1 property
1 required
Pairs
array
List of pair names.
AssetAlertSubRule
object
Information about the asset alert condition.
3 properties
2 required
CatalogExchangeMetricInfo
object
Information about exchange metric.
13 properties
10 required
CatalogMarketCandlesInfo
object
Information about market and its supported candle durations.
2 properties
2 required
AssetAlertRulesResponse
object
1 property
1 required
CatalogMarketFundingRatesResponse
object
List of market funding rates statistics.
1 property
1 required
CatalogExchangeAssetMetricsResponse
object
1 property
1 required
ExchangeMetricFrequency
object
3 properties
3 required
CatalogPairMetricFrequency
object
2 properties
2 required
ExperimentalAsset
boolean
If set to true, discrepancies might be present in the dataset for this asset, and that's expected.
MetricId
string
Name of the metric.
ExchangeAssets
array
List of exchange-asset pairs.
CatalogInstitutionMetricFrequency
object
2 properties
2 required
CatalogInstitutionMetricInfo
object
Information about institution metric.
13 properties
10 required
Description
string
Human-friendly description.
CatalogMarketFundingRatesInfo
object
Information about market and time range of its available funding rates data.
3 properties
3 required
IndexInfo
object
Information about an index.
5 properties
4 required
MetricType
string
Type of the metric.
PairMetricInfo
object
Information about availability of metric for an pair.
2 properties
2 required
ExperimentalMetric
boolean
If set to true, indicates that metrics collection is under active development - there is a chance of temporary discrepancies in the served dataset.
ExchangeMetricInfo
object
Information about availability of metric for an exchange.
2 properties
2 required
CatalogMarketTradesResponse
object
List of market trades statistics.
1 property
1 required
MarketContractSize
string
Market contract size.
CatalogAssetMetricFrequencies
array
List of asset metric frequencies.
PairInfo
object
Information about pair.
3 properties
1 required
AssetMetricFrequency
object
9 properties
3 required
OrderPriceMax
string
Maximum price.
CatalogPairMetricFrequencies
array
List of pair metric frequencies.
DefiQuoteAddress
string
DeFi quote address.
MetricDataType
string
Data Type of the metric. Can be bigint or decimal. "bigint" means that you should expect an integer number in a range from -9223372036854775808 to 922337203685…
AssetMetricInfo
object
Information about availability of metric for an asset.
2 properties
2 required
FullName
string
Human-friendly name.
ErrorObject
object
2 properties
2 required
CatalogMarketTradesInfo
object
Information about market and time range of its available trades data.
3 properties
3 required
InstitutionInfo
object
Information about Institution.
2 properties
1 required
MarginTradingEnabled
boolean
CatalogTransactionTrackerInfo
object
Information about transaction tracker.
3 properties
3 required
MarketsResponse
object
List of markets.
1 property
1 required
Unit
string
Unit of the metric.
CatalogAssetMetricFrequency
object
2 properties
2 required
CatalogMempoolFeeratesResponse
object
1 property
1 required
MinHeight
string
Minimal available block height for time series.
CatalogAssetChainsResponse
object
1 property
1 required
ExchangeAssetMetricFrequencies
array
List of metric frequencies.
ExchangesResponse
object
1 property
1 required
IndexesResponse
object
1 property
1 required
PairsResponse
object
1 property
1 required
CatalogMarketOrderbookDepths
array
Depths of the book.
MaxHeight
string
Maximal available block height for time series.
MarketsIds
array
List of market names.
MaxTime
string
Maximal available time for time series.
IndexFrequencies
array
Frequencies of the index.
CatalogMarketQuotesInfo
object
Information about market and time range of its available quotes data.
3 properties
3 required
CatalogMarketOrderbookDepth
object
Order book availability for a depth. The depth-level mintime and maxtime are backward-compatible summary fields. When the snapshots dataset is present, they ma…
4 properties
3 required
CatalogCandleFrequency
object
3 properties
3 required
InstitutionId
string
Unique name of the institution.
AssetsResponse
object
1 property
1 required
Status
string
Market status (online/offline).
Subcategory
string
Subcategory of the metric.
SettlementPrice
string
Price of underlying asset at contract expiration.
ExchangeAssetMetricsIds
array
List of metrics.
ErrorResponse
object
1 property
1 required
CatalogMiningPoolTipsSummaryResponse
object
1 property
1 required
AssetAlertSubRuleConstituent
string
Name of the alerting metric.
OrderPriceMin
string
Minimum price.
OptionContractType
string
'call or 'put' option contract type.
CatalogAssetChainsInfo
object
Information about asset chains.
3 properties
3 required
Institutions
array
List of institutions.
DerivativeContractExpiration
string
Derivative contract expiration date.
CatalogPairMetricInfo
object
Information about pair metric.
13 properties
10 required
InstitutionsResponse
object
1 property
1 required
AssetAlertRuleName
string
Name of the asset alert.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Coin Metrics publishes across the network.