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

# Rug Check token security

> Returns token contract security and liquidity risk signals, and the Rug Check score computed from them with the token's market and holder data: `score` (0-100, verdict, completeness, engine version, reasons) and `checks`, the same score and rows the /rug-check page shows. When GoPlus (the security provider) is unavailable, the answer is the token's last good record (`stale: true`, `dataAsOf`, at most 7 days old); without one, on Ethereum, BNB Smart Chain and Base, a partial record from Honeypot.is (`partial: true`: only `isHoneypot` is known); otherwise 503 with Retry-After. GoPlus throttling is never answered 429, which is your own rate limit.



## OpenAPI

````yaml /openapi.json get /v1/rug-check/security
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/rug-check/security:
    get:
      tags:
        - Screener
      summary: Rug Check token security
      description: >-
        Returns token contract security and liquidity risk signals, and the Rug
        Check score computed from them with the token's market and holder data:
        `score` (0-100, verdict, completeness, engine version, reasons) and
        `checks`, the same score and rows the /rug-check page shows. When GoPlus
        (the security provider) is unavailable, the answer is the token's last
        good record (`stale: true`, `dataAsOf`, at most 7 days old); without
        one, on Ethereum, BNB Smart Chain and Base, a partial record from
        Honeypot.is (`partial: true`: only `isHoneypot` is known); otherwise 503
        with Retry-After. GoPlus throttling is never answered 429, which is your
        own rate limit.
      operationId: getRugCheckSecurity
      parameters:
        - name: address
          in: query
          description: Token contract address.
          required: true
          schema:
            type: string
            minLength: 1
        - name: chainId
          in: query
          description: >-
            EVM chain ID (1 Ethereum, 56 BNB Smart Chain, 8453 Base, 42161
            Arbitrum, 137 Polygon, 10 Optimism, 43114 Avalanche, 146 Sonic,
            80094 Berachain, and 29 more), or 1399811149 for Solana and
            728126428 for Tron. An unsupported chain returns 400.
          required: true
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Rug-check security data returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RugCheckSecurityResponse'
          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'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    RugCheckSecurityResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/RugCheckSecurity'
          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
    RugCheckSecurity:
      type: object
      properties:
        isHoneypot:
          nullable: true
          type: boolean
        noMint:
          nullable: true
          type: boolean
        noBlacklist:
          nullable: true
          type: boolean
        isOpenSource:
          nullable: true
          type: boolean
        isProxy:
          nullable: true
          type: boolean
        hiddenOwner:
          nullable: true
          type: boolean
        buyTax:
          nullable: true
          type: number
        sellTax:
          nullable: true
          type: number
        canTakeBackOwnership:
          nullable: true
          type: boolean
        cannotSellAll:
          nullable: true
          type: boolean
        cannotBuy:
          nullable: true
          type: boolean
        tradingCooldown:
          nullable: true
          type: boolean
        selfDestruct:
          nullable: true
          type: boolean
        transferPausable:
          nullable: true
          type: boolean
        slippageModifiable:
          nullable: true
          type: boolean
        personalSlippageModifiable:
          nullable: true
          type: boolean
        isAntiWhale:
          nullable: true
          type: boolean
        antiWhaleModifiable:
          nullable: true
          type: boolean
        externalCall:
          nullable: true
          type: boolean
        isWhitelisted:
          nullable: true
          type: boolean
        honeypotWithSameCreator:
          nullable: true
          type: boolean
        transferTax:
          nullable: true
          type: number
        transferHook:
          nullable: true
          type: boolean
        transferHookUpgradable:
          nullable: true
          type: boolean
        transferFeeUpgradable:
          nullable: true
          type: boolean
        defaultAccountFrozen:
          nullable: true
          type: boolean
        defaultAccountStateUpgradable:
          nullable: true
          type: boolean
        metadataMutable:
          nullable: true
          type: boolean
        isInCex:
          nullable: true
          type: boolean
        cexList:
          nullable: true
          type: array
          items:
            type: string
        creatorAddress:
          nullable: true
          type: string
        creatorShare:
          nullable: true
          type: number
        ownerAddress:
          nullable: true
          type: string
        ownerShare:
          nullable: true
          type: number
        ownerChangeBalance:
          nullable: true
          type: boolean
        holderCount:
          nullable: true
          description: >-
            Wallets holding the token: the count the `Holders` check shows,
            GeckoTerminal's holder snapshot or GoPlus's count when that snapshot
            is stale or missing. On a `partial` record, null.
          type: integer
        totalSupply:
          nullable: true
          type: string
        lpHolderCount:
          nullable: true
          type: integer
        lpTotalSupply:
          nullable: true
          type: string
        trustList:
          nullable: true
          type: boolean
        topHolders:
          nullable: true
          type: array
          items:
            $ref: '#/components/schemas/RugCheckHolder'
        lpHolders:
          nullable: true
          description: >-
            LP holders of the main pool (the deepest dexInfo entry). Each
            holder's `share` is its part of that pool's LP token supply, 0 to 1
            (0.0002 = 0.02%) on every chain; Solana shares are recomputed from
            the holder balance over the pool's LP amount. Null when the list
            cannot be tied to a standard AMM pool.
          type: array
          items:
            $ref: '#/components/schemas/RugCheckHolder'
        dexInfo:
          nullable: true
          description: >-
            DEX pools, deepest first by `liquidity` (pools with a null
            `liquidity` last), so entry 0 is the main pool when its value is
            known.
          type: array
          items:
            $ref: '#/components/schemas/RugCheckDex'
        source:
          type: string
          enum:
            - evm-security-scan
            - solana-security-scan
            - combined
        stale:
          type: boolean
          description: >-
            Present and true only when the security provider was temporarily
            unavailable and this is the token's last good record (at most 7 days
            old). Absent on live answers.
        dataAsOf:
          type: string
          format: date-time
          description: >-
            When the last good record was fetched. Present only alongside
            `stale`.
        partial:
          type: boolean
          description: >-
            Present and true only when the security provider was unavailable and
            the token has no last good record, on Ethereum, BNB Smart Chain or
            Base: `isHoneypot` comes from Honeypot.is's buy/sell simulation and
            every other security field is null (unknown). The score then treats
            the contract checks as unknown, except that a detected honeypot
            scores 5 (Danger). Absent otherwise.
        score:
          $ref: '#/components/schemas/RugCheckScore'
        checks:
          description: >-
            The rows of the /rug-check page's checks for this token, in the
            page's order: the Contract Security rows, then the Top-10 holders
            row, then the Token Health rows. Present on every 200 answer, beside
            `score`.
          type: array
          items:
            $ref: '#/components/schemas/RugCheckCheck'
      required:
        - isHoneypot
        - noMint
        - noBlacklist
        - isOpenSource
        - isProxy
        - hiddenOwner
        - buyTax
        - sellTax
        - canTakeBackOwnership
        - cannotSellAll
        - cannotBuy
        - tradingCooldown
        - selfDestruct
        - transferPausable
        - slippageModifiable
        - personalSlippageModifiable
        - isAntiWhale
        - antiWhaleModifiable
        - externalCall
        - isWhitelisted
        - honeypotWithSameCreator
        - transferTax
        - isInCex
        - cexList
        - creatorAddress
        - creatorShare
        - ownerAddress
        - ownerShare
        - ownerChangeBalance
        - holderCount
        - totalSupply
        - lpHolderCount
        - lpTotalSupply
        - trustList
        - topHolders
        - lpHolders
        - dexInfo
        - source
    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
    RugCheckHolder:
      type: object
      properties:
        address:
          type: string
        balance:
          type: number
        share:
          type: number
        isLocked:
          type: boolean
        isContract:
          type: boolean
        tag:
          nullable: true
          type: string
      required:
        - address
        - balance
        - share
        - isLocked
        - isContract
        - tag
    RugCheckDex:
      type: object
      properties:
        name:
          type: string
        liquidity:
          nullable: true
          description: >-
            The pool's value in USD from GoPlus: Solana's pool TVL, and on EVM
            chains twice GoPlus's one-sided figure for a UniswapV2-type pool.
            Null when GoPlus gives no comparable figure: EVM
            concentrated-liquidity pools (UniswapV3/V4, whose GoPlus figure is
            not the pool's value) and pools it sends without one.
          type: number
        pair:
          type: string
        lpBurnedShare:
          nullable: true
          description: >-
            Burned share of this pool's LP tokens, 0 to 1 (0.7837 is 78.37%),
            from GoPlus, counting destroyed LP and LP held in Raydium's lock.
            Solana standard AMM pools only: null for concentrated-liquidity
            pools and on EVM chains.
          type: number
      required:
        - name
        - liquidity
        - pair
        - lpBurnedShare
    RugCheckScore:
      type: object
      properties:
        value:
          nullable: true
          description: >-
            0-100, higher is safer. Null only when no pillar had a scorable
            figure (`data_completeness` `none`), never a default 50.
          type: integer
          minimum: 0
          maximum: 100
        verdict:
          nullable: true
          description: >-
            `safe` at 80 or more, `caution` at 50, `risky` at 20, else `danger`.
            Null when `value` is null.
          type: string
          enum:
            - safe
            - caution
            - risky
            - danger
        verdict_label:
          nullable: true
          description: The verdict as the page labels it. Null when `value` is null.
          type: string
          enum:
            - Looks Safe
            - Use Caution
            - Risky
            - Danger
        verdict_note:
          nullable: true
          description: >-
            "Trusted issuer, centralised controls" when GoPlus trust-lists the
            token and its issuer can still mint, freeze, pause or upgrade it:
            those controls are listed as warnings but neither scored nor capped.
            Otherwise null.
          type: string
        data_completeness:
          type: string
          enum:
            - full
            - partial
            - none
          description: >-
            `full`: the contract, holder and market pillars each had data.
            `partial`: one or two had none (each such pillar scores a neutral
            50, and the score is capped at 69 so unknown data never reads
            `safe`). `none`: no pillar had a scorable figure (a holder count
            alone scores nothing), so there is no score.
        engine_version:
          type: integer
          description: >-
            Version of the scoring rules. A declared change to a weight, cap,
            band or check increments it, so a stored score can be told apart
            from one computed under other rules.
        insights:
          type: array
          items:
            type: string
          description: The verdict's reasons as the page lists them, at most 6.
      required:
        - value
        - verdict
        - verdict_label
        - verdict_note
        - data_completeness
        - engine_version
        - insights
      description: >-
        The Rug Check score the /rug-check page shows for this token, computed
        server-side (engine metric token_risk.rug_check) from this answer's
        GoPlus fields, the token's DexScreener market figures (liquidity and 24h
        volume summed over its pairs on this chain, age from its oldest pair)
        and its top-10 holder share (GoPlus's live top-holder list without the
        token's own pools and burn addresses; GeckoTerminal's snapshot when
        GoPlus has none, ignored when stale). Weighted 0.40 contract, 0.35
        holders, 0.25 market health, then capped by hard signals (a honeypot or
        sell block sets 5, a copy of a major's ticker from another contract 49).
        An input a lookup could not read is unknown, never zero: it is left out
        of its pillar's average (its row reads `—`), a pillar with no data at
        all scores a neutral 50, and `data_completeness` says whether every
        pillar had data; a `partial` score is capped at 69. On a `stale` answer
        the score is computed from the last good GoPlus record. Present on every
        200 answer.
    RugCheckCheck:
      type: object
      properties:
        pillar:
          type: string
          enum:
            - contract
            - holders
            - health
          description: >-
            The pillar the row scores under: `contract` (weight 0.40), `holders`
            (0.35: the wallets' share among the token's top 10 holders, GoPlus's
            live list without the token's own pools and burn addresses, or
            GeckoTerminal's snapshot when GoPlus has none) or `health` (0.25,
            market figures).
        label:
          type: string
          description: The check, e.g. `Honeypot`, `Mint`, `Liquidity`.
        value:
          type: string
          description: The displayed result, e.g. `Disabled`, `$6.5M`, `2.8y`.
        status:
          type: string
          enum:
            - safe
            - warning
            - danger
            - neutral
          description: >-
            `neutral`: shown without a judgement (unknown, or an owner-only
            power of a renounced contract).
        tooltip:
          type: string
          description: What the check means.
      required:
        - pillar
        - label
        - value
        - status
        - tooltip
      description: One row of the /rug-check page's Checks table.
  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'
    NotFound:
      description: >-
        Resource not found, or no v1 route matches the request path.
        Unauthenticated requests to an unknown path return 401 instead, so route
        existence is never disclosed without a key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/resource_not_found
            title: Resource Not Found
            status: 404
            detail: >-
              No v1 endpoint matches this path. Check the path against the
              endpoint list at https://www.sharpe.ai/docs/api-reference.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#error-codes
            suggested_action: >-
              Verify the URL path. See https://www.sharpe.ai/docs for a list of
              available endpoints.
      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.