認証

CoinBoss APIは公開APIです。どのデータエンドポイントを呼び出す場合も、アカウントやAPIキーは必要ありません。

キー不要

カタログ内のどのエンドポイントも、通常のHTTPS GETで呼び出せます。匿名リクエストはIPアドレスごとに毎分1200リクエストまでに制限されます。

curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"

任意のAPIキー

複数のサービスが1つのIPアドレスを共有している場合や、アドレスが変わるネットワークから呼び出す場合は、アカウントでキーを作成し、CB-API-KEYヘッダーで送信できます。有効なキー付きのリクエストは、IPアドレスではなくキーに対してカウントされます。

• キーの作成と失効は、アカウントのAPIキーページで行います。認証済みのメールアドレスが必要です。
• キーの全体が表示されるのは作成時の1回だけです。保存されるのはハッシュのみのため、再表示はできません。
• 1アカウントにつき、有効なキーを最大5個まで保持できます。
• 不明なキーや失効済みのキーは無視されます。リクエストは匿名として処理され、IPアドレスに対してカウントされます。

APIキーを管理

キー付きのリクエスト

curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
  -H "CB-API-KEY: $COINBOSS_API_KEY"

レート制限のティア

どのティアでも返されるデータは同じです。現在の無料期間中は、匿名トラフィックとすべてのキーに最上位ティアが適用されます。

キーを安全に保つ

• キーはパスワードと同様に扱ってください。ソースコードではなく、環境変数やシークレットストアに保管してください。
• Webページ、ブラウザ拡張機能、モバイルアプリにキーを埋め込まないでください。クライアントに配布したものは、すべてユーザーが読み取れます。APIは自社サーバーから呼び出すか、ブラウザからは匿名で呼び出してください。
• 漏えいの疑いがある場合は、ただちにキーを失効させ、新しいキーを作成してください。
• CoinBossが取引所のAPIキーを求めることはありません。データは取引所の公開エンドポイントから収集しており、このAPIは取引所の認証情報を必要とせず、受け付けることもありません。

ブラウザからの呼び出し

レスポンスにはAccess-Control-Allow-Origin: *が含まれるため、データエンドポイントは任意のWebオリジンから呼び出せます。X-Request-Id、X-Cache、X-RateLimit-*の各ヘッダーはスクリプトから参照できます。

アカウント用エンドポイント

/api/userおよび/api/auth配下のエンドポイントは、ログイン後のWebサイト機能（ウォッチリスト、設定、キー管理）のためのものです。サイトのセッションを使用し、公開データAPIには含まれず、カタログにも掲載されていません。