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

# Narratives data

> Returns narrative-level market data (L1, L2, DeFi, AI Agents, etc.) including market cap, volume, performance, and social metrics.



## OpenAPI

````yaml /openapi.json get /v1/narratives/data
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/narratives/data:
    get:
      tags:
        - Categories
      summary: Narratives data
      description: >-
        Returns narrative-level market data (L1, L2, DeFi, AI Agents, etc.)
        including market cap, volume, performance, and social metrics.
      operationId: getNarrativesData
      parameters:
        - name: narrative
          in: query
          description: >-
            Narrative to return detail for: the config id (e.g. dex) or the URL
            slug (e.g. dex-tokens, layer-1, ai-agents). An unknown value returns
            400 invalid_parameter listing the valid values.
          schema:
            type: string
        - name: correlation
          in: query
          description: Set to "true" to include correlation data.
          schema:
            type: string
        - name: timeframe
          in: query
          description: Timeframe for correlation data.
          schema:
            type: string
        - name: sort
          in: query
          description: >-
            List only: order `narratives` by 24h return, highest (`-return24h`)
            or lowest (`return24h`) first; a narrative without a 24h return is
            last either way.
          schema:
            type: string
            enum:
              - '-return24h'
              - return24h
        - name: top
          in: query
          description: 'List only: add `top`, the N narratives with the highest 24h change.'
          schema:
            type: integer
            minimum: 1
            maximum: 50
        - name: bottom
          in: query
          description: >-
            List only: add `bottom`, the N narratives with the lowest 24h
            change.
          schema:
            type: integer
            minimum: 1
            maximum: 50
        - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Narratives data returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NarrativesDataResponse'
          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'
        '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:
    NarrativesDataResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              anyOf:
                - $ref: '#/components/schemas/NarrativeOverviewPayload'
                - $ref: '#/components/schemas/NarrativeDetailPayload'
                - $ref: '#/components/schemas/CategoryCorrelationPayload'
          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
    NarrativeOverviewPayload:
      type: object
      properties:
        narratives:
          type: array
          items:
            $ref: '#/components/schemas/NarrativeMarketRow'
        top:
          description: >-
            With `top=N`: the N narratives with the highest `return24h`, highest
            first (a narrative without one is never ranked).
          type: array
          items:
            $ref: '#/components/schemas/NarrativeMarketRow'
        bottom:
          description: >-
            With `bottom=N`: the N narratives with the lowest `return24h`,
            lowest first.
          type: array
          items:
            $ref: '#/components/schemas/NarrativeMarketRow'
        totalNarrativeMcap:
          nullable: true
          type: number
        updatedAt:
          type: string
          description: >-
            ISO timestamp for populated cache data; an empty string for an empty
            cache response.
        basePrices:
          nullable: true
          description: >-
            `null` when CoinGecko did not return every window for BTC, ETH and
            SOL; no window reads a fabricated 0.
          allOf:
            - $ref: '#/components/schemas/CategoryBasePrices'
        lastAttemptAt:
          type: string
          format: date-time
          description: >-
            When the last sync ran. `updatedAt` stays at the last complete
            refresh when that run kept the previous rows.
        status:
          type: string
          enum:
            - full
            - partial
          description: '`partial` when at least one category fetch failed in the last sync.'
        coverage:
          $ref: '#/components/schemas/CategorySyncCoverage'
      required:
        - narratives
        - totalNarrativeMcap
        - updatedAt
    NarrativeDetailPayload:
      type: object
      properties:
        narratives:
          type: array
          items:
            $ref: '#/components/schemas/NarrativeMarketRow'
        totalNarrativeMcap:
          nullable: true
          type: number
        updatedAt:
          type: string
        coins:
          type: array
          items:
            $ref: '#/components/schemas/NarrativeCoin'
        sparkline:
          type: array
          items:
            minItems: 2
            maxItems: 2
            type: array
            items:
              type: number
        basePrices:
          nullable: true
          description: >-
            `null` when CoinGecko did not return every window for BTC, ETH and
            SOL; no window reads a fabricated 0.
          allOf:
            - $ref: '#/components/schemas/CategoryBasePrices'
        lastAttemptAt:
          type: string
          format: date-time
          description: >-
            When the last sync ran. `updatedAt` stays at the last complete
            refresh when that run kept the previous rows.
        status:
          type: string
          enum:
            - full
            - partial
          description: '`partial` when at least one category fetch failed in the last sync.'
        coverage:
          $ref: '#/components/schemas/CategorySyncCoverage'
      required:
        - narratives
        - totalNarrativeMcap
        - updatedAt
        - coins
        - sparkline
    CategoryCorrelationPayload:
      type: object
      properties:
        timeframe:
          type: string
          enum:
            - 24H
            - 1W
            - 1M
            - 3M
            - 6M
            - MTD
            - YTD
            - 1Y
        labels:
          type: array
          items:
            type: string
        matrix:
          type: array
          items:
            type: array
            items:
              nullable: true
              type: number
        coverage:
          $ref: '#/components/schemas/CategoryCoverage'
        availableTimeframes:
          type: array
          items:
            type: string
            enum:
              - 24H
              - 1W
              - 1M
              - 3M
              - 6M
              - MTD
              - YTD
              - 1Y
      required:
        - timeframe
        - labels
        - matrix
    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
    NarrativeMarketRow:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        return1h:
          nullable: true
          type: number
        return24h:
          nullable: true
          type: number
        return7d:
          nullable: true
          type: number
        return30d:
          nullable: true
          type: number
        return200d:
          nullable: true
          type: number
        return1y:
          nullable: true
          type: number
        medianReturn1h:
          nullable: true
          type: number
        medianReturn24h:
          nullable: true
          type: number
        medianReturn7d:
          nullable: true
          type: number
        medianReturn30d:
          nullable: true
          type: number
        medianReturn200d:
          nullable: true
          type: number
        medianReturn1y:
          nullable: true
          type: number
        marketCap:
          nullable: true
          type: number
        volume24h:
          nullable: true
          type: number
        openInterest:
          nullable: true
          description: >-
            One-sided open interest across every venue, summed over the
            constituents' assets (each once).
          type: number
        fundingRate:
          nullable: true
          description: >-
            Annualized, a fraction a year (0.0525 = 5.25% APR): the
            constituents' 8-hour-equivalent funding, weighted by their
            cross-venue open interest, x 1,095. Not the per-8h fraction the coin
            rows' fundingRate (and /global's) carry, which is ~1,000x smaller.
          type: number
        mcapFdvRatio:
          nullable: true
          type: number
        volMcapRatio:
          nullable: true
          type: number
        oiMcapRatio:
          nullable: true
          type: number
        topCoin:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/NarrativeTopCoin'
        coinCount:
          type: integer
        marketShare:
          nullable: true
          description: >-
            The narrative's market cap over the sum of every narrative's, 0 to 1
            (0.7506 is 75.06%). A coin in several narratives counts in each and
            in that sum, so the shares add up to 1 over an overlapping total.
          type: number
        momentumReturn:
          nullable: true
          description: >-
            0.4 x return1h + 0.35 x return24h + 0.25 x return7d, the weights
            renormalised over the windows present, clamped to -1..1: a fraction
            (-0.049 is -4.9%); null when no window is present.
          type: number
        sentiment:
          nullable: true
          description: >-
            Up-vote sentiment merged from the mindshare sync, 0 to 1 (0.704 is
            70.4%), or null when there is no measurement (unmeasured is not 0).
          type: number
        mindshare:
          nullable: true
          description: >-
            Mindshare merged from the mindshare sync, 0 to 1 (0.3616 is 36.16%),
            or null when there is no measurement (unmeasured is not 0).
          type: number
        watchlistUsers:
          nullable: true
          description: >-
            Watchlist users merged from the mindshare sync, or null when there
            is no measurement (never 0 as a stand-in).
          type: integer
        tvl:
          nullable: true
          type: number
        dexVolume:
          nullable: true
          type: number
        dexVolume24h:
          nullable: true
          type: number
        dexVolume7d:
          nullable: true
          type: number
        dexVolume30d:
          nullable: true
          type: number
        protocolRevenue:
          nullable: true
          type: number
        protocolRevenue24h:
          nullable: true
          type: number
        protocolRevenue7d:
          nullable: true
          type: number
        protocolRevenue30d:
          nullable: true
          type: number
      required:
        - id
        - name
        - slug
        - return1h
        - return24h
        - return7d
        - return30d
        - return200d
        - return1y
        - medianReturn1h
        - medianReturn24h
        - medianReturn7d
        - medianReturn30d
        - medianReturn200d
        - medianReturn1y
        - marketCap
        - volume24h
        - openInterest
        - fundingRate
        - mcapFdvRatio
        - volMcapRatio
        - oiMcapRatio
        - topCoin
        - coinCount
        - marketShare
        - momentumReturn
        - sentiment
        - mindshare
        - watchlistUsers
        - tvl
        - dexVolume
        - protocolRevenue
    CategoryBasePrices:
      type: object
      properties:
        btc:
          type: object
          properties:
            return1h:
              type: number
            return24h:
              type: number
            return7d:
              type: number
            return30d:
              type: number
            return200d:
              type: number
            return1y:
              type: number
          required:
            - return1h
            - return24h
            - return7d
            - return30d
            - return200d
            - return1y
        eth:
          type: object
          properties:
            return1h:
              type: number
            return24h:
              type: number
            return7d:
              type: number
            return30d:
              type: number
            return200d:
              type: number
            return1y:
              type: number
          required:
            - return1h
            - return24h
            - return7d
            - return30d
            - return200d
            - return1y
        sol:
          type: object
          properties:
            return1h:
              type: number
            return24h:
              type: number
            return7d:
              type: number
            return30d:
              type: number
            return200d:
              type: number
            return1y:
              type: number
          required:
            - return1h
            - return24h
            - return7d
            - return30d
            - return200d
            - return1y
      required:
        - btc
        - eth
        - sol
      description: >-
        BTC, ETH and SOL price returns from CoinGecko over the six windows, as
        fractions (-0.0249 is -2.49%), used to re-base category returns into
        BTC, ETH or SOL terms. There are no USD prices here.
    CategorySyncCoverage:
      type: object
      properties:
        expectedCount:
          type: integer
        freshCount:
          type: integer
        failedIds:
          type: array
          items:
            type: string
        retainedPreviousAggregate:
          type: boolean
      required:
        - expectedCount
        - freshCount
        - failedIds
        - retainedPreviousAggregate
      description: >-
        How many configured categories the last sync refreshed. When a category
        fetch failed and a previous aggregate existed, the previous rows are
        served unchanged (`retainedPreviousAggregate`).
    NarrativeCoin:
      type: object
      properties:
        id:
          type: string
        symbol:
          type: string
        name:
          type: string
        image:
          type: string
        price:
          nullable: true
          type: number
        marketCap:
          nullable: true
          type: number
        fdv:
          nullable: true
          type: number
        volume24h:
          nullable: true
          type: number
        return1h:
          nullable: true
          type: number
        return24h:
          nullable: true
          type: number
        return7d:
          nullable: true
          type: number
        return30d:
          nullable: true
          type: number
        return200d:
          nullable: true
          type: number
        return1y:
          nullable: true
          type: number
        ath:
          nullable: true
          type: number
        fromAth:
          nullable: true
          type: number
        fundingRate:
          nullable: true
          description: >-
            The coin's funding across venues, 8-hour-equivalent (fraction per 8
            hours), open-interest-weighted over each venue's primary contract;
            null when no venue has a fresh rate.
          type: number
        avgFundingApr:
          nullable: true
          description: '`fundingRate` x 1,095: a fraction a year (0.0493 is 4.93% APR).'
          type: number
        openInterest:
          nullable: true
          type: number
        sparkline7d:
          type: array
          items:
            type: number
      required:
        - id
        - symbol
        - name
        - image
        - price
        - marketCap
        - fdv
        - volume24h
        - return1h
        - return24h
        - return7d
        - return30d
        - return200d
        - return1y
        - ath
        - fromAth
        - fundingRate
        - openInterest
        - sparkline7d
    CategoryCoverage:
      type: object
      properties:
        status:
          type: string
          enum:
            - full
            - partial
            - insufficient
            - unknown
        requestedSince:
          nullable: true
          type: string
          format: date-time
        availableSince:
          nullable: true
          type: string
          format: date-time
        availableUntil:
          nullable: true
          type: string
          format: date-time
        computedAt:
          nullable: true
          type: string
          format: date-time
        pointCount:
          type: integer
        bucketSeconds:
          nullable: true
          type: integer
        usablePairCount:
          type: integer
      required:
        - status
        - requestedSince
        - availableSince
        - availableUntil
        - computedAt
        - pointCount
        - bucketSeconds
        - usablePairCount
    NarrativeTopCoin:
      type: object
      properties:
        symbol:
          type: string
        image:
          type: string
        price:
          nullable: true
          type: number
        return24h:
          nullable: true
          type: number
      required:
        - symbol
        - image
        - price
        - return24h
  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.
    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.