Get current order book

GET 
/v1/orderbooks/:symbol_id/current

Retrieves the current 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

200

successful operation

text/plain

Schema

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.

asks nullable

The asks made by market makers.

bids nullable

The bids made by market makers.

Example (from schema)

{
  "symbol_id": "string",
  "time_exchange": "2024-11-12T12:17:30.492Z",
  "time_coinapi": "2024-11-12T12:17:30.492Z"
}

Example response

{
  "symbol_id": "COINBASE_SPOT_BCH_USD",
  "time_exchange": "2020-08-27T10:28:35.6111130Z",
  "time_coinapi": "2020-08-27T10:28:35.6766461Z",
  "asks": [
    {
      "id": "3c5e789c-4c84-448a-9c5d-50532ea1ccbb",
      "price": 272.89,
      "size": 1
    },
    {
      "id": "c64a76ba-5107-4c1b-b788-271ee88df318",
      "price": 272.9,
      "size": 18
    }
  ],
  "bids": [
    {
      "id": "100d5004-f4e0-4e92-a571-392403d5b073",
      "price": 272.83,
      "size": 18
    },
    {
      "id": "0889cf06-4a9d-4519-98e6-fac5dcb7afbf",
      "price": 272.83,
      "size": 0.64185083
    }
  ]
}

application/json

Schema

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.

asks nullable

The asks made by market makers.

bids nullable

The bids made by market makers.

Example (from schema)

{
  "symbol_id": "string",
  "time_exchange": "2024-11-12T12:17:30.492Z",
  "time_coinapi": "2024-11-12T12:17:30.492Z"
}

Example response

{
  "symbol_id": "COINBASE_SPOT_BCH_USD",
  "time_exchange": "2020-08-27T10:28:35.6111130Z",
  "time_coinapi": "2020-08-27T10:28:35.6766461Z",
  "asks": [
    {
      "id": "3c5e789c-4c84-448a-9c5d-50532ea1ccbb",
      "price": 272.89,
      "size": 1
    },
    {
      "id": "c64a76ba-5107-4c1b-b788-271ee88df318",
      "price": 272.9,
      "size": 18
    }
  ],
  "bids": [
    {
      "id": "100d5004-f4e0-4e92-a571-392403d5b073",
      "price": 272.83,
      "size": 18
    },
    {
      "id": "0889cf06-4a9d-4519-98e6-fac5dcb7afbf",
      "price": 272.83,
      "size": 0.64185083
    }
  ]
}

text/json

Schema

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.

asks nullable

The asks made by market makers.

bids nullable

The bids made by market makers.

Example (from schema)

{
  "symbol_id": "string",
  "time_exchange": "2024-11-12T12:17:30.493Z",
  "time_coinapi": "2024-11-12T12:17:30.493Z"
}

Example response

{
  "symbol_id": "COINBASE_SPOT_BCH_USD",
  "time_exchange": "2020-08-27T10:28:35.6111130Z",
  "time_coinapi": "2020-08-27T10:28:35.6766461Z",
  "asks": [
    {
      "id": "3c5e789c-4c84-448a-9c5d-50532ea1ccbb",
      "price": 272.89,
      "size": 1
    },
    {
      "id": "c64a76ba-5107-4c1b-b788-271ee88df318",
      "price": 272.9,
      "size": 18
    }
  ],
  "bids": [
    {
      "id": "100d5004-f4e0-4e92-a571-392403d5b073",
      "price": 272.83,
      "size": 18
    },
    {
      "id": "0889cf06-4a9d-4519-98e6-fac5dcb7afbf",
      "price": 272.83,
      "size": 0.64185083
    }
  ]
}

application/x-msgpack

Schema

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.

asks nullable

The asks made by market makers.

bids nullable

The bids made by market makers.

Example (from schema)

{
  "symbol_id": "string",
  "time_exchange": "2024-11-12T12:17:30.493Z",
  "time_coinapi": "2024-11-12T12:17:30.493Z"
}

Example response

{
  "symbol_id": "COINBASE_SPOT_BCH_USD",
  "time_exchange": "2020-08-27T10:28:35.6111130Z",
  "time_coinapi": "2020-08-27T10:28:35.6766461Z",
  "asks": [
    {
      "id": "3c5e789c-4c84-448a-9c5d-50532ea1ccbb",
      "price": 272.89,
      "size": 1
    },
    {
      "id": "c64a76ba-5107-4c1b-b788-271ee88df318",
      "price": 272.9,
      "size": 18
    }
  ],
  "bids": [
    {
      "id": "100d5004-f4e0-4e92-a571-392403d5b073",
      "price": 272.83,
      "size": 18
    },
    {
      "id": "0889cf06-4a9d-4519-98e6-fac5dcb7afbf",
      "price": 272.83,
      "size": 0.64185083
    }
  ]
}

Loading...

Was this section helpful?

• 1
• 2
• 3
• 4
• 5