For the complete documentation index, see llms.txt. This page is also available as Markdown.

CoinMetricsClient.get_stream_market_orderbooks

coinmetrics.api_client.CoinMetricsClient.get_stream_market_orderbooks(
    markets,
    backfill=Backfill.LATEST,
    depth_limit=None,
)

Returns timeseries stream of market orderbooks.

  • Parameters:

    • 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.

    • depth_limit (str) -- Default: 100. Supported Values: 100 "full_book". Book depth limit.

Returns:

  • CmStream

    • Market Orderbooks timeseries stream.

Last updated

Was this helpful?