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

# Global market overview

> Whole-market derivatives board. Returns market-wide metrics (total open interest -- one-sided USD notional, each contract counted once, summed over every venue except metrics.openInterestExcludedVenues -- with its crypto-versus-RWA split, 24h liquidations on Binance, Bybit and Deribit only (a lower bound, not the market total), average Wilder RSI(14) across the top 100 crypto perps by market cap, the Altcoin Season Index, and open interest by asset class) plus a ranked per-asset row table for the requested tab. Liquidations are crypto-only: no RWA perp venue publishes a liquidation feed. Market cap is absent on the preipo and index tabs. When composing the board fails or runs past its 20-second budget, the crypto tab answers from the last composed snapshot with X-Data-Stale true and X-Data-As-Of set to that snapshot's own time, not cached; other tabs answer the last board the server composed for the tab, flagged the same way, when it has one, and 503 (Retry-After: 30) otherwise. A tab with no rows returns 503.



## OpenAPI

````yaml /openapi.json get /v1/global/overview
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/global/overview:
    get:
      tags:
        - Derivatives
      summary: Global market overview
      description: >-
        Whole-market derivatives board. Returns market-wide metrics (total open
        interest -- one-sided USD notional, each contract counted once, summed
        over every venue except metrics.openInterestExcludedVenues -- with its
        crypto-versus-RWA split, 24h liquidations on Binance, Bybit and Deribit
        only (a lower bound, not the market total), average Wilder RSI(14)
        across the top 100 crypto perps by market cap, the Altcoin Season Index,
        and open interest by asset class) plus a ranked per-asset row table for
        the requested tab. Liquidations are crypto-only: no RWA perp venue
        publishes a liquidation feed. Market cap is absent on the preipo and
        index tabs. When composing the board fails or runs past its 20-second
        budget, the crypto tab answers from the last composed snapshot with
        X-Data-Stale true and X-Data-As-Of set to that snapshot's own time, not
        cached; other tabs answer the last board the server composed for the
        tab, flagged the same way, when it has one, and 503 (Retry-After: 30)
        otherwise. A tab with no rows returns 503.
      operationId: getGlobalOverview
      parameters:
        - name: tab
          in: query
          description: >-
            Universe to return rows for. The metric block is identical on every
            tab.
          schema:
            default: crypto
            type: string
            enum:
              - crypto
              - equity
              - preipo
              - etf
              - index
              - commodity
              - fx
        - name: limit
          in: query
          description: Maximum rows per page (1-1000). Enables cursor pagination.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
        - name: cursor
          in: query
          description: Opaque pagination cursor from a previous response.
          schema:
            type: string
      responses:
        '200':
          description: Global market overview returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalOverviewResponse'
          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'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    GlobalOverviewResponse:
      anyOf:
        - allOf:
            - $ref: '#/components/schemas/SuccessEnvelope'
            - type: object
              properties:
                data:
                  type: object
                  properties:
                    tab:
                      type: string
                      enum:
                        - crypto
                        - equity
                        - preipo
                        - etf
                        - index
                        - commodity
                        - fx
                    updatedAt:
                      type: string
                      format: date-time
                    isStale:
                      type: boolean
                    metrics:
                      type: object
                      properties:
                        openInterestUsd:
                          type: number
                        openInterestChange24h:
                          nullable: true
                          type: number
                        openInterestSparkline:
                          type: array
                          items:
                            type: object
                            properties:
                              t:
                                type: string
                                format: date-time
                              v:
                                type: number
                        cryptoOpenInterestUsd:
                          type: number
                        rwaOpenInterestUsd:
                          type: number
                        liquidations24hUsd:
                          nullable: true
                          description: >-
                            Crypto only, and a lower bound rather than a
                            market-wide total: liquidations for three venues
                            (Binance and Bybit from our own capture, Deribit
                            from Velo) over the coins the futures sync tracks
                            (~85 rows carry one), summed over hourly buckets in
                            a rolling 23-24h window, newest bucket still
                            accumulating. OKX is not included (its series is a
                            delayed, partial sample of OKX's liquidations, not
                            their total), and neither are the other venues
                            behind openInterestUsd (Hyperliquid, Gate, Bitget,
                            ...).
                          type: number
                        liquidationsChange24h:
                          nullable: true
                          type: number
                        liquidationsLongUsd:
                          nullable: true
                          description: >-
                            Long side of the 24h liquidation total, so a cascade
                            reads as flushed longs or shorts. Crypto only.
                          type: number
                        liquidationsShortUsd:
                          nullable: true
                          description: >-
                            Short side of the 24h liquidation total. Crypto
                            only.
                          type: number
                        liquidationsSparkline:
                          type: array
                          items:
                            type: object
                            properties:
                              t:
                                type: string
                                format: date-time
                              v:
                                type: number
                        avgRsi:
                          nullable: true
                          description: >-
                            Unweighted mean Wilder RSI(14) on daily closes, top
                            100 crypto perps by market cap.
                          type: number
                        avgRsiSampleSize:
                          type: integer
                        altcoinSeasonIndex:
                          nullable: true
                          description: >-
                            Share of the top 50 by market cap beating BTC over
                            90 days; excludes stablecoins and wrapped/staked
                            derivatives.
                          type: number
                        altcoinSeasonSampleSize:
                          type: integer
                        classBreakdown:
                          type: array
                          items:
                            type: object
                            properties:
                              tab:
                                type: string
                              label:
                                type: string
                              openInterestUsd:
                                type: number
                              symbolCount:
                                type: integer
                        openInterestExcludedVenues:
                          type: array
                          items:
                            $ref: '#/components/schemas/OpenInterestExclusion'
                          description: >-
                            Venues whose open interest every figure on the board
                            leaves out, with the reason.
                    rows:
                      type: array
                      items:
                        $ref: '#/components/schemas/GlobalRow'
              required:
                - data
        - allOf:
            - $ref: '#/components/schemas/PaginatedEnvelope'
            - type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/GlobalRow'
              required:
                - data
      description: >-
        Market-wide metrics plus the ranked row table for one asset class.
        Paginated requests return rows only.
    SuccessEnvelope:
      type: object
      properties:
        data:
          description: >-
            Endpoint-specific response payload. See the operation response
            schema.
        meta:
          $ref: '#/components/schemas/ApiMeta'
      required:
        - data
        - meta
    OpenInterestExclusion:
      type: object
      properties:
        exchange:
          type: string
        reason:
          type: string
      required:
        - exchange
        - reason
      description: >-
        A venue whose stored open interest is published per venue but left out
        of every cross-venue total, and why. MEXC today: its holdVol moves 7.00x
        the position change of MEXC's own deal feed, so it fits neither side
        count.
    GlobalRow:
      type: object
      properties:
        rank:
          type: integer
        symbol:
          type: string
        name:
          type: string
        logoUrl:
          nullable: true
          type: string
        price:
          nullable: true
          description: >-
            Crypto tab: the freshest of the coin's 1h futures candle close, its
            Binance mark from the funding book (5-minute refresh), the CoinGecko
            price (3-hourly) and the last daily close; null when the coin has
            none of them. RWA tabs: the venues' mark price.
          type: number
        return24h:
          nullable: true
          description: >-
            The 24h price return, a fraction (0.01 is 1%). Crypto tab: from the
            1h futures candles (about 100 coins the futures sync tracks), else
            CoinGecko's 24h change (top 100 by market cap); null for most of the
            long tail.
          type: number
        fundingRate:
          nullable: true
          description: >-
            Funding fraction normalized to an 8h basis; never assumes the venue
            interval. Crypto tab: the coin's average across venues (the funding
            grid's Avg Rate), each venue's primary contract weighted by its
            one-sided open interest when at least two venues, and a majority of
            them, carry open interest, otherwise their median; only venues
            refreshed within 10 minutes; null when there is none. RWA tabs: the
            open-interest-weighted mean across RWA venues.
          type: number
        volume24hUsd:
          nullable: true
          description: >-
            Crypto tab: 24h futures notional from the 1h candles, which cover
            only the ~100 coins the futures sync tracks, so most crypto rows are
            null (not measured, never spot volume).
          type: number
        volumeChange24h:
          nullable: true
          type: number
        marketCapUsd:
          nullable: true
          description: >-
            Crypto tab: CoinGecko market cap, top 100 coins by market cap only
            (null below). Null on every RWA tab (no RWA market-cap source),
            including preipo and index, where no market cap exists.
          type: number
        openInterestUsd:
          nullable: true
          type: number
        oiChange1h:
          nullable: true
          type: number
        oiChange24h:
          nullable: true
          type: number
        liquidations24hUsd:
          nullable: true
          description: >-
            Crypto tab only: 24h liquidations on Binance and Bybit (our own
            capture of their liquidation streams) and Deribit (Velo), not every
            venue behind openInterestUsd. OKX is left out: its series is a
            delayed, partial sample of OKX's liquidations, not their total. Null
            for coins the futures sync does not track and on RWA tabs, where no
            venue publishes a liquidation feed.
          type: number
        venueCount:
          nullable: true
          description: >-
            Venues behind openInterestUsd: on the crypto tab the distinct venues
            holding the asset's contracts (lot and quote spellings count once
            per venue); on RWA tabs how many venues list the underlying.
          type: integer
        isStale:
          type: boolean
    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-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'
    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.