Документ OpenAPI
Описание публичного API в формате OpenAPI 3.0, сформированное из каталога и таблиц полей, выведенных из реальных ответов.
/api/meta/openapiЗапрос
У этого эндпоинта нет параметров.
Пример запроса
curl -s "https://www.coinboss.com/api/meta/openapi"Поля ответа
Таблица полей формируется из реальных ответов, поэтому в ней перечислено ровно то, что возвращает эндпоинт. В путях a[] обозначает элементы массива, а {*} — объекты с динамическим ключом, например монетой или биржей.
| Поле | Тип | Единица | Описание |
|---|---|---|---|
| openapi | string | — | Версия спецификации OpenAPI этого документа. |
| info | object | — | Название, версия и описание API. |
| info.title | string | — | Название API. |
| info.version | string | — | Версия API. |
| info.description | string | — | Краткое описание API и его соглашений. |
| servers | array | — | Базовые URL API. |
| servers[] | object | — | Одна запись сервера. |
| servers[].url | string | — | Базовый URL, который добавляется перед каждым путём. |
| tags | array | — | Категории эндпоинтов. |
| tags[] | object | — | Одна категория. |
| tags[].name | string | — | Название. |
| tags[].description | string | — | Описание категории. |
| paths | object | — | Эндпоинты; ключи словаря — пути. динамические ключи: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list |
| paths.{*} | object | — | Операции, доступные по одному пути. |
| paths.{*}.get | object | — | Операция GET. |
| paths.{*}.get.operationId | string | — | Идентификатор эндпоинта, тот же, что и в каталоге. |
| paths.{*}.get.summary | string | — | Блок сводки. |
| paths.{*}.get.description | string | — | Что возвращает эндпоинт, с пояснениями о покрытии и ограничениях. |
| paths.{*}.get.tags | array | — | Категории эндпоинта. |
| paths.{*}.get.tags[] | string | — | Идентификатор категории. |
| paths.{*}.get.x-declared-status | string | — | Заявленная доступность: `available`, `partial` или `unavailable`. |
| paths.{*}.get.x-cache-ttl-seconds | number | s | Время жизни серверного кеша эндпоинта. может отсутствовать |
| paths.{*}.get.parameters | array | — | Параметры запроса. пусто в образцах, по которым построена таблица |
| paths.{*}.get.parameters[] | object | — | Один параметр. |
| paths.{*}.get.parameters[].name | string | — | Название. |
| paths.{*}.get.parameters[].in | string | — | Куда помещается параметр: `query` или `path`. |
| paths.{*}.get.parameters[].required | boolean | — | `true`, если параметр необходимо передавать. |
| paths.{*}.get.parameters[].description | string | — | Смысл параметра. |
| paths.{*}.get.parameters[].schema | object | — | JSON Schema значения параметра (type, default, enum, minimum, maximum). |
| paths.{*}.get.parameters[].example | string | — | Пример значения. может отсутствовать |
| paths.{*}.get.responses | object | — | Ответы, сгруппированные по HTTP-статусу; ответ 200 содержит JSON Schema, сформированную из реальных ответов. |
| components | object | — | Общие схемы, включая тело ошибки, используемое всеми эндпоинтами. |
Сформировано 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"
- "tags"
- "paths"
- "/api/coin-heatmap"
- "/api/coins/all"
- "components"
- "schemas"
- "securitySchemes"
Сведения
- Аутентификация
- Не требуется. Публичный эндпоинт.
- Лимит запросов
- 1200 запросов в минуту на один IP
- Серверный кеш
- 5m
- Пограничный микрокеш
- 10s
- Метки времени
- Миллисекунды эпохи Unix (UTC), если в описании поля не указано иное
- Формат ответа
- json
- Стабильность
- Стабильный
- Доступен с
- 2026-11-11
Текущий статус
Доступность за последние 30 дней
Пройдено 100% из 408 проверок
Ошибки
Неудачные вызовы имеют одинаковую структуру на всех эндпоинтах. Полный список приведён на странице ошибок. Ошибки и лимиты запросов →
| Код | HTTP | Значение | Что делать |
|---|---|---|---|
| INVALID_PARAM | 400 | Отсутствует обязательный параметр, или значение не принимается. `param` называет параметр, если он известен. | Не повторяйте запрос без изменений; исправьте его. |
| UNAUTHORIZED | 401 | Заголовок `CB-API-KEY` был отправлен, но ключ неизвестен или отозван. Для публичных данных ключ не нужен — уберите заголовок или используйте действительный ключ. | Не повторяйте запрос без изменений. |
| FORBIDDEN | 403 | Маршрут не входит в публичный API (внутренний или только для аккаунта). | Не повторяйте запрос. |
| NOT_FOUND | 404 | Неизвестный маршрут, либо запрошенная монета / биржа / фонд не существует. | Не повторяйте запрос; сверьте путь и идентификаторы с каталогом. |
| RATE_LIMITED | 429 | Запросов больше, чем позволяет поминутный лимит. `Retry-After` указывает, сколько секунд нужно подождать. | Дождитесь истечения `Retry-After`, затем повторите запрос с нарастающей задержкой. |
| INTERNAL | 500 | Непредвиденная ошибка сервера. Сообщение намеренно общее; при обращении указывайте `request_id`. | Повторите запрос один раз через несколько секунд; если ошибка сохраняется, сообщите о ней, указав ID запроса. |
| UPSTREAM_FAILED | 503 | Источник данных, стоящий за этим эндпоинтом, не ответил вовремя. Устаревшие или подменные значения вместо него не возвращаются. | Повторите запрос с нарастающей задержкой; проверьте страницу статуса. |
| UNAVAILABLE | 501 / 503 | Набор данных временно не готов (прогрев кеша), либо у эндпоинта пока нет законного публичного источника. | Повторите запрос позже; каталог помечает эндпоинты, недоступные по проектному решению. |
| REQUEST_FAILED | 200 | Некоторые более старые эндпоинты отвечают HTTP 200 с `success: false`. Всегда проверяйте `success`, а не только статус HTTP. | Зависит от сообщения; считайте запрос неудачным. |
Попробовать
/api/meta/openapiДоступенПараметров нет.
https://www.coinboss.com/api/meta/openapiДругие эндпоинты этой категории
- Матрица качества данных (представление коллекторов) /api/sd/quality
- Каталог API /api/meta/catalog
- Журнал изменений и политика версионирования /api/meta/changelog
- Документация эндпоинта /api/meta/endpoint
- Документ OpenAPI /api/meta/openapi
- Матрица качества данных /api/meta/quality
- Статус сервиса /api/meta/status
- Проверка, известен ли платформе символ монеты /api/coin-exists
- Соответствие символа монеты пути к локально размещённой иконке /api/coin-icons
- Агрегированная сводка для страницы монеты /api/content/coin
- Сводка по разделам сайта /api/content/summary
- Таблица курсов фиатных валют /api/currency/fx
- Соответствие идентификатора биржи пути к локально размещённой иконке /api/exchange-icons
- Проверка работоспособности /api/health
- Статистика для страниц исследований /api/research/stats