Skip to main content
GET
Returns every stock order book on your instance, followed by every book you have imported from another instance. The list is filtered to tokenType: STOCK_TOKEN, so an off-chain book created without an explicit tokenType will not appear here. Owned books are ordered newest first. Imported books carry two extra fields, _imported and _importId, which owned books do not have. _importId is what Remove Import takes.

Query Parameters

string
Restrict to one status: ACTIVE, PAUSED or CLOSED. Applies to owned and imported books alike. Omit for all statuses.

Response Fields

data is an array of order book records. Each entry carries the same fields as Get Order Book, plus:
boolean
Present and true only on imported books.
string
Present only on imported books. Pass it to Remove Import.

Error Codes