> For the complete documentation index, see [llms.txt](https://docs.vooi.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vooi.io/vooi-ultra-v3/vooi-api.md).

# VOOI API

## Overview

VOOI provides two API layers for different integration needs: 

* **VOOI Perps API** for trading operations across supported perpetual venues 
* **VOOI Broker API** for broker-side user management and broker-level data 

**VOOI Perps API** provides a unified interface for trading across multiple perpetual trading venues. It standardizes trading operations, 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/) app 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
* **Deposits & transfers** – Move funds between supported venues

## Supported Venues and Markets

Supported venues and market groups currently include: 

* Extended
* Hyperliquid
* trade.xyz (HIP-3 market group on Hyperliquid)
* Kinetiq (HIP-3 market group on Hyperliquid)
* Lighter
* Aster

Supported venues, markets, and features may change over time.

## API Access

#### General Access

**VOOI Perps API** and **VOOI Broker API** are under active development and are not yet publicly available.

If you are interested in building with VOOI Perps API or VOOI Broker API, please request early access.

#### Access Through VOOI Ultra

Registered users can generate API tokens in the Ultra app where token generation is available.

These tokens can be used for supported automation workflows, MCP clients, trading bot examples, and integrations.

Access VOOI Ultra here: <https://ultra.vooi.io/>

### Non-Custodial Execution Model

VOOI Perps API does not custody user funds and does not replace venue trading engines.

Each supported venue:

* Maintains its own order book
* Holds user margin and positions
* Executes orders natively
* Applies its own venue-specific rules, fees, and risk logic

VOOI provides a standardized API layer for interacting with supported venues while execution remains venue-native and non-custodial.

### Related Guides

* [Ultra Overview](/vooi-ultra-v3/vooi_ultra-introduction.md)
* [Ultra MCP](/vooi-ultra-v3/vooi_ultra-mcp.md)
* [Automation Examples](/vooi-ultra-v3/vooi_ultra-automationexamples.md)
* [Ultra Tools](/vooi-ultra-v3/vooi_ultra-tools.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.vooi.io/vooi-ultra-v3/vooi-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.