メインコンテンツへスキップ
WSS
stream

Documentation Index

Fetch the complete documentation index at: https://benzinga-2-locadex-parallel-main.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
概要

証券の強気・弱気シナリオに関するリアルタイム分析を購読できます。株式についてのポジティブ（強気）およびネガティブ（弱気）双方のシナリオに対するバランスの取れた見解を得ることができます。

​
主な機能

  • バランスの取れた分析: 強気・弱気双方のケースを受け取り、市場を多角的に把握できます
  • リアルタイム更新: ケースが作成・更新・削除された際に即時に通知を受け取ります
  • 銘柄でフィルタリング: 特定の ticker や ISIN を対象に購読できます
  • 市場センチメント: 楽観的・悲観的な双方の見解を把握できます

​
ユースケース

  • 賛否両論を可視化するセンチメント分析ダッシュボードを構築する
  • 強気／弱気センチメントの変化を時間の経過とともに追跡する
  • 市場に対する見方の大きな変化をユーザーに通知する
  • クライアントにバランスの取れた投資リサーチを提供する

​
クイックスタート

上部のインタラクティブなウェブソケットテスターを使用して、リアルタイムで接続およびストリームのテストを行ってください。

​
接続 URL

wss://api.benzinga.com/api/v1/bulls_bears_say/stream?token=YOUR_TOKEN

​
クエリパラメータ

ParameterRequiredDescription
tokenYesBenzinga ウェブソケット API のトークン (bz.production***)
tickersNoティッカーシンボルのカンマ区切りリスト（例: AAPL,TSLA）
isinsNoフィルタリングに使用する ISIN（国際証券識別番号）のカンマ区切りリスト

​
メッセージ例

{
  "id": "websocket123",
  "api_version": "websocket/v1",
  "kind": "bull_bear_case",
  "data": {
    "action": "created",
    "id": "case123",
    "timestamp": "2024-10-01T10:00:00Z",
    "content": {
      "bull_case": "Strong earnings growth and market expansion expected.",
      "bear_case": "Increased competition and regulatory pressures.",
      "ticker": "AAPL",
      "updated": 1696153200
    }
  }
}

​
メッセージのアクション

アクション説明
created / Created新しい強気/弱気のケースが公開された
updated / Updated既存のケースが変更された
deleted / Deletedケースが削除された

​
インタラクティブコマンド

CommandDescription
ping接続を維持します（pong を返します）
replayキャッシュされた直近最大100件のメッセージを再送信します

​
ベストプラクティス

  • 重複排除: メッセージの重複処理を防ぐために id フィールドを使用する
  • ハートビート: 30〜60秒ごとに ping コマンドを送信する
  • バランスの取れた表示: 公平な分析のために、強気・弱気の両方のケースを表示する
  • 更新監視: 最新の変更を特定するために updated タイムスタンプを監視する
Messages
token
type:httpApiKey

Benzinga WebSocket API token (bz.production***)

publish
type:string

Send action commands (ping, replay)

subscribe
type:object

Bull/Bear case event