README.md

Metrics

(metrics)

Overview

Metrics are quantitative measurements used to evaluate the performance and activity of cryptocurrency exchanges. These metrics include:

1. Trading Volume: The total amount of cryptocurrency traded on an exchange within a specific time period, indicating liquidity and activity.
2. Market Depth: The level of buy and sell orders at different price levels, providing insights into liquidity and potential price impact.
3. Order Book: A record of outstanding buy and sell orders for a cryptocurrency, reflecting supply and demand dynamics.
4. Spread: The difference between the highest bid and lowest ask prices, indicating liquidity and trading costs.
5. Price Charts: Visual representations of cryptocurrency price movements over time, helping identify trends and inform trading decisions.
6. Market Cap: The total value of a cryptocurrency calculated by its price multiplied by circulating supply, reflecting relative size and value.
7. Trading Pairs: Combinations of cryptocurrencies available for trading, including volume, price, and spread for each pair.
8. User Metrics: Data on active users, new registrations, user retention, and engagement, indicating platform popularity and growth.
9. Trading Fees: Fees charged for executing trades, including fee structure, discounts, and revenue generated by the exchange.
10. Security Metrics: Measures assessing the security of an exchange, such as past incidents, user fund protection, and security audits.

These metrics assist traders and investors in evaluating market activity, liquidity, and the reliability of crypto exchanges for informed decision-making.

Available Operations

• get_v1_metrics_listing - Listing of all supported metrics by CoinAPI
• get_v1_metrics_exchange_listing - Listing of all supported exchange metrics
• get_v1_metrics_exchange_current - Current metrics for given exchange
• get_v1_metrics_exchange_history - Historical metrics for the exchange
• get_v1_metrics_symbol_listing - Listing of all supported metrics for symbol
• get_v1_metrics_symbol_current - Current metrics for given symbol
• get_v1_metrics_symbol_history - Historical metrics for symbol
• get_v1_metrics_asset_listing - Listing of all supported metrics for asset
• get_v1_metrics_asset_current - Current metrics for given asset
• get_v1_metrics_asset_history - Historical metrics for asset

get_v1_metrics_listing

Get all data metrics.

Example Usage

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metrics.get_v1_metrics_listing()

if res.content is not None:
    # handle response
    pass

Response

operations.GetV1MetricsListingResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_exchange_listing

Get data metrics for exchange.

Example Usage

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metrics.get_v1_metrics_exchange_listing(exchange_id='<value>', metric_id='<value>')

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
exchange_id	str	✔️	The exchange identifier (from the Metadata -> Exchanges)
metric_id	Optional[str]	➖	The metric identifier (from the Metrics -> Listing)

Response

operations.GetV1MetricsExchangeListingResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_exchange_current

Get current exchange metrics values.

Example Usage

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metrics.get_v1_metrics_exchange_current(exchange_id='<value>', metric_id='<value>')

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
exchange_id	str	✔️	The exchange identifier (from the Metadata -> Exchanges)
metric_id	Optional[str]	➖	The metric identifier (from the Metrics -> Listing)

Response

operations.GetV1MetricsExchangeCurrentResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_exchange_history

Get exchange metrics history.

Example Usage

import coinapi
from coinapi.models import operations

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)

req = operations.GetV1MetricsExchangeHistoryRequest(
    metric_id='<value>',
    exchange_id='<value>',
)

res = s.metrics.get_v1_metrics_exchange_history(req)

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.GetV1MetricsExchangeHistoryRequest	✔️	The request object to use for the request.

Response

operations.GetV1MetricsExchangeHistoryResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_symbol_listing

Get data metrics for symbol.

Example Usage

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metrics.get_v1_metrics_symbol_listing(metric_id='<value>', exchange_id='<value>', symbol_id='<value>')

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
metric_id	Optional[str]	➖	Metric identifier (from the Metrics -> Listing)
exchange_id	Optional[str]	➖	Exchange identifier (from the Metadata -> Exchanges)
symbol_id	Optional[str]	➖	Symbol identifier (from the Metadata -> Symbols)

Response

operations.GetV1MetricsSymbolListingResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_symbol_current

Get current symbol metrics.

Example Usage

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metrics.get_v1_metrics_symbol_current(metric_id='<value>', symbol_id='<value>', exchange_id='<value>')

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
metric_id	Optional[str]	➖	Metric identifier (from the Metrics -> Listing)
symbol_id	Optional[str]	➖	Symbol identifier (from the Metadata -> Symbols)
exchange_id	Optional[str]	➖	Exchange id (from the Metadata -> Exchanges)

Response

operations.GetV1MetricsSymbolCurrentResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_symbol_history

Get symbol metrics history.

Example Usage

import coinapi
from coinapi.models import operations

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)

req = operations.GetV1MetricsSymbolHistoryRequest(
    metric_id='<value>',
    symbol_id='<value>',
)

res = s.metrics.get_v1_metrics_symbol_history(req)

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.GetV1MetricsSymbolHistoryRequest	✔️	The request object to use for the request.

Response

operations.GetV1MetricsSymbolHistoryResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_asset_listing

Get data metrics for asset.

Example Usage

import coinapi
from coinapi.models import operations

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)

req = operations.GetV1MetricsAssetListingRequest()

res = s.metrics.get_v1_metrics_asset_listing(req)

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.GetV1MetricsAssetListingRequest	✔️	The request object to use for the request.

Response

operations.GetV1MetricsAssetListingResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_asset_current

Get current asset metrics.

Example Usage

import coinapi

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)


res = s.metrics.get_v1_metrics_asset_current(metric_id='<value>', asset_id='<value>', asset_id_external='<value>', exchange_id='<value>')

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
metric_id	Optional[str]	➖	Metric identifier (from the Metrics -> Listing)
asset_id	Optional[str]	➖	Asset identifier (from the Metadata -> Assets)
asset_id_external	Optional[str]	➖	Exchange asset identifier
exchange_id	Optional[str]	➖	Exchange identifier (from the Metadata -> Exchanges)

Response

operations.GetV1MetricsAssetCurrentResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/

get_v1_metrics_asset_history

Get asset metrics history.

Example Usage

import coinapi
from coinapi.models import operations

s = coinapi.CoinAPI(
    api_key="<YOUR_API_KEY_HERE>",
)

req = operations.GetV1MetricsAssetHistoryRequest(
    metric_id='<value>',
    exchange_id='<value>',
)

res = s.metrics.get_v1_metrics_asset_history(req)

if res.content is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.GetV1MetricsAssetHistoryRequest	✔️	The request object to use for the request.

Response

operations.GetV1MetricsAssetHistoryResponse

Errors

Error Object	Status Code	Content Type
errors.CoinAPIError	4x-5xx	/