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

# RWA perp funding rates

> Returns funding and carry for RWA perpetuals across 13 registry-driven venues: CEXs, perp DEXs and Hyperliquid HIP-3 builder markets. Rates are interval-true and mechanism-true: funding_apr annualizes each market's reported settlement interval, while both-sides rollover is reported as borrow_apr_annual and never mixed into funding spreads. The default payload omits venue-internal metadata. type=history returns stored session-tagged settlements (market / after_hours / weekend / holiday) for Hyperliquid (the trade.xyz HIP-3 dex) and Kraken only, stored from 2026-07-28; no other venue's settlement history is served. type=stats returns trusted, canonical-market carry/spread/OI aggregates and freshness: best carry is trailing-24h realised funding, spreads use only comparable funding (funding_status live or zero), and weekendPremiumApr is the mean annualized weekend settlement minus the mean weekday (market and after-hours) settlement over the trailing 7 days of the stored Hyperliquid (trade.xyz) and Kraken settlements, each settlement weighted equally (not OI-weighted, not market-wide).



## OpenAPI

````yaml /openapi.json get /v1/rwa-perps/rates
openapi: 3.0.0
info:
  title: Sharpe API
  version: 1.0.0
  description: >-
    Institutional-grade crypto market data API. Access funding rates, futures,
    arbitrage opportunities, narratives, ecosystems, and more.


    Authentication is supported via two production-safe methods:

    1. **Bearer token** in the Authorization header: `Authorization: Bearer
    sk_live_...`

    2. **X-API-Key header**: `X-API-Key: sk_live_...`


    API keys in query parameters are rejected by default because URLs are
    commonly stored in logs, browser history, analytics tools, and referrer
    headers.


    These `/v1` endpoints send no CORS headers and must be called from a server:
    calling them from a browser would expose your API key in page JavaScript.


    Every endpoint needs an API key, except `/v1/health` and
    `/v1/meta/coverage`. A key works on a paid plan
    (https://www.sharpe.ai/pricing) or during its account's one-time trial of 7
    days and 250 requests; otherwise it answers 401 `expired_api_key`. There is
    no free API tier and no keyless API.
  contact:
    name: Sharpe API Support
    url: https://sharpe.ai
    email: team@sharpe.ai
servers:
  - url: https://www.sharpe.ai/api
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: System
    description: Health checks and service status
  - name: Account
    description: API key usage and quota information
  - name: Derivatives
    description: Funding rates and futures data
  - name: Market Data
    description: >-
      Heatmaps, correlations, tracker, price predictions, news, gem finder, and
      market cap search
  - name: Arbitrage
    description: >-
      Spot-perp, cross-exchange, dated futures basis, calendar spread,
      perp-dated carry, and transfer arbitrage scanners
  - name: Categories
    description: Narratives, ecosystems, and memecoins data
  - name: New Listings
    description: >-
      Spot listings, Perp listings, delistings, suspensions, scheduled trading
      starts, exchange pages, and narrative flow across CEXs and Perp DEXs.
  - name: Screener
    description: Rug Check security, holders, resolve and trending endpoints.
  - name: Signals
    description: >-
      Composite signal scores derived from cross-exchange derivatives data:
      insider selling pressure and pump-and-dump detection.
  - name: Reports
    description: >-
      Markdown reports rendered on the server from the endpoints above: the
      market briefing, one coin's analysis, and the funding-arbitrage
      opportunities.
paths:
  /v1/rwa-perps/rates:
    get:
      tags:
        - Derivatives
      summary: RWA perp funding rates
      description: >-
        Returns funding and carry for RWA perpetuals across 13 registry-driven
        venues: CEXs, perp DEXs and Hyperliquid HIP-3 builder markets. Rates are
        interval-true and mechanism-true: funding_apr annualizes each market's
        reported settlement interval, while both-sides rollover is reported as
        borrow_apr_annual and never mixed into funding spreads. The default
        payload omits venue-internal metadata. type=history returns stored
        session-tagged settlements (market / after_hours / weekend / holiday)
        for Hyperliquid (the trade.xyz HIP-3 dex) and Kraken only, stored from
        2026-07-28; no other venue's settlement history is served. type=stats
        returns trusted, canonical-market carry/spread/OI aggregates and
        freshness: best carry is trailing-24h realised funding, spreads use only
        comparable funding (funding_status live or zero), and weekendPremiumApr
        is the mean annualized weekend settlement minus the mean weekday (market
        and after-hours) settlement over the trailing 7 days of the stored
        Hyperliquid (trade.xyz) and Kraken settlements, each settlement weighted
        equally (not OI-weighted, not market-wide).
      operationId: getRwaPerpRates
      parameters:
        - name: type
          in: query
          description: Type of rwa-perp data to retrieve.
          schema:
            default: current
            type: string
            enum:
              - current
              - history
              - stats
        - name: symbol
          in: query
          description: >-
            Underlying ticker (e.g. TSLA, XAU, US500), case-insensitive.
            Required when type=history. GOOG and GOOGL are distinct share
            classes.
          schema:
            type: string
        - name: venue
          in: query
          description: >-
            Filter to a single venue, case-insensitive (e.g. Binance, Bybit,
            OKX, Kraken, Aster, Lighter, Pacifica, or the Hyperliquid HIP-3
            builder venue: Hyperliquid). The venue list is registry-driven and
            grows over time; an unknown venue is a 400 that names the valid
            ones.
          schema:
            type: string
            maxLength: 32
        - name: days
          in: query
          description: Days of settlement history to retrieve (type=history only).
          schema:
            default: 7
            type: integer
            minimum: 1
            maximum: 90
        - name: limit
          in: query
          description: Maximum number of records to return per page.
          schema:
            type: integer
            minimum: 1
            maximum: 5000
        - name: cursor
          in: query
          description: Opaque pagination cursor from a previous response.
          schema:
            type: string
        - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Stock-perp funding data returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RwaPerpRatesResponse'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Quota-Limit:
              $ref: '#/components/headers/X-Quota-Limit'
            X-Quota-Remaining:
              $ref: '#/components/headers/X-Quota-Remaining'
            X-Quota-Reset:
              $ref: '#/components/headers/X-Quota-Reset'
            X-Data-Source:
              $ref: '#/components/headers/X-Data-Source'
            X-Data-Stale:
              $ref: '#/components/headers/X-Data-Stale'
            X-Data-As-Of:
              $ref: '#/components/headers/X-Data-As-Of'
            X-Freshness-Sla-Seconds:
              $ref: '#/components/headers/X-Freshness-Sla-Seconds'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/UpstreamError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  parameters:
    FormatParam:
      name: format
      in: query
      description: >-
        Response format. When set to "csv", the response Content-Type is
        text/csv instead of JSON.
      schema:
        default: json
        type: string
        enum:
          - json
          - csv
  schemas:
    RwaPerpRatesResponse:
      anyOf:
        - allOf:
            - $ref: '#/components/schemas/SuccessEnvelope'
            - type: object
              properties:
                data:
                  type: array
                  items:
                    oneOf:
                      - $ref: '#/components/schemas/RwaPerpCurrentRow'
                      - $ref: '#/components/schemas/RwaPerpHistoryRow'
              required:
                - data
        - allOf:
            - $ref: '#/components/schemas/PaginatedEnvelope'
            - type: object
              properties:
                data:
                  type: array
                  items:
                    oneOf:
                      - $ref: '#/components/schemas/RwaPerpCurrentRow'
                      - $ref: '#/components/schemas/RwaPerpHistoryRow'
              required:
                - data
        - allOf:
            - $ref: '#/components/schemas/SuccessEnvelope'
            - type: object
              properties:
                data:
                  $ref: '#/components/schemas/RwaPerpStats'
              required:
                - data
    SuccessEnvelope:
      type: object
      properties:
        data:
          description: >-
            Endpoint-specific response payload. See the operation response
            schema.
        meta:
          $ref: '#/components/schemas/ApiMeta'
      required:
        - data
        - meta
    RwaPerpCurrentRow:
      type: object
      properties:
        venue:
          type: string
        market:
          type: string
        symbol:
          type: string
        asset_class:
          nullable: true
          type: string
        mechanism:
          type: string
        price_deviation:
          nullable: true
          description: >-
            The mark's deviation from the cross-venue median mark, a fraction
            (0.01 is 1%). Beyond ±0.02 the row is `is_price_suspect`.
          type: number
        is_price_suspect:
          nullable: true
          type: boolean
        last_nonzero_funding_apr:
          nullable: true
          type: number
        last_nonzero_funding_at:
          nullable: true
          type: string
          format: date-time
        funding_rate:
          nullable: true
          description: >-
            Funding as a decimal fraction per `interval_hours`: for the
            standard-funding venues the in-progress rate for the settlement at
            `next_funding_time` (Kraken's prediction, Lighter's 8h-basis rate
            divided by 8 for its hourly charge), so `funding_rate × notional`
            estimates the next payment. GET /api/funding/rates serves Kraken's
            last settled rate for the same market instead (see its `rate_kind`).
            `null` when the venue published none.
          type: number
        interval_hours:
          type: number
          description: >-
            Hours between this market's settlements: the span `funding_rate` is
            charged over, and the gap to `next_funding_time`.
        funding_apr:
          nullable: true
          type: number
        borrow_apr_annual:
          nullable: true
          type: number
        mark_price:
          nullable: true
          type: number
        oracle_price:
          nullable: true
          type: number
        open_interest_usd:
          nullable: true
          type: number
        next_funding_time:
          nullable: true
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        is_stale:
          type: boolean
        funding_status:
          type: string
          enum:
            - live
            - zero
            - paused
            - zero_by_design
            - none
          description: >-
            What funding_rate means now. live: non-zero. zero: exactly 0 while
            the underlying's home market is open, on a market that has printed
            non-zero funding (a real 0, often a formula's dead band). paused:
            exactly 0 while the home market is closed on a market that does fund
            (Bitget and Bybit stock perps settle 0 outside US hours).
            zero_by_design: exactly 0 on a market that has never printed
            non-zero funding. none: no periodic funding (rollover venues). Only
            live and zero enter stats spreads.
      required:
        - venue
        - market
        - symbol
        - asset_class
        - mechanism
        - price_deviation
        - is_price_suspect
        - last_nonzero_funding_apr
        - last_nonzero_funding_at
        - funding_rate
        - interval_hours
        - funding_apr
        - borrow_apr_annual
        - mark_price
        - oracle_price
        - open_interest_usd
        - next_funding_time
        - updated_at
        - is_stale
        - funding_status
    RwaPerpHistoryRow:
      type: object
      properties:
        venue:
          type: string
        market:
          type: string
        symbol:
          type: string
        rate:
          type: number
        interval_hours:
          type: number
        session_phase:
          type: string
        settled_at:
          type: string
          format: date-time
      required:
        - venue
        - market
        - symbol
        - rate
        - interval_hours
        - session_phase
        - settled_at
    PaginatedEnvelope:
      type: object
      properties:
        data:
          type: array
          items: {}
          description: Endpoint-specific result items.
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
        meta:
          $ref: '#/components/schemas/ApiMeta'
      required:
        - data
        - pagination
        - meta
    RwaPerpStats:
      type: object
      properties:
        bestCarry:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RwaCarryMetric'
        topSpread:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RwaSpreadMetric'
        weekendPremiumApr:
          nullable: true
          type: number
        totalOpenInterestUsd:
          nullable: true
          type: number
        venues:
          type: integer
        symbols:
          type: integer
        markets:
          type: integer
        asOf:
          nullable: true
          type: string
          format: date-time
        stale:
          type: boolean
        laggingVenues:
          type: array
          items:
            type: object
            properties:
              venue:
                type: string
              asOf:
                nullable: true
                type: string
                format: date-time
            required:
              - venue
              - asOf
          description: >-
            Venue syncs behind the freshness threshold, oldest first; the rest
            are current. Empty when every venue is current.
      required:
        - bestCarry
        - topSpread
        - weekendPremiumApr
        - totalOpenInterestUsd
        - venues
        - symbols
        - markets
        - asOf
        - stale
        - laggingVenues
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: URI identifying the error type.
          example: https://www.sharpe.ai/errors/invalid_parameter
        title:
          type: string
          description: Short human-readable summary.
          example: Invalid Parameter
        status:
          type: integer
          description: HTTP status code.
          example: 400
        detail:
          type: string
          description: Human-readable explanation specific to this occurrence.
          example: 'Invalid parameter "coin": must not be empty'
        request_id:
          type: string
          description: Unique request identifier for support reference.
          example: req_a1b2c3d4e5f6g7h8i9j0
        doc_url:
          type: string
          format: uri
          description: Link to the relevant documentation page for troubleshooting.
          example: https://www.sharpe.ai/docs/errors#error-codes
        suggested_action:
          type: string
          description: Actionable suggestion for resolving the error.
          example: >-
            Check the 'coin' parameter value and ensure it is a valid ticker
            symbol.
      required:
        - type
        - title
        - status
        - detail
        - request_id
        - doc_url
        - suggested_action
      description: Error response following RFC 9457 (Problem Details for HTTP APIs).
    ApiMeta:
      type: object
      properties:
        request_id:
          type: string
          description: Unique request identifier.
          example: req_a1b2c3d4e5f6g7h8i9j0
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the response.
        elapsed_ms:
          type: integer
          minimum: 0
          description: Server processing time in milliseconds.
        dataset_id:
          type: string
          enum:
            - funding_rates_current
            - funding_rates_history
            - funding_accumulated
            - funding_fee_settlement
            - global_overview_snapshot
            - futures_open_interest
            - futures_basis
            - futures_term_structure
            - futures_liquidations
            - futures_long_short_ratio
            - futures_ohlcv
            - futures_coins
            - rwa_perp_rates_current
            - arbitrage_tickers
            - arbitrage_boards
            - arbitrage_dated_quotes
            - narratives
            - ecosystems
            - memecoins
            - mindshare
            - sectors
            - chains
            - sector_coins
            - chain_coins
            - gem_finder
            - web_traffic
            - heatmap_cache
            - stablecoins
            - news
            - listings
            - memecoin_launches
            - rug_check_inputs
            - rug_check_trending
            - pump_dump
            - insider_pressure
            - price_prediction_inputs
            - correlation_prices
            - market_cap_search
            - coingecko_coin_list
            - boros_markets
            - margin_borrow_rates
          description: >-
            The dataset the answer is read from; /v1/meta/coverage lists each
            product's datasets with their cadence and SLA.
        as_of:
          nullable: true
          type: string
          format: date-time
          description: >-
            When the data was current: the dataset's own time (the newest live
            row, the snapshot or refresh time, the fetch time), not the response
            time. Null when unknown.
        stale_after:
          nullable: true
          type: string
          format: date-time
          description: >-
            `as_of` plus the freshness SLA: after this instant the data is
            stale, whenever the body is read (a cached copy can be re-judged
            against it).
        freshness_sla_seconds:
          type: number
          description: >-
            Seconds after `as_of` the data stays fresh: the writer's cadence
            plus one skipped run.
        freshness_status:
          type: string
          enum:
            - fresh
            - stale
            - unknown
          description: >-
            `fresh` within the SLA at `generated_at`, `stale` past it, `unknown`
            when `as_of` is null.
        runtime_status:
          type: string
          enum:
            - ok
            - degraded
          description: >-
            `degraded` when this read was incomplete: a leg timed out or failed,
            a row budget was hit, or a fallback answered. Degraded answers are
            never cached.
        served_from:
          type: string
          enum:
            - snapshot
            - table
            - matview
            - live
            - last-good
          description: >-
            Where the rows came from: a precomputed snapshot, a table or
            materialized view, the upstream on request, or the server's last
            good answer.
        generated_at:
          type: string
          format: date-time
          description: >-
            When this answer was built (the instant `freshness_status` is judged
            at).
        source:
          type: array
          items:
            type: string
          description: >-
            The upstream sources behind the rows (source ids such as `binance`,
            `coingecko`).
        coverage:
          type: object
          properties:
            expected:
              type: number
            used:
              type: number
            dropped:
              type: object
              additionalProperties:
                type: number
            missing:
              type: array
              items:
                type: string
          required:
            - expected
            - used
            - dropped
          description: >-
            How complete the stored data is (never whether it is cached): `used`
            of `expected` inputs counted; `dropped` counts the rest by reason (a
            halted market is `not_live`, outside `expected`); `missing` names
            the late ones when known.
        warnings:
          type: array
          items:
            type: string
          description: >-
            What the read could not do, in words (an unreadable table, a late
            writer).
        truncated:
          type: boolean
          description: True when a row budget cut the answer short.
      required:
        - request_id
        - timestamp
        - elapsed_ms
    PaginationInfo:
      type: object
      properties:
        cursor:
          nullable: true
          type: string
        has_more:
          type: boolean
        total:
          type: integer
          minimum: 0
      required:
        - cursor
        - has_more
        - total
    RwaCarryMetric:
      type: object
      properties:
        symbol:
          type: string
        venue:
          type: string
        fundingApr:
          type: number
          description: >-
            Realised funding over the trailing windowHours: the settled rates
            summed and annualised (x 8760 / windowHours). Never one annualised
            print.
        mechanism:
          type: string
        windowHours:
          type: integer
          description: Length of the realised window, in hours (24).
        settlements:
          type: integer
          description: >-
            Settlements stored in the window. The market qualifies when they
            cover at least 90% of the window's hours (the hours each settlement
            stands for), not by their count.
      required:
        - symbol
        - venue
        - fundingApr
        - mechanism
        - windowHours
        - settlements
      description: >-
        Highest trailing-24h realised funding APR on a market with at least $1M
        open interest. Settlement history is stored for Hyperliquid and Kraken
        only, so best carry ranks those venues; null when none has at least 90%
        of the window covered by its settlements.
    RwaSpreadMetric:
      type: object
      properties:
        symbol:
          type: string
        spreadApr:
          type: number
          description: >-
            maxApr - minApr: the widest trusted cross-venue funding spread, this
            period annualised. Legs are funding_status live or zero only: a
            paused or by-design 0 is never a leg.
        maxVenue:
          type: string
        minVenue:
          type: string
        maxApr:
          type: number
        minApr:
          type: number
      required:
        - symbol
        - spreadApr
        - maxVenue
        - minVenue
        - maxApr
        - minApr
  headers:
    X-Request-Id:
      schema:
        type: string
      description: Unique request identifier. Include this value when contacting support.
    X-RateLimit-Limit:
      schema:
        type: integer
      description: Requests allowed per minute for the authenticated API key.
    X-RateLimit-Remaining:
      schema:
        type: integer
      description: Requests remaining in the current one-minute rate-limit window.
    X-RateLimit-Reset:
      schema:
        type: integer
      description: Unix timestamp in seconds when the current rate-limit window resets.
    X-Quota-Limit:
      schema:
        type: integer
      description: Monthly request quota for the authenticated API key.
    X-Quota-Remaining:
      schema:
        type: integer
      description: Monthly requests remaining in the current billing period.
    X-Quota-Reset:
      schema:
        type: string
        format: date-time
      description: >-
        ISO 8601 timestamp when the monthly quota resets, when available from
        the quota store.
    X-Data-Source:
      schema:
        type: string
      description: >-
        The sources behind the rows, comma-separated source ids (e.g.
        `binance,bybit`): `meta.source`. /v1/funding/rates and
        /v1/rwa-perps/rates send the origin tier instead, `live` or `supabase`.
    X-Data-Stale:
      schema:
        type: boolean
      description: >-
        True when the data is past its freshness SLA (`meta.freshness_status` is
        not `fresh`), judged for the answer as a whole; rows keep their own
        staleness flags. /v1/funding/rates and /v1/rwa-perps/rates set it when
        the response is empty or at least one returned row exceeds the published
        freshness target.
    X-Data-As-Of:
      schema:
        type: string
        format: date-time
      description: >-
        When the data was current: `meta.as_of` (the newest live row, the
        snapshot or refresh time, or the fetch time). /v1/funding/rates and
        /v1/rwa-perps/rates: the newest source timestamp in the response.
    X-Freshness-Sla-Seconds:
      schema:
        type: integer
      description: >-
        The dataset's freshness SLA in seconds (`meta.freshness_sla_seconds`):
        the writer's cadence plus one skipped run.
    Retry-After:
      schema:
        type: integer
      description: >-
        Seconds to wait before retrying after a per-minute rate-limit or
        monthly-quota rejection.
  responses:
    BadRequest:
      description: Invalid or missing parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/invalid_parameter
            title: Invalid Parameter
            status: 400
            detail: 'Invalid parameter "coin": must not be empty'
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#error-codes
            suggested_action: >-
              Check the parameter value against the endpoint documentation. Use
              GET /v1/futures/coins or GET /v1/meta/coverage to discover valid
              values.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    Unauthorized:
      description: >-
        Missing or invalid API key, or a key without an active plan
        (`expired_api_key`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid_api_key:
              summary: Missing or invalid API key
              value:
                type: https://www.sharpe.ai/errors/invalid_api_key
                title: Invalid API Key
                status: 401
                detail: >-
                  Missing API key. Pass via Authorization: Bearer <key> or the
                  X-API-Key header.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/authentication
                suggested_action: >-
                  Check your API key is correct. Pass it via Authorization:
                  Bearer <key> or the X-API-Key header.
            expired_api_key:
              summary: The key has no active plan
              value:
                type: https://www.sharpe.ai/errors/expired_api_key
                title: Expired API Key
                status: 401
                detail: >-
                  This API key has no active plan. Subscribe or renew at
                  https://www.sharpe.ai/dashboard/billing.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/authentication
                suggested_action: >-
                  Subscribe or renew at https://www.sharpe.ai/dashboard/billing.
                  The same key works again once the plan is active.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    Forbidden:
      description: The API key lacks a scope this endpoint requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/insufficient_scope
            title: Insufficient Scope
            status: 403
            detail: 'This API key requires the following scope(s): read.'
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/authentication
            suggested_action: >-
              Create a new API key with the required scopes, or contact support
              to update scopes on your existing key.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    RateLimited:
      description: >-
        Per-minute rate limit or monthly quota exceeded. Both are temporary;
        retry after the Retry-After header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rate_limit_exceeded:
              summary: Per-minute rate limit exceeded
              value:
                type: https://www.sharpe.ai/errors/rate_limit_exceeded
                title: Rate Limit Exceeded
                status: 429
                detail: Rate limit of 30 requests per minute exceeded.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/rate-limits
                suggested_action: >-
                  Wait until the time in the X-RateLimit-Reset header before
                  retrying. Upgrade your plan for higher limits.
            monthly_quota_exceeded:
              summary: Monthly quota exceeded
              value:
                type: https://www.sharpe.ai/errors/monthly_quota_exceeded
                title: Monthly Quota Exceeded
                status: 429
                detail: >-
                  Monthly quota of 50,000 requests exceeded. Resets at
                  2026-12-01T00:00:00.000Z.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/rate-limits
                suggested_action: >-
                  Retry after the seconds given in the Retry-After header, when
                  the monthly quota resets. Upgrade your plan for a higher
                  monthly quota. Check usage at GET /v1/usage.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-Quota-Limit:
          $ref: '#/components/headers/X-Quota-Limit'
        X-Quota-Remaining:
          $ref: '#/components/headers/X-Quota-Remaining'
        X-Quota-Reset:
          $ref: '#/components/headers/X-Quota-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/internal_error
            title: Internal Server Error
            status: 500
            detail: An unexpected error occurred. Please try again later.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#retry-guidance
            suggested_action: >-
              Retry with exponential backoff (1s, 2s, 4s, up to 30s). If the
              error persists, contact support with the X-Request-Id.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    UpstreamError:
      description: An upstream data source or dependency returned an error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/upstream_error
            title: Upstream Error
            status: 502
            detail: A data source is temporarily unavailable.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#retry-guidance
            suggested_action: >-
              A data source is temporarily unavailable. Retry with exponential
              backoff. If it persists, contact team@sharpe.ai with the
              X-Request-Id.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    ServiceUnavailable:
      description: The API or quota verification service is temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/service_unavailable
            title: Service Unavailable
            status: 503
            detail: >-
              API key verification is temporarily unavailable. Please retry
              shortly.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#retry-guidance
            suggested_action: >-
              The API is temporarily unavailable. Retry with exponential
              backoff. If it persists, contact team@sharpe.ai with the
              X-Request-Id.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your API key as a Bearer token in the Authorization header:
        `Authorization: Bearer sk_live_...`
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternatively, pass your API key via the X-API-Key header.

````

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