Stock Events

Stock Events

Stock Events APIを使ってみよう

Stock Events APIは、自分のツールからStock Eventsアカウントのデータを自動化するためのPro向け機能だよ。これはアカウントの自動化を目的として設計されていて、一般的な市場データやシンボル検索用のAPIではないから注意してね。

書き込みリクエストを行うと、Stock Eventsで見ているのと同じウォッチリスト、シンボル、取引内容が更新されるよ。

APIでできること

  • ウォッチリストの一覧表示、作成、取得、更新。
  • ウォッチリスト内のシンボルの表示、追加、更新、削除。
  • 取引（transactions）の一覧表示、作成、取得、更新、削除。
  • 計算済みの保有資産（Holdings）と配当（Dividends）ビューの読み取り。

APIキーの作成方法

APIキーを作成して使うには、有効なStock Events Proサブスクリプションが必要だよ。

  1. Stock Eventsのウェブアプリにサインインしてね。
  2. プロフィールを開こう。
  3. 設定を選択して。
  4. セクションにあるデータを選択。
  5. API Keysを選択。
  6. Create API keyを選択。
  7. 分かりやすい名前を入力して、作成を選択。
  8. Copy API keyを選択して、ダイアログを閉じる前にキーを安全な場所に保存しておいてね。

完全なAPIキーが表示されるのは一度きりだよ。ダイアログを閉じると、API Keys画面には完全なキーの代わりに、名前、プレフィックス、作成日、最終使用日が表示されるようになるんだ。

もしProサブスクリプションが無効になった場合、キーはアカウントに紐付いたままだけど、Proアクセスが再び有効になるまでAPIリクエストは403 Forbiddenを返すようになるよ。

最初のリクエストを送ってみよう

APIのベースURLは https://stockevents.app/api/v1 だよ。APIキーは Authorization ヘッダーにBearerトークンとして送ってね。

curl -H "Authorization: Bearer $STOCK_EVENTS_API_KEY" \  
  https://stockevents.app/api/v1/watchlists

このリクエストで、ウォッチリストとそのIDが返ってくるよ。ウォッチリストのIDを使えば、そのリスト専用のシンボル、保有資産、配当のエンドポイントが使えるようになるんだ。

リクエストのフィールド、レスポンスの構造、オプションのパラメータ、利用可能なすべてのエンドポイントについては、以下のリソースをチェックしてね：

APIキーを安全に保つために

APIキーはパスワードと同じように扱ってね。ソース管理にコミットしたり、公開されているクライアントコードにさらしたり、クエリパラメータやリクエストボディで送ったりしないでね。

APIキーは、個別の権限設定なしにアカウント自動化APIを認証するものだよ。信頼できるツールでのみ使用するようにしよう。

もしキーが漏洩してしまったら、API Keysに戻って、Revoke API keyを選択し、Revokeで確定してね。キーはすぐに使えなくなり、再有効化はできないよ。必要に応じて新しいキーを作成してね。

よくあるエラー

  • 401 Unauthorized: APIキーが見つからない、無効、または失効している。
  • 403 Forbidden: アカウントに現在有効なProアクセス権がない。