> ## Documentation Index
> Fetch the complete documentation index at: https://docs.benzinga.com/llms.txt
> Use this file to discover all available pages before exploring further.

# イントロダクション

> Benzinga のウェブソケット API を使ったリアルタイムデータストリーミングの簡単な紹介。

Benzinga ウェブソケット API のドキュメントへようこそ。このガイドでは、Benzinga のリアルタイムデータストリームへのアクセスを開始する方法を説明します。これにより、マーケットのリアルタイム気配値、約定、ニュースなどの重要なインサイトを含む金融データの継続的な更新を購読して受信できるようになります。

<div id="websocket-endpoint">
  ## ウェブソケットエンドポイント
</div>

すべてのウェブソケット接続は、以下のエンドポイントを使用して確立できます。

```
wss://api.benzinga.com
```

<div id="authentication">
  ## 認証
</div>

Benzinga ウェブソケット API では Bearer 認証が必要です。ウェブソケット接続を開始する際は、接続 URL のクエリパラメータとして、次の形式で API トークンを指定してください。
`token` クエリパラメータに、`token: <token>` という形式で必ず API トークンを含める必要があります。

API トークンの取得と管理の詳細については、[Authentication](./authentication) ページを参照してください。

<div id="subscribing-to-streams">
  ## ストリームの購読
</div>

接続が確立されたら、株価気配、約定データ、ニュース更新など、要件に応じて特定のデータストリームを購読できます。各購読には、一意の識別子と、データ種別に応じた特定のパラメータが必要です。

<div id="example-subscription-message">
  ### 購読メッセージの例
</div>

リアルタイム株価ストリームを購読するには、以下の形式の JSON メッセージを送信します。

```json theme={null}
{
  "action": "subscribe",
  "symbol": "AAPL",
  "type": "quote"
}
```

<div id="heartbeat-mechanism">
  ## ハートビートメカニズム
</div>

健全な接続を維持し、クライアントとサーバー間の同期を確保するために、Benzinga のウェブソケット API にはハートビートメカニズムが実装されています。

<div id="client-side-heartbeat">
  ### クライアント側ハートビート
</div>

* ping メッセージをプレーンテキストフレームとして送信した場合（例: 文字列 ping）、サーバーはプレーンテキストの pong メッセージで応答します（例: 文字列 pong）。

* これは、接続が引き続き有効で応答していることを確認するために使用できます。

<div id="example">
  #### 例
</div>

* クライアントは `ping` を送信

* サーバーは `pong` と応答

<div id="server-side-heartbeat">
  ### サーバー側のハートビート
</div>

* サーバーは接続がアクティブな状態であることを確認するため、10秒ごとにクライアントへ `ping` フレームを自動送信します。

* クライアントはこの `ping` フレームに応答する必要があります（ほとんどのウェブソケットライブラリでは自動的に処理されます）。

<div id="handling-heartbeats">
  ### ハートビートの処理
</div>

* ほとんどのウェブソケットクライアントライブラリ（JavaScript、Python、Go など）は、サーバーから送信される ping を自動的に処理し、pong で応答します。

* ただし、独自にウェブソケットクライアントを実装する場合は、接続が切断されるのを防ぐために、サーバーの ping フレームに正しく応答するようにしてください。

<div id="rate-limiting">
  ## レート制限
</div>

Benzinga API には、不正利用の防止とサービスの安定性を維持するためのレート制限があります。1 つの API トークンにつき、同時に許可される接続は 1 つのみです。レート制限を超過した場合は、エラーレスポンスが返されます。

***

このガイドが Benzinga API の利用開始に役立てば幸いです。ご不明な点がありましたら、遠慮なくサポートチームまでお問い合わせください。