メインコンテンツへスキップ
Benzinga の ウェブソケット API は、低レイテンシのプッシュ型金融データをアプリケーションへ直接配信します。REST エンドポイントを繰り返しポーリングする代わりに、単一の永続接続を開いておくだけで、アナリストのレーティング、決算結果、ニュース、トランスクリプトなどのイベントを、利用可能になった瞬間に受信できます。 すべてのストリームは同じベースエンドポイント、認証モデル、メッセージエンベロープを共有しているため、あるストリームで習得したパターンは他のすべてのストリームにも適用できます。

​
動作概要

1

認証

Benzinga Console から Benzinga API トークンを取得し、接続を開く際に token クエリパラメータとして付与します。
2

接続

必要なデータ用のストリーム URL に対してウェブソケット接続を開きます。たとえば wss://api.benzinga.com/api/v1/analyst/insights/stream?token=YOUR_TOKEN などです。
3

イベントの受信

メッセージは一貫した構造の JSON オブジェクトとして送信されます。id、api_version、kind と、アクション (created、updated、deleted のいずれか) およびペイロードを含む data ブロックで構成されます。
4

接続を維持する

ping プレーンテキストフレームを定期的に (30～60 秒ごとに) 送信します。サーバーは pong で応答します。サーバー側からも 10 秒ごとに ping が送信されますが、ほとんどのウェブソケットライブラリが自動的に処理します。

​
利用可能なストリーム

Analyst Insights

公開と同時に配信されるアナリストのレーティング、目標株価、詳細な推奨情報。

Ratings

大手機関からのアナリストレーティングの変更および目標株価の更新。

Consensus Ratings

追跡対象のすべてのアナリストを集約したコンセンサスレーティングと目標株価。

Earnings

EPS、売上高、予想値、サプライズ指標を含む決算発表。

Bulls/Bears Say

各銘柄に対する強気・弱気シナリオをリアルタイムに配信。

News

Benzingaの編集チームによる速報ニュース記事および市場アップデート。

Earnings Call Transcripts

発言と同時に文単位で配信される決算説明会のライブ書き起こし。

​
メッセージエンベロープ

すべてのストリームメッセージは、同一のトップレベル構造を持ちます。 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "api_version": "websocket/v1",
  "kind": "<stream-type>",
  "data": {
    "action": "created",
    "id": "<record-id>",
    "timestamp": "2024-10-08T10:00:00Z",
    "content": { ... }
  }
}
FieldDescription
id一意のメッセージ ID — 再接続時の重複排除に使用します
api_versionメッセージのプロトコルのバージョン
kindメッセージがどのストリームから来たかを識別します
data.actioncreated、updated、deleted のいずれか
data.contentストリーム固有のペイロード

​
リファレンスページ

認証

API トークンの取得および使用方法。

サポートされているアクション

どのストリームにも送信できる ping および replay コマンド。

エラー

エラーコードと接続障害の対処方法。