24h Volume—Open Interest—24h Liquidations$1.36B24h Long/Short—BTC Dominance—ETH Dominance—
App
Language ▾
$ USD ▾
/api/p3/btc-returns-weekly
GETAvailable

Weekly return matrix

Weekly return matrix (BTC / ETH)

GET/api/p3/btc-returns-weekly

Request

Query parameters

NameTypeRequiredDefaultAllowed valuesDescription
coinstringOptionalBTCBTC, ETHCoin; BTC or ETH only, others treated as BTC. Example: BTC

Example request

curl -s "https://www.coinboss.com/api/p3/btc-returns-weekly?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.

FieldTypeUnitDescription
successboolean—true when the request succeeded. On failure the body is `{ success: false, code, error, request_id }`.
nownumbermsServer time when the response was built.
coinstring—Coin symbol, upper case (for example BTC).
weeklyPctobject—Weekly returns grouped by ISO year; keys are ISO years. dynamic keys: 2013,2014,2015,2016,2017,2018
weeklyPct.{*}object—Returns of one ISO year; keys are ISO week numbers (`1`–`53`). dynamic keys: 1,2,3,4,5,6
weeklyPct.{*}.{*}number%Return of the ISO week (Monday–Sunday): last daily reference price ÷ first daily reference price of the week − 1; the current week is partial.
recentWeeklyarray—The 12 most recent completed ISO weeks, oldest first; the week in progress is excluded.
recentWeekly[]object—One week: `week` is the ISO week label (`2026-W45`), `pct` its return in percent.
recentWeekly[].weekstring—ISO week.
recentWeekly[].pctnumber%Percentage.

Generated 2026-11-11 23:00 UTC from 1 real responses.

Example response

/api/p3/btc-returns-weekly?coin=BTC · Real response captured 2026-11-13 04:02:30 UTC. Long arrays and maps are shortened for display: weeklyPct had 14 items; recentWeekly had 12 items; weeklyPct.{*} had 52 items.

  • {
    • "success": true,
    • "now": 1794542253574,
    • "coin": "BTC",
    • "weeklyPct": {
      • "2013": { … 2 },
      • "2014": { … 2 }
      },
    • "recentWeekly": [
      • { … 2 },
      • { … 2 }
      ]
    }

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
30m
Edge micro-cache
10s
Update frequency
daily (00:27 server time)
Window
full history by ISO year, plus the previous 12 completed weeks
Data sources
Weekly returns computed in-house from a public daily reference-rate dataset.
Exchange coverage
BTC (from 2013) and ETH (from 2016).
Sorting
ISO year / week ascending
Units
percent
Method
Weekly return = (last daily price - first daily price of the ISO week) / first x 100.
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable

Live status

AvailableChecked 2026-11-13 04:02:30 UTCHTTP 2001 msSchema matches

Availability, last 30 days

100% of 412 checks passed

Errors

Failed calls share one shape on every endpoint. The full list is on the errors page. Errors and rate limits →

CodeHTTPMeaningWhat to do
INVALID_PARAM400A 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.
UNAUTHORIZED401The `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.
FORBIDDEN403The route is not part of the public API (internal or account-only).Do not retry.
NOT_FOUND404Unknown route, or the requested coin / exchange / fund does not exist.Do not retry; check the path and identifiers against the catalog.
RATE_LIMITED429More requests than the per-minute limit. `Retry-After` gives the seconds to wait.Wait for `Retry-After`, then retry with backoff.
INTERNAL500Unexpected 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_FAILED503The 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.
UNAVAILABLE501 / 503The 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_FAILED200Some 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

GET/api/p3/btc-returns-weeklyAvailable
Parameters

string · default BTC — Coin; BTC or ETH only, others treated as BTC.

Request URLhttps://www.coinboss.com/api/p3/btc-returns-weekly?coin=BTC
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.