Skip to main content

​
Introduction

The VoxFi Public API allows you to interact with the VoxFi platform programmatically. All endpoints require authentication using an API key that you generate in your account settings.

​
Get Your API Key

  1. Log in to your VoxFi account
  2. Navigate to Profile → Security
  3. Generate a new API key
  4. Copy and securely store your API key (you won’t be able to see it again)
Keep your API key secure and never share it publicly. Treat it like a password.

​
Base URL

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

​
Authentication

Every request to the API must include your API key in the request headers: 
X-Api-Key: your-api-key-here

​
Your First Request

Let’s start by fetching a list of available events: 
curl -X GET "https://data-api.voxfi.com.br/v1/data/events" \
  -H "X-Api-Key: your-api-key-here"

​
Common Endpoints

​
Get Events

Retrieve a list of available events: 
GET /v1/data/events

​
Get Event Details

Get details for a specific event by ID or slug: 
GET /v1/data/events/{id_or_slug}

​
Get Orderbook

Get the orderbook snapshot for an event: 
GET /v1/trade/orderbook/{id}

​
Place an Order

Place a new order: 
POST /v1/trade/order

​
Get Portfolio

Get your portfolio and P&L: 
GET /v1/user/portfolio

​
Get Orders

List your open orders: 
GET /v1/user/orders

​
Get Balance

Get your account balance: 
GET /v1/user/balance

​
Rate Limits

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

​
Next Steps