> ## 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. # Upgrade request status > GET /v1/billing/upgrade returns an upgrade request's status, pending, paid or expired, with the transfers seen and when the plan ends. ## OpenAPI ````yaml GET /v1/billing/upgrade openapi: 3.1.0 info: title: Ironflow API version: 1.0.0 description: > Hyperliquid market data from Ironflow's own nodes: tick-level fills and trades, candles, funding rates, liquidations, mark prices, open interest, markets and wallet analytics over REST, live Server-Sent Events streams and read-only SQL. One schema across native HL perps, HIP-3 builder markets, HIP-4 outcome contracts and HL spot. The same data is a hosted MCP server for AI agents at `https://mcp.ironflow.sh/mcp`, and agents with a USDC wallet on Base can pay per call with x402, no key: the data GET endpoints are also served at `/x402/v1/...` (discovery: `https://api.ironflow.sh/openapi.json` and `https://api.ironflow.sh/.well-known/x402`). **Base URL:** `https://api.ironflow.sh` **Authentication:** Read endpoints work without a key (keyless access) or with a Bearer token in the `Authorization` header. Writes always need a key. ``` Authorization: Bearer if_your_api_key ``` Get a free key at https://ironflow.sh/key. **Access levels:** | Access | Requests per minute | History | Max range per request | |---|---|---|---| | No key | 30 per IP (2,000 a day) | 24 hours | 1 hour | | Free key | 60 | 30 days | 6 hours | | Explorer | 100 | 90 days | 24 hours | | Builder | 1,000 | 1 year | 7 days | | Enterprise | 10,000 | full | unlimited | Without a market filter, high-volume endpoints allow at most 4 hours per request. `/v1/trades` filtered to one perp or spot market allows 24 hours per request without a key and on a free key. A header that is present but malformed returns 401; keyless access applies only when no `Authorization` header is sent. **Data availability:** fills and trades start on 25 May 2025; other datasets start later (funding 2025-09-27, open interest and mark prices 2026-04-29). Bulk history is free to download from https://huggingface.co/ironflow. **Timestamps:** All timestamps are Unix milliseconds (int64). **Pagination:** Paginated endpoints return a `cursor` in `pagination.next_cursor`. Pass it as the `cursor` query parameter to fetch the next page. When `pagination.has_more` is `false`, you have reached the last page. **Notices:** a successful JSON object may start with `notice`, the `X-Ironflow-Notice` header in the body: what was served when it differs from what was asked (a keyless sample, a shortened history, a guessed path) and how to get the rest. **Guessed paths:** a few paths callers guess are answered by the endpoint they mean, with a `notice` and the `X-Ironflow-Canonical` header naming it: `/v1/liquidations/aggregate`, `/v1/summary/liquidations` and similar by `/v1/liquidations/summary`, `/v1/liquidations/buckets` and `heatmap` by `/v1/analytics/liquidation-levels`, and `/v1/liquidations/map/BTC-PERP` by `/v1/liquidations/map?market=BTC-PERP`. A path with trailing `.`, `,`, `;` or `)` (`/v1/query.`, copied from a sentence) is answered by the endpoint without them, with the same method, query and body. OpenAI-style paths (`/v1/models`, `/v1/chat/completions`) answer 404: this is not an LLM API, and agents use the MCP server above. contact: name: Ironflow Support url: https://ironflow.sh servers: - url: https://api.ironflow.sh description: Production security: - bearerAuth: [] - {} tags: - name: Market Data description: Historical tick-level market data stored in ClickHouse. - name: Analytics description: >- Aggregated analytics. Net flows, funding stats and the liquidation map markets work without a key; liquidation levels, the liquidation map and the vault leaderboard return a sample without one; order flow needs a key (a free key works). - name: Cohorts description: Predefined and custom address groups for filtering market data. - name: Alerts description: >- Liquidation alerts that Ironflow posts to your webhook, Discord channel, Slack channel or Telegram chat. - name: Ironbox description: >- Secure, sandboxed environments in Tokyo, next to Hyperliquid, where a trading agent runs with Ironflow's data, analytics, alerts and execution. Any API key, free included. - name: Query description: >- Read-only ClickHouse SQL over curated Hyperliquid tables (hl.*), limited by tier. - name: Billing description: >- Paid plans, paid in USDC on Hyperliquid or with x402 on Base. No card, no account page. - name: System description: Health checks and metadata endpoints. - name: TradingApp description: >- The trading terminal's own endpoints (terminal.ironflow.sh), wallet-session auth. Not part of the public data API; left out of the docs copy. paths: /v1/billing/upgrade: get: tags: - Billing summary: Upgrade request status description: | The status of one upgrade request: `pending`, `paid` or `expired`. While pending it lists the transfers from the wallet to the receiver seen so far; once paid, the payment, the tier and when the plan ends. The request id is the secret, so no key is needed. operationId: getUpgradeStatus parameters: - name: request in: query required: true description: >- `request_id` from POST /v1/billing/upgrade (`up_` and 32 hex characters). schema: type: string pattern: ^up_[0-9a-f]{32}$ responses: '200': description: The request. content: application/json: schema: allOf: - $ref: '#/components/schemas/UpgradeRequest' - type: object properties: created_at: type: string format: date-time paid: type: object properties: amount_usdc: type: number tx_hash: type: string at: type: string format: date-time tier: type: string plan_active_until: type: string format: date-time transfers_seen: type: array items: type: object properties: amount_usdc: type: number tx_hash: type: string at: type: string format: date-time '400': description: INVALID_REQUEST_ID. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No upgrade request with this id. content: application/json: schema: $ref: '#/components/schemas/Error' security: [] components: schemas: UpgradeRequest: type: object required: - request_id - status - plan - amount_usdc - to_address - from_wallet properties: request_id: type: string description: '`up_` and 32 hex characters' status: type: string enum: - pending - paid - expired status_url: type: string format: uri page_url: type: string format: uri email: type: string plan: type: string plan_name: type: string amount_usdc: type: number days: type: integer token: type: string enum: - USDC network: type: string enum: - Hyperliquid from_wallet: type: string to_address: type: string expires_at: type: string format: date-time description: The request lapses unpaid after 7 days checked_every_seconds: type: integer message: type: string example: request_id: up_0123456789abcdef0123456789abcdef status: pending status_url: >- https://api.ironflow.sh/v1/billing/upgrade?request=up_0123456789abcdef0123456789abcdef page_url: >- https://ironflow.sh/upgrade?request=up_0123456789abcdef0123456789abcdef email: dev@example.com plan: explorer plan_name: Explorer amount_usdc: 49 days: 30 token: USDC network: Hyperliquid from_wallet: '0x1234567890abcdef1234567890abcdef12345678' to_address: '0x0000000000000000000000000000000000000000' expires_at: '2026-11-14T09:00:00Z' checked_every_seconds: 10 Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Machine-readable error code. example: RATE_LIMIT_EXCEEDED message: type: string description: Human-readable error description. example: Rate limit exceeded. Retry after 60 seconds. upgrade: type: object description: >- On a limit a higher plan lifts, the next plan, its price, what it lifts and the call that gets it. ironbox: type: object description: >- On a rate limit, the keyless daily cap, the stream limit and the SQL time budget, how to run the agent in an Ironbox instead. properties: why: type: string example: >- No rate limits inside an Ironbox: your agent runs next to Hyperliquid with the data on the box. create: type: string example: POST https://api.ironflow.sh/v1/ironbox url: type: string format: uri example: https://ironflow.sh/ironbox?utm_source=api stream: type: string description: >- On the keyless daily limit of `/v1/liquidations` and `/v1/trades`, the live stream that replaces polling. example: >- GET https://api.ironflow.sh/v1/liquidations/stream (no daily limit for keyless streams) securitySchemes: bearerAuth: type: http scheme: bearer description: >- Ironflow API key, format `if_xxxx`. Free keys at https://ironflow.sh/key. Optional on read endpoints. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.