Pular para o conteúdo principal

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.

​
O que é um Evento?

Um Evento no VoxFi representa uma pergunta ou tópico de mercado de previsão no qual os usuários podem negociar. Eventos são os contêineres de nível superior que agrupam mercados relacionados.

​
Características Principais

  • Descrição: Uma pergunta ou declaração que define o que o evento está prevendo;
  • Status: O estado atual do evento (ex: aberto, fechado, resolvido);
  • Mercados: Um evento pode conter um ou vários mercados onde os usuários podem negociar;
  • Data de Resolução: Quando o evento será resolvido e os vencedores determinados;
  • Categorias e Tags: Eventos são organizados por categorias e podem ter várias tags.

​
Exemplo de Response de Evento

{
  "id": "73fb9a96-fa5b-4680-b1aa-448afe9ec650",
  "status_id": 2,
  "type_id": 1,
  "category_id": 11,
  "tags_ids": [
    6,
    8,
    1,
    2
  ],
  "status": "Ativo",
  "type": "future",
  "category": "Tecnologia",
  "description": "O X (antigo Twitter) sofrerá novo bloqueio judicial no Brasil em 2026?",
  "tags": [
    "judiciario",
    "Cultura Pop",
    "Brasil",
    "Governo Federal"
  ],
  "slug": "o-x-antigo-twitter-sofrera-novo-bloqueio-judicial-no-brasil-em-2026",
  "rules": "Para o resultado ser \"Sim\", a plataforma deve ficar inacessível no Brasil por determinação judicial por um período superior a 24 horas consecutivas em qualquer momento do ano de 2026. Instabilidades técnicas não contam.",
  "thumbnail_url": "",
  "documentation_url": "",
  "metadata": {},
  "created_at": "2025-12-29T09:21:46.836348Z",
  "starts_at": "2025-12-29T09:23:00Z",
  "closes_at": "2026-12-31T23:00:00Z",
  "finished_at": null,
  "qty_markets": 1,
  "is_single_market": true,
  "markets": [
    {
      "id": "95f88394-4f4d-4489-99dc-8cef9f7682ee",
      "description": "",
      "metadata": {},
      "thumbnail_url": null,
      "options": [
        {
          "id": "13f89ed4-8cc0-4d72-bc64-88faf17ef386",
          "option_type": 1,
          "description": "Yes",
          "metadata": {}
        },
        {
          "id": "230d9631-b35a-4fbc-970d-39a60df7a7c6",
          "option_type": 2,
          "description": "No",
          "metadata": {}
        }
      ],
      "volume": 29500,
      "closed_at": null,
      "resolved_at": null,
      "settled_at": null,
      "liquidity": 32051,
      "winner_option_type": null
    }
  ],
  "likes": 0,
  "volume": 29500,
  "liquidity": 32051
}

​
Endpoints da API

​
Obter Eventos

Recupera uma lista de eventos disponíveis com opções de paginação e filtragem. Documentação detalhada + playground

​
Obter Evento

Recupera um evento específico por ID. Documentação detalhada + playground

​
Casos de Uso

  • Navegar Eventos: Listar todos os eventos disponíveis com filtragem e ordenação;
  • Buscar Eventos: Encontrar eventos por descrição ou tags;
  • Detalhes do Evento: Obter informações completas sobre um evento específico incluindo todos os seus mercados;
  • Descoberta de Mercados: Usar eventos para descobrir mercados relacionados para negociação.