> ## 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.

# List order books

> Returns one order book per GPU type, sale type (spot or on-demand) and location, with its best ask and best bid. A location is a region slug such as us-east-11; the book with region any holds bids that take any location. Asks show what a buyer pays and bids show what a seller receives, so both already account for Ornn's fees. Prices are integer micro-USD per GPU-hour. Open to every member of your organization.

CLI equivalent: `ornn market books`. See [Rent GPUs on Spot](/guides/pay-as-you-go.md#use-the-api) for the complete bid flow.


## OpenAPI

````yaml openapi.yaml GET /v1/markets/books
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:
    get:
      tags:
        - Order books
      summary: List order books
      description: >-
        Returns one order book per GPU type, sale type (spot or on-demand) and
        location, with its best ask and best bid. A location is a region slug
        such as us-east-11; the book with region any holds bids that take any
        location. Asks show what a buyer pays and bids show what a seller
        receives, so both already account for Ornn's fees. Prices are integer
        micro-USD per GPU-hour. Open to every member of your organization.
      operationId: capacityListBooks
      parameters:
        - name: gpuSlug
          in: query
          required: false
          description: Only books for this catalog GPU slug.
          schema:
            type: string
          example: nvidia_h100_sxm
        - name: saleType
          in: query
          required: false
          description: Only books of this sale type.
          schema:
            type: string
            enum:
              - spot
              - on-demand
          example: spot
        - name: region
          in: query
          required: false
          description: >-
            Only books at this region slug, or any for the books of bids at any
            location.
          schema:
            type: string
          example: us-east-11
      responses:
        '200':
          description: Order books by GPU type, sale type and location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityMarketBookList'
              example:
                orderBooks:
                  - gpuSlug: nvidia_h100_sxm
                    saleType: spot
                    region: us-east-11
                    orderBookId: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb
                    bestAskPricePerGpuHourMicroUsd: 2650000
                    bestBidPricePerGpuHourMicroUsd: 2300000
                  - gpuSlug: nvidia_h100_sxm
                    saleType: spot
                    region: any
                    orderBookId: cccccccc-cccc-4ccc-8ccc-cccccccccccc
                    bestAskPricePerGpuHourMicroUsd: null
                    bestBidPricePerGpuHourMicroUsd: 2400000
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    CapacityMarketBookList:
      type: object
      required:
        - orderBooks
      properties:
        orderBooks:
          type: array
          items:
            $ref: '#/components/schemas/CapacityMarketBook'
    CapacityMarketBook:
      type: object
      required:
        - gpuSlug
        - saleType
        - region
        - orderBookId
      properties:
        gpuSlug:
          type: string
          description: Catalog GPU slug of the book.
        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
          description: >-
            The book's region slug, for example us-east-11, or any for the book
            of bids that take any location.
        orderBookId:
          type: string
          format: uuid
        bestAskPricePerGpuHourMicroUsd:
          type:
            - integer
            - 'null'
          format: int64
          description: Lowest ask, as a buyer pays it (fees included).
        bestBidPricePerGpuHourMicroUsd:
          type:
            - integer
            - 'null'
          format: int64
          description: Highest bid, as a seller receives it (fees removed).
    Error:
      type: object
      properties:
        code:
          type: string
        detail:
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
  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.