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

# Stablecoins data

> Returns hourly stablecoin overview, detail, or yield data with nominal supply at peg, live marked value, nullable peg metrics, chain supply/TVL ratios, velocity coverage, freshness, and APY risk flags. Shares, supply changes, the peg deviation and APYs are fractions (0.054 is 5.4%; APYs per year). NAV-accrual assets do not receive fixed-$1 depeg scores; ambiguous same-symbol yield pools are omitted.



## OpenAPI

````yaml /openapi.json get /v1/stablecoins/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/stablecoins/data:
    get:
      tags:
        - Market Data
      summary: Stablecoins data
      description: >-
        Returns hourly stablecoin overview, detail, or yield data with nominal
        supply at peg, live marked value, nullable peg metrics, chain supply/TVL
        ratios, velocity coverage, freshness, and APY risk flags. Shares, supply
        changes, the peg deviation and APYs are fractions (0.054 is 5.4%; APYs
        per year). NAV-accrual assets do not receive fixed-$1 depeg scores;
        ambiguous same-symbol yield pools are omitted.
      operationId: getStablecoinsData
      parameters:
        - name: type
          in: query
          description: Payload type.
          schema:
            default: overview
            type: string
            enum:
              - overview
              - detail
              - yields
        - name: slug
          in: query
          description: Stablecoin slug. Required when type=detail.
          schema:
            type: string
      responses:
        '200':
          description: Stablecoins data returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StablecoinsDataResponse'
          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-Partial:
              description: >-
                Present with value true when a degraded component or FX fallback
                makes the overview or yields snapshot partial.
              schema:
                type: string
                enum:
                  - 'true'
        '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:
    StablecoinsDataResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - type: object
          properties:
            data:
              $ref: '#/components/schemas/StablecoinsDataPayload'
          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
    StablecoinsDataPayload:
      oneOf:
        - $ref: '#/components/schemas/StablecoinOverviewPayload'
        - $ref: '#/components/schemas/StablecoinDetailPayload'
        - $ref: '#/components/schemas/StablecoinYieldsPayload'
    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
    StablecoinOverviewPayload:
      type: object
      properties:
        aggregate:
          $ref: '#/components/schemas/StablecoinsAggregate'
        universeItems:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinItem'
        items:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinItem'
        history90d:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinHistoryPoint'
        history365d:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinHistoryPoint'
        dailyNetIssuance90d:
          description: >-
            Daily net issuance in USD per UTC day (`t`, unix seconds), like for
            like: the day's change in supply at peg less any stablecoin DeFi
            Llama starts or stops charting that day. Differencing `history90d`
            counts those coins as mints and redemptions.
          type: array
          items:
            $ref: '#/components/schemas/StablecoinDailyNetIssuancePoint'
        fxFallbackCoins:
          type: integer
        chains:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinChainRow'
        degradedComponents:
          type: array
          items:
            type: string
        componentUpdatedAt:
          type: object
          properties:
            overview:
              nullable: true
              type: string
              format: date-time
            history:
              nullable: true
              type: string
              format: date-time
            chains:
              nullable: true
              type: string
              format: date-time
            details:
              nullable: true
              type: string
              format: date-time
          required:
            - history
            - chains
            - details
        componentSources:
          type: object
          properties:
            overview:
              type: array
              items:
                type: string
            history:
              type: array
              items:
                type: string
            chains:
              type: array
              items:
                type: string
            details:
              type: array
              items:
                type: string
          required:
            - overview
            - history
            - chains
            - details
        lastAttemptAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
          description: >-
            Oldest contributing component timestamp; retained components prevent
            partial refreshes from advancing it.
        partial:
          type: boolean
        source:
          type: string
          enum:
            - DeFiLlama
        sources:
          type: array
          items:
            type: string
            enum:
              - DeFiLlama
              - CoinGecko
              - Supabase
        as_of:
          type: string
          format: date-time
          description: Oldest contributing component timestamp for the served snapshot.
        stale:
          type: boolean
        cache_age_seconds:
          type: integer
          minimum: 0
        freshness_sla_seconds:
          type: integer
          enum:
            - 7200
      required:
        - aggregate
        - items
        - history90d
        - history365d
        - chains
        - updatedAt
        - partial
        - source
        - sources
        - as_of
        - stale
        - cache_age_seconds
        - freshness_sla_seconds
    StablecoinDetailPayload:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
        name:
          type: string
        symbol:
          type: string
        peg:
          type: string
          enum:
            - USD
            - XAU
            - EUR
            - GBP
            - JPY
            - CNY
            - CHF
            - CAD
            - AUD
            - MXN
            - SGD
            - TRY
            - BRL
            - OTHER
        mechanism:
          type: string
          enum:
            - fiat-backed
            - crypto-backed
            - algorithmic
            - yield-bearing
            - rwa-backed
            - other
        priceModel:
          type: string
          enum:
            - fixed-peg
            - nav-accrual
            - unknown
        yieldBearing:
          type: boolean
        image:
          nullable: true
          type: string
        price:
          nullable: true
          type: number
        pegDeviation:
          nullable: true
          description: >-
            Signed deviation of the price from the reference peg, a fraction
            (-0.001 is 0.1% below the peg): negative below the peg (a discount),
            positive above it. Rank depegs by its absolute value. Null for
            NAV-accrual and unclassified yield tokens, or without a usable price
            or FX rate.
          type: number
        pegQuality:
          nullable: true
          description: >-
            `measured` when 24h volume is at least $10K and the price at most 6
            h old; otherwise `indicative` (an illiquid or stale print, shown and
            ranked after the measured deviations). Null when there is no
            deviation.
          type: string
          enum:
            - measured
            - indicative
        volume24hUsd:
          nullable: true
          description: >-
            Trailing 24h trading volume in USD over the venues CoinGecko tracks;
            null when CoinGecko does not list the coin.
          type: number
        priceUpdatedAt:
          nullable: true
          description: >-
            Newest time the price can be vouched for (ISO 8601); null when
            neither CoinGecko's quote time nor the DeFi Llama snapshot stamp is
            known.
          format: date-time
          type: string
        nominalSupplyValue:
          type: number
        markedMarketValue:
          nullable: true
          type: number
        marketCap:
          type: number
          deprecated: true
        circulating:
          type: number
          description: >-
            USD value, not a token count: circulating units translated to USD at
            the peg's FX rate, the same number as nominalSupplyValue (equal to
            the unit count only for USD pegs; a EUR or gold peg reads its supply
            times the EUR or gold rate). Divide by the peg rate for units.
        change24hUsd:
          nullable: true
          type: number
        change7dUsd:
          nullable: true
          type: number
        change30dUsd:
          nullable: true
          type: number
        supplyChange24h:
          nullable: true
          type: number
        supplyChange7d:
          nullable: true
          type: number
        supplyChange30d:
          nullable: true
          type: number
        history:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinHistoryPoint'
        chainBreakdown:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinChainBreakdown'
        chainHistory:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinChainHistory'
        description:
          nullable: true
          type: string
        url:
          nullable: true
          format: uri
          type: string
        twitter:
          nullable: true
          type: string
        auditLinks:
          type: array
          items:
            type: string
            format: uri
        velocity:
          nullable: true
          type: number
        velocityNonEvmShare:
          type: number
        velocityCoverage:
          type: number
        velocityUnavailableReason:
          nullable: true
          type: string
        pegStability30d:
          $ref: '#/components/schemas/StablecoinPegStability'
        mintBurn90d:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinMintBurnPoint'
        bridgeFlow24h:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinBridgeFlowRow'
        mintRedeemDescription:
          nullable: true
          type: string
        updatedAt:
          type: string
          format: date-time
        source:
          type: string
          enum:
            - DeFiLlama
        sources:
          type: array
          items:
            type: string
            enum:
              - DeFiLlama
              - CoinGecko
              - Supabase
        as_of:
          type: string
          format: date-time
        stale:
          type: boolean
        cache_age_seconds:
          type: integer
          minimum: 0
        freshness_sla_seconds:
          type: integer
          enum:
            - 7200
      required:
        - id
        - slug
        - name
        - symbol
        - peg
        - mechanism
        - priceModel
        - yieldBearing
        - image
        - price
        - pegDeviation
        - nominalSupplyValue
        - markedMarketValue
        - marketCap
        - circulating
        - supplyChange24h
        - supplyChange7d
        - supplyChange30d
        - history
        - chainBreakdown
        - chainHistory
        - description
        - url
        - twitter
        - auditLinks
        - updatedAt
        - source
        - sources
        - as_of
        - stale
        - cache_age_seconds
        - freshness_sla_seconds
    StablecoinYieldsPayload:
      type: object
      properties:
        yields:
          $ref: '#/components/schemas/StablecoinYieldsCache'
        partial:
          type: boolean
        source:
          type: string
          enum:
            - DeFiLlama
        sources:
          type: array
          items:
            type: string
            enum:
              - DeFiLlama
              - CoinGecko
              - Supabase
        as_of:
          type: string
          format: date-time
        stale:
          type: boolean
        cache_age_seconds:
          type: integer
          minimum: 0
        freshness_sla_seconds:
          type: integer
          enum:
            - 7200
      required:
        - yields
        - partial
        - source
        - sources
        - as_of
        - stale
        - cache_age_seconds
        - freshness_sla_seconds
    StablecoinsAggregate:
      type: object
      properties:
        totalMarketCap:
          type: number
        supplyChange24h:
          nullable: true
          type: number
        supplyChange7d:
          nullable: true
          type: number
        supplyChange30d:
          nullable: true
          type: number
        mechanismSplit:
          type: array
          items:
            type: object
            properties:
              mechanism:
                type: string
              marketShare:
                type: number
              mcap:
                type: number
            required:
              - mechanism
              - marketShare
              - mcap
        assetConcentration:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              marketShare:
                type: number
              mcap:
                type: number
            required:
              - name
              - marketShare
              - mcap
        issuerSplit:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              marketShare:
                type: number
              mcap:
                type: number
            required:
              - name
              - marketShare
              - mcap
        count:
          type: integer
        updatedAt:
          type: string
          format: date-time
      required:
        - totalMarketCap
        - supplyChange24h
        - supplyChange7d
        - supplyChange30d
        - mechanismSplit
        - assetConcentration
        - issuerSplit
        - count
        - updatedAt
    StablecoinItem:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
        detailId:
          nullable: true
          type: string
        name:
          type: string
        symbol:
          type: string
        peg:
          type: string
          enum:
            - USD
            - XAU
            - EUR
            - GBP
            - JPY
            - CNY
            - CHF
            - CAD
            - AUD
            - MXN
            - SGD
            - TRY
            - BRL
            - OTHER
        mechanism:
          type: string
          enum:
            - fiat-backed
            - crypto-backed
            - algorithmic
            - yield-bearing
            - rwa-backed
            - other
        priceModel:
          type: string
          enum:
            - fixed-peg
            - nav-accrual
            - unknown
        yieldBearing:
          type: boolean
        image:
          nullable: true
          type: string
        price:
          nullable: true
          type: number
        pegDeviation:
          nullable: true
          description: >-
            Signed deviation of the price from the reference peg, a fraction
            (-0.001 is 0.1% below the peg): negative below the peg (a discount),
            positive above it. Rank depegs by its absolute value. Null for
            NAV-accrual and unclassified yield tokens, or without a usable price
            or FX rate.
          type: number
        pegQuality:
          nullable: true
          description: >-
            `measured` when 24h volume is at least $10K and the price at most 6
            h old; otherwise `indicative` (an illiquid or stale print, shown and
            ranked after the measured deviations). Null when there is no
            deviation.
          type: string
          enum:
            - measured
            - indicative
        volume24hUsd:
          nullable: true
          description: >-
            Trailing 24h trading volume in USD over the venues CoinGecko tracks;
            null when CoinGecko does not list the coin.
          type: number
        priceUpdatedAt:
          nullable: true
          description: >-
            Newest time the price can be vouched for (ISO 8601); null when
            neither CoinGecko's quote time nor the DeFi Llama snapshot stamp is
            known.
          format: date-time
          type: string
        nominalSupplyValue:
          type: number
        markedMarketValue:
          nullable: true
          type: number
        marketCap:
          type: number
          description: Use nominalSupplyValue.
          deprecated: true
        circulating:
          type: number
          description: >-
            USD value, not a token count: circulating units translated to USD at
            the peg's FX rate, the same number as nominalSupplyValue (equal to
            the unit count only for USD pegs; a EUR or gold peg reads its supply
            times the EUR or gold rate). Divide by the peg rate for units.
        change24hUsd:
          nullable: true
          type: number
        change7dUsd:
          nullable: true
          type: number
        change30dUsd:
          nullable: true
          type: number
        supplyChange24h:
          nullable: true
          type: number
        supplyChange7d:
          nullable: true
          type: number
        supplyChange30d:
          nullable: true
          type: number
        chainCount:
          type: integer
        marketShare:
          type: number
        chainSupplies:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinChainSupply'
        topChains:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinTopChain'
        velocity:
          nullable: true
          type: number
        velocityNonEvmShare:
          type: number
        velocityCoverage:
          type: number
        velocityUnavailableReason:
          nullable: true
          type: string
        pegStability30d:
          $ref: '#/components/schemas/StablecoinPegStability'
      required:
        - id
        - slug
        - name
        - symbol
        - peg
        - mechanism
        - priceModel
        - yieldBearing
        - image
        - price
        - pegDeviation
        - nominalSupplyValue
        - markedMarketValue
        - marketCap
        - circulating
        - supplyChange24h
        - supplyChange7d
        - supplyChange30d
        - chainCount
        - marketShare
        - topChains
    StablecoinHistoryPoint:
      type: object
      properties:
        t:
          type: integer
          format: int64
        v:
          type: number
      required:
        - t
        - v
    StablecoinDailyNetIssuancePoint:
      type: object
      properties:
        t:
          type: integer
          format: int64
        net:
          type: number
      required:
        - t
        - net
    StablecoinChainRow:
      type: object
      properties:
        name:
          type: string
        trackerId:
          nullable: true
          type: string
        totalUSD:
          type: number
        marketShare:
          type: number
      required:
        - name
        - trackerId
        - totalUSD
        - marketShare
    StablecoinChainBreakdown:
      type: object
      properties:
        chain:
          type: string
        trackerId:
          nullable: true
          type: string
        circulating:
          type: number
          description: >-
            USD value of the stablecoin's supply on this chain (units translated
            at the peg's FX rate), not a token count.
        supplyShare:
          type: number
        supplyTvlRatio:
          description: >-
            The coin's supply on this chain over the chain's reported DeFi TVL:
            a ratio that can exceed 1, not a share.
          nullable: true
          type: number
      required:
        - chain
        - trackerId
        - circulating
        - supplyShare
    StablecoinChainHistory:
      type: object
      properties:
        chain:
          type: string
        trackerId:
          nullable: true
          type: string
        points:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinHistoryPoint'
      required:
        - chain
        - trackerId
        - points
    StablecoinPegStability:
      type: object
      properties:
        share_inside_0_1:
          type: number
        share_inside_0_5:
          type: number
        share_inside_1_0:
          type: number
        sampleCount:
          type: integer
        earliestSampleAt:
          nullable: true
          type: string
          format: date-time
      required:
        - share_inside_0_1
        - share_inside_0_5
        - share_inside_1_0
        - sampleCount
        - earliestSampleAt
    StablecoinMintBurnPoint:
      type: object
      properties:
        bucketDate:
          type: string
          format: date
        mintsUsd:
          type: number
        burnsUsd:
          type: number
        netUsd:
          type: number
      required:
        - bucketDate
        - mintsUsd
        - burnsUsd
        - netUsd
    StablecoinBridgeFlowRow:
      type: object
      properties:
        chain:
          type: string
        trackerId:
          nullable: true
          type: string
        chainDeltaUsd:
          type: number
        netBridgeFlowUsd:
          type: number
        direction:
          type: string
          enum:
            - inbound
            - outbound
            - flat
            - mint-dominated
            - burn-dominated
      required:
        - chain
        - trackerId
        - chainDeltaUsd
        - netBridgeFlowUsd
        - direction
    StablecoinYieldsCache:
      type: object
      properties:
        rows:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinYieldRow'
        updatedAt:
          type: string
          format: date-time
        degraded:
          type: boolean
        lastSuccessfulAt:
          nullable: true
          type: string
          format: date-time
        lastAttemptAt:
          nullable: true
          type: string
          format: date-time
        degradedReason:
          nullable: true
          type: string
          enum:
            - upstream-empty
            - partial-result
      required:
        - rows
        - updatedAt
    StablecoinChainSupply:
      type: object
      properties:
        name:
          type: string
        supplyShare:
          type: number
        value:
          type: number
      required:
        - name
        - supplyShare
        - value
    StablecoinTopChain:
      type: object
      properties:
        name:
          type: string
        supplyShare:
          type: number
      required:
        - name
        - supplyShare
    StablecoinYieldRow:
      type: object
      properties:
        symbol:
          type: string
        slug:
          type: string
        stablecoinId:
          nullable: true
          type: string
        detailId:
          nullable: true
          type: string
        bestTotalApy:
          type: number
        bestBaseApy:
          nullable: true
          type: number
        bestRewardApy:
          nullable: true
          type: number
        bestTotalApyChange7d:
          nullable: true
          description: >-
            The best pool's `totalApy` now less its value 7 days ago, a
            difference of two APYs, not a relative change.
          type: number
        bestProject:
          type: string
        bestChain:
          type: string
        bestPoolMeta:
          nullable: true
          type: string
        bestTvlUsd:
          type: number
        bestRiskFlag:
          nullable: true
          type: string
          enum:
            - rewards
            - high_apy
          x-field: stablecoin.yield_risk_flag
          description: >-
            A stablecoin's best yield pool flagged from its APY and DefiLlama's
            base and reward split (percent): rewards when token rewards are at
            least half the APY or the base rate at most half of it, else
            high_apy when the APY is at least 50 %, at least 20 % with no split,
            or not a finite number; null when neither holds.
        pools:
          type: array
          items:
            $ref: '#/components/schemas/StablecoinYieldPool'
      required:
        - symbol
        - slug
        - bestTotalApy
        - bestBaseApy
        - bestRewardApy
        - bestTotalApyChange7d
        - bestProject
        - bestChain
        - bestPoolMeta
        - bestTvlUsd
        - bestRiskFlag
        - pools
    StablecoinYieldPool:
      type: object
      properties:
        project:
          type: string
        chain:
          type: string
        poolMeta:
          nullable: true
          type: string
        totalApy:
          type: number
        baseApy:
          nullable: true
          type: number
        rewardApy:
          nullable: true
          type: number
        totalApyChange7d:
          nullable: true
          description: >-
            `totalApy` now less its value 7 days ago, a difference of two APYs
            (0.05 rising to 0.062 is 0.012), not a relative change.
          type: number
        tvlUsd:
          type: number
      required:
        - project
        - chain
        - poolMeta
        - totalApy
        - baseApy
        - rewardApy
        - totalApyChange7d
        - tvlUsd
  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.