Bitculator
Bitculator · Data API · v1

Bitculator Data API

73 エンドポイント 15 グループ すべての呼び出しに X-Quota-* http://localhost/api/v1

すべてのエンドポイントは /api/v1 配下にあり、data-api 権限を持つ Bearer キーが必要です — 開発者コンソール で作成できます。

最初の呼び出し:

curl https://bitculator.com/api/v1/prices/bitcoin \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンスは JSON です。価格、レート、供給量は 10進文字列 です(浮動小数点数では市場の精度を保持できません)。件数や分析値は数値です。すべてのレスポンスには X-Quota-Limit / X-Quota-Used / X-Quota-Reset ヘッダーでライブのクォータが含まれ、エラーは常に {"error": {"code", "message", "details"}} エンベロープを使用します。

Data API には、API プランに紐づく 独自の月間クォータ があり、埋め込みウィジェットとは完全に分離されています。per_page の上限はプランに応じて決まり(Free 100、Starter/Pro 250)、上限を超えると値をクランプせずに 422 を返します。

認証

リクエストを認証するには、すべてのリクエストに Authorization: Bearer {YOUR_API_KEY} ヘッダーを含めてください。

開発者コンソール で Data API キーを作成してください — キーは Bearer 専用で data-api 権限を持ちます。サーバーサイドで保管し、クライアントサイドへの埋め込みには決して使用しないでください。

Authorization ヘッダー
キーを作成 →
Bearer
bc_••••••••••••••••

すべてのリクエストで Authorization: Bearer {YOUR_API_KEY} として送信されます。

9 エンドポイント

コイン

ランク付けされたコインとトークンのマーケットデータ: ページネーション対応の一覧、コイン単体の詳細、変動銘柄(gainers/losers)、最近追加、トレンド、コインごとの時系列。価格、時価総額、供給量は10進文字列です(浮動小数点数では市場の精度を保持できません)。変化率、ランク、件数は数値です。

コイン一覧

価格、フィルター、セレクター付きのランク付けされたコイン。Laravel の links + meta エンベロープでページネーションされます。価格、時価総額、circulating_supply は10進文字列、変化率とランクは数値です。

GET
http://localhost/api/v1/coins
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

type
string 任意
coin

単一のアセットタイプに限定: coin または token。

次のいずれか: coin token

status
string 任意
active

上場ステータス: active、delisted、untracked、progressing、awaiting または preparing。デフォルトはすべての公開ステータスです。

次のいずれか: active delisted untracked progressing awaiting preparing

search
string 任意
bitcoin

名前またはシンボルでのフリーテキスト検索。100 文字を超えてはいけません。

min_price
number 任意
0.5

この USD 値以上の価格のコインのみ。0 以上である必要があります。

max_price
number 任意
100000

この USD 値以下の価格のコインのみ。0 以上である必要があります。

min_marketcap
number 任意
1000000

USD 時価総額がこの値以上のコインのみ。0 以上である必要があります。

max_marketcap
number 任意
5000000000000

USD 時価総額がこの値以下のコインのみ。0 以上である必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のコインのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のコインのみ。0 以上である必要があります。

ids
string 任意
38,39

特定のコイン ID に絞り込みます(CSV、slugs/symbols と合わせて最大 100 セレクター)。1000 文字を超えてはいけません。

slugs
string 任意
bitcoin,ethereum

特定のコイン slug に絞り込みます(CSV、合計で最大 100 セレクター)。2000 文字を超えてはいけません。

symbols
string 任意
BTC,ETH

特定のコインシンボルに絞り込みます(CSV、大文字小文字を区別せず、合計で最大 100 セレクター)。1000 文字を超えてはいけません。

sort
string 任意
-marketcap

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: marketcap、rank、price、volume_24h、change_24h、change_7d。100 文字を超えてはいけません。

interval
string 任意
24h

/coins/gainers と /coins/losers 専用の変動ウィンドウ: 24h または 7d。

次のいずれか: 24h 7d

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

最近追加されたコイン

最新の上場 — status_updated_at(有効化されたタイムスタンプ)でソートされます(created_at はクロール日時で、上場より任意の期間だけ前の日付です)。行の形式とページネーションエンベロープは List coins と同じです。

GET
http://localhost/api/v1/coins/recently-added
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

type
string 任意
coin

単一のアセットタイプに限定: coin または token。

次のいずれか: coin token

status
string 任意
active

上場ステータス: active、delisted、untracked、progressing、awaiting または preparing。デフォルトはすべての公開ステータスです。

次のいずれか: active delisted untracked progressing awaiting preparing

search
string 任意
bitcoin

名前またはシンボルでのフリーテキスト検索。100 文字を超えてはいけません。

min_price
number 任意
0.5

この USD 値以上の価格のコインのみ。0 以上である必要があります。

max_price
number 任意
100000

この USD 値以下の価格のコインのみ。0 以上である必要があります。

min_marketcap
number 任意
1000000

USD 時価総額がこの値以上のコインのみ。0 以上である必要があります。

max_marketcap
number 任意
5000000000000

USD 時価総額がこの値以下のコインのみ。0 以上である必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のコインのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のコインのみ。0 以上である必要があります。

ids
string 任意
38,39

特定のコイン ID に絞り込みます(CSV、slugs/symbols と合わせて最大 100 セレクター)。1000 文字を超えてはいけません。

slugs
string 任意
bitcoin,ethereum

特定のコイン slug に絞り込みます(CSV、合計で最大 100 セレクター)。2000 文字を超えてはいけません。

symbols
string 任意
BTC,ETH

特定のコインシンボルに絞り込みます(CSV、大文字小文字を区別せず、合計で最大 100 セレクター)。1000 文字を超えてはいけません。

sort
string 任意
-marketcap

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: marketcap、rank、price、volume_24h、change_24h、change_7d。100 文字を超えてはいけません。

interval
string 任意
24h

/coins/gainers と /coins/losers 専用の変動ウィンドウ: 24h または 7d。

次のいずれか: 24h 7d

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/recently-added?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

上昇率トップ

interval ウィンドウ(デフォルト 24h、または 7d)で最も上昇した銘柄。行の形式とページネーションエンベロープは List coins と同じです。

GET
http://localhost/api/v1/coins/gainers
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

type
string 任意
coin

単一のアセットタイプに限定: coin または token。

次のいずれか: coin token

status
string 任意
active

上場ステータス: active、delisted、untracked、progressing、awaiting または preparing。デフォルトはすべての公開ステータスです。

次のいずれか: active delisted untracked progressing awaiting preparing

search
string 任意
bitcoin

名前またはシンボルでのフリーテキスト検索。100 文字を超えてはいけません。

min_price
number 任意
0.5

この USD 値以上の価格のコインのみ。0 以上である必要があります。

max_price
number 任意
100000

この USD 値以下の価格のコインのみ。0 以上である必要があります。

min_marketcap
number 任意
1000000

USD 時価総額がこの値以上のコインのみ。0 以上である必要があります。

max_marketcap
number 任意
5000000000000

USD 時価総額がこの値以下のコインのみ。0 以上である必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のコインのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のコインのみ。0 以上である必要があります。

ids
string 任意
38,39

特定のコイン ID に絞り込みます(CSV、slugs/symbols と合わせて最大 100 セレクター)。1000 文字を超えてはいけません。

slugs
string 任意
bitcoin,ethereum

特定のコイン slug に絞り込みます(CSV、合計で最大 100 セレクター)。2000 文字を超えてはいけません。

symbols
string 任意
BTC,ETH

特定のコインシンボルに絞り込みます(CSV、大文字小文字を区別せず、合計で最大 100 セレクター)。1000 文字を超えてはいけません。

sort
string 任意
-marketcap

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: marketcap、rank、price、volume_24h、change_24h、change_7d。100 文字を超えてはいけません。

interval
string 任意
24h

/coins/gainers と /coins/losers 専用の変動ウィンドウ: 24h または 7d。

次のいずれか: 24h 7d

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/gainers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

下落率トップ

interval ウィンドウ(デフォルト 24h、または 7d)で最も下落した銘柄。行の形式とページネーションエンベロープは List coins と同じです。

GET
http://localhost/api/v1/coins/losers
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

type
string 任意
coin

単一のアセットタイプに限定: coin または token。

次のいずれか: coin token

status
string 任意
active

上場ステータス: active、delisted、untracked、progressing、awaiting または preparing。デフォルトはすべての公開ステータスです。

次のいずれか: active delisted untracked progressing awaiting preparing

search
string 任意
bitcoin

名前またはシンボルでのフリーテキスト検索。100 文字を超えてはいけません。

min_price
number 任意
0.5

この USD 値以上の価格のコインのみ。0 以上である必要があります。

max_price
number 任意
100000

この USD 値以下の価格のコインのみ。0 以上である必要があります。

min_marketcap
number 任意
1000000

USD 時価総額がこの値以上のコインのみ。0 以上である必要があります。

max_marketcap
number 任意
5000000000000

USD 時価総額がこの値以下のコインのみ。0 以上である必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のコインのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のコインのみ。0 以上である必要があります。

ids
string 任意
38,39

特定のコイン ID に絞り込みます(CSV、slugs/symbols と合わせて最大 100 セレクター)。1000 文字を超えてはいけません。

slugs
string 任意
bitcoin,ethereum

特定のコイン slug に絞り込みます(CSV、合計で最大 100 セレクター)。2000 文字を超えてはいけません。

symbols
string 任意
BTC,ETH

特定のコインシンボルに絞り込みます(CSV、大文字小文字を区別せず、合計で最大 100 セレクター)。1000 文字を超えてはいけません。

sort
string 任意
-marketcap

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: marketcap、rank、price、volume_24h、change_24h、change_7d。100 文字を超えてはいけません。

interval
string 任意
24h

/coins/gainers と /coins/losers 専用の変動ウィンドウ: 24h または 7d。

次のいずれか: 24h 7d

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/losers?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

コイン詳細を取得

コイン単体の完全なプロフィール。リストのフィールドに加えて次を追加します: supply(流通/総/最大)、today の OHLC、all_time_high / all_time_low(価格、日付、現在価格からのパーセント)、fully_diluted_valuation、マーケットの counts(取引所/ペア/ティッカー/ウォレット)、decimalsgenesis_date、公式 links(型付き URL リスト)、トークンの contracts、そしてローカライズされた HTML の description(要求されたロケールがない場合は英語にフォールバック)。すべての価格/供給量フィールドは10進文字列です。

GET
http://localhost/api/v1/coins/{slug}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

クエリパラメータ

locale
string 任意
en

説明のコンテンツ言語(英語にフォールバックします)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ローソク足履歴

コインごとの OHLC + 出来高 + 時価総額の時系列。interval を選択: minutely、half-hourly、hourly または daily。保持期間はロールアップパイプラインの固定的な仕様です — minutely は 8 日、half-hourly は 3 か月、hourly は 6 か月、daily は永久。ウィンドウを超える要求は存在する分を返します。limit を設定すると、ウィンドウ内の最新 N 行が古い順に出力されます。価格は10進文字列です。

GET
http://localhost/api/v1/coins/{slug}/history
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

クエリパラメータ

interval
string 任意
daily

minutely、half-hourly、hourly または daily(デフォルトは daily)。

start
string 任意
2026-06-01

ISO 日時の下限。

end
string 任意
2026-06-30

ISO 日時の上限(日付のみの値はその日までを意味します)。

limit
integer 任意
30

最大行数(1〜2000、デフォルトは 1000)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

時価総額の履歴

Candle history と同じコインごとのロールアップを {time, marketcap} のみに投影したもの。同じ interval の選択肢と保持ウィンドウ(minutely 8 日、half-hourly 3 か月、hourly 6 か月、daily は永久)で、limit を設定すると最新 N 件になります。

GET
http://localhost/api/v1/coins/{slug}/marketcap-history
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

クエリパラメータ

interval
string 任意
daily

minutely、half-hourly、hourly または daily(デフォルトは daily)。

start
string 任意
2026-06-01

ISO 日時の下限。

end
string 任意
2026-06-30

ISO 日時の上限。

limit
integer 任意
30

最大行数(1〜2000、デフォルトは 1000)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/marketcap-history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

コインのスパークライン

スパークラインを描画するための、選択した period にわたるコインのコンパクトな価格系列。

GET
http://localhost/api/v1/coins/{slug}/sparkline
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

クエリパラメータ

period
string 任意
7d

24h、7d、30d、60d、90d、180d または 365d(デフォルトは 7d)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 エンドポイント

価格

軽量な価格ホットパス — 要求されたコインセットの現在価格、時価総額、24 時間出来高、直近の変化率。/prices はセレクター(ids、slugs または symbols)が必要です。/prices/{slug} は 1 つのコインを対象とします。任意で法定通貨に convert できます(暗号資産の価格は約1分ごと、法定通貨の為替は約1日2回更新)。価格と時価総額は10進文字列です。

価格を取得

要求されたコインセットの価格。少なくとも 1 つのセレクター — idsslugs または symbols(合計最大 100)を渡します。meta.currency は変換先(convert が設定されていない限り USD)を返します。

GET
http://localhost/api/v1/prices
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

ids
string 任意
38,39

価格を取得するコイン ID(CSV)。ids、slugs、symbols のうち少なくとも 1 つが必須で、3 つのリスト合計で最大 100 セレクター。slugssymbols のいずれも指定されていない場合、このフィールドは必須です。1000 文字を超えてはいけません。

slugs
string 任意
bitcoin,ethereum

価格を取得するコイン slug(CSV)。ids、slugs、symbols のうち少なくとも 1 つが必須です。idssymbols のいずれも指定されていない場合、このフィールドは必須です。2000 文字を超えてはいけません。

symbols
string 任意
BTC,ETH

価格を取得するコインシンボル(CSV、大文字小文字を区別しません)。ids、slugs、symbols のうち少なくとも 1 つが必須です。idsslugs のいずれも指定されていない場合、このフィールドは必須です。1000 文字を超えてはいけません。

convert
string 任意
EUR

価格/時価総額を、シンボルで指定した有効な法定通貨に変換します(デフォルトは USD)。為替レートは約1日2回更新されます。

次のいずれか: USD EUR JPY BGN CZK DKK GBP HUF PLN RON SEK CHF ISK NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR ILS INR KRW MXN MYR NZD PHP SGD THB ZAR ARS DZD MAD TWD

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/prices?ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

コイン価格を取得

コイン単体の価格スナップショット。任意でシンボル指定により有効な法定通貨に convert できます(デフォルトは USD)。

GET
http://localhost/api/v1/prices/{slug}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

クエリパラメータ

convert
string 任意
EUR

価格表示に使用する有効な法定通貨のシンボル(デフォルトは USD)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/prices/bitcoin?convert=EUR" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

過去の価格

指定日のコインの USD 価格。日次履歴から読み取ります(正確な日付、±3 日のフォールバック — ポートフォリオが使うのと同じリゾルバー)。暗号資産のみ: 法定通貨の行には日次履歴がありません。

GET
http://localhost/api/v1/historical-price
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

date
string 必須
2021-04-14

date 参照日(2008-12-31 より後、未来ではない)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/historical-price?slug=bitcoin&date=2021-04-14" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 エンドポイント

マーケット

ティッカー(取引所ごとのマーケット)とペア(取引所横断で集約されたマーケット)、さらにコインのマーケットと取引所ごとの生の取引シンボル。すべてスナップショットデータです — ティッカー/ペアごとの履歴はありません。USD の出来高は数値、価格は10進文字列です。

コインのマーケット

コインのすべてのマーケット — ペアの基軸または決済通貨としてそのコインを持つティッカー。行の形式とフィルターは List tickers と同じです。

GET
http://localhost/api/v1/coins/{slug}/markets
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

exchange
string 任意
binance-exchange

slug で単一の取引所に限定します(取引所ごとの一覧では既にスコープされているため省略します)。正規表現 /^[a-z0-9-]{1,120}$/ に一致する必要があります。

pair
integer 任意
1

id で単一のペアに限定します。1 以上である必要があります。

instrument
string 任意
spot

銘柄タイプ: future、option、swap、spot または margin(複数形も可)。

次のいずれか: future option swap spot margin

search
string 任意
BTC

ティッカーシンボルでのフリーテキスト検索。50 文字を超えてはいけません。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のティッカーのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のティッカーのみ。0 以上である必要があります。

min_change
number 任意
-50

24 時間の変化率がこの値以上のティッカーのみ。

max_change
number 任意
50

24 時間の変化率がこの値以下のティッカーのみ。

sort
string 任意
-volume_usd

単一のソートフィールド(降順にするには - を前置)。ソート可能: volume_usd、change_24h、price_usd、updated。デフォルトは -volume_usd。100 文字を超えてはいけません。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/markets?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

コインの取引シンボル

コインの取引所ごとの生の取引シンボル — まばらに埋められた参照データです(カバレッジはベストエフォート)。

GET
http://localhost/api/v1/coins/{slug}/symbols
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/symbols" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ティッカー一覧

取引所ごとの個別マーケット(ティッカー)。ページネーション対応。取引所、ペア、銘柄、出来高/変化率の範囲でフィルターできます。USD の出来高は数値、価格は10進文字列です。

GET
http://localhost/api/v1/tickers
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

exchange
string 任意
binance-exchange

slug で単一の取引所に限定します(取引所ごとの一覧では既にスコープされているため省略します)。正規表現 /^[a-z0-9-]{1,120}$/ に一致する必要があります。

pair
integer 任意
1

id で単一のペアに限定します。1 以上である必要があります。

instrument
string 任意
spot

銘柄タイプ: future、option、swap、spot または margin(複数形も可)。

次のいずれか: future option swap spot margin

search
string 任意
BTC

ティッカーシンボルでのフリーテキスト検索。50 文字を超えてはいけません。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のティッカーのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のティッカーのみ。0 以上である必要があります。

min_change
number 任意
-50

24 時間の変化率がこの値以上のティッカーのみ。

max_change
number 任意
50

24 時間の変化率がこの値以下のティッカーのみ。

sort
string 任意
-volume_usd

単一のソートフィールド(降順にするには - を前置)。ソート可能: volume_usd、change_24h、price_usd、updated。デフォルトは -volume_usd。100 文字を超えてはいけません。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ペア一覧

取引所横断で集約された取引ペア。24 時間 USD 出来高でランク付けされます。コイン slug(基軸または決済)と出来高範囲でフィルターできます。

GET
http://localhost/api/v1/pairs
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

search
string 任意
BTC

ペアシンボルでのフリーテキスト検索。50 文字を超えてはいけません。

coin
string 任意
bitcoin

このコイン slug が基軸または決済アセットであるペアに限定します。正規表現 /^[a-z0-9-]{1,120}$/ に一致する必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のペアのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のペアのみ。0 以上である必要があります。

sort
string 任意
-volume_usd

ソートフィールド: volume_usd または updated(降順にするには - を前置)。デフォルトは -volume_usd。

次のいずれか: volume_usd -volume_usd updated -updated

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/pairs?page=1&per_page=50&search=BTC&coin=bitcoin&min_volume=1000000&max_volume=100000000000&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ペア詳細を取得

1 つのペアと、それを扱うすべての取引所ティッカー。出来高順に並べられます。

GET
http://localhost/api/v1/pairs/{id}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

id
integer 必須
1

ペアの id。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/pairs/1" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
7 エンドポイント

取引所

取引所のランキング、詳細、信頼スコア、時系列、取引所ごとのマーケット/コイン一覧。出来高は USD です。CEX/DEX の列はありません — type は取引所の分類から導出され、"cex"、"dex" または null になります。

取引所一覧

24 時間出来高、ドミナンス、ペア/アセット数、直近の変化率を含むランク付けされた取引所。Laravel の links + meta エンベロープでページネーションされます。

GET
http://localhost/api/v1/exchanges
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

type
string 任意
cex

取引所タイプに限定: cex または dex(取引所の分類で解決されます)。

次のいずれか: cex dex

search
string 任意
binance

取引所名でのフリーテキスト検索。100 文字を超えてはいけません。

min_pairs
integer 任意
100

少なくともこの数のペアを扱う取引所のみ。0 以上である必要があります。

max_pairs
integer 任意
2000

最大でこの数のペアを扱う取引所のみ。0 以上である必要があります。

min_assets
integer 任意
50

少なくともこの数のアセットを扱う取引所のみ。0 以上である必要があります。

max_assets
integer 任意
1000

最大でこの数のアセットを扱う取引所のみ。0 以上である必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上の取引所のみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下の取引所のみ。0 以上である必要があります。

ids
string 任意
1,12

特定の取引所 ID に絞り込みます(CSV、最大 100 件)。1000 文字を超えてはいけません。

slugs
string 任意
binance-exchange,gateio

特定の取引所 slug に絞り込みます(CSV、最大 100 件)。2000 文字を超えてはいけません。

sort
string 任意
-volume

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: volume、rank、volume_dominance、change_24h、change_7d、pairs、assets。100 文字を超えてはいけません。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/exchanges?page=1&per_page=50&type=cex&search=binance&min_pairs=100&max_pairs=2000&min_assets=50&max_assets=1000&min_volume=1000000&max_volume=100000000000&ids=1%2C12&slugs=binance-exchange%2Cgateio&sort=-volume" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

取引所詳細を取得

取引所単体の完全なプロフィール: ランキング、出来高/ドミナンス、ペア数とアセット数、established の日付、location、リファラル website、および導出された type(cex/dex/null)。

GET
http://localhost/api/v1/exchanges/{slug}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
binance-exchange

取引所の slug。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

取引所の信頼スコアを取得

集計された 0〜10 の信頼 score と、その 13 項目の breakdown(rank、volume、age、volume_trend、stability、rank_stability、ticker_health、pairs、community、assets、dominance、market_breadth、transparency)。取引所ごとに計算され、24 時間キャッシュされます。

GET
http://localhost/api/v1/exchanges/{slug}/trust-score
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
binance-exchange

取引所の slug。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/trust-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

取引所の履歴

出来高/ドミナンス/ペア/アセットの時系列(取引所のロールアップには OHLC はありません)。interval を選択: minutely、hourly または daily。保持期間はロールアップパイプラインの固定的な仕様です — minutely は 8 日、hourly は 6 か月、daily は永久。limit を設定すると、ウィンドウ内の最新 N 行が古い順に得られます。

GET
http://localhost/api/v1/exchanges/{slug}/history
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
binance-exchange

取引所の slug。

クエリパラメータ

interval
string 任意
daily

minutely、hourly または daily(デフォルトは daily)。

start
string 任意
2026-06-01

ISO 日時の下限。

end
string 任意
2026-06-30

ISO 日時の上限(日付のみの値はその日までを意味します)。

limit
integer 任意
30

最大行数(1〜2000、デフォルトは 1000)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/history?interval=daily&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

取引所のスパークライン

期間内の取引所の出来高スパークライン系列(デフォルトは 7d) — Web の取引所行がレンダリングするのと同じ系列です。

GET
http://localhost/api/v1/exchanges/{slug}/sparkline
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
binance-exchange

取引所の slug。

クエリパラメータ

period
string 任意
7d

24h7d(デフォルト)、30d60d90d180d365d のいずれか。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/sparkline?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

取引所のマーケット

取引所のティッカー一覧(そのマーケット)。ページネーション対応。既に取引所にスコープされています — ここで exchange パラメータを渡さないでください。

GET
http://localhost/api/v1/exchanges/{slug}/tickers
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
binance-exchange

取引所の slug。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

exchange
string 任意
binance-exchange

slug で単一の取引所に限定します(取引所ごとの一覧では既にスコープされているため省略します)。正規表現 /^[a-z0-9-]{1,120}$/ に一致する必要があります。

pair
integer 任意
1

id で単一のペアに限定します。1 以上である必要があります。

instrument
string 任意
spot

銘柄タイプ: future、option、swap、spot または margin(複数形も可)。

次のいずれか: future option swap spot margin

search
string 任意
BTC

ティッカーシンボルでのフリーテキスト検索。50 文字を超えてはいけません。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のティッカーのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のティッカーのみ。0 以上である必要があります。

min_change
number 任意
-50

24 時間の変化率がこの値以上のティッカーのみ。

max_change
number 任意
50

24 時間の変化率がこの値以下のティッカーのみ。

sort
string 任意
-volume_usd

単一のソートフィールド(降順にするには - を前置)。ソート可能: volume_usd、change_24h、price_usd、updated。デフォルトは -volume_usd。100 文字を超えてはいけません。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/tickers?page=1&per_page=50&exchange=binance-exchange&pair=1&instrument=spot&search=BTC&min_volume=1000000&max_volume=100000000000&min_change=-50&max_change=50&sort=-volume_usd" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

取引所のコイン

取引所に上場しているコイン。List coins と同じ形式で返され、同じフィルター/ソートを受け付けます。

GET
http://localhost/api/v1/exchanges/{slug}/assets
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
binance-exchange

取引所の slug。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

type
string 任意
coin

単一のアセットタイプに限定: coin または token。

次のいずれか: coin token

status
string 任意
active

上場ステータス: active、delisted、untracked、progressing、awaiting または preparing。デフォルトはすべての公開ステータスです。

次のいずれか: active delisted untracked progressing awaiting preparing

search
string 任意
bitcoin

名前またはシンボルでのフリーテキスト検索。100 文字を超えてはいけません。

min_price
number 任意
0.5

この USD 値以上の価格のコインのみ。0 以上である必要があります。

max_price
number 任意
100000

この USD 値以下の価格のコインのみ。0 以上である必要があります。

min_marketcap
number 任意
1000000

USD 時価総額がこの値以上のコインのみ。0 以上である必要があります。

max_marketcap
number 任意
5000000000000

USD 時価総額がこの値以下のコインのみ。0 以上である必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のコインのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のコインのみ。0 以上である必要があります。

ids
string 任意
38,39

特定のコイン ID に絞り込みます(CSV、slugs/symbols と合わせて最大 100 セレクター)。1000 文字を超えてはいけません。

slugs
string 任意
bitcoin,ethereum

特定のコイン slug に絞り込みます(CSV、合計で最大 100 セレクター)。2000 文字を超えてはいけません。

symbols
string 任意
BTC,ETH

特定のコインシンボルに絞り込みます(CSV、大文字小文字を区別せず、合計で最大 100 セレクター)。1000 文字を超えてはいけません。

sort
string 任意
-marketcap

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: marketcap、rank、price、volume_24h、change_24h、change_7d。100 文字を超えてはいけません。

interval
string 任意
24h

/coins/gainers と /coins/losers 専用の変動ウィンドウ: 24h または 7d。

次のいずれか: 24h 7d

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/exchanges/binance-exchange/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 エンドポイント

ウォレット

暗号資産ウォレットのレビュー — レビュー score、対応アセット数、pros/cons の数、価格モデルとリリース日に加え、詳細/比較レスポンスにはグループ化されたタグ分類が含まれます。meta.top_score は全ウォレットの最高スコアです(スコアを 0〜1 の範囲に正規化するのに使用します)。

ウォレット一覧

スコア、アセット数、pros/cons の数、価格モデル、ステータス、リリース日を含むレビュー済みウォレット。Laravel の links + meta エンベロープと meta.top_score を伴ってページネーションされます。

GET
http://localhost/api/v1/wallets
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

search
string 任意
ledger

ウォレット名でのフリーテキスト検索。100 文字を超えてはいけません。

min_score
integer 任意
50

レビュースコアがこの値以上のウォレットのみ。0 以上である必要があります。

max_score
integer 任意
214

レビュースコアがこの値以下のウォレットのみ。0 以上である必要があります。

tags
string 任意
12,34

タグ分類でフィルター: カンマ区切りのカテゴリーグループ ID(Web のファセットフィルターが送信するのと同じ ID)。1000 文字を超えてはいけません。

ids
string 任意
175,317

特定のウォレット ID に絞り込みます(CSV、最大 100 件)。1000 文字を超えてはいけません。

slugs
string 任意
frostsnap,coin98-fusion-card

特定のウォレット slug に絞り込みます(CSV、最大 100 件)。2000 文字を超えてはいけません。

sort
string 任意
-score

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: score、released_at、assets、pros、cons。100 文字を超えてはいけません。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/wallets?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ウォレットのリリースタイムライン

released_at の降順に固定されたウォレット一覧(日付なしのウォレットは末尾)。行の形式とページネーションエンベロープは List wallets と同じです。

GET
http://localhost/api/v1/wallets/timeline
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

search
string 任意
ledger

ウォレット名でのフリーテキスト検索。100 文字を超えてはいけません。

min_score
integer 任意
50

レビュースコアがこの値以上のウォレットのみ。0 以上である必要があります。

max_score
integer 任意
214

レビュースコアがこの値以下のウォレットのみ。0 以上である必要があります。

tags
string 任意
12,34

タグ分類でフィルター: カンマ区切りのカテゴリーグループ ID(Web のファセットフィルターが送信するのと同じ ID)。1000 文字を超えてはいけません。

ids
string 任意
175,317

特定のウォレット ID に絞り込みます(CSV、最大 100 件)。1000 文字を超えてはいけません。

slugs
string 任意
frostsnap,coin98-fusion-card

特定のウォレット slug に絞り込みます(CSV、最大 100 件)。2000 文字を超えてはいけません。

sort
string 任意
-score

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: score、released_at、assets、pros、cons。100 文字を超えてはいけません。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/wallets/timeline?page=1&per_page=50&search=ledger&min_score=50&max_score=214&tags=12%2C34&ids=175%2C317&slugs=frostsnap%2Ccoin98-fusion-card&sort=-score" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ウォレットを比較

完全なグループ化タグ分類を伴う 2〜4 個のウォレットの並列比較。data[] は要求された slug の順序を保持するため、利用側は列を位置的にレンダリングできます。

GET
http://localhost/api/v1/wallets/compare
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

slugs
string 必須
frostsnap,coin98-fusion-card

2〜4 個の異なるウォレット slug をカンマ区切りで指定。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/wallets/compare?slugs=frostsnap%2Ccoin98-fusion-card" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ウォレット詳細を取得

グループ化されたタグ分類を含むウォレット単体の完全なプロフィール: categories{group, tags[]} のリストで、各タグには slug、名前、任意の値があります。meta.top_score は全ウォレットの最高スコアです。

GET
http://localhost/api/v1/wallets/{slug}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
frostsnap

ウォレットの slug。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ウォレットが対応するコイン

ウォレットが対応しているコイン。List coins と同じ形式で返され、同じフィルター/ソートを受け付けます。

GET
http://localhost/api/v1/wallets/{slug}/assets
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
frostsnap

ウォレットの slug。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

type
string 任意
coin

単一のアセットタイプに限定: coin または token。

次のいずれか: coin token

status
string 任意
active

上場ステータス: active、delisted、untracked、progressing、awaiting または preparing。デフォルトはすべての公開ステータスです。

次のいずれか: active delisted untracked progressing awaiting preparing

search
string 任意
bitcoin

名前またはシンボルでのフリーテキスト検索。100 文字を超えてはいけません。

min_price
number 任意
0.5

この USD 値以上の価格のコインのみ。0 以上である必要があります。

max_price
number 任意
100000

この USD 値以下の価格のコインのみ。0 以上である必要があります。

min_marketcap
number 任意
1000000

USD 時価総額がこの値以上のコインのみ。0 以上である必要があります。

max_marketcap
number 任意
5000000000000

USD 時価総額がこの値以下のコインのみ。0 以上である必要があります。

min_volume
number 任意
1000000

24 時間 USD 出来高がこの値以上のコインのみ。0 以上である必要があります。

max_volume
number 任意
100000000000

24 時間 USD 出来高がこの値以下のコインのみ。0 以上である必要があります。

ids
string 任意
38,39

特定のコイン ID に絞り込みます(CSV、slugs/symbols と合わせて最大 100 セレクター)。1000 文字を超えてはいけません。

slugs
string 任意
bitcoin,ethereum

特定のコイン slug に絞り込みます(CSV、合計で最大 100 セレクター)。2000 文字を超えてはいけません。

symbols
string 任意
BTC,ETH

特定のコインシンボルに絞り込みます(CSV、大文字小文字を区別せず、合計で最大 100 セレクター)。1000 文字を超えてはいけません。

sort
string 任意
-marketcap

カンマ区切りのソートフィールド。降順にするには - を前置します。ソート可能: marketcap、rank、price、volume_24h、change_24h、change_7d。100 文字を超えてはいけません。

interval
string 任意
24h

/coins/gainers と /coins/losers 専用の変動ウィンドウ: 24h または 7d。

次のいずれか: 24h 7d

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/wallets/frostsnap/assets?page=1&per_page=50&type=coin&status=active&search=bitcoin&min_price=0.5&max_price=100000&min_marketcap=1000000&max_marketcap=5000000000000&min_volume=1000000&max_volume=100000000000&ids=38%2C39&slugs=bitcoin%2Cethereum&symbols=BTC%2CETH&sort=-marketcap&interval=24h" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 エンドポイント

グローバルマーケット

マーケット全体の集計 — 総時価総額と出来高、アセット/取引所/ペア/マーケットの数、ランクベースのトップ 3 を含む BTC/ETH ドミナンス、マーケットの Fear & Greed 値、さらにトップ 100 のヒートマップと時価総額/出来高の履歴。

グローバルマーケットのスナップショット

マーケットの一括概要: 総時価総額と 24 時間出来高、暗号資産/トークン/取引所/ペア/マーケットの数、dominance(BTC と ETH のシェアに加えランクベースの top3)、およびマーケットの fear_greed 値。

GET
http://localhost/api/v1/global
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/global" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

マーケットヒートマップ

トップ 100 のツリーマップ行に加え、枠組みとなる統計(総時価総額/出来高、ドミナンス、マーケットの Fear & Greed スコア) — Web ヒートマップの API 版です。

GET
http://localhost/api/v1/global/heatmap
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/global/heatmap" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

グローバル時価総額/出来高の履歴

marketcap または volume の全市場時系列。粒度は period に従います: 24h = 30 分ごと、7d = 1 時間ごと、30d/all = 日次(より細かいロールアップは削除されます)。

GET
http://localhost/api/v1/global/history/{metric}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

metric
string 必須
marketcap

どの系列か: marketcap または volume。

クエリパラメータ

period
string 任意
7d

24h、7d、30d または all(デフォルトは 24h)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/global/history/marketcap?period=7d" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 エンドポイント

センチメント

マーケットおよびコイン別のセンチメント指標。Fear & Greed と Bull/Bear は15分ごとに更新されるスナップショットで、現在の値のみが存在し、時系列はありません。アルトシーズンは完全な日次履歴を持ちます。indicators はマーケット全体のテクニカル集計です。

コミュニティ投票の集計

ローリング 24 時間ウィンドウにおけるコインの強気/弱気のコミュニティ集計。

GET
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

センチメント投票を行う

キー所有者のコインに対するセンチメント投票を行います。ローリング 24 時間ウィンドウごとに、キー所有者・コインごとに 1 票 — ウィンドウ内での再投票は既存の投票を更新します。

POST
http://localhost/api/v1/coins/{slug}/votes
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

ボディパラメータ

vote
string 必須
bullish

あなたのセンチメント: bullish または bearish

リクエスト

curl --request POST \
    "http://localhost/api/v1/coins/bitcoin/votes" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vote\": \"bullish\"
}"

Fear & Greed 指数

現在の Fear & Greed の値(15 分のスナップショット — 履歴なし)。マーケット全体の指標には coin を省略し、コイン別の値にはコイン slug を渡します。intervals は 7d/30d のサブスコアとその構成要素の内訳を含みます。

GET
http://localhost/api/v1/sentiment/fear-greed
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

coin
string 任意
bitcoin

コイン別の値を取得するためのコイン slug。マーケット指標の場合は省略します。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/sentiment/fear-greed?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

強気/弱気指数

現在の Bull/Bear の値(15 分のスナップショット — 履歴なし)。マーケット全体の指標には coin を省略し、コイン別の値にはコイン slug を渡します。

GET
http://localhost/api/v1/sentiment/bull-bear
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

coin
string 任意
bitcoin

コイン別の値を取得するためのコイン slug。マーケット指標の場合は省略します。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/sentiment/bull-bear?coin=bitcoin" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

アルトシーズン指標

現在のアルトシーズンの値(トップ 100 のうち BTC を上回るコインの数)。任意で日次 history を含みます。Fear & Greed とは異なり、アルトシーズンは完全な日次履歴を持ちます — 含めるには days を渡します。

GET
http://localhost/api/v1/sentiment/altseason
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

days
integer 任意
30

含める日次履歴の日数(1〜365、0/省略 = 現在のみ)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/sentiment/altseason?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

マーケットインジケーターの集計

マーケット全体のテクニカル集計 — 25 のインジケーターカテゴリーをまとめたもので、それぞれ現在の状態、スコア、カテゴリーデータを持ちます。

GET
http://localhost/api/v1/sentiment/indicators
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/sentiment/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
2 エンドポイント

インジケーター

コインごとのテクニカルインジケーター — 複数インジケーターのスナップショットと、ファミリーごとの日次時系列。すべてのファミリーは日次ローソク足から計算された日次系列です(完全な保持。若いアセットは十分な履歴が揃うまでウォームアップの null を返します)。価格スケールのファミリー(sma、vwap、macd、obv)は10進文字列を、範囲が限定されたオシレーターは数値を出力します。一部の長いウィンドウの期間は有料プランが必要です(ファミリーのエンドポイントを参照)。

インジケーターのスナップショット

複数インジケーターのスナップショット — 各インジケーターカテゴリーの最新の state(bullish/bearish/sheepish…)、score、生の data を 1 つのペイロードにまとめたもの。

GET
http://localhost/api/v1/coins/{slug}/indicators
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

インジケーターファミリーの系列

1 つのインジケーターファミリーの日次時系列。複数のウィンドウを持つファミリーは period を受け付け、有効なウィンドウはファミリーごとに異なります: RSI/Stoch-RSI 7/14/21/28、SMA 50/100/200、CCI 20/50/100、MFI 7/14/28、Williams %R 14/20/50、price/volume-volatility 7/14/30。単一系列のファミリー(MACD、OBV、ADX、VWAP、CMF)は period を無視します。若いコインは先頭にウォームアップの null を返します。

一部の長いウィンドウは有料プランが必要です: RSI と Stoch-RSI の 21/28 日、および 30 日のボラティリティウィンドウは Starter 以上が必要です — Free プランで要求すると、コード plan_required とともに 403 を返します。

GET
http://localhost/api/v1/coins/{slug}/indicators/{family}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug。

family
string 必須
rsi

インジケーターファミリー — rsi、stoch-rsi、sma、cci、mfi、williams-r、price-volatility、volume-volatility、macd、obv、adx、vwap、cmf のいずれか。

クエリパラメータ

period
integer 任意
14

ウィンドウの長さ(ファミリーがウィンドウを持つ場合のみ。そのファミリーの有効なウィンドウのいずれかである必要があります)。

start
string 任意
2026-06-01

ISO 日付の下限。

end
string 任意
2026-06-30

ISO 日付の上限。

limit
integer 任意
30

最大行数(1〜1000、デフォルトは 365)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/indicators/rsi?period=14&start=2026-06-01&end=2026-06-30&limit=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
6 エンドポイント

清算

デリバティブの清算。ソースのカバレッジは現在 OKX のスワップマーケットのみです(すべての meta.note に明記)。生フィード(/liquidations リストと時間別内訳)は約48時間後に削除されます。日次ロールアップは永久に保存されます。当日の集計は部分的で、約15分ごとに更新されます。

清算フィード

生の清算フィード(直近約48時間、その後削除)。新しい順。ソースのカバレッジは現在 OKX のスワップマーケットです。価格は10進文字列です。meta はページネーションフィールドに加え retentionnote を含みます。

GET
http://localhost/api/v1/liquidations
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。1 以上である必要があります。

per_page
integer 任意
50

1 ページあたりの行数。上限はプランに応じて決まり(Free 100、Starter/Pro 250)、超えると値をクランプせずに 422 を返します。1 以上である必要があります。100 を超えてはいけません。

exchange
string 任意
okx

slug で単一の取引所に限定します。ソースのカバレッジは現在 OKX のスワップマーケットです。正規表現 /^[a-z0-9-]{1,120}$/ に一致する必要があります。

instrument
string 任意
swap

銘柄タイプ: future、option、swap、spot または margin。

次のいずれか: future option swap spot margin

position
string 任意
short

清算されたポジションのサイド: long または short。

次のいずれか: long short

order
string 任意
buy

清算を引き起こした約定サイド: buy または sell。

次のいずれか: buy sell

symbol
string 任意
BTC

取引所の instId に対する前方一致(例: BTC は BTC-USDT-SWAP に一致)。正規表現 /^[A-Za-z0-9$.-]{1,25}$/ に一致する必要があります。

min_usd
number 任意
1000

USD 値がこのしきい値以上の清算のみ。0 以上である必要があります。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/liquidations?page=1&per_page=50&exchange=okx&instrument=swap&position=short&order=buy&symbol=BTC&min_usd=1000" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

時間別清算

生フィードにわたる時間別のロング/ショートの USD 合計。生フィードは約48時間で削除されるため、hours は最大 48 に制限されます。ソースのカバレッジは現在 OKX のスワップマーケットです。

GET
http://localhost/api/v1/liquidations/hourly
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

hours
integer 任意
24

ルックバックウィンドウの時間数(1〜48、デフォルトは 24)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/liquidations/hourly?hours=24" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

日次清算

日次集計(永久保存)。日ごとに取引所/銘柄を横断して合算 — total/long/short の USD 額と、ロング/ショートのポジション数。当日の行は部分的で、約15分ごとに更新されます。ソースのカバレッジは現在 OKX のスワップマーケットです。

GET
http://localhost/api/v1/liquidations/daily
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

days
integer 任意
30

当日を含む暦日数(1〜365、デフォルトは 30)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/liquidations/daily?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

本日の清算サマリー

本日ここまで — total/long/short の USD、ポジション数、ロング対ショートの dominance。数値は部分的で、約15分ごとに更新されます。その日の最初の清算が記録されるまで data は null です。ソースのカバレッジは現在 OKX のスワップマーケットです。

GET
http://localhost/api/v1/liquidations/summary
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/liquidations/summary" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

清算のネットフロー

ウィンドウ内の 1 日あたりのロング対ショートの清算 USD フロー。ソースのカバレッジは現在 OKX のスワップマーケットです。

GET
http://localhost/api/v1/liquidations/netflow
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

days
integer 任意
30

当日を含む暦日数(1〜90、デフォルトは 30)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/liquidations/netflow?days=30" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

清算高トップのコイン

直近のウィンドウにおける清算高上位のコイン。コインごとのロング/ショートの USD 内訳付き。ソースのカバレッジは現在 OKX のスワップマーケットです。

GET
http://localhost/api/v1/liquidations/coins
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

hours
integer 任意
24

ルックバックウィンドウの時間数(1〜48、デフォルトは 24)。

limit
integer 任意
8

返すコインの数(1〜20、デフォルトは 8)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/liquidations/coins?hours=24&limit=8" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 エンドポイント

変換

有効な任意の 2 つのアセット(暗号資産と法定通貨の両方)間で変換し、変換の対象として使用できる通貨を一覧表示します。値は10進文字列です。法定通貨の為替レートは約1日2回、暗号資産のレートは約1分ごとに更新されます。

アセット間で変換

有効な任意の 2 つのアセット(暗号資産と法定通貨の両方)間のサーバーサイド変換。to は複数ターゲット変換のために CSV を受け付けます。逆変換は from/to を入れ替えるだけです。変換は線形なので value = unit_rate * amount です。法定通貨の為替レートは約1日2回、暗号資産のレートは約1分ごとに更新されます。

GET
http://localhost/api/v1/convert
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

from
string 必須
bitcoin

元アセットの slug。

to
string 必須
ethereum

対象アセットの slug(カンマ区切り、最大 10 件)。

amount
number 任意
2.5

変換する元アセットの数量(デフォルトは 1)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/convert?from=bitcoin&to=ethereum&amount=2.5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

法定通貨一覧

USD 為替レート付きの有効な法定通貨: rate_per_usd(USD あたりの単位数)とその逆数 usd_value。法定通貨の為替レートは約1日2回更新されます。

GET
http://localhost/api/v1/fiats
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/fiats" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

変換レート一覧

変換の対象として使用できる vs-currencies — 主要な法定通貨、コイン、トークン — それぞれ正規化された usd_value(1 単位あたりの USD)を持ちます。コイン/トークンの値は約1分ごとに更新され、更新の遅い法定通貨のレートは別途キャッシュされます(約1日2回)。

GET
http://localhost/api/v1/rates
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/rates" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 エンドポイント

計算ツール

Web ツールを再現したサーバーサイドの金融計算ツール: DCA、損益、ローン(キャッシュされたマーケットデータを読み取る)に加え、ステートレスな複利とステーキングの計算。

DCA 計算ツール

コインの実際の日次価格履歴に対するドルコスト平均法のバックテスト: startend の間で interval ごとに amount を 1 回購入します。購入ごとの完全な系列を含めるには series=true を渡します。

GET
http://localhost/api/v1/calculators/dca
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

amount
number 必須
100

購入ごとに費やす USD(0.01〜1,000,000,000)。

interval
string 必須
weekly

購入頻度: dailyweeklymonthlyquarterly または yearly

start
string 必須
2024-01-01

date 最初の購入日(2008-12-31 より後)。

end
string 任意
2025-01-01

date 最後の購入日(デフォルトは本日)。

series
boolean 任意
false

ペイロードに購入ごとの系列を含めます。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/calculators/dca?slug=bitcoin&amount=100&interval=weekly&start=2024-01-01&end=2025-01-01&series=" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

損益計算ツール

過去の 2 つの日付の間で「購入してから売却」した場合の結果。その日付でのコインの実際の価格を使用します。手数料はパーセントではなく定額の USD です。

GET
http://localhost/api/v1/calculators/profit-loss
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

amount
number 必須
1000

buy_date に投資した USD(0.01〜1,000,000,000)。

buy_date
string 必須
2023-01-01

date 購入日。

sell_date
string 必須
2025-01-01

date 売却日(buy_date 以降)。

buy_fee
number 任意
10

定額の購入手数料(USD、デフォルトは 0)。

sell_fee
number 任意
10

定額の売却手数料(USD、デフォルトは 0)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/calculators/profit-loss?slug=bitcoin&amount=1000&buy_date=2023-01-01&sell_date=2025-01-01&buy_fee=10&sell_fee=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

複利計算ツール

純粋な計算 — マーケットデータは使用しません。レートは年ごとではなく複利期間ごとに適用されることに注意してください(Web 計算ツールの慣例)。

GET
http://localhost/api/v1/calculators/compound-interest
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

principal
number 必須
10000

開始時の残高(USD)。

rate
number 必須
1

複利期間ごとの金利(%)。

duration
integer 必須
5

試算の期間(年数は最大 50 に制限されます)。

duration_unit
string 任意
years

years(デフォルト)または months

compound_frequency
string 任意
monthly

dailyweeklymonthly(デフォルト)、quarterly または annually

contribution
number 任意
100

定期的な入金額(USD、デフォルトは 0)。

contribution_frequency
string 任意
monthly

dailyweeklymonthly(デフォルト)、quarterly または annually

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/calculators/compound-interest?principal=10000&rate=1&duration=5&duration_unit=years&compound_frequency=monthly&contribution=100&contribution_frequency=monthly" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ローンと売却の比較計算ツール

暗号資産を担保に借り入れるか売却するか — コインの現在価格を使って両方のシナリオを比較します。情報提供を目的とした試算であり、投資助言ではありません。

GET
http://localhost/api/v1/calculators/loan
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

crypto_amount
number 必須
2

保有しているコインの数量。

needed_cash
number 必須
50000

確保する必要がある USD。

term_months
integer 任意
36

ローン期間(月数、デフォルトは 36)。

interest_rate
number 任意
10

ローンの APR(%、デフォルトは 10)。

ltv
number 任意
50

ローン・トゥ・バリュー比率(%、デフォルトは 50)。

expected_growth
number 任意
25

期間中に予想されるコイン価格の上昇率(%、デフォルトは 25)。

tax_rate
number 任意
25

売却に適用されるキャピタルゲイン税(%、デフォルトは 25)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/calculators/loan?slug=bitcoin&crypto_amount=2&needed_cash=50000&term_months=36&interest_rate=10&ltv=50&expected_growth=25&tax_rate=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

ステーキング報酬計算ツール

純粋な計算 — 任意の複利とバリデーター手数料を伴うステーキング報酬。マーケットデータは読み取りません。

GET
http://localhost/api/v1/calculators/staking
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

amount
number 必須
1000

ステーキングした数量(ステーキングしたアセットの単位)。

period
number 必須
2

ステーキング期間の長さ(50 年相当を上限とします)。

period_unit
string 任意
years

years(デフォルト)、months または days

apy
number 必須
5

表示された APY(%)。

compound_frequency
string 任意
monthly

neverdailyweeklymonthly(デフォルト)または yearly

commission
number 任意
10

バリデーター手数料(%、報酬から差し引かれます、デフォルトは 0)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/calculators/staking?amount=1000&period=2&period_unit=years&apy=5&compound_frequency=monthly&commission=10" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
8 エンドポイント

エディトリアル

エディトリアル記事 — 公開済み(ACTIVE)のみ。locale はコンテンツの言語を選択し、フィールドごとに英語へフォールバックします(ペイロードには実際に採用された locale が報告されます)。記事はタグ、または関連するコイン/取引所/ウォレットの slug でフィルターできます。API の読み取りは意図的に閲覧数を増加させません。

コインの動画

コインに紐づく厳選動画(コインページの動画タブ)。ページネーション対応。

GET
http://localhost/api/v1/coins/{slug}/videos
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。

per_page
integer 任意
10

1 ページあたりの行数(1〜50、デフォルトは 10)。

type
string 任意
review

動画タイプでフィルター(例: overviewtutorialexplainerreviewanalysisnews)。

search
string 任意
halving

タイトルでのフリーテキスト検索。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/videos?page=1&per_page=10&type=review&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

コインのインサイトタイムライン

コインのインサイトタイムライン — アセットページのインサイトパネルが使うのと同じペイロードで、offset/limit でウィンドウ化されます。

GET
http://localhost/api/v1/coins/{slug}/insights
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
bitcoin

コインの slug 識別子。

クエリパラメータ

locale
string 任意
en

コンテンツの言語(英語にフォールバックします)。

offset
integer 任意
0

スキップする行数(0〜500、デフォルトは 0)。

limit
integer 任意
5

返す行数(1〜50、デフォルトは 5)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/coins/bitcoin/insights?locale=en&offset=0&limit=5" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

記事一覧

公開済み記事(新しい順、ページネーション対応)。tag、関連する coin / exchange / wallet の slug、またはフリーテキストの search でフィルターできます。各行は概要(タイトル、サブタイトル、タグ、読了時間、ヒーロー画像、関連エンティティ、日付)です。

GET
http://localhost/api/v1/articles
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。

per_page
integer 任意
20

1 ページあたりの行数(1〜50、デフォルトは 20)。

locale
string 任意
en

コンテンツの言語(英語にフォールバックします)。

tag
string 任意
guide

タグでフィルター: news、guide、tutorial、explainer、analysis、review、trading、overview または information。

coin
string 任意
bitcoin

このコイン slug に関連する記事に絞り込みます。

exchange
string 任意
binance-exchange

この取引所 slug に関連する記事に絞り込みます。

wallet
string 任意
frostsnap

このウォレット slug に関連する記事に絞り込みます。

search
string 任意
halving

見出し/小見出しでのフリーテキスト検索。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/articles?page=1&per_page=20&locale=en&tag=guide&coin=bitcoin&exchange=binance-exchange&wallet=frostsnap&search=halving" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

記事を取得

公開済み記事 1 件。本文全体、タグ、ヒーロー画像、参考になったカウンター、関連エンティティを含みます。locale はコンテンツの言語を選択し、フィールドごとに英語へフォールバックします(ペイロードには実際に採用されたロケールが報告されます)。

GET
http://localhost/api/v1/articles/{slug}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
what-is-bitcoin

記事の slug。

クエリパラメータ

locale
string 任意
en

コンテンツの言語(英語にフォールバックします)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/articles/what-is-bitcoin?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

記事のフィードバックを送信

記事への高評価/低評価を登録します — Web の「参考になった」ボタンが使うのと同じカウンターです。キーごとのスロットリングが上流で適用されます。

POST
http://localhost/api/v1/articles/{slug}/feedback
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

slug
string 必須
what-is-bitcoin

記事の slug。

ボディパラメータ

helpful
boolean 必須
true

参考になった場合は true、参考にならなかった場合は false

リクエスト

curl --request POST \
    "http://localhost/api/v1/articles/what-is-bitcoin/feedback" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"helpful\": true
}"

動画を取得

厳選された動画 1 件。YouTube ID、タイトル、タイプ、再生時間、および紐づくコイン/取引所/ウォレットを含みます。

GET
http://localhost/api/v1/videos/{id}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

id
integer 必須
87

動画の id。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/videos/87" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

インサイト一覧

AI が生成したマーケットインサイト(ページネーション対応)。type、関連する coin slug、またはフリーテキストの search でフィルターできます。locale は見出し/要約の言語を選択し、英語にフォールバックします。

GET
http://localhost/api/v1/insights
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。

per_page
integer 任意
20

1 ページあたりの行数(1〜50、デフォルトは 20)。

locale
string 任意
en

コンテンツの言語(英語にフォールバックします)。

type
string 任意
per_asset

インサイトタイプでフィルター: per_assetmarket_overview または narrative

coin
string 任意
bitcoin

このコイン slug に関するインサイトに絞り込みます。

search
string 任意
etf

見出しでのフリーテキスト検索。

sort
string 任意
first_reported

ソート順: first_reported(デフォルト)または last_updated

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/insights?page=1&per_page=20&locale=en&type=per_asset&coin=bitcoin&search=etf&sort=first_reported" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

インサイトを取得

完全なペイロードを持つインサイト 1 件 — 見出し、要約、ソース記事のタイムライン、関連コイン。

GET
http://localhost/api/v1/insights/{id}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

id
integer 必須
101

インサイトの id。

クエリパラメータ

locale
string 任意
en

コンテンツの言語(英語にフォールバックします)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/insights/101?locale=en" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 エンドポイント

アラーム

価格アラームの CRUD — Web アプリが管理するのと同じアラームです。アラームはキー所有者のアラーム在庫残高を消費し、コインに対する TARGET タイプのみで、above/below と現在値のガードが即座に自己発火するアラームをブロックします。キースコープ(API キーが所有者を決定)で、レスポンスは決してキャッシュされません。

アラーム一覧

キー所有者のアラーム。新しい順、ページネーション対応。statusdirection、または notification チャネルでフィルターできます。

GET
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。

per_page
integer 任意
25

1 ページあたりの行数(1〜100、デフォルトは 25)。

status
string 任意
active

状態でフィルター: active または triggered

direction
string 任意
above

トリガー方向でフィルター: above または below

notification
string 任意
email

配信チャネルでフィルター: emailpush または webhook

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/alarms?page=1&per_page=25&status=active&direction=above&notification=email" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

アラームを作成

コインに TARGET アラームを作成し、キー所有者の残高からアラームスロットを 1 つ消費します。ターゲットはコインの現在値と照合され、アラームが即座に自己発火しないようになっています。above アラームは現在値より大きい値を、below アラームはより小さい値をターゲットにする必要があります。

POST
http://localhost/api/v1/alarms
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

ボディパラメータ

name
string 必須
BTC six figures

アラームのラベル(最大 255 文字)。

coin
string 必須
bitcoin

コインの slug 識別子。

metric
string 必須
rate

監視する指標: ratevolume または marketcap

direction
string 必須
above

トリガー方向: above または below

target
number 必須
100000

しきい値(コインの現在値に対して direction 側にある必要があります)。

notification
string 必須
email

配信チャネル: emailpush または webhook

リクエスト

curl --request POST \
    "http://localhost/api/v1/alarms" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"BTC six figures\",
    \"coin\": \"bitcoin\",
    \"metric\": \"rate\",
    \"direction\": \"above\",
    \"target\": 100000,
    \"notification\": \"email\"
}"

アラームを削除

キー所有者のアラームを 1 つ削除し、消費したアラームスロットを返却します。

DELETE
http://localhost/api/v1/alarms/{id}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

id
integer 必須
42

アラームの id。

リクエスト

curl --request DELETE \
    "http://localhost/api/v1/alarms/42" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
5 エンドポイント

Webhooks

Bitculator は各イベントを HMAC 署名ヘッダー付きの JSON として POST します:

X-Bitculator-Signature: t=<unix-ts>,v1=<hex hmac_sha256("<ts>.<raw-body>", secret)>
X-Bitculator-Event: alarm.triggered

エンドポイントシークレットを使って "." に対する HMAC を再計算し、定数時間で比較して検証してください。t が数分以上前のものであれば拒否してください(リプレイ対策)。例(PHP):

[$t, $v1] = sscanf($_SERVER['HTTP_X_BITCULATOR_SIGNATURE'], 't=%d,v1=%s');
$expected = hash_hmac('sha256', $t.'.'.file_get_contents('php://input'), $secret);
abort_unless(hash_equals($expected, $v1) && abs(time() - $t) < 300, 403);

サポートされるイベント: alarm.triggered。配信はバックオフ付きで 3 回リトライされます。エンドポイントは 10 回連続で配信に失敗すると自動的に無効化されます。

Webhook エンドポイント一覧

キー所有者の Webhook エンドポイント。新しい順。署名用シークレットは決して含まれません — 各シークレットは作成時に一度だけ表示されます。

GET
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Webhook エンドポイントを作成

イベント配信用の HTTPS エンドポイントを登録します(アカウントごとに最大 5 件)。レスポンスには署名用の secret が含まれます — これが表示される唯一の機会なので、すぐに保存してください。

POST
http://localhost/api/v1/webhooks
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

ボディパラメータ

url
string 必須
https://example.com/webhooks/bitculator

HTTPS の配信 URL。公開ホストのみ — 内部/プライベートアドレスは拒否されます。

events
string[] 必須
["alarm.triggered"]

購読するイベント。使用可能な値: alarm.triggered

リクエスト

curl --request POST \
    "http://localhost/api/v1/webhooks" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/example.com\\/webhooks\\/bitculator\",
    \"events\": [
        \"alarm.triggered\"
    ]
}"

Webhook エンドポイントを削除

キー所有者の Webhook エンドポイントを 1 つ削除します。そのエンドポイントへの保留中の配信は破棄されます。

DELETE
http://localhost/api/v1/webhooks/{id}
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

id
integer 必須
7

Webhook エンドポイントの id。

リクエスト

curl --request DELETE \
    "http://localhost/api/v1/webhooks/7" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

テストイベントを送信

署名付きの alarm.triggered テストイベント(ペイロードに test: true、実際の署名ヘッダー)を発火し、受信側をエンドツーエンドで検証できるようにします。

POST
http://localhost/api/v1/webhooks/{id}/test
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

id
integer 必須
7

Webhook エンドポイントの id。

リクエスト

curl --request POST \
    "http://localhost/api/v1/webhooks/7/test" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Webhook 配信ログ

エンドポイントの配信試行(30 日間保存)。新しい順、ページネーション対応。

GET
http://localhost/api/v1/webhooks/{id}/deliveries
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

パスパラメータ

id
integer 必須
7

Webhook エンドポイントの id。

クエリパラメータ

page
integer 任意
1

ページ番号(1 始まり)。

per_page
integer 任意
25

1 ページあたりの行数(1〜100、デフォルトは 25)。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/webhooks/7/deliveries?page=1&per_page=25" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
3 エンドポイント

メタ

API のメタ情報とイントロスペクション: キーとミドルウェアスタックを検証する認証済み ping、現在のキーの使用量/クォータ、機械可読な OpenAPI 仕様。

OpenAPI 仕様

この API の機械可読な OpenAPI 3 ドキュメント(JSON 形式) — コード生成や API ツールをこの URL に向けてください。パブリック: キー不要。

GET
http://localhost/api/v1/openapi.json
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/openapi.json" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Ping

Data API キーをエンドツーエンドで検証するための認証済みノーオペレーション(auth.api → プランごとのバーストスロットル → 月間クォータ)。他の呼び出しと同様にクォータを消費します。

GET
http://localhost/api/v1/ping
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/ping" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

キーの使用量とクォータ

呼び出し元キーの所有者に関する使用状況のイントロスペクション: Data API プラン、その月間上限、使用量と残量(常に X-Quota-* ヘッダーと一致)、現在の期間ウィンドウ、およびエンドポイントごと/トークンごとの内訳。埋め込みウィジェットの使用量には独自のプランとプールがあり、ここには一切表示されません。

GET
http://localhost/api/v1/usage
Bearer
bc_••••••••••••••••

キーは Bearer 専用で data-api 権限を持ちます — サーバーサイドで保管してください。

GET リクエスト — リクエストボディはありません。

リクエスト

curl --request GET \
    --get "http://localhost/api/v1/usage" \
    --header "Authorization: Bearer {YOUR_API_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"