クライアントを設定する
Node 22以降を使い、サーバー環境に NARWHAL_API_KEY を設定してください。APIキーをブラウザのコードに入れないでください。パッケージをインストールしてクライアントを作成します。クイックスタートをご覧ください。
// npm install narwhalapi
import { Narwhal } from "narwhalapi";
// Reads NARWHAL_API_KEY from the server environment.
const nw = new Narwhal();短期利回りから市場金利を取得する
短期国債利回りを市場金利としてリクエストします。3か月物の利回りは、情報源が公表している場合に利用できます。利用できる年限は国や日付によって異なり、ない年限は省略されます。10進数の値は正確な文字列で返され、10進数の入力に数値は使えません。
const short = await nw.economics.yieldCurve("GBR", { maturity: ["3m", "2y"] }); for (const point of short.yields) { console.log(point.maturity, point.yield_percent); }市場織り込みの政策パスを読み取る
イングランド銀行の市場織り込み政策金利パスをリクエストします。各会合には、確率を示す文字列の p_cut、p_hold、p_hike に加えて、expected_change_bps、cumulative_change_bps、resolves_at が含まれます。これらは公式の予測ではなく、予測市場のオッズです。
const path = await nw.predictions.policyPath("bank-of-england"); for (const meeting of path.meetings) { console.log(meeting.resolves_at, meeting.p_cut, meeting.p_hold, meeting.p_hike); }よくある質問
中央銀行の現在の政策金利を取得できますか?
いいえ。Narwhalには現在の公定政策金利のエンドポイントはありません。短期国債利回りと、今後の政策会合に対する市場織り込みの確率は取得できます。
3か月物の利回りがないのはなぜですか?
利用できる年限は、国の情報源と指定した日付によって異なります。ない年限は省略されるため、3か月物の利回りは情報源が公表している場合にのみ返されます。
ほかにどの政策当局を照会できますか?
ほかの当局には bank-of-canada、bank-of-japan、bank-indonesia があります。これらの政策パスは、公式の予測ではなく予測市場のオッズを反映しています。
公開日： 。最終確認日： 。