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

# Hyperliquid mark and oracle prices

> GET /v1/mark-prices returns Hyperliquid mark price and oracle price snapshots at 10-second resolution, with the funding rate at each snapshot for every perp.



## OpenAPI

````yaml GET /v1/mark-prices
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. One schema across native HL perps,

    HIP-3 builder markets, HIP-4 outcome contracts and HL spot.


    **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 | 10 per IP | 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.

    A header that is present but malformed returns 401; keyless access applies
    only

    when no `Authorization` header is sent.


    **Data availability:** fills and trades cover a rolling 12 months; other

    datasets start later (funding 2025-09-27, open interest and mark prices

    2026-04-29).


    **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.
  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 endpoints (Builder tier and above).
  - name: Cohorts
    description: Predefined and custom address groups for filtering market data.
  - name: Info Proxy
    description: >-
      Cached passthrough to the Hyperliquid Info API. No record caps, higher
      rate limits.
  - name: Export
    description: Bulk data export as CSV or Parquet (Builder tier and above).
  - name: Query
    description: >-
      Read-only ClickHouse SQL over curated Hyperliquid tables (hl.*), limited
      by tier.
  - name: System
    description: Health checks and metadata endpoints.
  - name: TradingApp
    description: >-
      Trading app Phase A — wallet auth (SIWE), agent-key provisioning, and
      kill-switch.
paths:
  /v1/mark-prices:
    get:
      tags:
        - Market Data
      summary: List mark and oracle prices
      description: >
        Query mark price and oracle price snapshots (10-second resolution).

        Also includes the current funding rate at each snapshot.


        - **Mark price:** Used for PnL calculation and liquidation triggers.

        - **Oracle price:** Index price from external sources.

        - **Funding rate:** Rate at snapshot time (annualized, sign indicates
        direction).
      operationId: listMarkPrices
      parameters:
        - $ref: '#/components/parameters/source'
        - name: market
          in: query
          required: true
          description: Market symbol (e.g. `BTC-PERP`).
          schema:
            type: string
            example: BTC-PERP
        - $ref: '#/components/parameters/base_market'
        - $ref: '#/components/parameters/issuer'
        - $ref: '#/components/parameters/from'
        - $ref: '#/components/parameters/to'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/cursor'
      responses:
        '200':
          description: Paginated list of mark/oracle price snapshots.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkPriceList'
              example:
                data:
                  - source: hyperliquid
                    market: BTC-PERP
                    issuer: ''
                    base_market: BTC-PERP
                    timestamp: 1718400000000
                    mark_price: '67432.10'
                    oracle_price: '67428.50'
                    funding_rate: '0.0001'
                pagination:
                  next_cursor: null
                  has_more: false
        '400':
          $ref: '#/components/responses/PerpOnlyBadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '504':
          $ref: '#/components/responses/QueryTimeout'
components:
  parameters:
    source:
      name: source
      in: query
      description: Venue identifier. Defaults to `hyperliquid`.
      schema:
        type: string
        enum:
          - hyperliquid
        default: hyperliquid
      example: hyperliquid
    base_market:
      name: base_market
      in: query
      description: >
        Base market symbol, stripped of any issuer namespace (e.g. `GAS-PERP`).

        Matches both native HL markets (`market` == `base_market`) and every
        HIP-3

        builder-deployed market with that base (e.g. `flx:GAS-PERP`). Use
        together

        with `issuer` to scope to a single builder, or alone to query across all

        issuers of the same base symbol.
      schema:
        type: string
        example: GAS-PERP
    issuer:
      name: issuer
      in: query
      description: >
        HIP-3 builder/issuer namespace (e.g. `flx`). For native HL perps the
        issuer

        is the empty string; do not combine `issuer=""` with this filter — omit
        the

        parameter instead. Commonly paired with `base_market` to disambiguate a

        builder-deployed market from its native counterpart.
      schema:
        type: string
        example: flx
    from:
      name: from
      in: query
      description: >-
        Start time as Unix milliseconds. Defaults to 24 hours ago. Clamped to
        tier history window. On /v1/trades and /v1/fills, the time range (to -
        from) is limited per tier (no key 1h, free key 6h, Explorer 24h, Builder
        7d, Enterprise unlimited; without market filter 4h for all tiers).
        Returns QUERY_WINDOW_EXCEEDED (400) if exceeded — paginate with narrower
        from/to windows.
      schema:
        type: integer
        format: int64
        example: 1718313600000
    to:
      name: to
      in: query
      description: End time as Unix milliseconds. Defaults to now.
      schema:
        type: integer
        format: int64
        example: 1718400000000
    limit:
      name: limit
      in: query
      description: Maximum number of results per page. Default 100, max 1000.
      schema:
        type: integer
        default: 100
        maximum: 1000
        example: 100
    cursor:
      name: cursor
      in: query
      description: >-
        Opaque pagination cursor from `pagination.next_cursor` in a previous
        response.
      schema:
        type: string
        example: MTcxODQwMDAwMDAwMC00Mg==
  schemas:
    MarkPriceList:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MarkPrice'
        pagination:
          $ref: '#/components/schemas/Pagination'
    MarkPrice:
      type: object
      required:
        - source
        - market
        - issuer
        - base_market
        - timestamp
        - mark_price
        - oracle_price
        - funding_rate
      properties:
        source:
          type: string
          example: hyperliquid
        market:
          type: string
          description: >-
            Full market identifier (`<builder>:<base>` for HIP-3, bare base for
            native HL).
          example: BTC-PERP
        issuer:
          type: string
          description: HIP-3 builder/issuer namespace. Empty string for native HL markets.
          example: ''
        base_market:
          type: string
          description: Base market symbol with any issuer namespace stripped.
          example: BTC-PERP
        timestamp:
          type: integer
          format: int64
          example: 1718400000000
        mark_price:
          type: string
          example: '67432.10'
        oracle_price:
          type: string
          description: Always `"0"` — the mark_prices table carries only `mark_price`.
          example: '0'
        funding_rate:
          type: string
          description: Always `"0"` — the mark_prices table carries only `mark_price`.
          example: '0'
        venue:
          type: string
          description: Venue identifier. The mark_prices table is perp-only.
          example: hyperliquid
        market_id:
          type: integer
          format: int64
          example: 0
        quote_asset:
          type: string
          example: USD
        display_symbol:
          type: string
          example: BTC-PERP
    Pagination:
      type: object
      required:
        - next_cursor
        - has_more
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Cursor to pass as `cursor` query parameter to fetch the next page.
            Null when no more pages.
          example: MTcxODQwMDAwMDAwMC00Mg==
        has_more:
          type: boolean
          description: Whether more pages are available.
          example: true
    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.
  responses:
    PerpOnlyBadRequest:
      description: >
        Bad request. Two distinct codes share this status on perp-only
        endpoints:

        - `QUERY_WINDOW_EXCEEDED` — `to - from` exceeds the per-tier max window.
        Narrow and paginate.

        - `INVALID_MARKET_CLASS` — `market` or `base_market` is a spot symbol
        (e.g. `HYPE/USDC`, `@285`); this endpoint serves perpetuals only.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            queryWindow:
              summary: Query window exceeded
              value:
                error:
                  code: QUERY_WINDOW_EXCEEDED
                  message: >-
                    query time range exceeds maximum 24h0m0s per request for
                    your tier — narrow your from/to window and paginate
            invalidMarketClass:
              summary: Spot symbol on perp-only endpoint
              value:
                error:
                  code: INVALID_MARKET_CLASS
                  message: >-
                    this endpoint serves perpetual markets only; spot symbols
                    (e.g. "HYPE/USDC", "@285") are not supported
    Unauthorized:
      description: Missing or invalid API key.
      headers:
        WWW-Authenticate:
          schema:
            type: string
            example: Bearer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    Forbidden:
      description: Your tier does not include this feature.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: TIER_FORBIDDEN
              message: Export requires Builder tier or above
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            example: 60
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMIT_EXCEEDED
              message: Rate limit exceeded. Retry after 60 seconds.
    InternalError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
    QueryTimeout:
      description: >-
        Query exceeded the 15-second execution limit. Narrow your time range,
        add a market filter, or reduce the limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: QUERY_TIMEOUT
              message: >-
                query took too long — narrow your time range, add a market
                filter, or reduce the limit
  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.