Data

GET 
/api/v1/orderbook

Fetch the latest orderbook for symbol from given exchange.

Request

Query Parameters

exchange stringrequired
Specifes exchange
Example: binance
symbol stringrequired
Specifies symbol
Example: BTC-USDT

Header Parameters

X-DTMX-APIKEY stringrequired

Your DataMaxi+ API key

Responses

200

OK

application/json

Schema

Schema

• Array [

as

object[]

list of asks (sell)

Array [

P number

price of orderbook entry

Example: 42000

v number

volume of orderbook entry

Example: 1000

]

b string
specifies the base token
Example: BTC

bs

object[]

list of bids (buy)

Array [

P number

price of orderbook entry

Example: 42000

v number

volume of orderbook entry

Example: 1000

]

d integer
specifies the date and the time in UTC milliseconds
Example: 1632960000000
e string
specifies the exchange name
Example: binance
q string
specifies the quote token
Example: USDT
s string
specifies the symbol (base-quote)
Example: BTC-USDT

• ]

Example (from schema)

[
  {
    "as": [
      {
        "P": 42000,
        "v": 1000
      }
    ],
    "b": "BTC",
    "bs": [
      {
        "P": 42000,
        "v": 1000
      }
    ],
    "d": 1632960000000,
    "e": "binance",
    "q": "USDT",
    "s": "BTC-USDT"
  }
]

400

Bad Request

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

Loading...