Объём 24ч—Открытый интерес—Ликвидации 24ч$1.36BЛонг/Шорт 24ч—Доминация BTC—Доминация ETH—
Приложение
Язык ▾
₽ RUB ▾
/api/meta/endpoint
GETДоступенFRESH

Документация эндпоинта

Полная документация одного эндпоинта: параметры, таблица полей, сформированная из реальных ответов, сохранённый пример ответа, проверенные образцы, история автопроверок за 30 дней, ошибки и лимиты.

GET/api/meta/endpoint

Запрос

Параметры запроса

ИмяТипОбязательныйПо умолчаниюДопустимые значенияОписание
idstringОбязательный——Идентификатор эндпоинта из каталога (например, `sd-oi`). Для неизвестных идентификаторов возвращается 404. Пример: sd-oi

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

curl -s "https://www.coinboss.com/api/meta/endpoint?id=sd-oi"

Поля ответа

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

ПолеТипЕдиницаОписание
successboolean—true, если запрос выполнен успешно. При ошибке тело ответа имеет вид `{ success: false, code, error, request_id }`.
schemastring—Идентификатор схемы этого ответа (`coinboss.meta.endpoint/1`).
nownumbermsВремя сервера в момент формирования ответа.
endpointobject—Запись эндпоинта в каталоге. Ключи словаря — имена атрибутов, например `id`, `path`, `status`, `params`, `category`, `sources`, `units`, `formula`. динамические ключи: id,cat,kind,method,path,title
endpoint.{*}array|number|object|string|null—Значение одного атрибута: текст, число, список (`params`, `required`, `ts_fields`) или объект (`probe`, `category`, `example_query`); null, если не задано.
endpoint.{*}[]object|string—Элемент атрибута-списка: определение параметра в `params` либо имя в `required` / `ts_fields`. может отсутствовать
endpoint.{*}[].namestring—Название. может отсутствовать
endpoint.{*}[].instring—Где передаётся параметр: `query` или `path`. может отсутствовать
endpoint.{*}[].typestring—Тип. может отсутствовать
endpoint.{*}[].requiredboolean—true, если параметр необходимо передавать. может отсутствовать
endpoint.{*}[].defaultnull—Значение, используемое, когда параметр опущен; null, если значения по умолчанию нет. может отсутствовать
endpoint.{*}[].enumnull—Список допустимых значений; null, если параметр не ограничен списком. может отсутствовать
endpoint.{*}[].minnull—Минимум. может отсутствовать
endpoint.{*}[].maxnull—Максимум. может отсутствовать
endpoint.{*}[].examplestring—Пример значения параметра; null, если пример не приведён. может отсутствовать
endpoint.{*}[].descstring—Описание параметра. может отсутствовать
endpoint.{*}.checked_atnumbermsМетка времени. может отсутствовать
endpoint.{*}.httpnumber—HTTP-статус последнего проверочного запроса. может отсутствовать
endpoint.{*}.okboolean—`true`, если последний проверочный запрос вернул HTTP 200 с корректным телом JSON. может отсутствовать
endpoint.{*}.schema_okboolean—`true`, если проверенный ответ соответствует документированной таблице полей; `null`, если таблицы полей нет. может отсутствовать
endpoint.{*}.latency_msnumbermsВремя ответа на последний проверочный запрос. может отсутствовать
endpoint.{*}.bytesnumberbytesРазмер тела проверенного ответа. может отсутствовать
endpoint.{*}.qualitynull—`meta.quality`, указанное в проверенном ответе (FRESH / PARTIAL / STALE …); `null`, если эндпоинт его не сообщает. может отсутствовать
endpoint.{*}.data_age_snumber|nullsЧисло секунд с события. может отсутствовать
endpoint.{*}.last_ok_atnumbermsМетка времени. может отсутствовать
endpoint.{*}.fail_streaknumbercountЧисло неудачных проверок подряд; 0, если последняя проверка прошла успешно. может отсутствовать
endpoint.{*}.idstring—Идентификатор. может отсутствовать
endpoint.{*}.titlestring—Отображаемое название категории эндпоинта (внутри `category`). может отсутствовать
endpoint.{*}.coinstring—Символ монеты в верхнем регистре (например, BTC). может отсутствовать
fieldsarray—Таблица полей ответа, выведенная из реальных ответов; null, если таблица не сформирована.
fields[]object—Одно поле ответа: `path`, `type`, `unit`, `desc` и флаги.
fields[].pathstring—Путь поля в ответе: `a.b` для вложенности, `[]` для элементов массива, `{*}` для значений словаря.
fields[].typestring—Тип.
fields[].unitstring|null—Единица значений в этом объекте.
fields[].descstring—Описание поля; null, если оно не написано.
fields[].optionalboolean—Присутствует и равно true, если поле отсутствовало хотя бы в одном из отобранных ответов. может отсутствовать
fields[].mapboolean—Присутствует и равно true, если объект является словарём с ключами, зависящими от данных (монеты, биржи, даты), а не набором фиксированных полей. может отсутствовать
fields[].keysarray—Выборка ключей, встреченных в словаре; только у полей, где `map` равно true. может отсутствовать
fields[].keys[]string—Один ключ из выборки. может отсутствовать
fields_generated_atnumbermsМетка времени.
fields_generated_fromarray—URL запросов, из реальных ответов на которые выведена таблица полей; null, если таблицы нет.
fields_generated_from[]string—Один путь запроса из выборки со строкой запроса.
exampleobject—Последний успешный реальный ответ, сохранённый проверкой: `request`, `captured_at`, `truncated` (исходные длины сокращённых массивов) и `body`; null, если такого нет.
example.requeststring—Запрос, на который получен сохранённый пример (путь и строка запроса).
example.captured_atnumbermsМетка времени.
example.truncatedobject—Что было сокращено в сохранённом примере: для каждого массива или словаря — число опущенных элементов. Его ключи зависят от документируемого эндпоинта.
example.bodyobject—Сохранённый ответ документируемого эндпоинта в сокращённом виде. Его структура описана в `fields`.
verified_samplesobject|null—Результаты дополнительных пробных запросов проверки (`at`, `samples` с параметрами запроса, HTTP-статусом, задержкой, проверкой схемы); null, если они не выполнялись.
verified_samples.atnumbermsВремя последней проверки дополнительных пробных запросов.
verified_samples.samplesarray—Число образцов.
verified_samples.samples[]object—Число образцов.
verified_samples.samples[].queryobject—Параметры строки запроса пробного запроса.
verified_samples.samples[].query.coinstring—Символ монеты в верхнем регистре (например, BTC). может отсутствовать
verified_samples.samples[].httpnumber—Возвращённый HTTP-статус.
verified_samples.samples[].okboolean—`true`, если пробный запрос вернул ожидаемое (HTTP 200 с корректным JSON либо ожидаемый статус ошибки).
verified_samples.samples[].latency_msnumbermsВремя ответа на пробный запрос.
verified_samples.samples[].schema_okboolean|null—`true`, если ответ на пробный запрос соответствует документированной таблице полей; `null`, если проверка не выполнялась.
verified_samples.samples[].qualitynull—`meta.quality`, указанное в ответе на пробный запрос; `null`, если не указано.
verified_samples.samples[].notestring|null—Примечание.
probe_detailnull—Расхождения схемы, найденные последней проверкой: пути полей `missing`, `mismatched` и `undocumented`; null, если расхождений нет.
uptime_30dobject—Проверки этого эндпоинта за последние 30 дней: итоги, процент успешных и разбивка по дням.
uptime_30d.checksnumbercountЧисло проверок эндпоинта за последние 30 дней (меньше дней, если отслеживание началось позже).
uptime_30d.oknumbercountЧисло успешных проверок среди них.
uptime_30d.pctnumber%Значение в процентах.
uptime_30d.daysarray—Дневные значения или число дней.
uptime_30d.days[]object—Дневные значения или число дней.
uptime_30d.days[].daystring—Календарный день (UTC).
uptime_30d.days[].checksnumbercountЧисло проверочных запросов за этот день.
uptime_30d.days[].oknumbercountЧисло успешных проверочных запросов за этот день.
uptime_30d.days[].pctnumber%Значение в процентах.
uptime_30d.days[].avg_msnumbermsСреднее время ответа за этот день; `null`, если проверок не было.
uptime_30d.days[].max_msnumbermsСамый медленный ответ за этот день.
errorsarray—Коды ошибок, которые может вернуть API, каждый с HTTP-статусом, значением и рекомендацией по повтору.
errors[]object—Один код ошибки.
errors[].codestring—Код.
errors[].httpnumber|string—HTTP-статус, отправляемый с этим кодом; строка вида `501 / 503`, если применимо несколько статусов.
errors[].meaningstring—Что означает ошибка.
errors[].retrystring—Рекомендация, стоит ли повторять запрос и как это делать.
errors[].legacyboolean—Присутствует и равно true только для кода, используемого старыми эндпоинтами, которые отвечают HTTP 200 с `success: false`. может отсутствовать
rate_limitobject—Правила ограничения частоты запросов публичного API.
rate_limit.window_snumbersДлина окна подсчёта (60).
rate_limit.anonymous_per_minnumbercountЧисло запросов в минуту, разрешённое на один IP клиента, если API-ключ не передан.
rate_limit.scopestring—Текст, поясняющий, как считаются запросы: по IP клиента для анонимных запросов, по ключу — если передан заголовок `CB-API-KEY`.
rate_limit.key_tiers_per_minobject—Число запросов в минуту, разрешённое для каждого уровня API-ключа; ключи словаря — названия уровней.
rate_limit.key_tiers_per_min.hobbyistnumbercountЧисло запросов в минуту для ключей уровня `hobbyist`.
rate_limit.key_tiers_per_min.startupnumbercountЧисло запросов в минуту для ключей уровня `startup`.
rate_limit.key_tiers_per_min.standardnumbercountЧисло запросов в минуту для ключей уровня `standard`.
rate_limit.key_tiers_per_min.professionalnumbercountЧисло запросов в минуту для ключей уровня `professional`.
rate_limit.exemptarray—Шаблоны путей, которые не учитываются в лимите.
rate_limit.exempt[]string—Один шаблон пути-исключения, например `/api/coin-icon/*`.
rate_limit.headersarray—Имена заголовков ответа, сообщающих состояние лимита запросов.
rate_limit.headers[]string—Имя одного заголовка, например `X-RateLimit-Remaining`.
rate_limit.on_exceedobject—Что возвращается при превышении лимита: статус `http` и код ошибки `code`.
rate_limit.on_exceed.httpnumber—HTTP-статус, возвращаемый при превышении лимита (429).
rate_limit.on_exceed.codestring—Код.
relatedarray—Все эндпоинты той же категории, включая этот.
related[]object—Один эндпоинт: `id`, `path` и `title`.
related[].idstring—Идентификатор.
related[].pathstring—Путь запроса эндпоинта.
related[].titlestring—Краткое отображаемое название эндпоинта.
probeobject—Состояние проверки эндпоинтов, на которой основаны текущие статусы: время последнего запуска, его возраст, интервал и признак актуальности.
probe.last_run_atnumbermsМетка времени.
probe.age_snumbersЧисло секунд с последнего обновления этой строки.
probe.interval_snumbersПлановый интервал между двумя запусками проверки (300).
probe.freshboolean—true, если с последнего запуска проверки прошло менее 20 минут; при false статусы эндпоинтов отдаются как `unknown`.
probe.errornull—Сообщение об ошибке (присутствует только при сбое).
metaobject—Обёртка этого ответа: идентификатор схемы, система-источник, метки времени, время жизни кеша и актуальность.
meta.schemastring—Идентификатор схемы этого ответа; то же значение, что и `schema` верхнего уровня.
meta.sourcearray—Откуда взято значение.
meta.source[]object—Откуда взято значение.
meta.source[].systemstring—Система, сформировавшая данные; для эндпоинтов центра разработчика всегда `coinboss`.
meta.source[].componentstring—Компонент, стоящий за данными: проверка эндпоинтов и патруль качества данных.
meta.observed_atnull—Метка времени.
meta.received_atnumbermsМетка времени.
meta.fetched_atnumbermsВремя, когда CoinBoss получил данные от источника.
meta.windowstring—Окно.
meta.cache_ttl_snumbersВремя жизни серверного кеша этого ответа.
meta.qualitystring—`FRESH`, если этот эндпоинт проверялся в последние 20 минут, иначе `STALE`.
meta.is_staleboolean—true, если строка старше окна актуальности; устаревшие строки в итогах не используются.
meta.fallbackstring—Текстовое пояснение того, что возвращает этот эндпоинт, когда его входные данные устарели или отсутствуют.

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

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

/api/meta/endpoint?id=sd-oi · Реальный ответ, получен 2026-11-13 03:59:28 UTC. Длинные массивы и словари сокращены для отображения: errors: элементов было 9; fields: элементов было 103; related: элементов было 6; endpoint: элементов было 35; uptime_30d.days: элементов было 3; verified_samples.samples: элементов было 4.

  • {
    • "success": true,
    • "schema": "coinboss.meta.endpoint/1",
    • "now": 1794542368241,
    • "endpoint": {
      • "id": "sd-oi",
      • "cat": "open-interest"
      },
    • "fields": [
      • { … 4 },
      • { … 4 }
      ],
    • "fields_generated_at": 1794438008862,
    • "fields_generated_from": [
      • "/api/sd/oi?coin=BTC",
      • "/api/sd/oi?coin=ETH",
      • "/api/sd/oi?coin=SOL",
      • "/api/sd/oi?coin=ARKM"
      ],
    • "example": {
      • "request": "/api/sd/oi?coin=BTC",
      • "captured_at": 1794542259642,
      • "truncated": { … 4 },
      • "body": { … 17 }
      },
    • "verified_samples": {
      • "at": 1794542259642,
      • "samples": [ … 2 ]
      },
    • "probe_detail": {
      • "missing": [],
      • "mismatched": [],
      • "undocumented": [ … 6 ]
      },
    • "uptime_30d": {
      • "checks": 411,
      • "ok": 411,
      • "pct": 100,
      • "days": [ … 2 ]
      },
    • "errors": [
      • { … 4 },
      • { … 4 }
      ],
    • "rate_limit": {
      • "window_s": 60,
      • "anonymous_per_min": 1200,
      • "scope": "per client IP for anonymous requests; per key when a CB-API-KEY header is sent",
      • "key_tiers_per_min": { … 4 },
      • "exempt": [ … 1 ],
      • "headers": [ … 4 ],
      • "on_exceed": { … 2 }
      },
    • "related": [
      • { … 3 },
      • { … 3 }
      ],
    • "probe": {
      • "last_run_at": 1794542029183,
      • "age_s": 339,
      • "interval_s": 300,
      • "fresh": true,
      • "error": null
      },
    • "meta": {
      • "schema": "coinboss.meta.endpoint/1",
      • "source": [ … 1 ],
      • "observed_at": null,
      • "received_at": 1794542259642,
      • "fetched_at": 1794542368241,
      • "window": "latest",
      • "cache_ttl_s": 30,
      • "quality": "FRESH",
      • "is_stale": false,
      • "fallback": "field table comes from the last schema generation; example is the last successful real response"
      }
    }

Проверенные образцы

Помимо примера выше, автопроверка вызывает этот эндпоинт с указанными параметрами и каждый раз сверяет схему.

ПараметрыHTTPЗадержкаРезультат
id=sd-funding2003 msПройдено FRESH
id=liquidations-overview2002 msПройдено FRESH
—4001 msПройдено возвращает ожидаемую ошибку

Проверено: 2026-11-13 03:59:28 UTC

Сведения

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

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

ДоступенПроверено: 2026-11-13 03:59:28 UTCHTTP 2002 msСхема совпадаетВозраст самой новой точки данных: 2m

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

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

Расхождение схемы, обнаруженное последней автопроверкой
  • Возвращается, но не документировано: probe_detail.missing, probe_detail.mismatched, probe_detail.undocumented, probe_detail.undocumented[]

Ошибки

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

Код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/endpointДоступен
Параметры

string — Endpoint id from the catalog (for example `sd-oi`). Unknown ids return 404.

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