/api/meta/openapi
GETДоступен

Документ OpenAPI

Описание публичного API в формате OpenAPI 3.0, сформированное из каталога и таблиц полей, выведенных из реальных ответов.

GET/api/meta/openapi

Запрос

У этого эндпоинта нет параметров.

Пример запроса

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

Поля ответа

Таблица полей формируется из реальных ответов, поэтому в ней перечислено ровно то, что возвращает эндпоинт. В путях a[] обозначает элементы массива, а {*} — объекты с динамическим ключом, например монетой или биржей.

ПолеТипЕдиницаОписание
openapistring—Версия спецификации OpenAPI этого документа.
infoobject—Название, версия и описание API.
info.titlestring—Название API.
info.versionstring—Версия API.
info.descriptionstring—Краткое описание API и его соглашений.
serversarray—Базовые URL API.
servers[]object—Одна запись сервера.
servers[].urlstring—Базовый URL, который добавляется перед каждым путём.
tagsarray—Категории эндпоинтов.
tags[]object—Одна категория.
tags[].namestring—Название.
tags[].descriptionstring—Описание категории.
pathsobject—Эндпоинты; ключи словаря — пути. динамические ключи: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list
paths.{*}object—Операции, доступные по одному пути.
paths.{*}.getobject—Операция GET.
paths.{*}.get.operationIdstring—Идентификатор эндпоинта, тот же, что и в каталоге.
paths.{*}.get.summarystring—Блок сводки.
paths.{*}.get.descriptionstring—Что возвращает эндпоинт, с пояснениями о покрытии и ограничениях.
paths.{*}.get.tagsarray—Категории эндпоинта.
paths.{*}.get.tags[]string—Идентификатор категории.
paths.{*}.get.x-declared-statusstring—Заявленная доступность: `available`, `partial` или `unavailable`.
paths.{*}.get.x-cache-ttl-secondsnumbersВремя жизни серверного кеша эндпоинта. может отсутствовать
paths.{*}.get.parametersarray—Параметры запроса. пусто в образцах, по которым построена таблица
paths.{*}.get.parameters[]object—Один параметр.
paths.{*}.get.parameters[].namestring—Название.
paths.{*}.get.parameters[].instring—Куда помещается параметр: `query` или `path`.
paths.{*}.get.parameters[].requiredboolean—`true`, если параметр необходимо передавать.
paths.{*}.get.parameters[].descriptionstring—Смысл параметра.
paths.{*}.get.parameters[].schemaobject—JSON Schema значения параметра (type, default, enum, minimum, maximum).
paths.{*}.get.parameters[].examplestring—Пример значения. может отсутствовать
paths.{*}.get.responsesobject—Ответы, сгруппированные по HTTP-статусу; ответ 200 содержит JSON Schema, сформированную из реальных ответов.
componentsobject—Общие схемы, включая тело ошибки, используемое всеми эндпоинтами.

Сформировано 2026-11-11 23:03 UTC; использовано реальных ответов: 1.

Пример ответа

/api/meta/openapi · Реальный ответ, получен 2026-11-13 03:59:28 UTC. Длинные массивы и словари сокращены для отображения: tags: элементов было 21; paths: элементов было 298; paths.{*}.get.responses: элементов было 5; paths.{*}.get.parameters: элементов было 3; components.schemas.Error.properties.code.enum: элементов было 9.

  • {
    • "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 }
      }
    }

Сведения

Аутентификация
Не требуется. Публичный эндпоинт.
Лимит запросов
1200 запросов в минуту на один IP
Серверный кеш
5m
Пограничный микрокеш
10s
Метки времени
Миллисекунды эпохи Unix (UTC), если в описании поля не указано иное
Формат ответа
json
Стабильность
Стабильный
Доступен с
2026-11-11

Текущий статус

ДоступенПроверено: 2026-11-13 03:59:28 UTCHTTP 20037 msСхема совпадает

Доступность за последние 30 дней

Пройдено 100% из 408 проверок

Ошибки

Неудачные вызовы имеют одинаковую структуру на всех эндпоинтах. Полный список приведён на странице ошибок. Ошибки и лимиты запросов →

КодHTTPЗначениеЧто делать
INVALID_PARAM400Отсутствует обязательный параметр, или значение не принимается. `param` называет параметр, если он известен.Не повторяйте запрос без изменений; исправьте его.
UNAUTHORIZED401Заголовок `CB-API-KEY` был отправлен, но ключ неизвестен или отозван. Для публичных данных ключ не нужен — уберите заголовок или используйте действительный ключ.Не повторяйте запрос без изменений.
FORBIDDEN403Маршрут не входит в публичный API (внутренний или только для аккаунта).Не повторяйте запрос.
NOT_FOUND404Неизвестный маршрут, либо запрошенная монета / биржа / фонд не существует.Не повторяйте запрос; сверьте путь и идентификаторы с каталогом.
RATE_LIMITED429Запросов больше, чем позволяет поминутный лимит. `Retry-After` указывает, сколько секунд нужно подождать.Дождитесь истечения `Retry-After`, затем повторите запрос с нарастающей задержкой.
INTERNAL500Непредвиденная ошибка сервера. Сообщение намеренно общее; при обращении указывайте `request_id`.Повторите запрос один раз через несколько секунд; если ошибка сохраняется, сообщите о ней, указав ID запроса.
UPSTREAM_FAILED503Источник данных, стоящий за этим эндпоинтом, не ответил вовремя. Устаревшие или подменные значения вместо него не возвращаются.Повторите запрос с нарастающей задержкой; проверьте страницу статуса.
UNAVAILABLE501 / 503Набор данных временно не готов (прогрев кеша), либо у эндпоинта пока нет законного публичного источника.Повторите запрос позже; каталог помечает эндпоинты, недоступные по проектному решению.
REQUEST_FAILED200Некоторые более старые эндпоинты отвечают HTTP 200 с `success: false`. Всегда проверяйте `success`, а не только статус HTTP.Зависит от сообщения; считайте запрос неудачным.

Попробовать

GET/api/meta/openapiДоступен
Параметры

Параметров нет.

URL запросаhttps://www.coinboss.com/api/meta/openapi
Выберите эндпоинт и нажмите «Отправить запрос». Здесь появятся ответ, заголовки и время выполнения.