> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ornn.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get order book depth

> Returns aggregated depth for one GPU type and sale type: whole nodes and order counts at each price level, up to 50 levels per side. Ask levels also count their GPUs; a bid takes nodes of any size, so bid levels have none. With a region, asks are that location's and bids include those that take any location; without one, depth spans every location. Depth never identifies who placed an order.

CLI equivalent: `ornn market book --gpu-slug <gpu-slug>`.


## OpenAPI

````yaml openapi.yaml GET /v1/markets/books/{gpuSlug}
openapi: 3.1.0
info:
  title: Ornn compute API
  version: 1.0.0
  description: >-
    Customer HTTP API for Ornn GPU capacity. It covers reserved capacity and
    nodes, VM and Bare Metal access, Kubernetes and Slurm clusters, SSH keys,
    storage volumes and GitHub repositories, private networks, monitoring,
    buying and selling capacity (Reserve, Market, order books, and Relist), and
    billing. API keys are scoped to one organization and act with their
    creator's access there; account, team, and API-key management stay in the
    console. Most operations require an approved organization. See
    https://docs.ornn.com/api-keys to create a key and
    https://docs.ornn.com/guides/kubernetes-api for an end-to-end Kubernetes
    integration. Examples use fictional IDs and credentials. The info.version
    field identifies the contract revision, not a shared API path version.
  contact:
    email: support@ornn.com
servers:
  - url: https://api.ornn.com
    description: Production
security:
  - OrnnApiKey: []
tags:
  - name: Authentication
  - name: Reservations
  - name: GPU nodes
  - name: Clusters
  - name: Workers
  - name: Virtual machines
    description: >-
      Choose a VM disk, launch VM access on a reservation, and read each VM's
      status, launch progress, and SSH connection details.
  - name: Bare Metal
    description: >-
      Launch Bare Metal access on a reservation, read a host's readiness and SSH
      connection details, and reboot or hard reset it.
  - name: SSH keys
    description: >-
      Register public keys for your organization, choose which keys a VM or Bare
      Metal reservation uses, and queue key delivery to machines. Slurm clusters
      take organization key IDs at launch. Kubernetes API access does not use
      SSH keys.
  - name: Reserve
    description: >-
      Browse reserved-capacity listings and their terms, and post, cancel, or
      accept offers. Reserve listings are visible to approved organizations.
  - name: Market
    description: >-
      Browse relisted capacity and buy windows at the asking price, paid up
      front. Open to every member of your organization.
  - name: Order books
    description: >-
      Hourly order books for whole nodes, one VM per node: read books, trades,
      and quotes, place and cancel bids, and follow and end fills.
  - name: Relist
    description: >-
      Sell whole nodes from a reservation you hold at your asking price, and
      manage those listings.
  - name: Storage
    description: >-
      Managed volumes, their files, and GitHub repository pulls. Volumes belong
      to the API key's creator in the key's organization.
  - name: Networks
    description: >-
      Organization private networks and the WireGuard configs you use to reach
      private machines and clusters.
  - name: Monitoring
    description: >-
      Machine telemetry and console logs for capacity your organization holds.
      Reads are limited to your reservation window.
  - name: Billing
    description: >-
      Invoices, billing summary, usage cost, Ornn credits, and account
      statements. Saving a card and paying invoices stay in the console.
externalDocs:
  description: REST integration walkthrough
  url: >-
    https://docs.ornn.com/guides/kubernetes-access#provision-and-manage-through-rest
paths:
  /v1/markets/books/{gpuSlug}:
    get:
      tags:
        - Order books
      summary: Get order book depth
      description: >-
        Returns aggregated depth for one GPU type and sale type: whole nodes and
        order counts at each price level, up to 50 levels per side. Ask levels
        also count their GPUs; a bid takes nodes of any size, so bid levels have
        none. With a region, asks are that location's and bids include those
        that take any location; without one, depth spans every location. Depth
        never identifies who placed an order.
      operationId: capacityGetBook
      parameters:
        - name: gpuSlug
          in: path
          required: true
          description: Catalog GPU slug of the order book, from List order books.
          schema:
            type: string
          example: nvidia_h100_sxm
        - name: saleType
          in: query
          required: false
          description: >-
            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.
          schema:
            type: string
            enum:
              - spot
              - on-demand
            default: spot
          example: spot
        - name: region
          in: query
          required: false
          description: >-
            A region with an order book, for example us-east-11 (see GET
            /v1/markets/books). Omit for every location.
          schema:
            type: string
          example: us-east-11
      responses:
        '200':
          description: Order book depth.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityMarketDepth'
              example:
                gpuSlug: nvidia_h100_sxm
                saleType: spot
                region: us-east-11
                orderBookId: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb
                asks:
                  - pricePerGpuHourMicroUsd: 2650000
                    nodes: 2
                    gpus: 16
                    orders: 2
                  - pricePerGpuHourMicroUsd: 2900000
                    nodes: 1
                    gpus: 8
                    orders: 1
                bids:
                  - pricePerGpuHourMicroUsd: 2300000
                    nodes: 3
                    gpus: null
                    orders: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: There is no order book for that GPU slug.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: order_book_not_found
                  message: There is no order book for that GPU type.
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    CapacityMarketDepth:
      type: object
      required:
        - gpuSlug
        - saleType
        - region
        - orderBookId
        - asks
        - bids
      properties:
        gpuSlug:
          type: string
        saleType:
          type: string
          enum:
            - spot
            - on-demand
          description: >-
            spot: a reservation on the node can end the VM. on-demand: only a
            stop or the listing's end ends it.
        region:
          type:
            - string
            - 'null'
          description: The location the depth is for; null when it spans every location.
        orderBookId:
          type:
            - string
            - 'null'
          format: uuid
          description: The location's book; null when locations are combined.
        asks:
          type: array
          description: Up to 50 ask levels, lowest price first.
          items:
            $ref: '#/components/schemas/CapacityMarketLevel'
        bids:
          type: array
          description: Up to 50 bid levels, highest price first.
          items:
            $ref: '#/components/schemas/CapacityMarketLevel'
    Error:
      type: object
      properties:
        code:
          type: string
        detail:
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
    CapacityMarketLevel:
      type: object
      required:
        - pricePerGpuHourMicroUsd
        - nodes
        - gpus
        - orders
      properties:
        pricePerGpuHourMicroUsd:
          type: integer
          format: int64
          description: Asks show what a buyer pays; bids show what a seller receives.
        nodes:
          type: integer
          description: Whole nodes resting at this price.
        gpus:
          type:
            - integer
            - 'null'
          description: >-
            GPUs on the ask nodes resting at this price; null for bids, which
            take nodes of any size.
        orders:
          type: integer
          description: Orders resting at this price.
  responses:
    Unauthorized:
      description: >-
        The credential is missing, invalid, revoked, or no longer belongs to a
        current organization member. Check the HTTP status before parsing the
        body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The credential lacks access to this operation, or the organization
        requires approval. An API key does not bypass these checks.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: >-
        Unsuccessful request. Check HTTP status first. Errors may have
        detail.code/detail.message, a string detail and optional top-level code,
        or an empty/non-JSON body. 401: invalid credential; 403: access or
        approval required; 404: not visible or credentials not ready; 409:
        lifecycle conflict; 429: back off; 5xx: service failure. Inspect current
        state before retrying mutations.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    OrnnApiKey:
      type: http
      scheme: bearer
      bearerFormat: ornn_sk_...
      description: >-
        Create an organization API key in Account Settings > Developer. Do not
        send this key to the Kubernetes API server.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.