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

# Pump and dump detection

> Composite score (0-10) flagging coins where price is rising while funding is negative, a divergence pattern consistent with pump-and-dump activity. Gated on negative 72h average funding AND positive 7d price change. Updates every 30 minutes. Units: every share, return and change is a fraction (0.054 = 5.4%). `oi_change_24h` is the change of USD-notional open interest over 24 h on the venues read at both ends, so a price move alone moves it; `return_24h` / `return_7d` are read from the market tracker cache (refreshed every few hours, accepted up to 24 h old), not measured by the 30-minute scoring run; `top10_holders_share` and `signal_coverage` run from 0 to 1; `holders_change`, `liquidity_change` and `volume_change` are relative changes between the two most recent distinct on-chain snapshots (about 3 h apart), and `top10_holders_share_change` the difference of the two shares, each null on a run with no newer snapshot. Basis and CVD exist only for the futures-covered majors, so most altcoin rows carry them null. A `coin` answer is dated by that coin's own row (`updated_at`): a coin that stopped qualifying keeps the inputs of its last qualifying run and reads stale.



## OpenAPI

````yaml /openapi.json get /v1/pump-dump/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/pump-dump/data:
    get:
      tags:
        - Signals
      summary: Pump and dump detection
      description: >-
        Composite score (0-10) flagging coins where price is rising while
        funding is negative, a divergence pattern consistent with pump-and-dump
        activity. Gated on negative 72h average funding AND positive 7d price
        change. Updates every 30 minutes. Units: every share, return and change
        is a fraction (0.054 = 5.4%). `oi_change_24h` is the change of
        USD-notional open interest over 24 h on the venues read at both ends, so
        a price move alone moves it; `return_24h` / `return_7d` are read from
        the market tracker cache (refreshed every few hours, accepted up to 24 h
        old), not measured by the 30-minute scoring run; `top10_holders_share`
        and `signal_coverage` run from 0 to 1; `holders_change`,
        `liquidity_change` and `volume_change` are relative changes between the
        two most recent distinct on-chain snapshots (about 3 h apart), and
        `top10_holders_share_change` the difference of the two shares, each null
        on a run with no newer snapshot. Basis and CVD exist only for the
        futures-covered majors, so most altcoin rows carry them null. A `coin`
        answer is dated by that coin's own row (`updated_at`): a coin that
        stopped qualifying keeps the inputs of its last qualifying run and reads
        stale.
      operationId: getPumpDumpData
      parameters:
        - name: limit
          in: query
          description: Maximum number of coins to return.
          schema:
            default: 100
            type: integer
            minimum: 1
            maximum: 500
        - name: min_score
          in: query
          description: Filter to coins scoring at or above this value.
          schema:
            default: 0
            type: number
            minimum: 0
            maximum: 10
        - name: phase
          in: query
          description: Filter to one manipulation phase label.
          schema:
            type: string
            enum:
              - setup
              - markup
              - distribution
              - dump
              - dumping
        - name: coin
          in: query
          description: >-
            One coin by its CoinGecko id (e.g. pepe): its row exactly as the
            scorer wrote it, whatever its score, and the answer is dated by that
            row's own `updated_at`. A coin that stopped qualifying answers
            `score: null` with its sub-scores and phase cleared, keeps the other
            inputs of its last qualifying run, and reads stale with a warning;
            an id with no row answers an empty list. `limit`, `min_score` and
            `phase` do not apply.
          schema:
            type: string
            minLength: 1
            maxLength: 128
        - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PumpDumpResponse'
          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-Sharpe-Data-State:
              description: Freshness state using the 1-hour market-manipulation SLA.
              schema:
                type: string
                enum:
                  - ok
                  - stale
        '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:
    PumpDumpResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              type: object
              properties:
                coins:
                  type: array
                  items:
                    $ref: '#/components/schemas/PumpDumpRow'
                count:
                  type: integer
                description:
                  type: string
                signal:
                  $ref: '#/components/schemas/ManipulationSignal'
                data_as_of:
                  nullable: true
                  type: string
                  format: date-time
                stale:
                  type: boolean
                freshness_sla_seconds:
                  type: integer
                  enum:
                    - 3600
                  description: Freshness SLA in seconds (1 hour).
              required:
                - coins
                - count
                - description
                - signal
                - data_as_of
                - stale
                - freshness_sla_seconds
          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
    PumpDumpRow:
      type: object
      properties:
        coin_id:
          type: string
        symbol:
          type: string
        name:
          type: string
        score:
          nullable: true
          type: number
        avg_funding_72h:
          nullable: true
          type: number
        exchange_count:
          type: integer
        funding_magnitude:
          nullable: true
          type: number
        manipulation_phase:
          nullable: true
          type: string
        oi_change_24h:
          description: >-
            Fraction (0.07 = +7%): 24 h change of the coin's USD-notional open
            interest over the contracts with a reading 24-28 h before their
            latest (MEXC excluded), computed as `/v1/global/overview` computes
            `oiChange24h`. USD, so a price move alone moves it.
          nullable: true
          type: number
        cvd_trend_24h:
          description: >-
            Taker CVD trend over the newest 24 hourly candles, -1 to 1. Null
            outside the futures-covered majors (the only coins with taker-split
            candles).
          nullable: true
          type: number
        basis_rate_avg:
          description: >-
            Mean perp basis across venues, a fraction. Null outside the
            futures-covered majors (the only coins with stored basis).
          nullable: true
          type: number
        top10_holders_share:
          description: >-
            Share of supply held by the 10 largest holders of the coin's main
            contract, 0 to 1 (0.3553 is 35.53%). Null when unknown. On Pump &
            Dump it is also null when contracts (treasury Safes, vesting,
            bridges, pools) hold over half of that top-10 share; Insider Selling
            keeps that share, since treasury and vesting supply is insider
            supply. Exchange hot wallets count as holders on both.
          nullable: true
          type: number
        holders_count:
          nullable: true
          type: integer
        liquidity_usd:
          nullable: true
          type: number
        volume_24h_usd:
          nullable: true
          type: number
        volume_to_liquidity_24h:
          nullable: true
          type: number
        buy_sell_imbalance_24h:
          nullable: true
          type: number
        mintable:
          nullable: true
          type: boolean
        freezable:
          nullable: true
          type: boolean
        consecutive_negative_days:
          nullable: true
          type: integer
        return_24h:
          description: >-
            Price return over 24 h, a fraction (0.054 = +5.4%), from the tracker
            cache (refreshed every few hours, accepted up to 24 h old), not
            measured by the scoring run.
          nullable: true
          type: number
        return_7d:
          description: >-
            Price return over 7 days, a fraction, from the tracker cache
            (refreshed every few hours, accepted up to 24 h old), not measured
            by the scoring run.
          nullable: true
          type: number
        signal_start_date:
          nullable: true
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        holders_change:
          description: >-
            Fraction (0.07 = +7%): relative change between the two most recent
            distinct on-chain snapshots (about 3 h apart). Null on a run with no
            newer snapshot than the previous row, never a measured 0.
          nullable: true
          type: number
        top10_holders_share_change:
          description: >-
            The difference of the two most recent distinct `top10_holders_share`
            readings: 0.012 is a share up from 0.300 to 0.312, not a relative
            change. Null on a run with no newer snapshot than the previous row,
            never a measured 0.
          nullable: true
          type: number
        liquidity_change:
          description: >-
            Fraction (0.07 = +7%): relative change between the two most recent
            distinct on-chain snapshots (about 3 h apart). Null on a run with no
            newer snapshot than the previous row, never a measured 0.
          nullable: true
          type: number
        volume_change:
          description: >-
            Fraction (0.07 = +7%): relative change between the two most recent
            distinct on-chain snapshots (about 3 h apart). Null on a run with no
            newer snapshot than the previous row, never a measured 0.
          nullable: true
          type: number
        pump_magnitude:
          nullable: true
          type: number
        divergence_persistence:
          nullable: true
          type: number
        derivatives_pressure:
          nullable: true
          type: number
        holder_concentration:
          nullable: true
          type: number
        liquidity_fragility:
          nullable: true
          type: number
        flow_imbalance:
          nullable: true
          type: number
        market_structure_risk:
          nullable: true
          type: number
        dump_pressure:
          nullable: true
          type: number
        price_funding_divergence:
          nullable: true
          type: number
        signal_coverage:
          type: number
          minimum: 0
          maximum: 1
          description: >-
            Weighted completeness of the score's inputs over the funding, price,
            derivatives and on-chain groups, 0 to 1 (0.81 is 81%).
        signal_coverage_status:
          type: string
          enum:
            - full
            - partial
            - limited
        incomplete_signal_groups:
          type: array
          items:
            type: string
        score_interpretation:
          type: string
          enum:
            - fully-observed
            - lower-bound-partial-inputs
      required:
        - coin_id
        - symbol
        - name
        - score
        - exchange_count
        - updated_at
        - signal_coverage
        - signal_coverage_status
        - incomplete_signal_groups
        - score_interpretation
    ManipulationSignal:
      type: object
      properties:
        methodology:
          type: string
        coverage:
          type: string
        gate:
          nullable: true
          type: string
        phase_filter:
          nullable: true
          type: string
        update_frequency:
          type: string
        exchanges:
          type: array
          items:
            type: string
      required:
        - methodology
        - coverage
        - update_frequency
        - exchanges
    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
  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.