24h出来高—建玉—24h清算$1.36B24hロング/ショート—BTCドミナンス—ETHドミナンス—
アプリ
言語 ▾
¥ JPY ▾
/api/meta/catalog
GET利用可能FRESH

APIカタログ

すべての公開エンドポイントについて、カテゴリ、宣言上のステータスとライブステータス、キャッシュTTL、直近のプローブ結果を返します。レート制限とエラーコード表も含まれます。

GET/api/meta/catalog

リクエスト

このエンドポイントにパラメータはありません。

リクエスト例

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

レスポンスフィールド

フィールド表は実際のレスポンスから生成しているため、エンドポイントが返す内容をそのまま反映しています。パスでは、配列の要素をa[]、銘柄や取引所などの動的な名前をキーとするオブジェクトを{*}で表します。

フィールド型単位説明
successboolean—リクエストが成功した場合はtrue。失敗した場合、ボディは`{ success: false, code, error, request_id }`になります。
schemastring—このレスポンスのスキーマID（`coinboss.meta.catalog/1`）。
nownumbermsレスポンスを生成した時点のサーバー時刻。
api_versionstring—公開APIのバージョン（`v1`）。
catalog_versionstring—エンドポイントカタログのバージョン。`2026.11.11`のようなリリース日です。
base_pathstring—すべてのエンドポイントに共通するパスのプレフィックス（`/api`）。
summaryobject—概要ブロック。
summary.totalnumber—合計。
summary.availablenumber—データが利用可能かどうか。
summary.partialnumber—想定されるデータの一部しか存在しない場合はtrue。
summary.degradednumbercountライブステータスが`degraded`のエンドポイント数。
summary.downnumbercountライブステータスが`down`のエンドポイント数。
summary.unavailablenumber—データが利用できない項目とその理由。0として報告されることはありません。
summary.unknownnumbercountライブステータスが`unknown`（最近のプローブ結果なし）のエンドポイント数。
probeobject—ライブステータスの基となるエンドポイントプローブの状態：最終実行時刻、その経過時間、間隔、鮮度内かどうか。
probe.last_run_atnumbermsタイムスタンプ。
probe.age_snumbersこの行が最後に更新されてからの経過秒数。
probe.interval_snumbersプローブ実行の予定間隔（300）。
probe.freshboolean—最後のプローブ実行が20分未満前の場合はtrue。falseの場合、エンドポイントのステータスは`unknown`として報告されます。
probe.errornull—エラーメッセージ（失敗時のみ存在）。
categoriesarray—エンドポイントを1つ以上含むエンドポイントカテゴリ。ステータス別のエンドポイント数を含みます。
categories[]object—1カテゴリ分：`id`、`title`、`desc`、各ステータスのエンドポイント数。
categories[].idstring—識別子。
categories[].titlestring—カテゴリの表示タイトル。
categories[].descstring—カテゴリの1文の説明。記述がない場合はnull。
categories[].totalnumber—合計。
categories[].availablenumber—データが利用可能かどうか。
categories[].partialnumber—想定されるデータの一部しか存在しない場合はtrue。
categories[].degradednumbercountそのカテゴリのうち、ライブステータスが`degraded`のエンドポイント数。
categories[].downnumbercountそのカテゴリのうち、ライブステータスが`down`のエンドポイント数。
categories[].unavailablenumber—データが利用できない項目とその理由。0として報告されることはありません。
categories[].unknownnumbercountそのカテゴリのうち、ライブステータスが`unknown`のエンドポイント数。
endpointsarray—ドキュメント化されたすべてのエンドポイントと、そのライブステータス。
endpoints[]object—1エンドポイント分：識別情報、パス、宣言上のステータスとライブステータス、キャッシュの有効期間、パラメータ名、直近のプローブ結果。
endpoints[].idstring—識別子。
endpoints[].catstring—エンドポイントが属するカテゴリのID。
endpoints[].kindstring—種類。
endpoints[].methodstring—計算式/算出方法の注記。
endpoints[].pathstring—エンドポイントのリクエストパス。`:name`のセグメントはパスパラメータです。
endpoints[].titlestring—エンドポイントの短い表示タイトル。
endpoints[].summarystring—概要ブロック。
endpoints[].declaredstring—プローブとは無関係にカタログで宣言されたステータス：`available`、`partial`、`unavailable`のいずれか。
endpoints[].statusstring—ステータス。
endpoints[].status_reasonstring|null—`status`が`available`でない理由（平文）。該当しない場合はnull。
endpoints[].stabilitystring—`stable`、`beta`（90日前の予告なしにフィールド構成が変更されることがあります）、`legacy`（引き続き動作しますが、代替があります）のいずれか。
endpoints[].sincestring|null—期間の開始時刻。
endpoints[].ttl_snumber|nullsエンドポイントのレスポンスのサーバー側キャッシュの有効期間。キャッシュされない場合、または該当しない場合はnull。
endpoints[].paramsarray—エンドポイントが受け付けるすべてのパラメータの名前。 この表の生成に使用したサンプルでは空
endpoints[].params[]string—パラメータ名1件。
endpoints[].requiredarray—送信が必須のパラメータの名前。 この表の生成に使用したサンプルでは空
endpoints[].probeobject—エンドポイントの直近のプローブ結果：チェック時刻、HTTPステータス、`ok`、`schema_ok`、レイテンシ、サイズ、データの経過時間、最後の成功、連続失敗回数。一度もプローブされていない場合はnull。
endpoints[].probe.checked_atnumbermsタイムスタンプ。
endpoints[].probe.httpnumber—直近のプローブリクエストのHTTPステータス。
endpoints[].probe.okboolean—直近のプローブリクエストが、有効なJSONボディとともにHTTP 200を返した場合は`true`。
endpoints[].probe.schema_okboolean—プローブしたレスポンスがドキュメントのフィールド表と一致した場合は`true`。フィールド表が存在しない場合は`null`。
endpoints[].probe.latency_msnumberms直近のプローブリクエストの応答時間。
endpoints[].probe.bytesnumberbytesプローブしたレスポンスボディのサイズ。
endpoints[].probe.qualitynull—プローブしたレスポンスが報告する`meta.quality`（FRESH / PARTIAL / STALE …）。エンドポイントが報告しない場合は`null`。
endpoints[].probe.data_age_snumber|nullsイベントからの経過秒数。
endpoints[].probe.last_ok_atnumbermsタイムスタンプ。
endpoints[].probe.fail_streaknumbercountプローブの連続失敗回数。直近のプローブが成功した場合は0。
endpoints[].required[]string—必須パラメータ名1件。
rate_limitobject—公開APIのレート制限ルール。
rate_limit.window_snumbersカウントウィンドウの長さ（60）。
rate_limit.anonymous_per_minnumbercountAPIキーを送信しない場合に、クライアントIPごとに許可される1分あたりのリクエスト数。
rate_limit.scopestring—リクエストのカウント方法を述べたテキスト：匿名の場合はクライアントIP単位、`CB-API-KEY`ヘッダーを送信した場合はキー単位。
rate_limit.key_tiers_per_minobject—APIキーの各ティアに許可される1分あたりのリクエスト数。キーはティア名です。
rate_limit.key_tiers_per_min.hobbyistnumbercount`hobbyist`ティアのキーの1分あたりのリクエスト数。
rate_limit.key_tiers_per_min.startupnumbercount`startup`ティアのキーの1分あたりのリクエスト数。
rate_limit.key_tiers_per_min.standardnumbercount`standard`ティアのキーの1分あたりのリクエスト数。
rate_limit.key_tiers_per_min.professionalnumbercount`professional`ティアのキーの1分あたりのリクエスト数。
rate_limit.exemptarray—制限のカウント対象外となるパスパターン。
rate_limit.exempt[]string—対象外のパスパターン1件。例：`/api/coin-icon/*`。
rate_limit.headersarray—レート制限の状態を報告するレスポンスヘッダーの名前。
rate_limit.headers[]string—ヘッダー名1件。例：`X-RateLimit-Remaining`。
rate_limit.on_exceedobject—制限を超えた場合に返される内容：`http`ステータスとエラー`code`。
rate_limit.on_exceed.httpnumber—制限を超えた場合に返されるHTTPステータス（429）。
rate_limit.on_exceed.codestring—コード。
errorsarray—APIが返す可能性のあるエラーコード。それぞれにHTTPステータス、意味、再試行に関する助言が付きます。
errors[]object—エラーコード1件。
errors[].codestring—コード。
errors[].httpnumber|string—このコードとともに送信されるHTTPステータス。複数が該当する場合は`501 / 503`のような文字列です。
errors[].meaningstring—エラーの意味。
errors[].retrystring—再試行すべきかどうか、およびその方法に関する助言。
errors[].legacyboolean—`success: false`付きでHTTP 200を返す旧エンドポイントが使用するコードにのみ含まれ、値はtrueです。 省略される場合あり
status_legendobject—各エンドポイントステータスの定義（平文）。
status_legend.availablestring—データが利用可能かどうか。
status_legend.partialstring—想定されるデータの一部しか存在しない場合はtrue。
status_legend.degradedstring—ステータス`degraded`の定義。
status_legend.downstring—ステータス`down`の定義。
status_legend.unavailablestring—データが利用できない項目とその理由。0として報告されることはありません。
status_legend.unknownstring—ステータス`unknown`の定義。
metaobject—このレスポンスのエンベロープ：スキーマID、生成元のシステム、タイムスタンプ、キャッシュの有効期間、鮮度。
meta.schemastring—このレスポンスのスキーマID。トップレベルの`schema`と同じ値です。
meta.sourcearray—値の取得元。
meta.source[]object—値の取得元。
meta.source[].systemstring—データを生成したシステム。開発者センターのエンドポイントでは常に`coinboss`です。
meta.source[].componentstring—データの基となるコンポーネント：エンドポイントプローブとデータ品質巡回。
meta.observed_atnull—タイムスタンプ。
meta.received_atnumbermsタイムスタンプ。
meta.fetched_atnumbermsCoinBossがソースからデータを取得した時刻。
meta.windowstring—ウィンドウ。
meta.cache_ttl_snumbersこのレスポンスのサーバー側キャッシュの有効期間。
meta.qualitystring—エンドポイントプローブが直近20分以内に報告した場合は`FRESH`、それ以外は`STALE`。
meta.is_staleboolean—行が鮮度ウィンドウより古い場合はtrue。鮮度切れの行は合計に使用されません。
meta.fallbackstring—入力が鮮度切れまたは欠落している場合に、このエンドポイントが何を返すかに関する注記（平文）。

2026-11-11 23:01 UTCに1件の実レスポンスから生成。

レスポンス例

/api/meta/catalog · 実際のレスポンス（2026-11-13 03:59:27 UTCに取得）。 長い配列とマップは表示用に短縮しています：errorsは9件; endpointsは299件; categoriesは21件。

  • {
    • "success": true,
    • "schema": "coinboss.meta.catalog/1",
    • "now": 1794542367982,
    • "api_version": "v1",
    • "catalog_version": "2026.11.12",
    • "base_path": "/api",
    • "summary": {
      • "total": 299,
      • "available": 256,
      • "partial": 19,
      • "degraded": 17,
      • "down": 6,
      • "unavailable": 1,
      • "unknown": 0
      },
    • "probe": {
      • "last_run_at": 1794542029183,
      • "age_s": 339,
      • "interval_s": 300,
      • "fresh": true,
      • "error": null
      },
    • "categories": [
      • { … 10 },
      • { … 10 }
      ],
    • "endpoints": [
      • { … 16 },
      • { … 16 }
      ],
    • "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 }
      },
    • "errors": [
      • { … 4 },
      • { … 4 }
      ],
    • "status_legend": {
      • "available": "last probe returned HTTP 200 and the response matched the documented schema",
      • "partial": "works, but exchange / field coverage is incomplete (see status_reason)",
      • "degraded": "responding, but schema drift or stale data was detected by the last probe",
      • "down": "last probe failed",
      • "unavailable": "documented for completeness; no lawful public source yet, the endpoint returns nulls or is not served",
      • "unknown": "no probe result within the last 20 minutes"
      },
    • "meta": {
      • "schema": "coinboss.meta.catalog/1",
      • "source": [ … 1 ],
      • "observed_at": null,
      • "received_at": 1794542029183,
      • "fetched_at": 1794542367982,
      • "window": "latest",
      • "cache_ttl_s": 30,
      • "quality": "FRESH",
      • "is_stale": false,
      • "fallback": "when the probe has not reported within 20 minutes every endpoint status becomes \"unknown\""
      }
    }

詳細

認証
不要。公開エンドポイントです。
レート制限
IPごとに毎分1200リクエスト
サーバーキャッシュ
30s
エッジマイクロキャッシュ
10s
更新頻度
カタログファイルと最新のプローブ結果から、リクエスト時に再構築します（プローブは5分ごとに実行）。
データソース
CoinBossのエンドポイントカタログ + sd_api_probe（APIプローブによる実呼び出しの結果）。
タイムスタンプ
フィールドの説明に別途記載がない限り、Unixエポックミリ秒（UTC）
レスポンス形式
json
安定性
安定版
提供開始
2026-11-11

ライブステータス

利用可能2026-11-13 03:59:27 UTCにチェックHTTP 20010 msスキーマ一致最新データポイントは6m前

可用性（過去30日間）

409回のチェック中100%が合格

エラー

失敗した呼び出しは、すべてのエンドポイントで共通の形式で返されます。一覧はエラーページにあります。 エラーとレート制限 →

コードHTTP意味対処方法
INVALID_PARAM400必須パラメータが不足しているか、値が受け付けられません。該当するパラメータが特定できる場合は、`param`にその名前が入ります。そのまま再試行せず、リクエストを修正してください。
UNAUTHORIZED401`CB-API-KEY`ヘッダーが送信されましたが、キーが不明か失効済みです。公開データにキーは不要です。ヘッダーを外すか、有効なキーを使用してください。そのまま再試行しないでください。
FORBIDDEN403このルートは公開APIに含まれません（内部用またはアカウント専用）。再試行しないでください。
NOT_FOUND404不明なルートであるか、リクエストされた銘柄 / 取引所 / ファンドが存在しません。再試行せず、パスと識別子をカタログと照合してください。
RATE_LIMITED429リクエスト数が1分あたりの上限を超えました。`Retry-After`に待機すべき秒数が示されます。`Retry-After`で示された時間だけ待ってから、バックオフ付きで再試行してください。
INTERNAL500予期しないサーバーエラーです。メッセージは意図的に汎用的な内容にしています。報告の際は`request_id`を引用してください。数秒後に1回だけ再試行してください。解消しない場合は、リクエストIDを添えて報告してください。
UPSTREAM_FAILED503このエンドポイントの背後にあるデータソースが時間内に応答しませんでした。鮮度切れの数値や代替の数値を代わりに返すことはありません。バックオフ付きで再試行し、ステータスページを確認してください。
UNAVAILABLE501 / 503データセットが一時的に準備できていない（キャッシュのウォームアップ中）か、このエンドポイントに適法な公開ソースがまだありません。時間をおいて再試行してください。仕様上利用できないエンドポイントは、カタログに明示されています。
REQUEST_FAILED200一部の古いエンドポイントは、HTTP 200で`success: false`を返します。HTTPステータスだけでなく、必ず`success`を確認してください。メッセージによって異なります。失敗したリクエストとして扱ってください。

試してみる

GET/api/meta/catalog利用可能
パラメータ

パラメータはありません。

リクエストURLhttps://www.coinboss.com/api/meta/catalog
エンドポイントを選択して「リクエストを送信」を押してください。レスポンス、ヘッダー、所要時間がここに表示されます。