Skip to main content

​
Base URL

All API requests must be made to: 
https://data-api-dev.voxfi.com.br/v1

​
Authentication

All endpoints require authentication using the X-Api-Key header: 
X-Api-Key: your-api-key-here
Learn more about authentication and API key management in the Authentication guide.

​
Rate Limits

The API implements rate limiting to ensure fair use. Rate limit information is returned in response headers when limits are approached.

​
Response Format

All responses are returned in JSON format. Successful responses return HTTP status codes in the 200 range, while errors return appropriate HTTP status codes with error details in the response body.

​
Core Concepts

The VoxFi API is organized around these core concepts:
  • Events - Prediction market events that users can trade on;
  • Markets - Individual markets within an event (an event can have one or multiple markets);
  • Orders - Trading orders (limit and market orders);
  • Wallets - User balances and portfolio management.

​
Getting Started

  1. Get your API key in Profile → Security;
  2. Read the Quick Start guide to make your first request;
  3. Explore the API endpoints organized by concept below.