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

# Market heatmap

> Returns the market heatmap: coins (a Top N universe, or one narrative's or ecosystem's members) or one tile per narrative or ecosystem. Eligible coins: a 24h price change, market cap at least $1M, plausible 24h spot volume (at most 50x market cap) at least $100K, CoinGecko data under 48 hours old, and not a stablecoin, wrapped, bridged or staked copy, LP token, tokenized metal, fund, stock, ETF or pre-IPO token. A category tile covers every eligible member: price changes are cap-weighted, funding is open-interest weighted, OI value change and RVOL are ratios of member sums, and RSI is the median member; each tile carries `constituents` (members with a value and the share of weight they carry) and its `median` member, and a value is null below its floor. `ex` leaves coins out in every mode; aggregate tiles are rebuilt without them. `returns.1h`, `returns.4h`, `avgFundingApr`, `rsi`, `median` and `constituents` are rounded (returns and funding, fractions, to 4 dp; RVOL to 2 dp, RSI to 1 dp, `weightCoverage` to 3 dp, `largest.marketCapShare` to 4 dp); every other field keeps full precision. Aggregate modes expose complete or partial category coverage. The cache is rebuilt every three hours; X-Data-Stale is true once updated_at is more than six hours old (X-Freshness-Sla-Seconds 21600) or missing, and X-Data-As-Of repeats updated_at. Candle and funding metrics carry their own times in `as_of`.



## OpenAPI

````yaml /openapi.json get /v1/heatmap/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/heatmap/data:
    get:
      tags:
        - Market Data
      summary: Market heatmap
      description: >-
        Returns the market heatmap: coins (a Top N universe, or one narrative's
        or ecosystem's members) or one tile per narrative or ecosystem. Eligible
        coins: a 24h price change, market cap at least $1M, plausible 24h spot
        volume (at most 50x market cap) at least $100K, CoinGecko data under 48
        hours old, and not a stablecoin, wrapped, bridged or staked copy, LP
        token, tokenized metal, fund, stock, ETF or pre-IPO token. A category
        tile covers every eligible member: price changes are cap-weighted,
        funding is open-interest weighted, OI value change and RVOL are ratios
        of member sums, and RSI is the median member; each tile carries
        `constituents` (members with a value and the share of weight they carry)
        and its `median` member, and a value is null below its floor. `ex`
        leaves coins out in every mode; aggregate tiles are rebuilt without
        them. `returns.1h`, `returns.4h`, `avgFundingApr`, `rsi`, `median` and
        `constituents` are rounded (returns and funding, fractions, to 4 dp;
        RVOL to 2 dp, RSI to 1 dp, `weightCoverage` to 3 dp,
        `largest.marketCapShare` to 4 dp); every other field keeps full
        precision. Aggregate modes expose complete or partial category coverage.
        The cache is rebuilt every three hours; X-Data-Stale is true once
        updated_at is more than six hours old (X-Freshness-Sla-Seconds 21600) or
        missing, and X-Data-As-Of repeats updated_at. Candle and funding metrics
        carry their own times in `as_of`.
      operationId: getHeatmapData
      parameters:
        - name: mode
          in: query
          description: Heatmap grouping mode.
          schema:
            default: coins
            type: string
            enum:
              - coins
              - narratives
              - ecosystems
        - name: category
          in: query
          description: >-
            Coins-mode universe. `top10`, `top20`, `top30` and `top50` (the
            default) are the N largest eligible coins by market cap; the legacy
            `top-100` is an alias of `top50`. Otherwise one of the 15 narrative
            ids or 20 ecosystem ids (e.g. `layer-1`, `solana-ecosystem`), an
            alias such as `defi` or `sol`, or a /heatmap/<slug> page slug: the
            category's eligible members, of which the 50 largest are served; an
            ecosystem's members are the coins whose home chain it is. Ignored in
            the aggregate modes. Eligible coins: a 24h price change, market cap
            at least $1M, plausible 24h spot volume (at most 50x market cap) at
            least $100K, CoinGecko data under 48 hours old, and not a
            stablecoin, wrapped, bridged or staked copy, LP token, tokenized
            metal, fund, stock, ETF or pre-IPO token.
          schema:
            default: top50
            type: string
        - name: ex
          in: query
          description: >-
            Comma-separated CoinGecko coin ids to leave out, lower case (e.g.
            `bitcoin,ethereum`). Coins mode: removed after the Top N cut and
            never refilled, so `top10` with two member ids answers 8 coins.
            Aggregate modes: every tile is rebuilt from its members without
            them; a tile left with no member is dropped and counted in
            `omitted`. `excluded` lists the ids that were applied; the others
            are ignored and named in `meta.warnings`.
          schema:
            type: string
            maxLength: 2000
            pattern: ^[a-z0-9_.-]+(,[a-z0-9_.-]+)*$
        - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Heatmap data returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HeatmapDataResponse'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Quota-Limit:
              $ref: '#/components/headers/X-Quota-Limit'
            X-Quota-Remaining:
              $ref: '#/components/headers/X-Quota-Remaining'
            X-Quota-Reset:
              $ref: '#/components/headers/X-Quota-Reset'
            X-Data-Stale:
              $ref: '#/components/headers/X-Data-Stale'
            X-Data-As-Of:
              $ref: '#/components/headers/X-Data-As-Of'
            X-Freshness-Sla-Seconds:
              $ref: '#/components/headers/X-Freshness-Sla-Seconds'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  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:
    HeatmapDataResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              type: object
              properties:
                dots:
                  type: array
                  items:
                    $ref: '#/components/schemas/HeatmapDot'
                updated_at:
                  type: string
                  description: ISO timestamp for the populated heatmap cache.
                coverage:
                  nullable: true
                  description: >-
                    Aggregate category coverage for narrative and ecosystem
                    modes; null for coins mode.
                  allOf:
                    - $ref: '#/components/schemas/HeatmapCoverage'
                as_of:
                  description: >-
                    Per-metric observation times; null on a cache row written
                    before they existed.
                  nullable: true
                  allOf:
                    - $ref: '#/components/schemas/HeatmapAsOf'
                eligible:
                  description: >-
                    Coins mode: the universe's size before `ex`: N for a Top N
                    universe (capped at the coins cached), every eligible member
                    for one category (of which `dots` are the 50 largest). Null
                    in the aggregate modes.
                  nullable: true
                  type: integer
                  minimum: 0
                excluded:
                  description: >-
                    The `ex` ids that were applied: members of this coin
                    universe, or of at least one category in the aggregate
                    modes. Empty when `ex` is absent or could not be applied
                    (see `meta.warnings`).
                  type: array
                  items:
                    type: string
                omitted:
                  description: >-
                    Aggregate modes: categories left off because `ex` removed
                    every member. Null in coins mode.
                  nullable: true
                  type: integer
                  minimum: 0
              required:
                - dots
                - updated_at
                - coverage
          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
    HeatmapDot:
      type: object
      properties:
        id:
          type: string
          description: >-
            Coin: the CoinGecko coin id (the id `ex` takes). Category: the
            narrative or ecosystem id.
        name:
          type: string
        symbol:
          type: string
          description: 'Coin: the ticker. Category: the tile''s short name.'
        kind:
          description: >-
            `coin`, or `category` for an aggregate tile (narratives and
            ecosystems modes). Field rules below are stated per kind.
          type: string
          enum:
            - coin
            - category
        x:
          nullable: true
          description: >-
            Relative volume (RVOL). Coin: 24h spot volume divided by the mean of
            its prior daily volumes (up to 10 days), capped at 10; null under 3
            days of positive history. For a coin with $100B or more market cap,
            a day over 5x its median prior day is left out of the mean, and x is
            null when today's volume is. Category: the members' summed 24h
            volume over their summed mean prior daily volume, across members
            with at least 3 days of history; null when they carry under half the
            tile's volume.
          type: number
        returns:
          type: object
          properties:
            1h:
              description: >-
                Coin: return over the last closed hour, ending at
                `as_of.candle_1h`.
              nullable: true
              type: number
            4h:
              description: >-
                Coin: return over the last 4 closed hours, ending at
                `as_of.candle_1h`.
              nullable: true
              type: number
            24h:
              nullable: true
              type: number
            7d:
              nullable: true
              type: number
            30d:
              nullable: true
              type: number
            1y:
              nullable: true
              type: number
            3y:
              nullable: true
              description: >-
                Always null today: the upstream market feed (CoinGecko
                /coins/markets) has no 3-year window.
              type: number
          required:
            - 24h
            - 7d
            - 30d
            - 1y
            - 3y
          description: >-
            Price return per window, a fraction (0.054 is 5.4%). Coin: 24h, 7d,
            30d and 1y are CoinGecko's price changes read at the sync; 1h and 4h
            come from stored closed perp candles (venue order Binance, Bybit,
            OKX, Hyperliquid, joined by coin id), null when the coin has no perp
            series ending at `as_of.candle_1h`. Category: the cap-weighted,
            winsorized change over the members with a value; null when they
            carry under half the tile's market cap (the median member is in
            `median`).
        marketCap:
          type: number
          description: 'CoinGecko market cap. Category: the sum over the tile''s members.'
        logoUrl:
          type: string
        price:
          description: 'Coins only: CoinGecko price.'
          type: number
        volume24h:
          description: >-
            Spot volume 24h (CoinGecko), left out when implausible: over 50x
            market cap, or, for a coin with $100B or more market cap, over 5x
            its median prior day. Category: the sum over the tile's members.
          type: number
        openInterest:
          description: >-
            Open interest summed across venues by coin id, MEXC excluded.
            Category: the sum over the tile's members.
          type: number
        oiChange24h:
          description: >-
            OI value change (USD), 24h: summed USD open interest now over the
            same contracts' sum 24 hours earlier, minus 1, across the contracts
            present at both times (MEXC excluded). A change in USD value, so it
            moves with price as well as positioning. Category: the same sums
            over the tile's members; left out when they cover under half the
            tile's open interest.
          type: number
        avgFundingApr:
          description: >-
            Funding APR, a fraction per year (0.068 is 6.8%), as of
            `as_of.funding`. Coin: the funding snapshot's per-asset 8-hour
            average (one primary contract per venue, open-interest weighted when
            a majority of venues carry open interest, else the median; MEXC
            carries no weight) x 1,095, joined by coin id; null when no venue
            lists the coin under its own id. Category: open-interest weighted
            over the members with funding; null when they carry under half the
            tile's open interest.
          nullable: true
          type: number
        fundingMethod:
          description: >-
            Coins only: how `avgFundingApr` was averaged across venues. Null
            with `avgFundingApr`.
          nullable: true
          type: string
          enum:
            - oi_weighted
            - median_fallback
        fundingVenuesUsed:
          description: >-
            Coins only: venues behind `avgFundingApr`, one primary contract
            each.
          type: integer
          minimum: 0
        rsi:
          $ref: '#/components/schemas/HeatmapRsi'
        median:
          $ref: '#/components/schemas/HeatmapMedian'
        constituents:
          $ref: '#/components/schemas/HeatmapConstituents'
      required:
        - id
        - name
        - symbol
        - x
        - returns
        - marketCap
    HeatmapCoverage:
      type: object
      properties:
        status:
          type: string
          enum:
            - complete
            - partial
          description: >-
            `complete` when every configured category was fetched:
            availableCategories plus emptyCategories equals totalCategories.
        availableCategories:
          type: integer
          minimum: 0
        totalCategories:
          type: integer
          minimum: 1
        ratio:
          type: number
          minimum: 0
          maximum: 1
        emptyCategories:
          description: >-
            Categories fetched with no eligible member: left off the board, not
            counted as missing.
          type: integer
          minimum: 0
        failedCategories:
          description: >-
            Ids of the configured categories whose fetch failed at the last
            refresh: missing from the board, the reason status is partial.
            Absent on a cache row written before this field existed.
          type: array
          items:
            type: string
      required:
        - status
        - availableCategories
        - totalCategories
        - ratio
    HeatmapAsOf:
      type: object
      properties:
        funding:
          nullable: true
          description: The funding snapshot behind `avgFundingApr`.
          type: string
          format: date-time
        candle_1h:
          nullable: true
          description: >-
            The last closed hour, behind `returns.1h`, `returns.4h` and
            `rsi.1h`.
          type: string
          format: date-time
        candle_4h:
          nullable: true
          description: The end of the last closed UTC 4-hour block, behind `rsi.4h`.
          type: string
          format: date-time
        candle_1d:
          nullable: true
          description: The last UTC midnight, behind `rsi.1d`.
          type: string
          format: date-time
      required:
        - funding
        - candle_1h
        - candle_4h
        - candle_1d
      description: >-
        When each non-CoinGecko metric was observed; every other field is as of
        `updated_at`.
    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
    HeatmapRsi:
      type: object
      properties:
        1h:
          nullable: true
          type: number
          minimum: 0
          maximum: 100
        4h:
          nullable: true
          type: number
          minimum: 0
          maximum: 100
        1d:
          nullable: true
          type: number
          minimum: 0
          maximum: 100
      required:
        - 1h
        - 4h
        - 1d
      description: >-
        Wilder RSI(14) per candle size, from the same perp series as
        `returns.1h`. Coin: null unless 64 contiguous closed bars end at
        `as_of.candle_1h` (1h), `as_of.candle_4h` (4h: four 1h candles per UTC
        4-hour block) or `as_of.candle_1d` (1d). Category: the median member's
        RSI; null unless 5 members have a value or the members with one hold at
        least half the category's market cap.
    HeatmapMedian:
      type: object
      properties:
        returns:
          type: object
          properties:
            1h:
              nullable: true
              type: number
            4h:
              nullable: true
              type: number
            24h:
              nullable: true
              type: number
            7d:
              nullable: true
              type: number
            30d:
              nullable: true
              type: number
            1y:
              nullable: true
              type: number
          required:
            - 1h
            - 4h
            - 24h
            - 7d
            - 30d
            - 1y
        avgFundingApr:
          nullable: true
          type: number
        x:
          nullable: true
          type: number
      required:
        - returns
        - avgFundingApr
        - x
      description: >-
        Category tiles only: the median member's price return, funding APR
        (fractions) and RVOL, beside the tile's weighted values. Each is null
        under 5 members with a value.
    HeatmapConstituents:
      type: object
      properties:
        m:
          type: integer
          minimum: 0
          description: >-
            Tile members: the category's eligible members (an ecosystem's are
            the coins whose home chain it is), minus `ex`, with market cap above
            0.
        'n':
          type: object
          properties:
            return1h:
              type: integer
              minimum: 0
            return4h:
              type: integer
              minimum: 0
            return24h:
              type: integer
              minimum: 0
            return7d:
              type: integer
              minimum: 0
            return30d:
              type: integer
              minimum: 0
            return1y:
              type: integer
              minimum: 0
            avgFundingApr:
              type: integer
              minimum: 0
            oiChange24h:
              type: integer
              minimum: 0
            rsi1h:
              type: integer
              minimum: 0
            rsi4h:
              type: integer
              minimum: 0
            rsi1d:
              type: integer
              minimum: 0
            rvol:
              type: integer
              minimum: 0
          required:
            - return1h
            - return4h
            - return24h
            - return7d
            - return30d
            - return1y
            - avgFundingApr
            - oiChange24h
            - rsi1h
            - rsi4h
            - rsi1d
            - rvol
          description: Members with a value, per metric.
        weightCoverage:
          type: object
          properties:
            return1h:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            return4h:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            return24h:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            return7d:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            return30d:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            return1y:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            avgFundingApr:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            oiChange24h:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
            rvol:
              nullable: true
              type: number
              minimum: 0
              maximum: 1
          required:
            - return1h
            - return4h
            - return24h
            - return7d
            - return30d
            - return1y
            - avgFundingApr
            - oiChange24h
            - rvol
          description: >-
            Share of the tile's weight carried by the members with a value:
            market cap for the price returns, open interest for avgFundingApr
            and oiChange24h, 24h volume for rvol. A weighted tile value is null
            below 0.5. Null when the tile has no weight.
        largest:
          nullable: true
          description: >-
            The largest member by market cap and its share of the tile's market
            cap.
          type: object
          properties:
            id:
              type: string
            symbol:
              type: string
            marketCapShare:
              type: number
              minimum: 0
              maximum: 1
          required:
            - id
            - symbol
            - marketCapShare
      required:
        - m
        - 'n'
        - weightCoverage
        - largest
      description: 'Category tiles only: who the tile''s numbers cover.'
  headers:
    X-Request-Id:
      schema:
        type: string
      description: Unique request identifier. Include this value when contacting support.
    X-RateLimit-Limit:
      schema:
        type: integer
      description: Requests allowed per minute for the authenticated API key.
    X-RateLimit-Remaining:
      schema:
        type: integer
      description: Requests remaining in the current one-minute rate-limit window.
    X-RateLimit-Reset:
      schema:
        type: integer
      description: Unix timestamp in seconds when the current rate-limit window resets.
    X-Quota-Limit:
      schema:
        type: integer
      description: Monthly request quota for the authenticated API key.
    X-Quota-Remaining:
      schema:
        type: integer
      description: Monthly requests remaining in the current billing period.
    X-Quota-Reset:
      schema:
        type: string
        format: date-time
      description: >-
        ISO 8601 timestamp when the monthly quota resets, when available from
        the quota store.
    X-Data-Stale:
      schema:
        type: boolean
      description: >-
        True when the data is past its freshness SLA (`meta.freshness_status` is
        not `fresh`), judged for the answer as a whole; rows keep their own
        staleness flags. /v1/funding/rates and /v1/rwa-perps/rates set it when
        the response is empty or at least one returned row exceeds the published
        freshness target.
    X-Data-As-Of:
      schema:
        type: string
        format: date-time
      description: >-
        When the data was current: `meta.as_of` (the newest live row, the
        snapshot or refresh time, or the fetch time). /v1/funding/rates and
        /v1/rwa-perps/rates: the newest source timestamp in the response.
    X-Freshness-Sla-Seconds:
      schema:
        type: integer
      description: >-
        The dataset's freshness SLA in seconds (`meta.freshness_sla_seconds`):
        the writer's cadence plus one skipped run.
    Retry-After:
      schema:
        type: integer
      description: >-
        Seconds to wait before retrying after a per-minute rate-limit or
        monthly-quota rejection.
  responses:
    BadRequest:
      description: Invalid or missing parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/invalid_parameter
            title: Invalid Parameter
            status: 400
            detail: 'Invalid parameter "coin": must not be empty'
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#error-codes
            suggested_action: >-
              Check the parameter value against the endpoint documentation. Use
              GET /v1/futures/coins or GET /v1/meta/coverage to discover valid
              values.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    Unauthorized:
      description: >-
        Missing or invalid API key, or a key without an active plan
        (`expired_api_key`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid_api_key:
              summary: Missing or invalid API key
              value:
                type: https://www.sharpe.ai/errors/invalid_api_key
                title: Invalid API Key
                status: 401
                detail: >-
                  Missing API key. Pass via Authorization: Bearer <key> or the
                  X-API-Key header.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/authentication
                suggested_action: >-
                  Check your API key is correct. Pass it via Authorization:
                  Bearer <key> or the X-API-Key header.
            expired_api_key:
              summary: The key has no active plan
              value:
                type: https://www.sharpe.ai/errors/expired_api_key
                title: Expired API Key
                status: 401
                detail: >-
                  This API key has no active plan. Subscribe or renew at
                  https://www.sharpe.ai/dashboard/billing.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/authentication
                suggested_action: >-
                  Subscribe or renew at https://www.sharpe.ai/dashboard/billing.
                  The same key works again once the plan is active.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    Forbidden:
      description: The API key lacks a scope this endpoint requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/insufficient_scope
            title: Insufficient Scope
            status: 403
            detail: 'This API key requires the following scope(s): read.'
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/authentication
            suggested_action: >-
              Create a new API key with the required scopes, or contact support
              to update scopes on your existing key.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    RateLimited:
      description: >-
        Per-minute rate limit or monthly quota exceeded. Both are temporary;
        retry after the Retry-After header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rate_limit_exceeded:
              summary: Per-minute rate limit exceeded
              value:
                type: https://www.sharpe.ai/errors/rate_limit_exceeded
                title: Rate Limit Exceeded
                status: 429
                detail: Rate limit of 30 requests per minute exceeded.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/rate-limits
                suggested_action: >-
                  Wait until the time in the X-RateLimit-Reset header before
                  retrying. Upgrade your plan for higher limits.
            monthly_quota_exceeded:
              summary: Monthly quota exceeded
              value:
                type: https://www.sharpe.ai/errors/monthly_quota_exceeded
                title: Monthly Quota Exceeded
                status: 429
                detail: >-
                  Monthly quota of 50,000 requests exceeded. Resets at
                  2026-12-01T00:00:00.000Z.
                request_id: req_a1b2c3d4e5f6g7h8i9j0
                doc_url: https://www.sharpe.ai/docs/rate-limits
                suggested_action: >-
                  Retry after the seconds given in the Retry-After header, when
                  the monthly quota resets. Upgrade your plan for a higher
                  monthly quota. Check usage at GET /v1/usage.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-Quota-Limit:
          $ref: '#/components/headers/X-Quota-Limit'
        X-Quota-Remaining:
          $ref: '#/components/headers/X-Quota-Remaining'
        X-Quota-Reset:
          $ref: '#/components/headers/X-Quota-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/internal_error
            title: Internal Server Error
            status: 500
            detail: An unexpected error occurred. Please try again later.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#retry-guidance
            suggested_action: >-
              Retry with exponential backoff (1s, 2s, 4s, up to 30s). If the
              error persists, contact support with the X-Request-Id.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    ServiceUnavailable:
      description: The API or quota verification service is temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            type: https://www.sharpe.ai/errors/service_unavailable
            title: Service Unavailable
            status: 503
            detail: >-
              API key verification is temporarily unavailable. Please retry
              shortly.
            request_id: req_a1b2c3d4e5f6g7h8i9j0
            doc_url: https://www.sharpe.ai/docs/errors#retry-guidance
            suggested_action: >-
              The API is temporarily unavailable. Retry with exponential
              backoff. If it persists, contact team@sharpe.ai with the
              X-Request-Id.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your API key as a Bearer token in the Authorization header:
        `Authorization: Bearer sk_live_...`
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternatively, pass your API key via the X-API-Key header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.