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

# Livro de Ordens

> Entendendo orderbooks e dados de preço em mercados de previsão

## O que é um Orderbook?

O **Orderbook** (livro de ordens) mostra as ordens de compra e venda atuais para um mercado. Cada mercado possui orderbooks separados para os resultados **YES** e **NO**, permitindo visualizar a profundidade do mercado e a liquidez disponível em diferentes níveis de preço.

### Fonte Principal de Dados de Preço

Além de fornecer o livro de ordens completo, o endpoint de orderbook é **a melhor e mais confiável fonte para obter dados de preço das opções de mercado**. Ele oferece:

* **Preços de mercado atualizados**: `market_price_yes` e `market_price_no` representam os preços de mercado mais recentes;
* **Último preço negociado**: `last_price` em cada orderbook mostra o último preço em que uma transação foi executada;
* **Probabilidade implícita**: O campo `chance` indica a probabilidade percentual implícita pelo mercado;
* **Spread**: A diferença entre o melhor preço de compra (*bid*) e venda (*ask*);
* **Profundidade de mercado**: Visualização completa das ordens pendentes em diferentes níveis de preço;

Esses dados são essenciais para tomar decisões de negociação informadas e entender o sentimento atual do mercado.

## Estrutura do Orderbook

Cada orderbook contém:

* **Bids** (ofertas de compra): Ordens de compradores dispostos a comprar a um determinado preço, ordenadas do maior para o menor preço;
* **Asks** (ofertas de venda): Ordens de vendedores dispostos a vender a um determinado preço, ordenadas do menor para o maior preço;
* **Spread**: Diferença entre o melhor preço de venda (ask) e o melhor preço de compra (bid);
* **Last Price**: Último preço em que uma transação foi executada.

### Dados de Preço do Mercado

Além dos orderbooks individuais para YES e NO, a resposta inclui dados agregados de preço:

* **`market_price_yes`**: Preço de mercado atual para a opção YES (em ticks);
* **`market_price_no`**: Preço de mercado atual para a opção NO (em ticks);
* **`chance`**: Probabilidade percentual implícita pelo mercado (baseada nos preços de mercado);
* **`volume`**: Volume total negociado no mercado (em ticks);
* **`liquidity`**: Liquidez total disponível no mercado (em ticks).

## Obter Orderbook

Recupera o snapshot do orderbook para todos os mercados em um evento. Esta é a **fonte recomendada** para obter dados de preço atualizados e precisos das opções de mercado.

```json theme={null}
{
  "95f88394-4f4d-4489-99dc-8cef9f7682ee": {
    "yes_orderbook": {
      "outcome": "YES",
      "bids": [
        {
          "price_ticks": 39,
          "quantity": 93,
          "order_count": 1
        },
        {
          "price_ticks": 37,
          "quantity": 109,
          "order_count": 1
        },
        {
          "price_ticks": 28,
          "quantity": 18,
          "order_count": 1
        },
        {
          "price_ticks": 26,
          "quantity": 31,
          "order_count": 1
        },
        {
          "price_ticks": 24,
          "quantity": 31,
          "order_count": 1
        },
        {
          "price_ticks": 22,
          "quantity": 154,
          "order_count": 1
        },
        {
          "price_ticks": 20,
          "quantity": 23,
          "order_count": 1
        }
      ],
      "asks": [
        {
          "price_ticks": 57,
          "quantity": 58,
          "order_count": 1
        },
        {
          "price_ticks": 55,
          "quantity": 10,
          "order_count": 1
        },
        {
          "price_ticks": 53,
          "quantity": 95,
          "order_count": 1
        },
        {
          "price_ticks": 51,
          "quantity": 52,
          "order_count": 1
        },
        {
          "price_ticks": 49,
          "quantity": 112,
          "order_count": 1
        },
        {
          "price_ticks": 40,
          "quantity": 47,
          "order_count": 1
        }
      ],
      "spread": 1,
      "last_price": 40
    },
    "no_orderbook": {
      "outcome": "NO",
      "bids": [
        {
          "price_ticks": 60,
          "quantity": 47,
          "order_count": 1
        },
        {
          "price_ticks": 51,
          "quantity": 112,
          "order_count": 1
        },
        {
          "price_ticks": 49,
          "quantity": 52,
          "order_count": 1
        },
        {
          "price_ticks": 47,
          "quantity": 95,
          "order_count": 1
        },
        {
          "price_ticks": 45,
          "quantity": 10,
          "order_count": 1
        },
        {
          "price_ticks": 43,
          "quantity": 58,
          "order_count": 1
        }
      ],
      "asks": [
        {
          "price_ticks": 80,
          "quantity": 23,
          "order_count": 1
        },
        {
          "price_ticks": 78,
          "quantity": 154,
          "order_count": 1
        },
        {
          "price_ticks": 76,
          "quantity": 31,
          "order_count": 1
        },
        {
          "price_ticks": 74,
          "quantity": 31,
          "order_count": 1
        },
        {
          "price_ticks": 72,
          "quantity": 18,
          "order_count": 1
        },
        {
          "price_ticks": 63,
          "quantity": 109,
          "order_count": 1
        },
        {
          "price_ticks": 61,
          "quantity": 93,
          "order_count": 1
        }
      ],
      "spread": 1,
      "last_price": 60
    },
    "market_price_yes": 40,
    "market_price_no": 61,
    "chance": 39,
    "volume": 29500,
    "liquidity": 32051
  }
}
```

## Endpoints da API

### Obter Orderbook de um Evento

Recupera o snapshot do orderbook para todos os mercados de um evento específico. Retorna um objeto onde cada chave é o ID de um mercado e o valor contém os orderbooks completos para YES e NO, além de dados agregados de preço.

Use este endpoint quando desejar obter orderbooks de todos os mercados de um evento.

[Documentação detalhada + playground](/playground/data/get-event-orderbook-snapshot)

### Obter Orderbook de um Mercado

Recupera o snapshot do orderbook para um mercado específico. Retorna os orderbooks completos para YES e NO, além de dados agregados de preço do mercado.

Use este endpoint quando precisar obter o orderbook de um mercado específico e já tiver o ID do mercado.

[Documentação detalhada + playground](/playground/data/get-market-orderbook-snapshot)

## Casos de Uso

* **Obter Preços de Mercado**: Usar `market_price_yes` e `market_price_no` para obter os preços mais atualizados das opções de mercado;
* **Descoberta de Preços**: Analisar o livro de ordens completo para entender a distribuição de preços e identificar oportunidades;
* **Análise de Liquidez**: Verificar a profundidade do mercado (quantidade disponível em cada nível de preço) antes de executar ordens grandes;
* **Monitoramento de Spread**: Acompanhar o spread entre bids e asks para avaliar o custo de transação;
* **Market Making**: Fornecer liquidez fazendo ordens limitadas em ambos os lados do orderbook;
* **Arbitragem**: Encontrar diferenças de preço entre os resultados YES e NO que não somam 100 ticks;
* **Análise de Sentimento**: Usar o campo `chance` e a distribuição de ordens para entender a probabilidade implícita pelo mercado;
* **Execução de Ordens**: Usar os dados do orderbook para determinar o melhor preço e estratégia ao executar uma ordem.
