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

# API

Ventuals is built on Hyperliquid, so you can interact with any asset listed on Ventuals directly through the [Hyperliquid API](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api). All core functionality—market data, order placement, order management, account queries, and position tracking—is available via the Hyperliquid API.

When interacting with Hyperliquid's API, you may need to specify `dex: "vntl"` in your queries, or filter for coins whose ticker symbols are prefixed with `vntl:` (e.g., `vntl:SPACEX`).

The key steps are:

1. **Connect to the API** — Via HTTP or websockets
2. **Fetch data** — Use the `/info` endpoint to fetch information about markets and specific users.
3. **Place and manage orders** — Use the `/exchange` endpoint to place, cancel, and modify orders.
4. **Subscribe to real-time data streams** — Use the websocket endpoint to receive real-time updates about markets and specific users


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ventuals.com/developers/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
