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

# Get Event OrderBook Snapshot

> Get the orderbook snapshot for a specific event



## OpenAPI

````yaml /swagger.json get /data/events/{id}/orderbook
openapi: 3.0.1
info:
  contact: {}
  title: VoxFi API
  version: 0.0.1
servers:
  - url: https://data-api-dev.voxfi.com.br/v1
security: []
paths:
  /data/events/{id}/orderbook:
    get:
      tags:
        - data
      summary: Get Event OrderBook Snapshot
      description: Get the orderbook snapshot for a specific event
      parameters:
        - name: x-api-key
          in: header
          description: API Key
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: Event ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.SwaggerEventOrderBookSnapshot'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    models.SwaggerEventOrderBookSnapshot:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/models.OrderBookSnapshot'
    models.OrderBookSnapshot:
      type: object
      properties:
        chance:
          type: integer
          description: chance of YES in percentage (0-100)
        liquidity:
          type: integer
          description: total contracts available in orderbook
        market_price_no:
          type: integer
          description: market price for NO in ticks (0-100)
        market_price_yes:
          type: integer
          description: market price for YES in ticks (0-100)
        no_orderbook:
          $ref: '#/components/schemas/models.OrderBookSnapshotOption'
        volume:
          type: integer
          description: total contracts created (historical trades)
        yes_orderbook:
          $ref: '#/components/schemas/models.OrderBookSnapshotOption'
    models.OrderBookSnapshotOption:
      type: object
      properties:
        asks:
          type: array
          items:
            $ref: '#/components/schemas/models.PriceLevel'
        bids:
          type: array
          items:
            $ref: '#/components/schemas/models.PriceLevel'
        last_price:
          type: integer
          description: price of last executed trade in ticks (null if no trades)
        outcome:
          type: string
        spread:
          type: integer
          description: >-
            spread between best ask and best bid in ticks (null if no spread
            available)
    models.PriceLevel:
      type: object
      properties:
        order_count:
          type: integer
        price_ticks:
          type: integer
        quantity:
          type: integer

````