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

# Get order book

> Aggregated price levels, best first on both sides, with your share of each level.

Guide: [Order book](/market-makers/market-data#order-book).



## OpenAPI

````yaml /api-reference/openapi.json get /mm/v1/markets/{instrumentId}/orderbook
openapi: 3.1.0
info:
  title: D1 Market Maker API
  version: mm/v1
  description: >-
    API for authorized market makers: market data, account state, order
    placement and cancellation, fills and sequenced executions. Read endpoints
    require the mm:read scope; trading endpoints require mm:trade.
servers:
  - url: '{D1_API_URL}'
    description: Base URL provided by D1 during onboarding.
    variables:
      D1_API_URL:
        default: $D1_API_URL
        description: Provided by D1 during onboarding.
security:
  - bearerAuth:
      - mm:read
tags:
  - name: Status
  - name: Market data
  - name: Account
  - name: Orders
  - name: Trading
  - name: Executions
paths:
  /mm/v1/markets/{instrumentId}/orderbook:
    get:
      tags:
        - Market data
      summary: Get order book
      description: >-
        Aggregated price levels, best first on both sides, with your share of
        each level.


        Guide: [Order book](/market-makers/market-data#order-book).
      operationId: getOrderBook
      parameters:
        - name: instrumentId
          in: path
          required: true
          schema:
            type: string
          description: Market identifier from /mm/v1/markets.
        - name: depth
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
          description: Price levels per side, 1–50.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  instrumentId:
                    type: string
                  status:
                    $ref: '#/components/schemas/MarketStatus'
                  tradingPaused:
                    type: boolean
                  depth:
                    type: integer
                  bids:
                    type: array
                    items:
                      $ref: '#/components/schemas/BookLevel'
                    description: Highest price first.
                  asks:
                    type: array
                    items:
                      $ref: '#/components/schemas/BookLevel'
                    description: Lowest price first.
                  truncated:
                    type: boolean
                    description: More book exists than shown.
                  serverTimeMs:
                    type: string
                    description: >-
                      D1 server time at the read, Unix milliseconds, as a
                      decimal string.
                    example: '1800000000000'
                required:
                  - instrumentId
                  - status
                  - tradingPaused
                  - depth
                  - bids
                  - asks
                  - truncated
                  - serverTimeMs
              example:
                instrumentId: <instrument-id>
                status: ACTIVE
                tradingPaused: false
                depth: 20
                bids:
                  - price:
                      units: '105'
                      decimals: 0
                    quantity:
                      units: '12'
                      decimals: 0
                    ownQuantity:
                      units: '0'
                      decimals: 0
                    partial: false
                asks:
                  - price:
                      units: '110'
                      decimals: 0
                    quantity:
                      units: '8'
                      decimals: 0
                    ownQuantity:
                      units: '3'
                      decimals: 0
                    partial: false
                truncated: false
                serverTimeMs: '1800000000456'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/Internal'
components:
  schemas:
    MarketStatus:
      type: string
      description: Market lifecycle status.
      enum:
        - ACTIVE
        - TRADING_CLOSED
        - EXPIRING
        - SETTLED
    BookLevel:
      type: object
      properties:
        price:
          $ref: '#/components/schemas/Exact'
        quantity:
          $ref: '#/components/schemas/Exact'
          description: >-
            Total resting quantity at this price. A lower bound when partial is
            true.
        ownQuantity:
          $ref: '#/components/schemas/Exact'
          description: >-
            Your share of quantity. Zero if none. A lower bound when partial is
            true.
        partial:
          type: boolean
          description: >-
            True on the one level where D1's read bound was reached; its
            quantities are lower bounds.
      required:
        - price
        - quantity
        - ownQuantity
        - partial
    Exact:
      type: object
      properties:
        units:
          type: string
          description: >-
            Integer value as a decimal string. May be negative. May exceed 2^53
            − 1: parse with BigInt or a decimal library, never Number.
          example: '105000123456'
        decimals:
          type: integer
          minimum: 0
          description: Scale. value = units × 10^-decimals.
          example: 6
      required:
        - units
        - decimals
      description: Exact fixed-point number. value = units × 10^-decimals.
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable error code.
          enum:
            - AUTH_REQUIRED
            - INVALID_API_KEY
            - API_KEY_REVOKED
            - DEALER_SUSPENDED
            - INSUFFICIENT_SCOPE
            - MALFORMED_REQUEST
            - INVALID_CURSOR
            - NOT_FOUND
            - RATE_LIMITED
            - INTERNAL
            - TRADING_DISABLED
            - UNKNOWN_INSTRUMENT
            - MARKET_NOT_TRADING
            - MARKET_PAUSED
            - INVALID_PRICE
            - INVALID_QUANTITY
            - IDEMPOTENCY_CONFLICT
            - INSUFFICIENT_FUNDS
            - INSUFFICIENT_POSITION
            - RISK_LIMIT
            - ORDER_NOT_FOUND
            - ORDER_NOT_CANCELLABLE
        message:
          type: string
          description: Human-readable message. Do not parse.
        limit:
          type: string
          enum:
            - MAX_OPEN_EXPOSURE
            - MAX_RESTING_ORDERS
            - MAX_RESTING_ORDERS_PER_INSTRUMENT
          description: >-
            Present only when error is RISK_LIMIT: the limit the order would
            exceed.
      required:
        - error
        - message
  responses:
    BadRequest:
      description: MALFORMED_REQUEST or INVALID_CURSOR.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: MALFORMED_REQUEST
            message: …
    Unauthorized:
      description: AUTH_REQUIRED, INVALID_API_KEY or API_KEY_REVOKED.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: INVALID_API_KEY
            message: …
    Forbidden:
      description: DEALER_SUSPENDED or INSUFFICIENT_SCOPE.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: INSUFFICIENT_SCOPE
            message: …
    NotFound:
      description: NOT_FOUND.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: NOT_FOUND
            message: …
    RateLimited:
      description: >-
        RATE_LIMITED: not admitted. Wait Retry-After seconds, then retry the
        same request.
      headers:
        Retry-After:
          description: Seconds until the rate-limit window ends (at least 1).
          schema:
            type: integer
            minimum: 1
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: RATE_LIMITED
            message: Too many requests. Retry after the indicated delay.
    Internal:
      description: INTERNAL. Retry with backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: INTERNAL
            message: …
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authorization: Bearer <your-api-key>. Scopes: mm:read (GET endpoints),
        mm:trade (POST endpoints).

````

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