CoinMetricsClient

CoinMetricsClient is the main entry point for the Python client. Instantiate it once with your API key and call the method that matches the Coin Metrics REST endpoint you want to hit; every method returns either a DataCollection (REST endpoints) or a CmStream (WebSocket endpoints).

class coinmetrics.api_client.CoinMetricsClient(
    api_key='',
    verify_ssl_certs=True,
    proxy_url=None,
    session=None,
    debug_mode=False,
    verbose=False,
    host=None,
    port=None,
    schema='https',
    ignore_unsupported_errors=False,
    ignore_forbidden_errors=False,
    max_retries=5,
)

Bases: object

The CoinMetricsClient class is a Python wrapper for calling the Coin Metrics API.

• Parameters:

  • api_key (str)

  • verify_ssl_certs (bool | str)

  • proxy_url (str | None)

  • session (Session | None)

  • debug_mode (bool)

  • verbose (bool)

  • host (str | None)

  • port (int | None)

  • schema (str)

  • ignore_unsupported_errors (bool)

  • ignore_forbidden_errors (bool)

  • max_retries (int | None)

Endpoints

Methods are grouped by endpoint root. For example, every catalog-v2/* request lives under Catalog v2 and every timeseries/* request lives under Time Series.