24h出来高—建玉—24h清算$1.36B24hロング/ショート—BTCドミナンス—ETHドミナンス—
アプリ
言語 ▾
¥ JPY ▾
/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—APIのベースURL。
servers[]object—サーバーエントリー1件。
servers[].urlstring—すべてのパスの先頭に付加するベースURL。
tagsarray—エンドポイントのカテゴリ。
tags[]object—カテゴリ1件。
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—1つのパスで利用できるオペレーション。
paths.{*}.getobject—GETオペレーション。
paths.{*}.get.operationIdstring—エンドポイントID。カタログと同じIDです。
paths.{*}.get.summarystring—概要ブロック。
paths.{*}.get.descriptionstring—エンドポイントが返す内容。カバレッジと制限に関する注記を含みます。
paths.{*}.get.tagsarray—エンドポイントのカテゴリ。
paths.{*}.get.tags[]string—カテゴリID。
paths.{*}.get.x-declared-statusstring—宣言上の可用性：`available`、`partial`、`unavailable`のいずれか。
paths.{*}.get.x-cache-ttl-secondsnumbersエンドポイントのサーバー側キャッシュの有効期間。 省略される場合あり
paths.{*}.get.parametersarray—リクエストパラメータ。 この表の生成に使用したサンプルでは空
paths.{*}.get.parameters[]object—パラメータ1件。
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 }
      }
    }

詳細

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

ライブステータス

利用可能2026-11-13 03:59:28 UTCにチェックHTTP 20037 msスキーマ一致

可用性（過去30日間）

408回のチェック中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/openapi利用可能
パラメータ

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

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