Catalog

Get the order book

Keytrading trading::read
Throttleread
Cost1 /request
Answers<span class="st st-ok">200</span> <span class="st st-info">304</span> <span class="st st-warn">400</span> <span class="st st-warn">401</span> <span class="st st-warn">403</span> <span class="st st-warn">404</span> <span class="st st-hold">423</span> <span class="st st-hold">429</span> <span class="st st-warn">451</span>
Idempotenttrue

Also served without a signature at GET /v3/public/catalog/markets/{id}/book. The edge throttles it per IP.

get/v3/catalog/markets/{id}/book

Request

  • Base URL: https://api.paper.novig.com
  • URL: https://api.paper.novig.com/v3/catalog/markets/{id}/book
  • Auth: API key in header Novig-Key-Id and API key in header Novig-Signature and API key in header Novig-Timestamp

Path parameters

idstring uuid required

Market ID.

Query parameters

depthinteger

Number of price levels per outcome, best price first. Every order at a kept level is included. Defaults to 20. 1 to 20. A value outside that range answers 400.

Headers

If-None-Matchstring nullable

A prior response's ETag. A match answers 304.

Response

Resting orders by outcome.

marketIdstring uuid required
ordersobject required

Resting orders by outcome ID, best price first, earlier order first within a price. Limited to depth price levels per outcome.

seqinteger required

The book's sequence number at this snapshot. The next book delta on the websocket follows it.

Changes

No recorded changes to this operation across all 1 revision of this API.