24h Volume—Open Interest—24h Liquidations$1.36B24h Long/Short—BTC Dominance—ETH Dominance—
App
Language ▾
$ USD ▾
/api/meta/openapi
GETAvailable

OpenAPI document

OpenAPI 3.0 description of the public API, generated from the catalog and from field tables inferred from real responses.

GET/api/meta/openapi

Request

This endpoint takes no parameters.

Example request

curl -s "https://www.coinboss.com/api/meta/openapi"

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
openapistring—OpenAPI specification version of this document.
infoobject—Title, version and description of the API.
info.titlestring—API title.
info.versionstring—API version.
info.descriptionstring—Short description of the API and its conventions.
serversarray—Base URLs of the API.
servers[]object—One server entry.
servers[].urlstring—Base URL to prepend to every path.
tagsarray—Endpoint categories.
tags[]object—One category.
tags[].namestring—Name.
tags[].descriptionstring—Description of the category.
pathsobject—Endpoints, keyed by path. dynamic keys: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list
paths.{*}object—Operations available on one path.
paths.{*}.getobject—The GET operation.
paths.{*}.get.operationIdstring—Endpoint id, the same id as in the catalog.
paths.{*}.get.summarystring—Summary block.
paths.{*}.get.descriptionstring—What the endpoint returns, with notes on coverage and limits.
paths.{*}.get.tagsarray—Categories of the endpoint.
paths.{*}.get.tags[]string—Category id.
paths.{*}.get.x-declared-statusstring—Declared availability: `available`, `partial` or `unavailable`.
paths.{*}.get.x-cache-ttl-secondsnumbersServer-side cache lifetime of the endpoint. may be absent
paths.{*}.get.parametersarray—Request parameters. empty in the samples used to generate this table
paths.{*}.get.parameters[]object—One parameter.
paths.{*}.get.parameters[].namestring—Name.
paths.{*}.get.parameters[].instring—Where the parameter goes: `query` or `path`.
paths.{*}.get.parameters[].requiredboolean—`true` when the parameter must be sent.
paths.{*}.get.parameters[].descriptionstring—Meaning of the parameter.
paths.{*}.get.parameters[].schemaobject—JSON Schema of the parameter value (type, default, enum, minimum, maximum).
paths.{*}.get.parameters[].examplestring—Example value. may be absent
paths.{*}.get.responsesobject—Responses keyed by HTTP status; the 200 response carries the JSON Schema generated from real responses.
componentsobject—Shared schemas, including the error body used by every endpoint.

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

Example response

/api/meta/openapi · Real response captured 2026-11-13 03:53:45 UTC. Long arrays and maps are shortened for display: tags had 21 items; paths had 298 items; paths.{*}.get.responses had 5 items; paths.{*}.get.parameters had 3 items; components.schemas.Error.properties.code.enum had 9 items.

  • {
    • "openapi": "3.0.3",
    • "info": {
      • "title": "CoinBoss API",
      • "version": "v1 (2026.11.12)",
      • "description": "Public market-data API of CoinBoss. Generated from the endpoint catalog and from field tables inferred from real responses."
      },
    • "servers": [
      • { … 1 }
      ],
    • "tags": [
      • { … 2 },
      • { … 2 }
      ],
    • "paths": {
      • "/api/coin-heatmap": { … 1 },
      • "/api/coins/all": { … 1 }
      },
    • "components": {
      • "schemas": { … 1 },
      • "securitySchemes": { … 1 }
      }
    }

Details

Authentication
None. Public endpoint.
Rate limit
1200 requests per minute per IP
Server cache
5m
Edge micro-cache
10s
Timestamps
Unix epoch milliseconds (UTC) unless the field description says otherwise
Response format
json
Stability
Stable
Available since
2026-11-11

Live status

AvailableChecked 2026-11-13 03:53:45 UTCHTTP 20040 msSchema matches

Availability, last 30 days

100% of 407 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/meta/openapiAvailable
Parameters

No parameters.

Request URLhttps://www.coinboss.com/api/meta/openapi
Choose an endpoint and press “Send request”. The response, headers and timing will appear here.