Skip to main content
GET
Get order book depth
CLI equivalent: ornn market book --gpu-slug <gpu-slug>.

Authorizations

Authorization
string
header
required

Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server.

Path Parameters

gpuSlug
string
required

Catalog GPU slug of the order book, from List order books.

Query Parameters

saleType
enum<string>
default:spot

spot (the default): a reservation on the node can end the VM. on-demand: only you, the seller or the listing's end ends it.

Available options:
spot,
on-demand
region
string

A region with an order book, for example us-east-11 (see GET /v1/markets/books). Omit for every location.

Response

Order book depth.

gpuSlug
string
required
saleType
enum<string>
required

spot: a reservation on the node can end the VM. on-demand: only a stop or the listing's end ends it.

Available options:
spot,
on-demand
region
string | null
required

The location the depth is for; null when it spans every location.

orderBookId
string<uuid> | null
required

The location's book; null when locations are combined.

asks
object[]
required

Up to 50 ask levels, lowest price first.

bids
object[]
required

Up to 50 bid levels, highest price first.