> ## Documentation Index
> Fetch the complete documentation index at: https://perps-api.vooi.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> VOOI Perps API for trading across multiple perpetual trading venues: Hyperliquid, Lighter, Aster, Extended, Binance, Robinhood, Bybit, MEXC, and Ondo

<Info>
  **Early Access:** VOOI Perps API and VOOI Broker API are under active development. Some behavior and interfaces may change.

  * **Real-time updates (SSE)** – The streaming endpoint is under active development and not yet stable
  * **Response schemas** – Some fields may be missing or return empty values while the schema is being finalized
  * **Deposits, withdrawals & transfers** – Available in beta; behavior and API surface may change
</Info>

## Overview

There are two API layers:

* **VOOI Perps API** for trading operations
* **VOOI Broker API** for broker-side user management

**VOOI Perps API** provides a unified interface for trading across multiple perpetual trading venues. It standardizes order execution, account management, and portfolio data, including positions, orders, balances, and trade history.

**VOOI Broker API** supports broker-side functionality for broker applications built on top of  VOOI Perps API. It provides user registration, public key management, and access to broker-level trading statistics.

[**VOOI Ultra**](https://ultra.vooi.io/) is VOOI’s own broker application that handles user onboarding, manages broker-side flows, and provides access to trading through the VOOI Perps API. It can also be used as a reference broker app for integrations.

## What you can do

* **Market data** – Get prices, volume, and trading pair info across supported venues
* **Order management** – Place and manage market, limit, and bracket orders, including take-profit and stop-loss
* **Positions and leverage management** – Monitor open positions and get or set leverage by market
* **Account balances** – View balances across connected venues through a unified interface
* **Real-time streaming** – Receive SSE events for prices, orders, positions, and trades
* **Cross-exchange spreads** – Rank funding and price spreads between venues with the [arbitrage scanner](/docs/arbitrage-scanner)
* **Deposits & transfers** – Move funds between supported venues *(beta)*

## Supported exchanges

| Exchange | Type | Description |
| - | - | - |
| [**Hyperliquid**](https://app.hyperliquid.xyz) | DEX | Decentralized perpetuals with on-chain settlement |
| [**Lighter**](https://lighter.xyz) | DEX | zkSync-based perpetuals with low fees |
| [**Aster**](https://asterdex.com) | CEX | Binance-like interface with high liquidity |
| [**Extended**](https://extended.exchange) | DEX | Starknet-based perpetuals, USD-quoted |
| [**Binance**](https://www.binance.com/en/futures) | CEX | Deep-liquidity USDⓈ-M perpetual futures |
| [**Robinhood**](https://robinhood.com) | DEX | Perpetuals built on Lighter's infrastructure, USDG-settled |
| [**Bybit**](https://www.bybit.com) | CEX | Unified-account perpetuals, including traditional-asset markets |
| [**MEXC**](https://www.mexc.com) | CEX | USDT-margined perpetual futures |
| [**Ondo**](https://app.ondoperps.xyz) | DEX | USDC-settled perpetuals, wallet-authenticated |

## API reference

* The complete [API reference](/docs/api-reference) for all available endpoints
* The raw [OpenAPI specification](https://perps-api.vooi.io/swagger/json) for code generators and other development tools

## Environments

There is one production endpoint: `https://perps-api.vooi.io/`

There is no separate sandbox or testnet environment. All integrations run against live infrastructure, and every connected exchange is a mainnet venue.

For integration testing, the practical approach is to use a dedicated VOOI user funded with a small balance. A few USDC is usually enough to test order placement, positions, and account-related endpoints across supported venues. Once testing is complete, the test user can be removed through its broker.

## Next steps

* [Quickstart](/docs/quickstart) – use your API token to place your first trade
* [VOOI Perps API Tokens](/docs/tokens) – create and manage API tokens, including signing and token-related errors
* [VOOI Broker API](/docs/broker) – for broker applications: register users, manage their public keys, and access broker-side trading statistics


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.