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

# Cross-exchange arbitrage

> Returns cross-exchange funding differentials across every funding venue and asset class — crypto plus RWA perps (equity, commodity, FX, index). Legs pair within one instrument-master asset (BONK, 1000BONK and KBONK are one; prices compared per asset unit), never across asset classes. One row per coin: the executable pair with the highest net APR, else the best pair whose only gap is unreported depth (`no_depth`), else the largest gross differential. netFundingRate is the per-period differential at intervalHours (the faster leg's cadence). Spread uses real order books where both legs expose one (spreadSource "book") and reference prices otherwise ("reference"). A row is executable when its spread is book-priced, its legs are within 5% of each other, both quotes are fresh and top-of-book depth reported by BOTH venues covers $10,000 (unknown depth is indicative `no_depth`, never executable); executable rows rank first by netApr — gross less both venues' taker fees and the adverse entry spread over a 30-day hold, present only on book-priced rows — then `no_depth` rows, then the other indicative rows, each by netApr where present, else gross annualized differential (apr). Unknown spread, open interest or volume are null, never zero.



## OpenAPI

````yaml /openapi.json get /v1/arbitrage/cross-exchange
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/arbitrage/cross-exchange:
    get:
      tags:
        - Arbitrage
      summary: Cross-exchange arbitrage
      description: >-
        Returns cross-exchange funding differentials across every funding venue
        and asset class — crypto plus RWA perps (equity, commodity, FX, index).
        Legs pair within one instrument-master asset (BONK, 1000BONK and KBONK
        are one; prices compared per asset unit), never across asset classes.
        One row per coin: the executable pair with the highest net APR, else the
        best pair whose only gap is unreported depth (`no_depth`), else the
        largest gross differential. netFundingRate is the per-period
        differential at intervalHours (the faster leg's cadence). Spread uses
        real order books where both legs expose one (spreadSource "book") and
        reference prices otherwise ("reference"). A row is executable when its
        spread is book-priced, its legs are within 5% of each other, both quotes
        are fresh and top-of-book depth reported by BOTH venues covers $10,000
        (unknown depth is indicative `no_depth`, never executable); executable
        rows rank first by netApr — gross less both venues' taker fees and the
        adverse entry spread over a 30-day hold, present only on book-priced
        rows — then `no_depth` rows, then the other indicative rows, each by
        netApr where present, else gross annualized differential (apr). Unknown
        spread, open interest or volume are null, never zero.
      operationId: getCrossExchangeArbitrage
      parameters:
        - name: exchanges
          in: query
          description: >-
            Comma-separated list of venues to compare. Omit for every funding
            venue in the funding tracker's registry that the instrument master
            does not mark not live (`X-Data-Venues` lists them).
          schema:
            type: string
        - name: assetClass
          in: query
          description: >-
            Underlying filter: "all" (default), "crypto", or "rwa" (equity,
            commodity, FX and index perps).
          schema:
            default: all
            type: string
            enum:
              - all
              - crypto
              - rwa
        - name: minOiUsd
          in: query
          description: >-
            Minimum open interest in USD on the smaller leg. Default 0 (no
            floor). Legs with unknown OI fail a positive floor, and so does a
            leg on a venue left out of the API's open-interest totals (MEXC).
          schema:
            default: 0
            type: number
            minimum: 0
        - name: minVolUsd
          in: query
          description: >-
            Minimum 24h perp volume in USD on the smaller leg. Default 0 (no
            floor). Legs with unknown volume fail a positive floor.
          schema:
            default: 0
            type: number
            minimum: 0
        - name: sector
          in: query
          description: >-
            Narrative filter: only crypto coins in that narrative's CoinGecko
            category (the constituents /api/narratives/data lists). Omit or
            "all" for every coin. A coin the category does not list, and every
            RWA perp, is left out when a sector is set.
          schema:
            type: string
            enum:
              - all
              - memes
              - ai-agents
              - layer-1
              - defi
        - name: limit
          in: query
          description: >-
            Return at most this many rows, the first in board order (executable
            rows first by netApr, then `no_depth` rows, then the rest, each by
            netApr or apr). Default: every row. On v1 a limited answer carries
            `pagination`.
          schema:
            type: integer
            minimum: 1
        - name: cursor
          in: query
          description: >-
            Opaque cursor from the previous page's `pagination.cursor` (100 rows
            a page when `limit` is omitted).
          schema:
            type: string
        - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Arbitrage data returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossExchangeArbitrageResponse'
          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-Missing:
              $ref: '#/components/headers/X-Data-Missing'
            X-Data-Venues:
              $ref: '#/components/headers/X-Data-Venues'
        '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'
        '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:
    CrossExchangeArbitrageResponse:
      anyOf:
        - allOf:
            - $ref: '#/components/schemas/SuccessEnvelope'
            - type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/CrossExchangeOpportunity'
              required:
                - data
        - allOf:
            - $ref: '#/components/schemas/PaginatedEnvelope'
            - type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/CrossExchangeOpportunity'
              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
    CrossExchangeOpportunity:
      type: object
      properties:
        symbol:
          type: string
        assetClass:
          type: string
          enum:
            - crypto
            - equity
            - commodity
            - fx
            - index
          description: >-
            Underlying category from the funding book: `crypto`, `equity`,
            `commodity`, `fx` or `index`. A pair's two legs always share it.
        longExchange:
          type: string
        shortExchange:
          type: string
        longRate:
          type: number
        shortRate:
          type: number
        netFundingRate:
          type: number
        apr:
          type: number
        grossApr:
          type: number
        netApr:
          nullable: true
          description: >-
            `apr` − (2 perpetual taker fills on each venue at its standard fee +
            the adverse entry spread) × 365 / 30, a decimal fraction per year. A
            favourable (negative) spread is never credited. Only on a
            book-priced spread whose legs are within 20% of each other; else
            `null`.
          type: number
        spreadRate:
          nullable: true
          description: >-
            The entry price gap between the legs, not a funding spread:
            (long-leg ask − short-leg bid) ÷ their midpoint, a fraction (from
            last or mark prices when a book is missing, see `spreadSource`).
            Positive costs the trade on entry, negative is favourable. The
            funding spread is `netFundingRate`.
          type: number
        spreadSource:
          nullable: true
          description: >-
            Where `spreadRate` comes from: `book` (both legs' order books),
            `reference` (last or mark prices), or `null` when either leg has no
            price.
          type: string
          enum:
            - book
            - reference
        longAsk:
          nullable: true
          description: >-
            Best ask on the long venue, per asset unit (the contract's price ÷
            its lot multiplier: a 1000PEPE contract's ask ÷ 1000).
          type: number
        shortBid:
          nullable: true
          description: Best bid on the short venue, per asset unit.
          type: number
        executableDepthUsd:
          nullable: true
          description: >-
            Top-of-book depth in USD the entry can fill: the smallest of the
            long venue's ask size and the short venue's bid size among the legs
            that report one. When only one venue reports depth it is that leg's
            figure, an upper bound, and the row is `indicative` (`no_depth`, or
            `thin_book` when it is under $10,000); `null` when neither venue
            reports depth (`no_depth`).
          type: number
        holdingDays:
          type: number
        executionStatus:
          type: string
          enum:
            - executable
            - indicative
          description: >-
            Whether the row can be traded on the figures shown. "executable"
            needs a book-priced spread (spreadSource "book"), leg prices within
            5% of each other, both quotes within the board's 10-minute SLA at
            the time of the request, no leg reporting open interest under
            $10,000, and top-of-book depth REPORTED by both venues and at least
            $10,000 (unknown depth is not evidence of a fill). Anything else is
            "indicative" with `indicativeReason`; past a 20% gap the legs read
            as two instruments and `netApr` is null. Indicative rows keep every
            figure and sort below executable ones: first those whose only gap is
            unreported depth (`no_depth`), then the rest.
        oiLong:
          nullable: true
          type: number
        oiShort:
          nullable: true
          type: number
        volumeLong24hUsd:
          nullable: true
          description: >-
            24h perp turnover in USD on the long venue; `null` when the venue
            does not report it.
          type: number
        volumeShort24hUsd:
          nullable: true
          description: >-
            24h perp turnover in USD on the short venue; `null` when the venue
            does not report it.
          type: number
        nextSettlement:
          nullable: true
          description: >-
            The sooner of the two legs' next settlements; each leg's own is
            `longNextSettlement` / `shortNextSettlement`.
          type: string
          format: date-time
        intervalHours:
          type: number
        pairStatus:
          type: string
          enum:
            - eligible
            - unpriced
            - identity_mismatch
            - not_live
            - contract_type
            - margin_type
            - price_gap
          description: >-
            Whether the two legs are one instrument: `eligible`, `unpriced` when
            a leg has no price to check, else the first check that failed;
            `price_gap` means the legs' prices are more than 20% apart.
        fundingAsOf:
          nullable: true
          description: >-
            When the older leg's funding rate was written; `null` when either is
            unknown.
          type: string
          format: date-time
        pricesAsOf:
          nullable: true
          description: >-
            When the older of the two legs' quotes behind the spread and depth
            was read; `null` when neither leg has a quote.
          type: string
          format: date-time
        indicativeReason:
          nullable: true
          description: >-
            Why the row is `indicative`; `null` when executable.
            `reference_only`: no book on a leg (spread from last or mark
            prices); `price_gap`: legs 5-20% apart (net APR kept) or past 20%
            (none); `thin_book`: reported top-of-book depth under $10,000;
            `oi_below_notional`: a leg reports open interest under $10,000
            (unknown open interest is no evidence either way); `stale_quote`: a
            quote older than the board's 10-minute SLA; `no_depth`: every other
            check passes but a venue reports no top-of-book size, so the fill is
            unproven (ranks right after the executable rows).
          type: string
          enum:
            - unpriced
            - identity_mismatch
            - not_live
            - contract_type
            - margin_type
            - price_gap
            - reference_only
            - thin_book
            - stale_quote
            - no_depth
            - oi_below_notional
        roundTripFeeRate:
          nullable: true
          description: >-
            Two perpetual taker fills on each venue at its standard (VIP 0) fee,
            a decimal fraction of notional.
          type: number
        breakEvenDays:
          nullable: true
          description: >-
            Days of carry that pay back the one-time costs: (fees + adverse
            entry spread) ÷ (`apr` / 365). `null` without a `netApr`.
          type: number
        longSymbol:
          nullable: true
          description: >-
            The long venue's own contract symbol (e.g. `1000PEPEUSDT`, `kPEPE`):
            legs of one asset pair across lot sizes.
          type: string
        shortSymbol:
          nullable: true
          description: The short venue's own contract symbol.
          type: string
        longIntervalHours:
          nullable: true
          description: >-
            The long leg's own funding interval in hours: `longRate` is per this
            many hours (`intervalHours` is the faster of the two legs).
          type: number
        shortIntervalHours:
          nullable: true
          description: >-
            The short leg's own funding interval in hours: `shortRate` is per
            this many hours.
          type: number
        longPricesAsOf:
          nullable: true
          description: When the long venue's quote was read; `null` without one.
          type: string
          format: date-time
        shortPricesAsOf:
          nullable: true
          description: When the short venue's quote was read; `null` without one.
          type: string
          format: date-time
        longNextSettlement:
          nullable: true
          description: >-
            The long leg's own next funding settlement; `null` when the venue
            does not report it. On a mixed-interval pair the slower leg's larger
            print lands here or in `shortNextSettlement`, not in
            `nextSettlement`.
          type: string
          format: date-time
        shortNextSettlement:
          nullable: true
          description: >-
            The short leg's own next funding settlement; `null` when the venue
            does not report it.
          type: string
          format: date-time
      required:
        - symbol
        - assetClass
        - longExchange
        - shortExchange
        - longRate
        - shortRate
        - netFundingRate
        - apr
        - grossApr
        - netApr
        - spreadRate
        - spreadSource
        - longAsk
        - shortBid
        - executableDepthUsd
        - holdingDays
        - executionStatus
        - oiLong
        - oiShort
        - volumeLong24hUsd
        - volumeShort24hUsd
        - nextSettlement
        - intervalHours
    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
    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
  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-Missing:
      schema:
        type: string
      description: >-
        Each configured venue that is not a quoted member of the board,
        comma-separated `Venue:reason`: `not_live` (the instrument master says
        every contract is halted; the venue is not asked), `stale` (no funding
        row inside the funding SLA), `no_ticker` (rows served unpriced: the
        venue has no bulk ticker, or its fetch failed). Absent when every venue
        is a quoted member.
    X-Data-Venues:
      schema:
        type: string
      description: >-
        The venues a venue filter may offer, comma-separated: the configured
        venues the instrument master does not call not live.
    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'
    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.