Monthly / quarterly / yearly return matrix
Monthly / quarterly / yearly return matrix (BTC / ETH)
/api/p3/btc-returnsRequest
Query parameters
| Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|
| coin | string | Optional | BTC | BTC, ETH | Coin; BTC or ETH only, others treated as BTC. Example: BTC |
Example request
curl -s "https://www.coinboss.com/api/p3/btc-returns?coin=BTC"Response fields
The field table is generated from real responses, so it lists exactly what the endpoint returns. Paths use a[] for array items and {*} for objects keyed by a dynamic name such as a coin or an exchange.
| Field | Type | Unit | Description |
|---|---|---|---|
| success | boolean | — | true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`. |
| now | number | ms | Server time when the response was built. |
| coin | string | — | Coin symbol, upper case (for example BTC). |
| matrix | object | — | Matrix keyed by row and column. dynamic keys: 2013,2014,2015,2016,2017,2018 |
| matrix.{*} | object | — | Matrix keyed by row and column. dynamic keys: 1,2,3,4,5,6 |
| matrix.{*}.{*} | number | — | Matrix keyed by row and column. |
| monthAvg | object | — | Mean monthly return of each calendar month across all years in `matrix`; keys are month numbers `1`–`12`. dynamic keys: 1,2,3,4,5,6 |
| monthAvg.{*} | number | % | Arithmetic mean of that calendar month's returns over all years with data; the key is the month number. |
| monthMed | object | — | Median monthly return of each calendar month across all years; keys are month numbers `1`–`12`. dynamic keys: 1,2,3,4,5,6 |
| monthMed.{*} | number | % | Median of that calendar month's returns over all years with data; the key is the month number. |
| qmatrix | object | — | Quarterly returns by year; keys are calendar years. dynamic keys: 2013,2014,2015,2016,2017,2018 |
| qmatrix.{*} | object | — | Returns of one year's quarters; keys are quarter numbers `1`–`4`, quarters without data are omitted. dynamic keys: 1,2,3,4 |
| qmatrix.{*}.{*} | number | % | Return of the quarter, compounded from the monthly returns available in that quarter (the current quarter is partial). |
| qAvg | object | — | Mean return of each quarter across all years; keys are quarter numbers `1`–`4`. dynamic keys: 1,2,3,4 |
| qAvg.{*} | number | % | Arithmetic mean of that quarter's returns over all years with data. |
| qMed | object | — | Median return of each quarter across all years; keys are quarter numbers `1`–`4`. dynamic keys: 1,2,3,4 |
| qMed.{*} | number | % | Median of that quarter's returns over all years with data. |
| yearly | object | — | Yearly values. dynamic keys: 2013,2014,2015,2016,2017,2018 |
| yearly.{*} | number | — | Yearly values. |
| yearSrc | object | — | Origin of the monthly candles used for each year; keys are calendar years. dynamic keys: 2013,2014,2015,2016,2017,2018 |
| yearSrc.{*} | string | — | Source label of that year's monthly candles: `binance`, a third-party reference-price label for years before Binance listed the pair, or `mixed`. |
Generated 2026-11-11 23:00 UTC from 1 real responses.
Example response
/api/p3/btc-returns?coin=BTC · Real response captured 2026-11-13 03:57:33 UTC. Long arrays and maps are shortened for display: qAvg had 4 items; qMed had 4 items; matrix had 14 items; yearly had 14 items; qmatrix had 14 items; yearSrc had 14 items.
- "success"true
- "now"1794542253311
- "coin""BTC"
- "matrix"
- "2013"
- "2014"
- "monthAvg"
- "1"3.3
- "2"10.27
- "monthMed"
- "1"-1.09
- "2"11.63
- "qmatrix"
- "2013"
- "2014"
- "qAvg"
- "1"47.83
- "2"23.04
- "qMed"
- "1"-3
- "2"9.21
- "yearly"
- "2013"5372.48
- "2014"-57.38
- "yearSrc"
- "2013""coinmetrics"
- "2014""coinmetrics"
Details
- Authentication
- None. Public endpoint.
- Rate limit
- 1200 requests per minute per IP
- Server cache
- 10m
- Edge micro-cache
- 10s
- Update frequency
- every 6 hours (current month is updated in place)
- Window
- full monthly history
- Data sources
- Monthly, quarterly and yearly returns computed in-house from a public reference-rate dataset (early years) and exchange monthly klines.
- Exchange coverage
- BTC and ETH.
- Sorting
- year ascending
- Units
- percent
- Method
- Monthly return = (close - open) / open x 100; quarterly and yearly returns compound the monthly ones; averages and medians per calendar month/quarter.
- Timestamps
- Unix epoch milliseconds (UTC) unless the field description says otherwise
- Response format
- json
- Stability
- Stable
Live status
Availability, last 30 days
100% of 411 checks passed
Errors
Failed calls share one shape on every endpoint. The full list is on the errors page. Errors and rate limits →
| Code | HTTP | Meaning | What to do |
|---|---|---|---|
| INVALID_PARAM | 400 | A required parameter is missing or a value is not accepted. `param` names the parameter when it is known. | Do not retry unchanged; fix the request. |
| UNAUTHORIZED | 401 | The `CB-API-KEY` header was sent but the key is unknown or revoked. Public data needs no key — drop the header or use a valid key. | Do not retry unchanged. |
| FORBIDDEN | 403 | The route is not part of the public API (internal or account-only). | Do not retry. |
| NOT_FOUND | 404 | Unknown route, or the requested coin / exchange / fund does not exist. | Do not retry; check the path and identifiers against the catalog. |
| RATE_LIMITED | 429 | More requests than the per-minute limit. `Retry-After` gives the seconds to wait. | Wait for `Retry-After`, then retry with backoff. |
| INTERNAL | 500 | Unexpected server error. The message is generic by design; quote `request_id` when reporting it. | Retry once after a few seconds; report it with the request id if it persists. |
| UPSTREAM_FAILED | 503 | The data source behind this endpoint did not answer in time. No stale or substitute numbers are returned in its place. | Retry with backoff; check the status page. |
| UNAVAILABLE | 501 / 503 | The dataset is temporarily not ready (cache warming) or the endpoint has no lawful public source yet. | Retry later; the catalog marks endpoints that are unavailable by design. |
| REQUEST_FAILED | 200 | Some older endpoints answer HTTP 200 with `success: false`. Always check `success`, not only the HTTP status. | Depends on the message; treat as a failed request. |
Try it
/api/p3/btc-returnsAvailablestring · default BTC — Coin; BTC or ETH only, others treated as BTC.
https://www.coinboss.com/api/p3/btc-returns?coin=BTCMore in this category
- Coin heatmap data /api/coin-heatmap
- Full coin list /api/coins/all
- Coin search /api/coins/search
- Coin-page exchange table /api/currency/ex-table
- Coin money flow /api/currency/flows
- Coin list for navigation /api/currency/list
- Per-exchange markets for one coin /api/currency/markets
- Coin detail overview /api/currency/overview
- Coin price performance across periods /api/currency/performance
- Spot taker net inflow for one coin /api/currency/spot-netflow
- Margin borrow-rate matrix /api/margin-fee/matrix
- Margin borrow rates /api/margin/rates
- Gainers & losers (with volume floor) /api/market/gainers-losers
- Quick movers snapshot for top market-cap coins /api/market/top-movers
- Monthly / quarterly / yearly return matrix /api/p3/btc-returns
- Daily return matrix /api/p3/btc-returns-daily
- Weekly return matrix /api/p3/btc-returns-weekly
- Gainers & losers (futures or spot) /api/p3/gainers-losers
- Hourly candles /api/p3/klines
- Volatility overview /api/p3/volatility
- Volatility history for one coin /api/p3/volatility/series
- Spot coin market list /api/spot/coins
- Coin volume page data /api/volume/coin