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

# Ironflow REST API reference

> Reference for every Ironflow REST endpoint for Hyperliquid data: base URL, bearer key authentication, the shared response envelope and cursor pagination.

The Ironflow REST API is documented via OpenAPI 3.1. Every endpoint page below is auto-generated from the spec and includes a built-in playground for live requests.

## Base URL

```
https://api.ironflow.sh
```

## Authentication

All endpoints require a Bearer token:

```
Authorization: Bearer if_your_api_key
```

## Response format

All list endpoints return the same envelope:

```json theme={null}
{
  "data": [...],
  "pagination": {
    "next_cursor": "MTcx...",
    "has_more": true
  }
}
```

All errors return:

```json theme={null}
{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 60 seconds."
  }
}
```

See [Rate Limits & Errors](/concepts/rate-limits) for the full list of error codes.

## Try it

Every endpoint page has a built-in playground. Click **Try it** and enter your API key to make live requests directly from the docs.


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