Read Book
Request and response reference for GET /v1/exchange/markets/{market}/book.
/v1/exchange/markets/{market}/bookRequest
This interface uses an approved institutional session, not a financial API key. Session writes also need Origin and CSRF protection. Use the JavaScript sample within an authorized browser integration.
curl -X GET "$OSAI_CONSOLE_BASE_URL/v1/exchange/markets/$MARKET_ID/book" \
-H "Origin: $OSAI_APP_ORIGIN" \
--cookie "$OSAI_SESSION_COOKIE_FILE"Parameters
| Name | Location | Requirement | Description |
|---|---|---|---|
market | path · string | Required | Use the value defined for this resource. |
Request body
This operation does not define a JSON request body.
Responses
Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.
200 · HTTP 200 response
| Field | Type | Description & constraints |
|---|---|---|
market_idRequired in parent object | string | Defined by the resource contract. |
market_versionRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
pairRequired in parent object | string | Defined by the resource contract. |
sequenceRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
price_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
quantity_scaleRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
source_timestampRequired in parent object | string | nulldate-time | Defined by the resource contract. |
bidsRequired in parent object | array | Defined by the resource contract. |
bids[].price_scaledRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
bids[].quantity_scaledRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
asksRequired in parent object | array | Defined by the resource contract. |
asks[].price_scaledRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
asks[].quantity_scaledRequired in parent object | string | Exact nonnegative base-10 integer; never a JSON number.Pattern: ^(0|[1-9][0-9]*)$ |
400 · Invalid bounded instruction
No client body fields are defined for this response.
401 · Authentication required
No client body fields are defined for this response.
403 · Permission, recent verified MFA or CSRF denied
No client body fields are defined for this response.
409 · Version, preview, instruction or capacity conflict
No client body fields are defined for this response.
503 · Unavailable or unknown commit outcome; query the original command before retrying
No client body fields are defined for this response.
Retries & recovery
Keep the original request identifiers and any required idempotency key. A timeout does not establish failure. Read the original resource or command before another financial write; use expected versions for concurrent changes.