Error
A valid request URL is required to generate request examples{
"version": "external-book-snapshot/v1",
"marketId": "<string>",
"snapshotSequence": 1,
"readModelDigest": "<string>",
"bids": [
{
"priceAtoms": "<string>",
"price": "<string>",
"sizeAtoms": "<string>",
"size": "<string>"
}
],
"asks": [
{
"priceAtoms": "<string>",
"price": "<string>",
"sizeAtoms": "<string>",
"size": "<string>"
}
],
"checksum": "<string>",
"resync": {
"stream": "market.book",
"fromSequence": 123
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}Markets
Get the order book
Returns the current order-book snapshot (aggregated levels) for a market.
Method and path: GET /v1/markets//book
Authentication: none.
Request schema: none.
Response schema: ExternalBookSnapshotResponse.
Error envelope: ExternalRestError (external-rest-error/v1).
GET
/
v1
/
markets
/
{marketId}
/
book
Error
A valid request URL is required to generate request examples{
"version": "external-book-snapshot/v1",
"marketId": "<string>",
"snapshotSequence": 1,
"readModelDigest": "<string>",
"bids": [
{
"priceAtoms": "<string>",
"price": "<string>",
"sizeAtoms": "<string>",
"size": "<string>"
}
],
"asks": [
{
"priceAtoms": "<string>",
"price": "<string>",
"sizeAtoms": "<string>",
"size": "<string>"
}
],
"checksum": "<string>",
"resync": {
"stream": "market.book",
"fromSequence": 123
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid"
}Path Parameters
Minimum string length:
1Response
Success
Allowed value:
"external-book-snapshot/v1"Minimum string length:
1Required range:
x >= 0Covers the book content published here -- marketId, snapshotSequence, bids and asks. Recomputable by a client from this payload.
Pattern:
^sha256:[0-9a-f]{64}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^sha256:[0-9a-f]{64}$Show child attributes
Show child attributes