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

# API data coverage

> Returns metadata about available data products, supported exchanges, coins, chart types, and timeframes. No authentication required.



## OpenAPI

````yaml /openapi.json get /v1/meta/coverage
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/meta/coverage:
    get:
      tags:
        - System
      summary: API data coverage
      description: >-
        Returns metadata about available data products, supported exchanges,
        coins, chart types, and timeframes. No authentication required.
      operationId: getCoverage
      responses:
        '200':
          description: Coverage metadata returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoverageResponse'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '500':
          $ref: '#/components/responses/InternalError'
      security: []
components:
  schemas:
    CoverageResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/CoveragePayload'
          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
    CoveragePayload:
      type: object
      properties:
        product_count:
          type: integer
        status_counts:
          type: object
          properties:
            production:
              type: integer
            shared:
              type: integer
            planned:
              type: integer
          required:
            - production
            - shared
            - planned
        products:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ProductCoverage'
      required:
        - product_count
        - status_counts
        - products
    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
    ProductCoverage:
      type: object
      properties:
        name:
          type: string
        status:
          type: string
          enum:
            - production
            - shared
            - planned
        ui_routes:
          type: array
          items:
            type: string
        public_api_routes:
          type: array
          items:
            type: string
          description: >-
            Always empty since 2026-11-11: the API is paid-only and no keyless
            route is open to outside callers. Kept so clients that read the
            field keep working.
        v1_api_routes:
          type: array
          items:
            type: string
        docs_routes:
          type: array
          items:
            type: string
        openapi_paths:
          type: array
          items:
            type: string
        mcp_tools:
          type: array
          items:
            type: string
        data_sources:
          type: array
          items:
            type: string
        tests:
          type: array
          items:
            type: string
        freshness_sla:
          type: string
        datasets:
          description: >-
            The datasets behind the product with their writer cadence and
            freshness SLA: the numbers `freshness_sla` states in words.
          type: array
          items:
            type: object
            properties:
              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
              cadence_seconds:
                type: integer
                minimum: 0
                description: >-
                  Seconds between two runs of the dataset's writer; 0 when it is
                  fetched per request.
              freshness_sla_seconds:
                type: integer
                minimum: 1
                description: >-
                  Seconds after its as_of past which the dataset's answers say
                  `freshness_status: "stale"` (the writer's cadence plus one
                  skipped run).
            required:
              - id
              - cadence_seconds
              - freshness_sla_seconds
        notes:
          type: string
      required:
        - name
        - status
        - ui_routes
        - public_api_routes
        - v1_api_routes
        - docs_routes
        - openapi_paths
        - mcp_tools
        - data_sources
        - tests
        - freshness_sla
  headers:
    X-Request-Id:
      schema:
        type: string
      description: Unique request identifier. Include this value when contacting support.
  responses:
    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'
  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.