バフェット・コードのブログ

企業分析に役立つ記事を配信中

Web API従量課金エンドポイントのご利用にあたって

ここでは、プレミアムプラン*1に含まれる従量課金の WEB API を利用する場合においてバフェットコードが推奨する利用方法について説明します。

なお、このページは従量課金エンドポイントの利用についての注意事項並びに推奨する利用方法を記載した補助的なものであり、ご利用前に利用規約については バフェットコード WEB API機能に関する特記事項 を必ず確認してください。

目次

 WEB API従量課金エンドポイントとは

バフェット・コードの提供するAPIのエンドポイントには、下記の2通りの課金体系が存在します。

  1. 料金がプレミアムプランの月額利用料金に含まれる、定額エンドポイント
  2. APIのリクエスト数に応じて都度料金が発生する、従量課金エンドポイント

定額エンドポイントについては、有効なAPI Token をお持ちの方であればプレミアムプランの月額利用料金以外の追加料金は発生しません。

一方、従量課金エンドポイントはエンドポイントごとに設定されたリクエスト数に対応した料金がプレミアムコースの月額利用料金に加えて発生します。

従量課金エンドポイントは、基本的に「対応する定額エンドポイントの強化版」として提供しています。例えば四半期毎の財務数値を取得する querater の場合、取得可能な期間に下記のような違いがあります(2020年12月現在)。

  • /api/v2/quarter(定額):直近5年分
  • /api/v2/ondemand/quarter(従量): バフェット・コードが所有する全期間 

従量課金エンドポイントの一覧

 /api/${API_VERSION}/ondemand/${DATA_NAME} の命名規則に従うものが従量課金エンドポイント、それ以外の /api/${API_VERSION}/${DATA_NAME} が定額のエンドポイントです *2

API Versionごとの従量課金エンドポイントは下記のとおりです。なお、API Version 1はすでにサポートを終了しています。

API Version 2 の従量課金エンドポイント

API Version 3 の従量課金エンドポイント

 

従量課金エンドポイントの利用状況を確認する

APIページで、従量課金エンドポイントの利用状況を確認いただけます。

f:id:shoe116:20201213183230p:plain

なお、APIの利用量は日次(タイムゾーンはUTC)で計算され、毎月の請求もその集計に従います。

従量課金エンドポイントの推奨利用方法

ここでは、従量課金エンドポイントの推奨される利用方法を

  1. プログラミング言語等を利用して、直接WEB APIを利用する場合(開発者向け)
  2. スプレットシートアドオン、エクセルアドイン等を利用して間接的にAPIを利用する場合

の2つに分けてご紹介します。

直接APIを利用する場合(開発者向け)

version、エンドポイントごとにバフェット・コード側で想定しているユースケースをご紹介します。

なお、2020年12月現在、サポート中のAPI versionは version 2 のみです。

API Version 2

Version 2では、/api/v2/ondemand/quarter(8.8円 /requests)のみがが従量課金のエンドポイントです。

定額エンドポイント /api/v2/quarter と従量課金エンドポイント /api/v2/ondemand/quarterは取得可能な期間のみが異なり、それぞれ

  • /api/v2/quarter(定額):直近5年分
  • /api/v2/ondemand/quarter(従量): バフェット・コードが所有する全期間

です。リクエスト方法、レスポンスの形式や取得できるデータの種類(カラム)は共通です。

なお、各銘柄(ticker)コードについて、定額・従量課金のエンドポイントでそれぞれ取得可能な四半期の範囲は企業情報エンドポイント (/api/v2/company)  から取得できる下記エンティティから参照できます。

  • 定額で取得可能な範囲:fixed_tier_range
  • 従量課金で取得可能な範囲:[oldest|latest]_fiscal_year, [oldest|latest]_fiscal_quarter 

定額で取得できる「直近5年」は、従量課金で取得できる「バフェット・コードの保有する全期間」に含まれているため、「企業情報エンドポイントを利用して銘柄ごとの fixed_tier_range を確認の上、定額で取得できない期間のみ従量課金エンドポイントを利用する」ことを推奨します。

API Version 3

Version 3では、 

が従量課金のエンドポイントです。

定額エンドポイントと従量課金エンドポイントは取得可能な期間のみが異なり、それぞれ

  • /api/v3/daily(定額):直近5年分
  • /api/v3/ondemand/daily(従量): バフェット・コードが所有する全期間

です。リクエスト方法、レスポンスの形式や取得できるデータの種類(カラム)は共通です。

なお、各銘柄(ticker)コードについて、定額・従量課金のエンドポイントでそれぞれ取得可能な四半期の範囲は企業情報エンドポイント (/api/v2/company)  から取得できる下記エンティティから参照できます。

  • 定額で取得可能な範囲:fixed_tier_range
  • 従量課金で取得可能な範囲:[oldest|latest]_fiscal_year, [oldest|latest]_fiscal_quarter 

定額で取得できる「直近5年」は、従量課金で取得できる「バフェット・コードの保有する全期間」に含まれているため、「企業情報エンドポイントを利用して銘柄ごとの fixed_tier_range を確認の上、定額で取得できない期間のみ従量課金エンドポイントを利用する」ことを推奨します。

スプレットシートアドオン、エクセルアドイン等を利用して間接的にAPIを利用する場合

スプレッドシートアドオン

設定から「従量課金APIを利用する」の設定にチェックを入れることで、必要に応じて従量課金エンドポイントBCODE関数で取得することができるようになります。

利用に際して、特に注意していただきたいのは下記の3点です

  • 昨日まで定額料金の範囲内だったもの(直近5年以内だったもの)が日付変わって今日には従量課金の対象(直近5年より前)になりえます。
  • 従量課金対象となるBCODE関数は、数値を取得後、値貼り付けで保存されることを強く推奨します。スプレッドシートは任意のタイミングで自動更新がかかるため、BCODE関数のままで残っていると知らぬ間に課金が発生する可能性があります。
  • スプレッドシートは他人に共有しないようにしてください。APIキーが設定されたままスプレッドシートが共有されることは利用規約で禁止されております*3。万が一、利用規約違反を知らず共有した場合でも、共有先の相手が従量課金の対象となるBCODE関数の存在を知らずにスプレッドシートを更新するなど、従量課金APIが稼働するとご契約者(あなた)に課金がなされます。
エクセルアドオン

現在鋭意開発中です、もうしばらくお待ち下さい

FAQ

従量課金APIのレスポンスがエラーの場合、課金されますか?

レスポンスがエラーの場合、課金されません。

従量課金の利用料の請求はいつ、どのように行われますか?

翌月中旬にバフェット・コード契約時に登録されたクレジットカードに請求されます。従量課金用に専用の支払い方法を登録することはできません。

スプレッドシートアドオン、エクセルアドオンで従量課金エンドポイントを利用したいです

スプレッドシートアドオンのみ対応しています。

開発したプログラミングにバグが有り、意図しない従量課金エンドポイントの利用が発生してしまいました

 バフェットコード WEB API機能に関する特記事項 に記載のとおり、意図しないリクエストでも返金等は行いません。

意図するとしないとに関わらず、BC内のデータが本APIを利用して呼び出されたと当社が判定するものについては、1リクエストとみなし、従量課金ユーザーは取消すことができません。

定額のエンドポイントを利用し、十分デバッグを行うことを推奨します。

API Token が流出し、第三者よる従量課金エンドポイントの利用が行われました

バフェットコード WEB API利用規約に記載の通り、API Tokenの流出による返金は行いません。API Tokenの管理にはくれぐれもご注意ください。

トークン等の管理不十分、使用上の過誤、第三者の使用等による損害の責任はPremium会員が負うものとし、当社は一切の責任を負いません。

Premium会員は、トークン等が盗まれたり、第三者に使用されていることが判明した場合には、直ちにトークン等の再発行を自ら行うものとします。 

共有したスプレッドシートから、第三者よる従量課金エンドポイントの利用が行われました

API Tokenを設定したままスプレッドシートを共有することは、「トークンの貸与」にあたり、バフェットコード WEB API利用規約で禁止されています。第三者による従量課金エンドポイントの料金も、すべてトークンの管理者に請求されます。

注釈等

*1:プランについては下記をご参照ください

 

blog.buffett-code.com

 

*2:各エンドポイントの詳細については BuffettCode API ドキュメント をご参照ください

*3: バフェットコード WEB API利用規約 第5条 (トークン等の取得手続と管理について)をご参照ください