Order Book

GET 
/marketdata/api/v1/orderbook/:symbol

Retrieves order book data for a specific market (ticker).

Request

Path Parameters

symbol stringrequired

Market pair like btc_usdc

Query Parameters

depth int32

Default value: 300

Order book depth, default and max value is 300

Responses

200

Success

text/plain

Schema

Schema

bids

object[]

nullable

List of bid orders

Array [

price double

The order price.

amount double

The order amount.

]

asks

object[]

nullable

List of ask orders

Array [

price double

The order price.

amount double

The order amount.

]

timestamp date-time

The timestamp of when the order book data was retrieved.

version int64

The version of the order book data.

Example (from schema)

{
  "bids": [
    {
      "price": 0,
      "amount": 0
    }
  ],
  "asks": [
    {
      "price": 0,
      "amount": 0
    }
  ],
  "timestamp": "2024-05-14T08:03:09.478Z",
  "version": 0
}

Example

{
  "bids": [
    {
      "price": 58000.28,
      "amount": 1.4
    },
    {
      "price": 58000.2,
      "amount": 8
    },
    {
      "price": 58000.1,
      "amount": 20
    }
  ],
  "asks": [
    {
      "price": 58000.4,
      "amount": 10
    },
    {
      "price": 58000.38,
      "amount": 4
    },
    {
      "price": 58000.3,
      "amount": 0.6
    }
  ],
  "timestamp": "2024-05-14T08:03:04.2632866Z",
  "version": 8
}

application/json

Schema

Schema

bids

object[]

nullable

List of bid orders

Array [

price double

The order price.

amount double

The order amount.

]

asks

object[]

nullable

List of ask orders

Array [

price double

The order price.

amount double

The order amount.

]

timestamp date-time

The timestamp of when the order book data was retrieved.

version int64

The version of the order book data.

Example (from schema)

{
  "bids": [
    {
      "price": 0,
      "amount": 0
    }
  ],
  "asks": [
    {
      "price": 0,
      "amount": 0
    }
  ],
  "timestamp": "2024-05-14T08:03:09.479Z",
  "version": 0
}

Example

{
  "bids": [
    {
      "price": 58000.28,
      "amount": 1.4
    },
    {
      "price": 58000.2,
      "amount": 8
    },
    {
      "price": 58000.1,
      "amount": 20
    }
  ],
  "asks": [
    {
      "price": 58000.4,
      "amount": 10
    },
    {
      "price": 58000.38,
      "amount": 4
    },
    {
      "price": 58000.3,
      "amount": 0.6
    }
  ],
  "timestamp": "2024-05-14T08:03:04.2632866Z",
  "version": 8
}

text/json

Schema

Schema

bids

object[]

nullable

List of bid orders

Array [

price double

The order price.

amount double

The order amount.

]

asks

object[]

nullable

List of ask orders

Array [

price double

The order price.

amount double

The order amount.

]

timestamp date-time

The timestamp of when the order book data was retrieved.

version int64

The version of the order book data.

Example (from schema)

{
  "bids": [
    {
      "price": 0,
      "amount": 0
    }
  ],
  "asks": [
    {
      "price": 0,
      "amount": 0
    }
  ],
  "timestamp": "2024-05-14T08:03:09.480Z",
  "version": 0
}

Example

{
  "bids": [
    {
      "price": 58000.28,
      "amount": 1.4
    },
    {
      "price": 58000.2,
      "amount": 8
    },
    {
      "price": 58000.1,
      "amount": 20
    }
  ],
  "asks": [
    {
      "price": 58000.4,
      "amount": 10
    },
    {
      "price": 58000.38,
      "amount": 4
    },
    {
      "price": 58000.3,
      "amount": 0.6
    }
  ],
  "timestamp": "2024-05-14T08:03:04.2632866Z",
  "version": 8
}

Loading...