DN-01SOON

Market Data API

第二期での公開に先立ち、REST / JSON、認証、データセットの予定仕様を技術プレビューとして掲載しています。

Endpoint
api.arcaneflux.com/v1/market-data
Protocol
REST / JSON
Metering
Request based

01 / QUICKSTART

最初の価格データを取得

Bearer API key を設定し、Quotes エンドポイントから JSON レスポンスを確認します。

始める前に

  • Market Data API を利用できるアカウント
  • Market Data API を許可した API キー
  • curl と JSON を確認できる環境

1. API キーを設定

SHELL
export ARCANEFLUX_API_KEY="your_api_key"
export ARCANEFLUX_BASE_URL="https://api.arcaneflux.com/v1/market-data"

2. Bearer authentication

すべてのリクエストで Authorization ヘッダーへ API key を設定します。

HTTP
Authorization: Bearer $ARCANEFLUX_API_KEY

3. Quotes を取得

CURL
curl "$ARCANEFLUX_BASE_URL/quotes" \
  --get \
  --data-urlencode "symbols=BTC-USD" \
  -H "Authorization: Bearer $ARCANEFLUX_API_KEY"

4. レスポンスを確認

  • HTTP ステータスと Content-Type
  • 銘柄識別子、値、タイムスタンプ
  • レスポンスの request ID
  • コンソールに記録された呼び出し数

02 / DATASETS

Datasets

Quotes、Markets、History の用途と更新の前提を確認します。
代表的なデータセット
DatasetPurposeUpdate
Quotes銘柄ごとの最新値と時刻公開データセット仕様に従う
Markets利用可能な市場と銘柄定期更新
History指定期間の時系列データ対象範囲に従う

03 / OPERATIONS

Usage & quota

呼び出し数は API キーと期間から確認します。

レスポンスの request ID と時間帯を記録すると、利用量とエラーを同じ条件で照合できます。

Limits

Rate limit と月間呼び出し数はプランと API キーの Quota によって異なります。

429 の判定
HTTPcodeAction
429rate_limit_exceededRetry-After 後に再試行
429insufficient_quota残高またはプランを確認

04 / API REFERENCE

API Reference

代表的なパス、必須パラメータ、Bearer 認証とエラーを確認します。

Base URL

TEXT
https://api.arcaneflux.com/v1/market-data

Endpoints

代表的なエンドポイント
MethodPathPurpose
GET/quotes指定した銘柄の最新値を取得
GET/markets市場と利用可能な銘柄を取得
GET/history期間を指定して時系列を取得

ページネーション、日時形式、銘柄識別子、必須パラメータは公開時の API 定義を確認してください。

Errors

共通エラー
HTTPcodeClient action
401invalid_api_keyBearer key を確認
403subscription_requiredMarket Data API を開通
404unknown_productBase URL とパスを確認
502upstream_errorrequest ID を保存して再試行
504upstream_timeouttimeout と再試行上限を確認

05 / SUPPORT

Frequently asked questions

データが取得できない場合は認証、対象銘柄、時間範囲を順に確認します。
銘柄が見つからない

Markets で利用可能な識別子と対象市場を確認します。

値の時刻が想定と違う

タイムゾーン、更新頻度、対象データセットの仕様を確認します。

06 / RELEASE NOTES

Dataset updates

対象市場、更新頻度、履歴範囲の変更をこの章へ追記します。