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

エンドポイントドキュメント

1つのエンドポイントの完全なドキュメントを返します。パラメータ、実レスポンスから生成したフィールド表、取得済みのレスポンス例、検証済みサンプル、30日間のプローブ履歴、エラー、制限が含まれます。

GET/api/meta/endpoint

リクエスト

クエリパラメータ

名前型必須デフォルト指定可能な値説明
idstring必須——カタログ上のエンドポイントID（例：`sd-oi`）。不明なIDは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—このレスポンスのスキーマID（`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—1つの属性の値：テキスト、数値、リスト（`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—直近のプローブリクエストが、有効なJSONボディとともにHTTP 200を返した場合は`true`。 省略される場合あり
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—レスポンスフィールド1件：`path`、`type`、`unit`、`desc`と各種フラグ。
fields[].pathstring—レスポンス内のフィールドのパス：`a.b`はネスト、`[]`は配列の要素、`{*}`はマップの値を表します。
fields[].typestring—種別。
fields[].unitstring|null—このオブジェクト内の値の単位。
fields[].descstring—フィールドの説明。記述がない場合はnull。
fields[].optionalboolean—サンプリングしたレスポンスの1つ以上でフィールドが欠落していた場合に含まれ、値はtrueです。 省略される場合あり
fields[].mapboolean—オブジェクトが固定フィールドではなく、データに依存するキー（銘柄、取引所、日付）を持つマップである場合に含まれ、値はtrueです。 省略される場合あり
fields[].keysarray—マップで確認されたキーのサンプル。`map`がtrueのフィールドにのみ含まれます。 省略される場合あり
fields[].keys[]string—サンプルキー1件。 省略される場合あり
fields_generated_atnumbermsタイムスタンプ。
fields_generated_fromarray—フィールド表の推定に使用した実レスポンスのリクエストURL。表がない場合はnull。
fields_generated_from[]string—サンプリングしたリクエストパス1件（クエリ文字列付き）。
exampleobject—プローブが取得した最後に成功した実レスポンス：`request`、`captured_at`、`truncated`（短縮した配列の元の長さ）、`body`。存在しない場合はnull。
example.requeststring—取得済みのレスポンス例を生成したリクエスト（パスとクエリ文字列）。
example.captured_atnumbermsタイムスタンプ。
example.truncatedobject—取得済みのレスポンス例で短縮された箇所：配列またはマップごとに、省略された要素の数。キーはドキュメント対象のエンドポイントによって異なります。
example.bodyobject—ドキュメント対象のエンドポイントの取得済みレスポンス（短縮済み）。構造は`fields`に記載のとおりです。
verified_samplesobject|null—プローブの追加サンプルリクエストの結果（`at`、クエリ・HTTPステータス・レイテンシ・スキーマチェックを含む`samples`）。実行されていない場合は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—サンプルが期待どおりの結果（有効なJSONを伴うHTTP 200、または期待されるエラーステータス）を返した場合は`true`。
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—エラーコード1件。
errors[].codestring—コード。
errors[].httpnumber|string—このコードとともに送信されるHTTPステータス。複数が該当する場合は`501 / 503`のような文字列です。
errors[].meaningstring—エラーの意味。
errors[].retrystring—再試行すべきかどうか、およびその方法に関する助言。
errors[].legacyboolean—`success: false`付きでHTTP 200を返す旧エンドポイントが使用するコードにのみ含まれ、値はtrueです。 省略される場合あり
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—コード。
relatedarray—同じカテゴリのすべてのエンドポイント（このエンドポイントを含む）。
related[]object—1エンドポイント分：`id`、`path`、`title`。
related[].idstring—識別子。
related[].pathstring—エンドポイントのリクエストパス。
related[].titlestring—エンドポイントの短い表示タイトル。
probeobject—ライブステータスの基となるエンドポイントプローブの状態：最終実行時刻、その経過時間、間隔、鮮度内かどうか。
probe.last_run_atnumbermsタイムスタンプ。
probe.age_snumbersこの行が最後に更新されてからの経過秒数。
probe.interval_snumbersプローブ実行の予定間隔（300）。
probe.freshboolean—最後のプローブ実行が20分未満前の場合はtrue。falseの場合、エンドポイントのステータスは`unknown`として報告されます。
probe.errornull—エラーメッセージ（失敗時のみ存在）。
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: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にチェック

詳細

認証
不要。公開エンドポイントです。
レート制限
IPごとに毎分1200リクエスト
サーバーキャッシュ
30s
エッジマイクロキャッシュ
10s
データソース
CoinBossのエンドポイントカタログ、APIプローブが生成したスキーマ、sd_api_probe。
タイムスタンプ
フィールドの説明に別途記載がない限り、Unixエポックミリ秒（UTC）
レスポンス形式
json
安定性
安定版
提供開始
2026-11-11

ライブステータス

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

可用性（過去30日間）

408回のチェック中99.75%が合格

直近のプローブで検出されたスキーマのずれ
  • 返されているがドキュメントに未記載: 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リクエスト数が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/endpoint利用可能
パラメータ

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

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