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

# Funding history

> Bounded native capture history, not a venue backfill. Up to 50,000 rows in venue/symbol/time order. Source outages return 503 history_unavailable; an empty result does not establish complete coverage.



## OpenAPI

````yaml https://www.oceanx.trade/api/v1/openapi.json get /api/v1/perps/funding
openapi: 3.1.0
info:
  title: OceanX Developer API
  version: 1.0.0
  description: >-
    OceanX Developer API v1 (beta). Covers every public route and method: market
    data, charts, token/risk facts, wallet analytics, tracker, copy reads,
    alerts, owned account wallet/funding reads, spot quotes and perps. Scope and
    availability are operation-specific. Spot execution, copy execution, account
    withdrawals, developer webhooks and prediction trading are not public v1
    capabilities. Perps order submission and collateral rebalance remain
    unavailable; their error contracts are explicit. Documentation:
    https://docs.oceanx.trade/api/overview.
  contact:
    url: https://docs.oceanx.trade
  termsOfService: https://www.oceanx.trade/legal/terms
  license:
    name: Proprietary
    url: https://www.oceanx.trade/legal/terms
servers:
  - url: https://www.oceanx.trade
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Perps
    description: Cross-venue market data and explicit account-wallet execution limitations.
  - name: Router
    description: >-
      Read-only Raptor route quotes and public Solana transaction status. Build
      and execution remain separately gated.
  - name: Market Data
    description: Read-only OceanX market context sourced and cached by VM producers.
  - name: Spot
    description: >-
      Executable Solana swap quotes off OceanX's own router, and the exit
      checker that reports whether a whole position can be sold.
  - name: Callouts
    description: >-
      Public token callouts — user-posted token calls with live click/volume
      attribution stats. Read-only.
  - name: Copy Trading
    description: Key-owner follow, fill and PnL reads; no execution authority.
  - name: Price Alerts
    description: Key-owner alert management through the existing evaluator; no webhooks.
paths:
  /api/v1/perps/funding:
    get:
      tags:
        - Perps
      summary: Funding history
      description: >-
        Bounded native capture history, not a venue backfill. Up to 50,000 rows
        in venue/symbol/time order. Source outages return 503
        history_unavailable; an empty result does not establish complete
        coverage.
      operationId: getPerpsFunding
      parameters:
        - name: symbol
          in: query
          required: true
          description: Cross-venue symbol.
          schema:
            type: string
            minLength: 1
            maxLength: 64
        - name: venue
          in: query
          required: false
          description: Optional venue filter.
          schema:
            type: string
            minLength: 1
            maxLength: 32
        - name: hours
          in: query
          required: false
          description: >-
            Default 24. Router clamps to at least 1 hour and truncates
            fractional hours.
          schema:
            type: number
            exclusiveMinimum: 0
            maximum: 720
      responses:
        '200':
          description: Captured history window.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed per window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix seconds when the window resets.
          content:
            application/json:
              schema:
                type: object
                required:
                  - symbol
                  - hours
                  - rows
                properties:
                  symbol:
                    type: string
                  hours:
                    type: number
                  rows:
                    type: array
                    maxItems: 50000
                    items:
                      $ref: '#/components/schemas/PerpsFundingPoint'
        '400':
          description: Failed validation before reaching the engine.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key is valid but lacks the required scope
            (`insufficient_scope`), or its account no longer has product access
            (`product_access_revoked`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Honour `Retry-After`.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Requests allowed per window.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Requests left.
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Unix seconds when the window resets.
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            The routing engine or rate-limit storage is unavailable. Retry with
            backoff; no upstream work was admitted when the limiter failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    PerpsFundingPoint:
      type: object
      required:
        - venue
        - symbol
        - ts
        - fundingRate
        - predictedRate
        - openInterest
        - markPrice
      properties:
        venue:
          type: string
        symbol:
          type: string
        ts:
          type: integer
          description: Hour boundary, Unix seconds.
        fundingRate:
          type: number
        predictedRate:
          type: number
        openInterest:
          type: number
        markPrice:
          type: number
    Error:
      type: object
      required:
        - error
      properties:
        requestId:
          type: string
          description: Request identifier on new token endpoints.
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable code. Branch on this, not the message.
              example: no_route
            message:
              type: string
              description: Human-readable detail. May change.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An OceanX API key, created in the app under Settings → Developer API.
        Send it as `Authorization: Bearer ox_live_…`. Required scopes are
        operation-specific: market reads use md.read, tracker uses tracker.read,
        copy reads use copy.read, alert operations use alerts.read or
        alerts.write, and owned wallet/funding reads require explicit
        account.read. New scopes require explicit selection and grant no trading
        authority. Existing perps operations retain their documented scopes.

````

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