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

# Versioning

> Learn how Sharpe versions API routes, preserves backward compatibility, communicates deprecations, and handles migration paths for production clients.

The Sharpe API uses URL-path versioning (`/v1/`). Additions ship at any time; a breaking change ships on a stated day, announced in the changelog with a migration note.

## Current version

The current and only production version is **v1**, accessible at `https://www.sharpe.ai/api/v1/`.

## Backward-compatible changes

The following changes are considered **backward-compatible** and may be made without a version bump or advance notice:

* Adding new endpoints
* Adding new optional query parameters to existing endpoints
* Adding new fields to response objects
* Adding new error codes
* Adding new enum values to non-strict parameters
* Improving error messages for clarity

Your integration should handle unknown response fields gracefully (ignore fields you don't recognize).

## Breaking changes

The following changes are considered **breaking**:

* Removing or renaming existing endpoints
* Removing or renaming response fields
* Changing the type or the unit of an existing response field
* Making an optional parameter required
* Changing authentication requirements
* Changing the response envelope structure

A breaking change ships on the day its [changelog](https://docs.sharpe.ai/changelog.md) entry names, with a migration note saying what to change. The old shape is not served beside the new one. A field never keeps its name when its meaning or its unit changes, so code written for the old shape fails on a missing field instead of reading a wrong number.

### Exception: discontinued upstream sources

When the upstream source behind an endpoint is discontinued, the endpoint can be removed without the notice window. From the day it is removed, it answers `410 Gone` with a problem+json body that links to the [changelog](https://docs.sharpe.ai/changelog.md) entry recording the removal.

The endpoints removed on 2026-09-23 were removed before this rule and answer `404`.

> [!NOTE]
>
> Query-string API keys are rejected by default. Use `Authorization: Bearer` or `X-API-Key` headers for all production integrations. See [Authentication](https://docs.sharpe.ai/authentication.md) for the supported request shape.

## Monitoring for changes

* **Changelog**: [/docs/changelog](https://docs.sharpe.ai/changelog.md) lists changes from 2026-09-23 on, each with its date, kind and affected endpoints. The [RSS feed](https://www.sharpe.ai/feed.xml) carries the same entries
* **Response headers**: A request that uses a deprecated shape (today, the `api_key` query parameter, where it is still accepted) is answered with a `Deprecation` header naming the replacement

## Migration: percent fields became fractions (2026-11-14)

Every `/v1` field that was served in percent (`5.4` for 5.4%) is a fraction (`0.054`) under a new name, and the fields whose name said "percent" while holding a fraction lost the word. The scanners' `minApr` (percentage points) is `minNet`, a fraction; a request that still sends `minApr` gets `400 invalid_parameter`. To move: read each field under its new name and multiply any value you stored before by the factor below.

The names follow one rule: the unit word goes (`basisPct` → `basis`), price and market-cap moves are returns (`change24h` → `return24h`), shares say share (`btcDominance` → `btcMarketShare`), the distance from the all-time high or low is `fromAth` / `fromAtl`, and a field that only repeated another is removed. Paths are inside each answer's `data`.

| Endpoint | Before | Now | Multiply by | Note |
| - | - | - | - | - |
| `/v1/arbitrage/cex-spot-transfer` `/v1/arbitrage/dated-futures-basis` `/v1/arbitrage/futures-calendar-spread` `/v1/arbitrage/perp-dated-carry` | `minApr` (query) | `minNet` | 0.01 | A fraction (0.05 is 5%) of the board's net figure: `netApr`, `netRollApy`, `netCarryApr`, or `netReturn` on the CEX transfer board. |
| `/v1/narratives/data` | `sort=change24h` (query) | `sort=return24h` | | And `-change24h` → `-return24h`. |
| `/v1/arbitrage/cex-spot-transfer` | `rows[].grossSpreadPct` | `rows[].grossSpread` | 0.01 | |
| | `rows[].slippagePct` | `rows[].slippage` | 0.01 | |
| | `rows[].netProfitPct` | `rows[].netReturn` | 0.01 | Per trip, not annualized. |
| | `rows[].buyTakerFeePct` | `rows[].buyTakerFee` | 0.01 | |
| | `rows[].sellTakerFeePct` | `rows[].sellTakerFee` | 0.01 | |
| | `scannerMeta.transferScan.bestNetPct` | `scannerMeta.transferScan.bestNetReturn` | 0.01 | |
| `/v1/arbitrage/dated-futures-basis` | `rows[].basisPct` | `rows[].basis` | 0.01 | |
| | `rows[].annualizedBasisPct` | `rows[].annualizedBasis` | 0.01 | |
| | `rows[].netAprPct` | `rows[].netApr` | 0.01 | |
| | `rows[].feesPct` | `rows[].fees` | 0.01 | |
| | `aggregate[].oiWeightedAprPct` | `aggregate[].oiWeightedApr` | 0.01 | |
| | `aggregate[].bestAprPct` | `aggregate[].bestApr` | 0.01 | |
| | `scannerMeta.transferScan.bestNetPct` | `scannerMeta.transferScan.bestNetReturn` | 0.01 | |
| `/v1/arbitrage/futures-calendar-spread` | `rows[].nearBasisPct` | `rows[].nearBasis` | 0.01 | |
| | `rows[].farBasisPct` | `rows[].farBasis` | 0.01 | |
| | `rows[].forwardYieldPct` | `rows[].forwardYield` | 0.01 | |
| | `rows[].netRollApyPct` | `rows[].netRollApy` | 0.01 | |
| | `rows[].referenceForwardYieldPct` | `rows[].referenceForwardYield` | 0.01 | |
| | `rows[].feesPct` | `rows[].fees` | 0.01 | |
| | `scannerMeta.transferScan.bestNetPct` | `scannerMeta.transferScan.bestNetReturn` | 0.01 | |
| `/v1/arbitrage/perp-dated-carry` | `rows[].perpFundingAprPct` | `rows[].perpFundingApr` | 0.01 | |
| | `rows[].currentFundingAprPct` | removed | | The same number as `perpFundingAprPct`: read `perpFundingApr`. |
| | `rows[].expectedFundingToExpiryPct` | `rows[].expectedFundingToExpiry` | 0.01 | |
| | `rows[].datedBasisPct` | `rows[].datedBasis` | 0.01 | |
| | `rows[].carryEdgePct` | `rows[].carryEdge` | 0.01 | |
| | `rows[].netCarryEdgePct` | `rows[].netCarryEdge` | 0.01 | |
| | `rows[].grossCarryAprPct` | `rows[].grossCarryApr` | 0.01 | |
| | `rows[].netCarryAprPct` | `rows[].netCarryApr` | 0.01 | |
| | `rows[].funding7dAprPct` | `rows[].funding7dApr` | 0.01 | |
| | `rows[].funding7dCumulativePct` | `rows[].funding7dCumulative` | 0.01 | |
| | `rows[].feesPct` | `rows[].fees` | 0.01 | |
| | `scannerMeta.transferScan.bestNetPct` | `scannerMeta.transferScan.bestNetReturn` | 0.01 | |
| `/v1/futures/data` | `data[].basis_pct` | `data[].basis_rate` | 0.01 | Term structure rows, to expiry: the formula `basis_rate` names on the basis chart. Null on Velo `-VELO-3M-BASIS` rows, whose `basis_pct` held an annualized figure (`basis_apr` keeps it). |
| | `data[].annualized_basis_pct` | `data[].basis_apr` | 0.01 | |
| | `data[].annualized_basis` | removed | | Not annualized: `basis_rate` × 100. Read `basis_rate`. |
| `/v1/funding/settlement` | `rows[].price` | removed | | Always null. |
| | `rows[].price_change_24h_pct` | removed | | Always null. |
| `/v1/rwa-perps/rates` | `[].price_deviation_pct` | `[].price_deviation` | 0.01 | |
| `/v1/global/overview` | `[].priceChange24hPct` | `[].return24h` | 0.01 | |
| | `[].volumeChange24hPct` | `[].volumeChange24h` | 0.01 | |
| | `[].oiChange1hPct` | `[].oiChange1h` | 0.01 | |
| | `[].oiChange24hPct` | `[].oiChange24h` | 0.01 | |
| | `rows[].priceChange24hPct` | `rows[].return24h` | 0.01 | |
| | `rows[].volumeChange24hPct` | `rows[].volumeChange24h` | 0.01 | |
| | `rows[].oiChange1hPct` | `rows[].oiChange1h` | 0.01 | |
| | `rows[].oiChange24hPct` | `rows[].oiChange24h` | 0.01 | |
| | `metrics.openInterestChange24hPct` | `metrics.openInterestChange24h` | 0.01 | |
| | `metrics.liquidationsChange24hPct` | `metrics.liquidationsChange24h` | 0.01 | |
| `/v1/tracker/market-overview` | `bitcoin.change` | `bitcoin.return_24h` | 0.01 | |
| | `ethereum.change` | `ethereum.return_24h` | 0.01 | |
| | `market_cap_change_24h` | `market_cap_return_24h` | 0.01 | |
| | `btc_dominance` | `btc_market_share` | 0.01 | |
| | `btc_dominance_pct` | removed | | The same number as `btc_dominance`: read `btc_market_share`. |
| `/v1/heatmap/data` | `dots[].y` | `dots[].returns` | 0.01 | The same window keys (`1h` … `3y`). |
| | `dots[].median.y` | `dots[].median.returns` | 0.01 | The same window keys. |
| | `dots[].fundingApr` | `dots[].avgFundingApr` | 0.01 | |
| | `dots[].median.fundingApr` | `dots[].median.avgFundingApr` | 0.01 | |
| | `dots[].openInterestChange24h` | `dots[].oiChange24h` | 0.01 | |
| | `dots[].constituents.n.change1h` | `dots[].constituents.n.return1h` | 1 | |
| | `dots[].constituents.n.change4h` | `dots[].constituents.n.return4h` | 1 | |
| | `dots[].constituents.n.change24h` | `dots[].constituents.n.return24h` | 1 | |
| | `dots[].constituents.n.change7d` | `dots[].constituents.n.return7d` | 1 | |
| | `dots[].constituents.n.change30d` | `dots[].constituents.n.return30d` | 1 | |
| | `dots[].constituents.n.change1y` | `dots[].constituents.n.return1y` | 1 | |
| | `dots[].constituents.n.fundingApr` | `dots[].constituents.n.avgFundingApr` | 1 | |
| | `dots[].constituents.n.openInterestChange24h` | `dots[].constituents.n.oiChange24h` | 1 | |
| | `dots[].constituents.weightCoverage.change1h` | `dots[].constituents.weightCoverage.return1h` | 1 | |
| | `dots[].constituents.weightCoverage.change4h` | `dots[].constituents.weightCoverage.return4h` | 1 | |
| | `dots[].constituents.weightCoverage.change24h` | `dots[].constituents.weightCoverage.return24h` | 1 | |
| | `dots[].constituents.weightCoverage.change7d` | `dots[].constituents.weightCoverage.return7d` | 1 | |
| | `dots[].constituents.weightCoverage.change30d` | `dots[].constituents.weightCoverage.return30d` | 1 | |
| | `dots[].constituents.weightCoverage.change1y` | `dots[].constituents.weightCoverage.return1y` | 1 | |
| | `dots[].constituents.weightCoverage.fundingApr` | `dots[].constituents.weightCoverage.avgFundingApr` | 1 | |
| | `dots[].constituents.weightCoverage.openInterestChange24h` | `dots[].constituents.weightCoverage.oiChange24h` | 1 | |
| `/v1/narratives/data` | `narratives[].change1h` | `narratives[].return1h` | 0.01 | |
| | `narratives[].median1h` | `narratives[].medianReturn1h` | 0.01 | |
| | `narratives[].change24h` | `narratives[].return24h` | 0.01 | |
| | `narratives[].median24h` | `narratives[].medianReturn24h` | 0.01 | |
| | `narratives[].change7d` | `narratives[].return7d` | 0.01 | |
| | `narratives[].median7d` | `narratives[].medianReturn7d` | 0.01 | |
| | `narratives[].change30d` | `narratives[].return30d` | 0.01 | |
| | `narratives[].median30d` | `narratives[].medianReturn30d` | 0.01 | |
| | `narratives[].change200d` | `narratives[].return200d` | 0.01 | |
| | `narratives[].median200d` | `narratives[].medianReturn200d` | 0.01 | |
| | `narratives[].change1y` | `narratives[].return1y` | 0.01 | |
| | `narratives[].median1y` | `narratives[].medianReturn1y` | 0.01 | |
| | `narratives[].dominance` | `narratives[].marketShare` | 0.01 | |
| | `narratives[].momentum` | `narratives[].momentumReturn` | 0.01 | |
| | `narratives[].mindsharePct` | `narratives[].mindshare` | 0.01 | |
| | `narratives[].sentimentPct` | `narratives[].sentiment` | 0.01 | |
| | `narratives[].topCoin.change24h` | `narratives[].topCoin.return24h` | 0.01 | |
| | `top[].change1h` | `top[].return1h` | 0.01 | |
| | `top[].median1h` | `top[].medianReturn1h` | 0.01 | |
| | `top[].change24h` | `top[].return24h` | 0.01 | |
| | `top[].median24h` | `top[].medianReturn24h` | 0.01 | |
| | `top[].change7d` | `top[].return7d` | 0.01 | |
| | `top[].median7d` | `top[].medianReturn7d` | 0.01 | |
| | `top[].change30d` | `top[].return30d` | 0.01 | |
| | `top[].median30d` | `top[].medianReturn30d` | 0.01 | |
| | `top[].change200d` | `top[].return200d` | 0.01 | |
| | `top[].median200d` | `top[].medianReturn200d` | 0.01 | |
| | `top[].change1y` | `top[].return1y` | 0.01 | |
| | `top[].median1y` | `top[].medianReturn1y` | 0.01 | |
| | `top[].dominance` | `top[].marketShare` | 0.01 | |
| | `top[].momentum` | `top[].momentumReturn` | 0.01 | |
| | `top[].mindsharePct` | `top[].mindshare` | 0.01 | |
| | `top[].sentimentPct` | `top[].sentiment` | 0.01 | |
| | `top[].topCoin.change24h` | `top[].topCoin.return24h` | 0.01 | |
| | `bottom[].change1h` | `bottom[].return1h` | 0.01 | |
| | `bottom[].median1h` | `bottom[].medianReturn1h` | 0.01 | |
| | `bottom[].change24h` | `bottom[].return24h` | 0.01 | |
| | `bottom[].median24h` | `bottom[].medianReturn24h` | 0.01 | |
| | `bottom[].change7d` | `bottom[].return7d` | 0.01 | |
| | `bottom[].median7d` | `bottom[].medianReturn7d` | 0.01 | |
| | `bottom[].change30d` | `bottom[].return30d` | 0.01 | |
| | `bottom[].median30d` | `bottom[].medianReturn30d` | 0.01 | |
| | `bottom[].change200d` | `bottom[].return200d` | 0.01 | |
| | `bottom[].median200d` | `bottom[].medianReturn200d` | 0.01 | |
| | `bottom[].change1y` | `bottom[].return1y` | 0.01 | |
| | `bottom[].median1y` | `bottom[].medianReturn1y` | 0.01 | |
| | `bottom[].dominance` | `bottom[].marketShare` | 0.01 | |
| | `bottom[].momentum` | `bottom[].momentumReturn` | 0.01 | |
| | `bottom[].mindsharePct` | `bottom[].mindshare` | 0.01 | |
| | `bottom[].sentimentPct` | `bottom[].sentiment` | 0.01 | |
| | `bottom[].topCoin.change24h` | `bottom[].topCoin.return24h` | 0.01 | |
| | `coins[].change1h` | `coins[].return1h` | 0.01 | |
| | `coins[].change24h` | `coins[].return24h` | 0.01 | |
| | `coins[].change7d` | `coins[].return7d` | 0.01 | |
| | `coins[].change30d` | `coins[].return30d` | 0.01 | |
| | `coins[].change200d` | `coins[].return200d` | 0.01 | |
| | `coins[].change1y` | `coins[].return1y` | 0.01 | |
| | `coins[].athDistance` | `coins[].fromAth` | 0.01 | |
| | `coins[].fundingApr` | `coins[].avgFundingApr` | 0.01 | |
| | `basePrices.btc.change1h` | `basePrices.btc.return1h` | 0.01 | |
| | `basePrices.btc.change24h` | `basePrices.btc.return24h` | 0.01 | |
| | `basePrices.btc.change7d` | `basePrices.btc.return7d` | 0.01 | |
| | `basePrices.btc.change30d` | `basePrices.btc.return30d` | 0.01 | |
| | `basePrices.btc.change200d` | `basePrices.btc.return200d` | 0.01 | |
| | `basePrices.btc.change1y` | `basePrices.btc.return1y` | 0.01 | |
| | `basePrices.eth.change1h` | `basePrices.eth.return1h` | 0.01 | |
| | `basePrices.eth.change24h` | `basePrices.eth.return24h` | 0.01 | |
| | `basePrices.eth.change7d` | `basePrices.eth.return7d` | 0.01 | |
| | `basePrices.eth.change30d` | `basePrices.eth.return30d` | 0.01 | |
| | `basePrices.eth.change200d` | `basePrices.eth.return200d` | 0.01 | |
| | `basePrices.eth.change1y` | `basePrices.eth.return1y` | 0.01 | |
| | `basePrices.sol.change1h` | `basePrices.sol.return1h` | 0.01 | |
| | `basePrices.sol.change24h` | `basePrices.sol.return24h` | 0.01 | |
| | `basePrices.sol.change7d` | `basePrices.sol.return7d` | 0.01 | |
| | `basePrices.sol.change30d` | `basePrices.sol.return30d` | 0.01 | |
| | `basePrices.sol.change200d` | `basePrices.sol.return200d` | 0.01 | |
| | `basePrices.sol.change1y` | `basePrices.sol.return1y` | 0.01 | |
| `/v1/ecosystems/data` | `ecosystems[].change1h` | `ecosystems[].return1h` | 0.01 | |
| | `ecosystems[].median1h` | `ecosystems[].medianReturn1h` | 0.01 | |
| | `ecosystems[].change24h` | `ecosystems[].return24h` | 0.01 | |
| | `ecosystems[].median24h` | `ecosystems[].medianReturn24h` | 0.01 | |
| | `ecosystems[].change7d` | `ecosystems[].return7d` | 0.01 | |
| | `ecosystems[].median7d` | `ecosystems[].medianReturn7d` | 0.01 | |
| | `ecosystems[].change30d` | `ecosystems[].return30d` | 0.01 | |
| | `ecosystems[].median30d` | `ecosystems[].medianReturn30d` | 0.01 | |
| | `ecosystems[].change200d` | `ecosystems[].return200d` | 0.01 | |
| | `ecosystems[].median200d` | `ecosystems[].medianReturn200d` | 0.01 | |
| | `ecosystems[].change1y` | `ecosystems[].return1y` | 0.01 | |
| | `ecosystems[].median1y` | `ecosystems[].medianReturn1y` | 0.01 | |
| | `ecosystems[].dominance` | `ecosystems[].marketShare` | 0.01 | |
| | `ecosystems[].momentum` | `ecosystems[].momentumReturn` | 0.01 | |
| | `ecosystems[].mindsharePct` | `ecosystems[].mindshare` | 0.01 | |
| | `ecosystems[].sentimentPct` | `ecosystems[].sentiment` | 0.01 | |
| | `ecosystems[].topCoin.change24h` | `ecosystems[].topCoin.return24h` | 0.01 | |
| | `ecosystems[].fundingApr` | removed | | Declared but never served; the coins carry `avgFundingApr`. |
| | `coins[].change1h` | `coins[].return1h` | 0.01 | |
| | `coins[].change24h` | `coins[].return24h` | 0.01 | |
| | `coins[].change7d` | `coins[].return7d` | 0.01 | |
| | `coins[].change30d` | `coins[].return30d` | 0.01 | |
| | `coins[].change200d` | `coins[].return200d` | 0.01 | |
| | `coins[].change1y` | `coins[].return1y` | 0.01 | |
| | `coins[].athDistance` | `coins[].fromAth` | 0.01 | |
| | `coins[].fundingApr` | `coins[].avgFundingApr` | 0.01 | |
| | `basePrices.btc.change1h` | `basePrices.btc.return1h` | 0.01 | |
| | `basePrices.btc.change24h` | `basePrices.btc.return24h` | 0.01 | |
| | `basePrices.btc.change7d` | `basePrices.btc.return7d` | 0.01 | |
| | `basePrices.btc.change30d` | `basePrices.btc.return30d` | 0.01 | |
| | `basePrices.btc.change200d` | `basePrices.btc.return200d` | 0.01 | |
| | `basePrices.btc.change1y` | `basePrices.btc.return1y` | 0.01 | |
| | `basePrices.eth.change1h` | `basePrices.eth.return1h` | 0.01 | |
| | `basePrices.eth.change24h` | `basePrices.eth.return24h` | 0.01 | |
| | `basePrices.eth.change7d` | `basePrices.eth.return7d` | 0.01 | |
| | `basePrices.eth.change30d` | `basePrices.eth.return30d` | 0.01 | |
| | `basePrices.eth.change200d` | `basePrices.eth.return200d` | 0.01 | |
| | `basePrices.eth.change1y` | `basePrices.eth.return1y` | 0.01 | |
| | `basePrices.sol.change1h` | `basePrices.sol.return1h` | 0.01 | |
| | `basePrices.sol.change24h` | `basePrices.sol.return24h` | 0.01 | |
| | `basePrices.sol.change7d` | `basePrices.sol.return7d` | 0.01 | |
| | `basePrices.sol.change30d` | `basePrices.sol.return30d` | 0.01 | |
| | `basePrices.sol.change200d` | `basePrices.sol.return200d` | 0.01 | |
| | `basePrices.sol.change1y` | `basePrices.sol.return1y` | 0.01 | |
| `/v1/memecoins/data` | `narratives[].change1h` | `narratives[].return1h` | 0.01 | |
| | `narratives[].median1h` | `narratives[].medianReturn1h` | 0.01 | |
| | `narratives[].change24h` | `narratives[].return24h` | 0.01 | |
| | `narratives[].median24h` | `narratives[].medianReturn24h` | 0.01 | |
| | `narratives[].change7d` | `narratives[].return7d` | 0.01 | |
| | `narratives[].median7d` | `narratives[].medianReturn7d` | 0.01 | |
| | `narratives[].change30d` | `narratives[].return30d` | 0.01 | |
| | `narratives[].median30d` | `narratives[].medianReturn30d` | 0.01 | |
| | `narratives[].change200d` | `narratives[].return200d` | 0.01 | |
| | `narratives[].median200d` | `narratives[].medianReturn200d` | 0.01 | |
| | `narratives[].change1y` | `narratives[].return1y` | 0.01 | |
| | `narratives[].median1y` | `narratives[].medianReturn1y` | 0.01 | |
| | `narratives[].marketSharePct` | `narratives[].marketShare` | 0.01 | |
| | `narratives[].dominance` | removed | | The same number as `marketSharePct`: read `marketShare`. |
| | `narratives[].momentum` | `narratives[].momentumReturn` | 0.01 | |
| | `narratives[].returnCoverage` | `narratives[].returnCoverageShare` | 0.01 | The same window keys, each 0 to 1. |
| | `narratives[].topCoin.change24h` | `narratives[].topCoin.return24h` | 0.01 | |
| | `coins[].change1h` | `coins[].return1h` | 0.01 | |
| | `coins[].change24h` | `coins[].return24h` | 0.01 | |
| | `coins[].change7d` | `coins[].return7d` | 0.01 | |
| | `coins[].change30d` | `coins[].return30d` | 0.01 | |
| | `coins[].change200d` | `coins[].return200d` | 0.01 | |
| | `coins[].change1y` | `coins[].return1y` | 0.01 | |
| | `coins[].athPercent` | `coins[].fromAth` | 0.01 | |
| | `coins[].atlPercent` | `coins[].fromAtl` | 0.01 | |
| | `coins[].supplyRatio` | `coins[].circulatingShare` | 0.01 | |
| | `primaryThemeBuckets[].sharePct` | `primaryThemeBuckets[].share` | 0.01 | |
| | `primaryThemeBuckets[].change24h` | `primaryThemeBuckets[].return24h` | 0.01 | |
| | `primaryThemeBuckets[].change7d` | `primaryThemeBuckets[].return7d` | 0.01 | |
| | `primaryThemeBuckets[].change30d` | `primaryThemeBuckets[].return30d` | 0.01 | |
| `/v1/memecoins/launches` | `rows[].priceChangeH1` | `rows[].return1h` | 0.01 | |
| | `rows[].priceChangeH24` | `rows[].return24h` | 0.01 | |
| `/v1/mindshare/data` | `narratives[].mindsharePct` | `narratives[].mindshare` | 0.01 | |
| | `narratives[].sentimentPct` | `narratives[].sentiment` | 0.01 | |
| | `narratives[].priceChange24h` | `narratives[].return24h` | 0.01 | |
| | `narratives[].delta24h` | `narratives[].mindshareChange24h` | 0.01 | A difference of two shares. |
| | `narratives[].delta7d` | `narratives[].mindshareChange7d` | 0.01 | A difference of two shares. |
| | `tokens[].mindsharePct` | `tokens[].mindshare` | 0.01 | |
| | `tokens[].sentimentPct` | `tokens[].sentiment` | 0.01 | |
| | `tokens[].priceChange24h` | `tokens[].return24h` | 0.01 | |
| | `tokens[].delta24h` | `tokens[].mindshareChange24h` | 0.01 | A difference of two shares. |
| | `tokens[].delta7d` | `tokens[].mindshareChange7d` | 0.01 | A difference of two shares. |
| | `narratives[].delta30d` | `narratives[].mindshareChange30d` | 0.01 | A difference of two shares. |
| | `snapshots[].mindshare_pct` | `snapshots[].mindshare` | 0.01 | |
| `/v1/web-traffic/data` | `rankings[].sentimentUpPct` | `rankings[].sentimentUp` | 0.01 | |
| | `rankings[].sentimentDownPct` | `rankings[].sentimentDown` | 0.01 | |
| | `rankings[].priceChange7d` | `rankings[].return7d` | 0.01 | |
| | `rankings[].communityScore` | `rankings[].mindshare` | 0.01 | Narrative rankings: it was the narrative's mindshare. |
| | `btcDominance` | `btcMarketShare` | 0.01 | |
| | `ethDominance` | `ethMarketShare` | 0.01 | |
| | `usdtDominance` | `usdtMarketShare` | 0.01 | |
| | `marketCapChangePercentage24h` | `marketCapReturn24h` | 0.01 | |
| | `categories[].marketCapChange24h` | `categories[].marketCapReturn24h` | 0.01 | |
| | `categories[].marketCap1hChange` | `categories[].marketCapReturn1h` | 0.01 | |
| | `coins[].priceChange24h` | `coins[].return24h` | 0.01 | |
| | `snapshots[].sentiment_up_pct` | `snapshots[].sentiment_up` | 0.01 | |
| | `snapshots[].community_score` | `snapshots[].mindshare` | 0.01 | Narrative rows only, where it held the mindshare in percent: they serve `mindshare` and a null `community_score`. Exchange rows keep their CoinGecko trust score (0-10) in `community_score`. |
| `/v1/gem-finder/data` | `[].change24h` | `[].return24h` | 0.01 | |
| | `[].change7d` | `[].return7d` | 0.01 | |
| | `[].mcapChange24h` | `[].marketCapReturn24h` | 0.01 | |
| | `[].athDistance` | `[].fromAth` | 0.01 | |
| | `[].atlDistance` | `[].fromAtl` | 0.01 | |
| | `coins[].change24h` | `coins[].return24h` | 0.01 | |
| | `coins[].change7d` | `coins[].return7d` | 0.01 | |
| | `coins[].mcapChange24h` | `coins[].marketCapReturn24h` | 0.01 | |
| | `coins[].athDistance` | `coins[].fromAth` | 0.01 | |
| | `coins[].atlDistance` | `coins[].fromAtl` | 0.01 | |
| `/v1/market-cap/search` | `assets[].change24h` | `assets[].dayReturn` | 0.01 | Crypto: the last 24 hours. Stocks, ETFs, indices and commodity proxies: the last trading session against the prior close. |
| `/v1/price-prediction/data` | `coin.priceChange24h` | `coin.return24h` | 0.01 | |
| | `coin.priceChange7d` | `coin.return7d` | 1 | |
| | `coin.priceChange30d` | `coin.return30d` | 1 | |
| | `coin.forecasts[].expectedChangePct` | `coin.forecasts[].expectedReturn` | 0.01 | |
| | `coins[].priceChange24h` | `coins[].return24h` | 0.01 | |
| | `coins[].priceChange7d` | `coins[].return7d` | 1 | |
| | `coins[].priceChange30d` | `coins[].return30d` | 1 | |
| | `coins[].forecasts[].expectedChangePct` | `coins[].forecasts[].expectedReturn` | 0.01 | |
| `/v1/insider-selling/data` | `coins[].price_change_24h` | `coins[].return_24h` | 0.01 | |
| | `coins[].price_change_7d` | `coins[].return_7d` | 0.01 | |
| | `coins[].top10_holders_pct` | `coins[].top10_holders_share` | 0.01 | |
| | `coins[].top10_holders_pct_change` | `coins[].top10_holders_share_change` | 0.01 | A difference of two shares, not a relative change. |
| | `coins[].signal_coverage_pct` | `coins[].signal_coverage` | 0.01 | |
| | `coins[].holders_change_pct` | `coins[].holders_change` | 1 | |
| | `coins[].liquidity_change_pct` | `coins[].liquidity_change` | 1 | |
| | `coins[].volume_change_pct` | `coins[].volume_change` | 1 | |
| `/v1/pump-dump/data` | `coins[].price_change_24h` | `coins[].return_24h` | 0.01 | |
| | `coins[].price_change_7d` | `coins[].return_7d` | 0.01 | |
| | `coins[].top10_holders_pct` | `coins[].top10_holders_share` | 0.01 | |
| | `coins[].top10_holders_pct_change` | `coins[].top10_holders_share_change` | 0.01 | A difference of two shares, not a relative change. |
| | `coins[].signal_coverage_pct` | `coins[].signal_coverage` | 0.01 | |
| | `coins[].holders_change_pct` | `coins[].holders_change` | 1 | |
| | `coins[].liquidity_change_pct` | `coins[].liquidity_change` | 1 | |
| | `coins[].volume_change_pct` | `coins[].volume_change` | 1 | |
| `/v1/rug-check/security` | `creatorPercent` | `creatorShare` | 1 | |
| | `ownerPercent` | `ownerShare` | 1 | |
| | `topHolders[].percent` | `topHolders[].share` | 1 | |
| | `lpHolders[].percent` | `lpHolders[].share` | 1 | |
| | `dexInfo[].burnPercent` | `dexInfo[].lpBurnedShare` | 0.01 | |
| `/v1/rug-check/trending` | `tokens[].priceChange24h` | `tokens[].return24h` | 0.01 | |
| `/v1/stablecoins/data` | `items[].pegDeviationPct` | `items[].pegDeviation` | 0.01 | |
| | `items[].change24h` | `items[].supplyChange24h` | 0.01 | |
| | `items[].change7d` | `items[].supplyChange7d` | 0.01 | |
| | `items[].change30d` | `items[].supplyChange30d` | 0.01 | |
| | `items[].velocityCoveragePct` | `items[].velocityCoverage` | 0.01 | |
| | `items[].velocityNonEvmSharePct` | `items[].velocityNonEvmShare` | 0.01 | |
| | `items[].pegStability30d.inside_0_1` | `items[].pegStability30d.share_inside_0_1` | 0.01 | |
| | `items[].pegStability30d.inside_0_5` | `items[].pegStability30d.share_inside_0_5` | 0.01 | |
| | `items[].pegStability30d.inside_1_0` | `items[].pegStability30d.share_inside_1_0` | 0.01 | |
| | `items[].dominance` | `items[].marketShare` | 0.01 | |
| | `items[].chainSupplies[].share` | `items[].chainSupplies[].supplyShare` | 0.01 | |
| | `items[].topChains[].share` | `items[].topChains[].supplyShare` | 0.01 | |
| | `universeItems[].pegDeviationPct` | `universeItems[].pegDeviation` | 0.01 | |
| | `universeItems[].change24h` | `universeItems[].supplyChange24h` | 0.01 | |
| | `universeItems[].change7d` | `universeItems[].supplyChange7d` | 0.01 | |
| | `universeItems[].change30d` | `universeItems[].supplyChange30d` | 0.01 | |
| | `universeItems[].velocityCoveragePct` | `universeItems[].velocityCoverage` | 0.01 | |
| | `universeItems[].velocityNonEvmSharePct` | `universeItems[].velocityNonEvmShare` | 0.01 | |
| | `universeItems[].pegStability30d.inside_0_1` | `universeItems[].pegStability30d.share_inside_0_1` | 0.01 | |
| | `universeItems[].pegStability30d.inside_0_5` | `universeItems[].pegStability30d.share_inside_0_5` | 0.01 | |
| | `universeItems[].pegStability30d.inside_1_0` | `universeItems[].pegStability30d.share_inside_1_0` | 0.01 | |
| | `universeItems[].dominance` | `universeItems[].marketShare` | 0.01 | |
| | `universeItems[].chainSupplies[].share` | `universeItems[].chainSupplies[].supplyShare` | 0.01 | |
| | `universeItems[].topChains[].share` | `universeItems[].topChains[].supplyShare` | 0.01 | |
| | `pegDeviationPct` | `pegDeviation` | 0.01 | |
| | `change24h` | `supplyChange24h` | 0.01 | |
| | `change7d` | `supplyChange7d` | 0.01 | |
| | `change30d` | `supplyChange30d` | 0.01 | |
| | `velocityCoveragePct` | `velocityCoverage` | 0.01 | |
| | `velocityNonEvmSharePct` | `velocityNonEvmShare` | 0.01 | |
| | `pegStability30d.inside_0_1` | `pegStability30d.share_inside_0_1` | 0.01 | |
| | `pegStability30d.inside_0_5` | `pegStability30d.share_inside_0_5` | 0.01 | |
| | `pegStability30d.inside_1_0` | `pegStability30d.share_inside_1_0` | 0.01 | |
| | `chainBreakdown[].share` | `chainBreakdown[].supplyShare` | 0.01 | |
| | `chainBreakdown[].supplyTvlRatioPct` | `chainBreakdown[].supplyTvlRatio` | 0.01 | |
| | `chainBreakdown[].tvlShare` | removed | | The same number as `supplyTvlRatioPct`: read `supplyTvlRatio`. |
| | `chains[].share` | `chains[].marketShare` | 0.01 | |
| | `aggregate.change24h` | `aggregate.supplyChange24h` | 0.01 | |
| | `aggregate.change7d` | `aggregate.supplyChange7d` | 0.01 | |
| | `aggregate.change30d` | `aggregate.supplyChange30d` | 0.01 | |
| | `aggregate.mechanismSplit[].share` | `aggregate.mechanismSplit[].marketShare` | 0.01 | |
| | `aggregate.assetConcentration[].share` | `aggregate.assetConcentration[].marketShare` | 0.01 | |
| | `aggregate.issuerSplit[].share` | `aggregate.issuerSplit[].marketShare` | 0.01 | |
| | `yields.rows[].pools[].apy` | `yields.rows[].pools[].totalApy` | 0.01 | |
| | `yields.rows[].pools[].apyBase` | `yields.rows[].pools[].baseApy` | 0.01 | |
| | `yields.rows[].pools[].apyReward` | `yields.rows[].pools[].rewardApy` | 0.01 | |
| | `yields.rows[].pools[].apyPct7D` | `yields.rows[].pools[].totalApyChange7d` | 0.01 | A difference of two APYs. |
| | `yields.rows[].bestApy` | `yields.rows[].bestTotalApy` | 0.01 | |
| | `yields.rows[].bestApyBase` | `yields.rows[].bestBaseApy` | 0.01 | |
| | `yields.rows[].bestApyReward` | `yields.rows[].bestRewardApy` | 0.01 | |
| | `yields.rows[].bestApyPct7D` | `yields.rows[].bestTotalApyChange7d` | 0.01 | A difference of two APYs. |


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