API仕様
BudgetHub の資産設定で保存したカスタムAPIは、資産種別ごとに同じ基本形式で呼び出されます。 ここでは、現在のアプリ実装で扱うリクエストとレスポンスの条件を案内します。
リクエスト形式
カスタムAPIには GET でアクセスします。
GET {endpointURL}?symbol={SYMBOL}&apikey={APIKEY}
APIキー が入力されている場合は、クエリに加えて次のヘッダーも送信します。
X-API-Key: {APIKEY}
Authorization: Bearer {APIKEY}
APIキー を空で保存している場合は、ヘッダーは付きません。
レスポンス形式
レスポンスは JSON を想定しています。現在価格としては、次のいずれかのフィールド名を認識します。
| 項目 | 対応フィールド |
|---|---|
| 現在価格 | price, close, c, last, current, latestPrice, regularMarketPrice |
| 通貨 | currency |
| 前日終値 | previousClose, pc |
| 前月比較用 | previousMonth |
| 前年比較用 | previousYear |
レスポンス例
基本形
{
"price": 150.25,
"currency": "USD",
"previousClose": 149.80
}
ネストされた形
トップレベルまたは1階層目のオブジェクト内にある項目を認識します。
{
"data": {
"price": 150.25,
"currency": "USD"
}
}
よくあるエラー
401 / 403: APIキーが無効、またはアクセス権限がありません。404: エンドポイントURLまたはシンボルが正しくありません。429: APIの利用回数制限に達しています。- 価格が表示されない: レスポンスに価格フィールドが含まれていない可能性があります。
関連ページ
このページはアプリの現在実装に合わせた仕様です。外部API側の仕様が異なる場合は、BudgetHub が認識できる形に整えてご利用ください。