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

# Get order book

> Get the order book for a specific instrument.



## OpenAPI

````yaml https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json?mintlify-view=derivatives get /v1/orderbooks/{asset_type}/{symbol}
openapi: 3.1.0
info:
  title: PWS Public API
  version: '1'
  description: >-
    Integrate with Payward Services to onboard users, manage accounts and funds,
    trade assets, and receive event notifications.
  contact:
    name: Payward Services
servers:
  - url: https://api.sandbox.services.payward.com
security: []
tags:
  - name: Assets
    description: List the assets PWS is willing to swap.
    x-displayName: Assets
  - name: Conversions
    description: >-
      Rule-driven and on-demand fiat ↔ crypto value movement, including
      conversion rules and deposits.
    x-displayName: Conversions
  - name: Auto Earn
    description: >-
      Manage Auto Earn preferences and retrieve allocation and reward
      information.
    x-displayName: Auto Earn
  - name: Bonded Earn
    description: >-
      Allocate funds to and deallocate funds from bonded earn strategies, review
      allocations, and track request status.
    x-displayName: Bonded Earn
  - name: Funding
    description: >-
      Discover deposit and withdrawal options, manage deposit addresses, and
      move funds between accounts.
    x-displayName: Funding
  - name: Derivatives transfers
    description: >-
      Move funds between an account's spot balance and the same owner's futures
      balance.
    x-displayName: Derivatives transfers
  - name: Portfolio
    description: 'Inspect a customer''s portfolio: balances, valuations, and transactions.'
    x-displayName: Portfolio
  - name: Ramp
    description: >-
      Support Ramp flows with discovery, quotes, limits, and hosted checkout
      experiences.
    x-displayName: Ramp
  - name: Reports
    description: Settlement and reconciliation reports for the partner.
    x-displayName: Reports
  - name: Market data stream
    description: Live market data for derivatives instruments.
    x-displayName: Market data stream
  - name: Derivatives instruments
    description: Discover instruments available for trading by asset type.
    x-displayName: Derivatives instruments
  - name: Derivatives tickers
    x-group: Derivatives market data
    description: Read market-data snapshots for supported trading instruments.
    x-displayName: Derivatives tickers
  - name: Derivatives order books
    x-group: Derivatives market data
    description: Read level-two market depth for supported trading instruments.
    x-displayName: Derivatives order books
  - name: Derivatives OHLC
    x-group: Derivatives market data
    description: Read historical candlestick market data for supported trading instruments.
    x-displayName: Derivatives OHLC
  - name: Derivatives orders
    description: Submit and inspect orders by asset type.
    x-displayName: Derivatives orders
  - name: Derivatives trades
    description: Inspect executions by asset type.
    x-displayName: Derivatives trades
  - name: Derivatives leverage
    description: Read and update per-instrument leverage preferences for trading accounts.
    x-displayName: Derivatives leverage
  - name: Swaps
    description: Account-funded quotes that lock a price until they expire or are executed.
    x-displayName: Swaps
  - name: Onchain quotes
    description: Wallet-funded quotes that return the data needed to settle onchain.
    x-displayName: Onchain quotes
  - name: Price trigger swaps
    description: Swaps that wait for a target price before submitting a trade.
    x-displayName: Price trigger swaps
  - name: Travel Rule verifications
    description: Travel Rule address ownership verification flows.
    x-displayName: Travel Rule verifications
  - name: Users
    description: >-
      User onboarding and status flows that the partner manages.


      - **Create User** provisions an account-owned user from an external
      reference and optional email.

      - **Get User** retrieves the user's profile, verification status, and
      required actions.


      Use the returned user `id` for calls that require the user's identifier.
    x-displayName: Users
  - name: Verifications
    description: Identity verification (KYC) submission and status for end users.
    x-displayName: Verifications
  - name: Webhooks
    description: >-
      Register HTTPS destinations to receive event deliveries, rotate signing
      secrets, and inspect, update, or delete existing subscriptions. Each
      subscription is owned by the authenticated partner; deliveries are signed
      with HMAC-SHA256 and retried on transient failures.


      In webhook payloads, `account_id` and `user_id` are in groups of four
      characters, with a space between the groups. For example, `WCQY T95Y CUL2
      A7NX`. The REST APIs send the same identifier without spaces, for example
      `WCQYT95YCUL2A7NX`. Remove the spaces before you compare a webhook
      identifier with a REST identifier.


      Amounts in webhook payloads are decimal strings, in the ledger precision
      of the asset. Compare amounts as decimal numbers, not as strings.
    x-displayName: Webhooks
paths:
  /v1/orderbooks/{asset_type}/{symbol}:
    servers:
      - url: https://api.sandbox.services.payward.com
    get:
      tags:
        - Derivatives order books
      summary: Get order book
      description: Get the order book for a specific instrument.
      operationId: getOrderBook
      parameters:
        - $ref: '#/components/parameters/TradingOrderBooks_AssetTypePath'
        - $ref: '#/components/parameters/TradingOrderBooks_InstrumentSymbol'
        - $ref: '#/components/parameters/TradingOrderBooks_CountryFilter'
        - $ref: '#/components/parameters/TradingOrderBooks_OrderBookDepth'
      responses:
        '200':
          description: The requested order book.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/TradingOrderBooks_OrderBook'
              examples:
                us-derivatives:
                  value:
                    data:
                      symbol: PBTCUCZ0.BTNL
                      bids:
                        - price: '82205'
                          quantity: '10'
                        - price: '82200'
                          quantity: '10'
                      asks:
                        - price: '83475'
                          quantity: '10'
                        - price: '83480'
                          quantity: '10'
                international-eea-derivatives:
                  value:
                    data:
                      symbol: PF_ETHUSD
                      bids:
                        - price: '2470.1'
                          quantity: '1.96'
                        - price: '2470'
                          quantity: '80'
                      asks:
                        - price: '2472.4'
                          quantity: '11.97'
                        - price: '2472.5'
                          quantity: '38'
                empty-order-book:
                  value:
                    data:
                      symbol: PF_ETHUSD
                      bids: []
                      asks: []
        '400':
          description: >-
            A request parameter is invalid, such as the instrument symbol or
            order book depth.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
              examples:
                invalid-depth:
                  value:
                    error:
                      type: service_error
                      status: 400
                      instance: 4bf92f3577b34da6a3ce929d0e0e4736
                      code: gateway
                invalid-symbol:
                  value:
                    error:
                      type: derivatives_error
                      status: 400
                      instance: 4bf92f3577b34da6a3ce929d0e0e4736
                      code: bad_request
                      causes:
                        - field: symbol
                          message: must match pattern "^\S+$"
        '401':
          description: Authentication failed.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
              examples:
                authentication-failed:
                  $ref: '#/components/examples/spot-derivatives-unauthenticated'
                gateway-authentication-failed:
                  $ref: >-
                    #/components/examples/spot-derivatives-gateway-unauthenticated
        '403':
          description: The caller is not allowed to perform this operation.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
              examples:
                access-denied:
                  $ref: '#/components/examples/spot-derivatives-forbidden'
                gateway-access-denied:
                  $ref: '#/components/examples/spot-derivatives-gateway-forbidden'
        '404':
          description: No matching instrument is available.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TradingOrderBooks_InstrumentNotFoundError'
              examples:
                instrument-not-found:
                  value:
                    error:
                      type: derivatives_error
                      status: 404
                      instance: 4bf92f3577b34da6a3ce929d0e0e4736
                      code: instrument_not_found
                      causes:
                        - field: symbol
                          message: No supported instrument matches the supplied symbol.
        '429':
          description: The request was rate limited.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceExhaustedError'
              examples:
                rate-limit-exceeded:
                  $ref: '#/components/examples/spot-derivatives-resource-exhausted'
        '500':
          description: An unexpected server-side error occurred.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
              examples:
                internal-error:
                  $ref: '#/components/examples/spot-derivatives-internal'
        '503':
          description: Order book data or the service is temporarily unavailable.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: >-
                      #/components/schemas/TradingOrderBooks_MarketDataUnavailableError
                  - $ref: '#/components/schemas/UnavailableError'
                    title: Service unavailable
              examples:
                market-data-unavailable:
                  value:
                    error:
                      type: derivatives_error
                      status: 503
                      instance: 4bf92f3577b34da6a3ce929d0e0e4736
                      code: market_data_unavailable
                      causes:
                        - field: symbol
                          message: >-
                            Current market data is not available for this
                            instrument.
                service-unavailable:
                  $ref: '#/components/examples/spot-derivatives-unavailable'
        '504':
          description: The request deadline elapsed.
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeadlineExceededError'
              examples:
                request-deadline-exceeded:
                  $ref: '#/components/examples/spot-derivatives-deadline-exceeded'
      security:
        - ApiKey: []
          ApiSign: []
          ApiTimestamp: []
      x-codeSamples:
        - lang: bash
          label: US offering
          source: |
            curl --request GET \
              --url 'https://api.sandbox.services.payward.com/v1/orderbooks/perpetual/PBTCUCZ0.BTNL?country=US&depth=2' \
              --header "API-Key: $PWS_API_KEY" \
              --header "API-Timestamp: $PWS_API_TIMESTAMP" \
              --header "API-Sign: $PWS_API_SIGN"
        - lang: bash
          label: International/EEA offering
          source: |
            curl --request GET \
              --url 'https://api.sandbox.services.payward.com/v1/orderbooks/perpetual/PF_ETHUSD?country=DE&depth=2' \
              --header "API-Key: $PWS_API_KEY" \
              --header "API-Timestamp: $PWS_API_TIMESTAMP" \
              --header "API-Sign: $PWS_API_SIGN"
components:
  parameters:
    TradingOrderBooks_AssetTypePath:
      name: asset_type
      in: path
      required: true
      example: perpetual
      schema:
        $ref: '#/components/schemas/TradingOrderBooks_AssetType'
        example: perpetual
    TradingOrderBooks_InstrumentSymbol:
      name: symbol
      in: path
      description: Native market symbol identifying the instrument.
      required: true
      example: PBTCUCZ0.BTNL
      schema:
        type: string
        minLength: 1
        maxLength: 64
        pattern: ^\S+$
        example: PBTCUCZ0.BTNL
    TradingOrderBooks_CountryFilter:
      name: country
      in: query
      description: >-
        ISO 3166-1 alpha-2 country code used to select the derivatives offering.
        `US` and supported US territory codes, such as `PR`, select US
        Derivatives. Other countries select International/EEA Derivatives,
        subject to geographic restrictions.
      required: true
      example: US
      schema:
        type: string
        minLength: 2
        maxLength: 2
        pattern: ^[A-Z]{2}$
        example: US
    TradingOrderBooks_OrderBookDepth:
      name: depth
      in: query
      description: Maximum number of price levels to return on each side.
      example: 20
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        default: 20
        example: 20
  headers:
    TraceId:
      description: Trace identifier for the request. Include it when contacting support.
      schema:
        type: string
        example: 4bf92f3577b34da6a3ce929d0e0e4736
    StrictTransportSecurity:
      description: Enforces HTTPS for the duration specified by `max-age`.
      schema:
        type: string
        example: max-age=31536000; includeSubDomains; preload
    CacheControl:
      description: Prevents caching of sensitive financial data. Always `no-store`.
      schema:
        type: string
        enum:
          - no-store
        example: no-store
  schemas:
    TradingOrderBooks_OrderBook:
      description: L2 order book snapshot for the requested instrument.
      type: object
      required:
        - symbol
        - bids
        - asks
      properties:
        symbol:
          description: Native market symbol identifying the instrument.
          type: string
          example: PBTCUCZ0.BTNL
        bids:
          description: Bid levels ordered from highest to lowest price.
          type: array
          items:
            $ref: '#/components/schemas/TradingOrderBooks_OrderBookLevel'
        asks:
          description: Ask levels ordered from lowest to highest price.
          type: array
          items:
            $ref: '#/components/schemas/TradingOrderBooks_OrderBookLevel'
    BadRequestError:
      title: Bad Request
      description: Request validation failed or the request could not be processed.
      oneOf:
        - title: Bad Request
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          enum:
                            - bad_request
        - title: Gateway
          description: >-
            Gateway-level validation failure returned before the request reaches
            the service.
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          const: gateway
    UnauthenticatedError:
      title: Unauthenticated
      description: Authentication credentials are missing, invalid, or not accepted.
      oneOf:
        - title: Unauthenticated
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          enum:
                            - unauthenticated
        - title: Gateway
          description: Authentication failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          const: gateway
    ForbiddenError:
      title: Forbidden
      description: The caller is not allowed to perform this operation.
      oneOf:
        - title: Forbidden
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          enum:
                            - forbidden
        - title: Gateway
          description: Authorization failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          const: gateway
    TradingOrderBooks_InstrumentNotFoundError:
      title: Instrument not found
      description: No supported instrument matches the supplied symbol.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                    - causes
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 404
                    code:
                      type: string
                      enum:
                        - instrument_not_found
                    causes:
                      type: array
                      minItems: 1
                      maxItems: 1
                      items:
                        $ref: >-
                          #/components/schemas/TradingOrderBooks_DerivativesErrorCause
    ResourceExhaustedError:
      description: The request was rate limited or a resource quota was exhausted.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 429
                    code:
                      type: string
                      enum:
                        - resource_exhausted
    InternalError:
      description: An unexpected server-side error occurred.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 500
                    code:
                      type: string
                      enum:
                        - internal
    TradingOrderBooks_MarketDataUnavailableError:
      title: Market data unavailable
      description: >-
        The instrument is supported, but no current market-data snapshot is
        available.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                    - causes
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 503
                    code:
                      type: string
                      enum:
                        - market_data_unavailable
                    causes:
                      type: array
                      minItems: 1
                      maxItems: 1
                      items:
                        $ref: >-
                          #/components/schemas/TradingOrderBooks_DerivativesErrorCause
    UnavailableError:
      description: The service is temporarily unavailable.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 503
                    code:
                      type: string
                      enum:
                        - unavailable
    DeadlineExceededError:
      description: The request deadline was exceeded before a response could be produced.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 504
                    code:
                      type: string
                      enum:
                        - deadline_exceeded
    TradingOrderBooks_AssetType:
      description: Classification of the trading instrument.
      type: string
      enum:
        - perpetual
    TradingOrderBooks_OrderBookLevel:
      description: Order book price level.
      type: object
      required:
        - price
        - quantity
      properties:
        price:
          $ref: '#/components/schemas/Price'
          description: Price in quote-asset units.
          example: '66285'
        quantity:
          description: >-
            Aggregate quantity at this price, in contracts. See the instrument's
            `contract_size`.
          type: string
          example: '12'
    PwsValidationErrorEnvelope:
      description: Error envelope for request validation failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsValidationError'
          description: Validation error details.
    PwsValidationError:
      description: Standard PWS API error object for request validation failures.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
        causes:
          description: Validation failures that contributed to the error.
          type: array
          items:
            $ref: '#/components/schemas/PwsErrorCause'
    PwsGeneralErrorEnvelope:
      description: Error envelope for operational or domain failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsGeneralError'
          description: General error details.
    PwsGeneralError:
      description: Standard PWS API error object for non-validation failures.
      allOf:
        - $ref: '#/components/schemas/PwsErrorBase'
        - type: object
          properties:
            causes:
              description: Additional error details, when present.
              type: array
              items:
                type: object
                additionalProperties: true
    TradingOrderBooks_DerivativesErrorCause:
      description: One client-actionable detail for a derivatives error.
      type: object
      required:
        - field
        - message
      properties:
        field:
          description: Dot-notation path to the affected request or resource field.
          type: string
        message:
          description: >-
            Human-readable explanation of the condition and safe client
            response.
          type: string
    Price:
      description: >-
        Price of one unit of an asset or instrument in the applicable quote
        units.
      type: string
      minLength: 1
      maxLength: 64
      pattern: ^[0-9]+(\.[0-9]+)?$
    PwsErrorCause:
      description: A single request validation failure.
      type: object
      required:
        - field
        - message
      properties:
        field:
          description: Dot-notation path to the offending request field.
          type: string
        message:
          description: Human-readable explanation of the failed validation rule.
          type: string
    PwsErrorBase:
      description: Common fields present on every PWS API error object.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
  examples:
    spot-derivatives-unauthenticated:
      summary: Authentication required
      value:
        error:
          type: derivatives_error
          status: 401
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: unauthenticated
    spot-derivatives-gateway-unauthenticated:
      summary: Gateway authentication failed
      value:
        error:
          type: service_error
          status: 401
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: gateway
    spot-derivatives-forbidden:
      summary: Access denied
      value:
        error:
          type: derivatives_error
          status: 403
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: forbidden
    spot-derivatives-gateway-forbidden:
      summary: Gateway access denied
      value:
        error:
          type: service_error
          status: 403
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: gateway
    spot-derivatives-resource-exhausted:
      summary: Rate limit exceeded
      value:
        error:
          type: derivatives_error
          status: 429
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: resource_exhausted
    spot-derivatives-internal:
      summary: Internal service error
      value:
        error:
          type: derivatives_error
          status: 500
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: internal
    spot-derivatives-unavailable:
      summary: Service unavailable
      value:
        error:
          type: derivatives_error
          status: 503
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: unavailable
    spot-derivatives-deadline-exceeded:
      summary: Request deadline exceeded
      value:
        error:
          type: derivatives_error
          status: 504
          instance: 4bf92f3577b34da6a3ce929d0e0e4736
          code: deadline_exceeded
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: Your public API key. Identifies the partner making the request.
    ApiSign:
      type: apiKey
      in: header
      name: API-Sign
      description: HMAC signature over the request, computed with your API secret.
    ApiTimestamp:
      type: apiKey
      in: header
      name: API-Timestamp
      description: >-
        Time the request was signed, as Unix milliseconds. Included in the
        request signature. Requests signed too far from the server's time are
        rejected.

````