> ## 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.

# Quickstart: your first Hyperliquid data request

> Make your first Ironflow API request in under 5 minutes: get a key, call the REST API with cURL, Python or TypeScript, and page through Hyperliquid trades.

<Steps>
  <Step title="Get your API key">
    [Request access](https://ironflow.sh/api) with your use case — keys are issued manually, usually within one business day, and start with a free 7-day trial. A key looks like `if_xxxxxxxxxxxxxxxx`.
  </Step>

  <Step title="Make your first request">
    Pick your preferred client:

    <CodeGroup>
      ```bash cURL theme={null}
      curl "https://api.ironflow.sh/v1/trades?source=hyperliquid&market=BTC-PERP&limit=5" \
        -H "Authorization: Bearer if_your_api_key"
      ```

      ```typescript TypeScript theme={null}
      npm install @ironflowsh/sdk
      ```

      ```python Python theme={null}
      pip install ironflow-sdk
      ```
    </CodeGroup>

    <CodeGroup>
      ```bash cURL theme={null}
      # Response
      {
        "data": [
          {
            "market": "BTC-PERP",
            "timestamp": 1718400000000,
            "price": "67432.10",
            "size": "1.5",
            "side": "buy"
          }
        ],
        "pagination": { "next_cursor": "MTcx...", "has_more": true }
      }
      ```

      ```typescript TypeScript theme={null}
      import { Ironflow } from "@ironflowsh/sdk";

      const client = new Ironflow("if_your_api_key");

      const trades = await client.trades("BTC-PERP", { limit: 5 });
      console.log(trades.data);
      // [{ market: "BTC-PERP", price: "67432.10", size: "1.5", ... }]
      ```

      ```python Python theme={null}
      import asyncio
      from ironflow_sdk import Ironflow

      async def main():
          async with Ironflow("if_your_api_key") as client:
              trades = await client.trades("BTC-PERP", limit=5)
              print(trades.data)
              # [Trade(market='BTC-PERP', price='67432.10', size='1.5', ...)]

      asyncio.run(main())
      ```
    </CodeGroup>

    <Tip>
      Hyperliquid hosts third-party HIP-3 builder markets alongside its native perps. Their symbols are namespaced as `<issuer>:<base>-PERP`:

      ```bash theme={null}
      # Felix Exchange's natural-gas perp
      curl "https://api.ironflow.sh/v1/trades?source=hyperliquid&market=flx:GAS-PERP&limit=5" \
        -H "Authorization: Bearer if_your_api_key"
      ```

      Or query every builder's GOLD-PERP at once with the decomposed form:

      ```bash theme={null}
      curl "https://api.ironflow.sh/v1/trades?source=hyperliquid&base_market=GOLD-PERP&limit=20" \
        -H "Authorization: Bearer if_your_api_key"
      ```

      Spot pairs work the same way — use the human form `BASE/QUOTE` or the numeric coin alias `@N`:

      ```bash theme={null}
      # HL spot — HYPE/USDC pair
      curl "https://api.ironflow.sh/v1/trades?source=hyperliquid&market=HYPE/USDC&limit=5" \
        -H "Authorization: Bearer if_your_api_key"
      ```

      HIP-4 outcome contracts (binary prediction markets, live since 2026-05-02) carry `market_class: "prediction"`. Display symbols read as `{UNDERLYING}-{TARGET}-{EXPIRY}-{Yes|No}`:

      ```bash theme={null}
      # "Yes" side of the BTC-above-$78,213 daily binary
      curl "https://api.ironflow.sh/v1/trades?source=hyperliquid&market=BTC-78213-20260503-Yes&limit=5" \
        -H "Authorization: Bearer if_your_api_key"

      # All current prediction markets with full metadata
      curl "https://api.ironflow.sh/v1/markets?market_class=prediction" \
        -H "Authorization: Bearer if_your_api_key"
      ```

      Filter by class instead of by symbol with `market_class=spot`, `market_class=perp`, or `market_class=prediction`. See [Sources & Markets](/concepts/sources-and-markets) for the full filter scheme.
    </Tip>
  </Step>

  <Step title="Explore more">
    <CardGroup cols={2}>
      <Card title="Pagination" icon="arrow-right" href="/concepts/pagination">
        Fetch large datasets page by page.
      </Card>

      <Card title="Whale alerts guide" icon="bell" href="/guides/whale-alerts">
        Watch large wallets and react to their fills.
      </Card>

      <Card title="Wallet analytics guide" icon="user" href="/guides/analytics">
        Reconstruct any HL wallet end-to-end.
      </Card>

      <Card title="Full API reference" icon="code" href="/api-reference/introduction">
        Every endpoint across market data, analytics, cohorts, and system status — parameters and response schemas.
      </Card>
    </CardGroup>
  </Step>
</Steps>


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