Pular para o conteúdo principal

URL Base

Todas as requisições à API devem ser feitas para:
https://data-api-dev.voxfi.com.br/v1

Autenticação

Todos os endpoints requerem autenticação usando o cabeçalho X-Api-Key:
X-Api-Key: sua-chave-de-api-aqui
Saiba mais sobre autenticação e gerenciamento de chaves de API no guia de Autenticação.

Limites de Taxa

A API implementa limitação de taxa para garantir uso justo. Informações sobre limites de taxa são retornadas nos cabeçalhos de resposta quando os limites são aproximados.

Formato de Resposta

Todas as respostas são retornadas em formato JSON. Respostas bem-sucedidas retornam códigos de status HTTP na faixa 200, enquanto erros retornam códigos de status HTTP apropriados com detalhes do erro no corpo da resposta.

Conceitos Principais

A API VoxFi é organizada em torno destes conceitos principais:
  • Eventos - Eventos de mercado de previsão nos quais os usuários podem negociar;
  • Mercados - Mercados individuais dentro de um evento (um evento pode ter um ou vários mercados);
  • Ordens - Ordens de negociação (ordens limitadas e a mercado);
  • Carteiras - Saldos e gerenciamento de portfólio do usuário.

Começando

  1. Obtenha sua chave de API em Perfil → Segurança;
  2. Leia o guia de Início Rápido para fazer sua primeira requisição;
  3. Explore os endpoints da API organizados por conceito abaixo.