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

# REST API reference

> Every venue endpoint, generated from the OpenAPI specification.

The pages in this tab are generated from
[`venue-openapi.yaml`](/api-spec/venue-openapi.yaml). Use the sidebar groups
(Exchange, Account, Markets, Portfolio, Orders, Funding) to jump to an
endpoint.

## Download

* [OpenAPI — REST](/api-spec/venue-openapi.yaml)
* [AsyncAPI — WebSocket](/api-spec/venue-asyncapi.yaml)

## Common entry points

| Need                | Endpoint                                             |
| ------------------- | ---------------------------------------------------- |
| Is the venue up?    | `GET /v1/exchange/status`                            |
| What can my key do? | `GET /v1/account/limits`                             |
| Current round       | `GET /v1/rounds?limit=1`                             |
| Book                | `GET /v1/markets/{market_id}/orderbook`              |
| Place               | `POST /v1/portfolio/orders`                          |
| Shares ahead        | `GET /v1/portfolio/orders/{order_id}/queue_position` |
| Retention caps      | `GET /v1/exchange/retention`                         |

Guides: [Authentication](/quickstart/authentication),
[Errors](/concepts/errors), [Changelog](/changelog).