Skip to main content

Current depth of the order book

GET 
/v1/orderbooks/:symbol_id/depth/current

Retrieves the current depth of the order book for the specified symbol.

Request​

Path Parameters

    symbol_id stringrequired

    The symbol ID (from the Metadata -> Symbols)

Query Parameters

    limit_levels int32

    The maximum number of levels to include in the response.

Responses​

successful operation

Schema

    symbol_id stringnullable

    The symbol identifier.

    time_exchange date-time

    The exchange time of the order book.

    time_coinapi date-time

    The CoinAPI time when the order book was received.

    ask_levels int64

    The number of ask levels in the order book.

    bid_levels int64

    The number of bid levels in the order book.

    ask_depth double

    The depth of the ask side of the order book.

    bid_depth double

    The depth of the bid side of the order book.

Loading...