> ## 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 のリアルタイムニュース記事および更新情報。
## 概要
リアルタイムのニュース配信を購読し、新しい記事の公開や既存の記事の更新を即座に通知として受け取ることができます。
### 主な機能
* **リアルタイム更新**: ニュース記事が公開または更新されると、即座に通知を受け取れます
* **銘柄によるフィルタリング**: 特定の ticker や ISIN を購読し、関連するニュースだけを受信できます
* **包括的なデータ**: 記事の content、著者情報、画像、および関連する証券情報を提供します
* **アクションの追跡**: 記事の作成・更新・削除のタイミングを監視できます
### ユースケース
* 特定の証券向けのリアルタイムニュースフィードを構築する
* ポートフォリオ銘柄に関する速報ニュースのアラートを作成する
* 複数のティッカーにまたがるニュースを集約する
* 取引シグナル向けにニュースのセンチメントと件数を追跡する
## クイックスタート
上部のインタラクティブなウェブソケットテスターを使用して接続し、ストリームをリアルタイムにテストしてください。
### 接続 URL
```
wss://api.benzinga.com/api/v1/news/stream?token=YOUR_TOKEN
```
### クエリパラメータ
| Parameter | Required | Description |
| ---------- | -------- | ------------------------------------------------- |
| `token` | Yes | Benzinga ウェブソケット API 用のトークン (bz.production\*\*\*) |
| `tickers` | No | ティッカーシンボルのカンマ区切りリスト (例: `AAPL,MSFT`) |
| `channels` | No | フィルタリングに使用するニュースチャンネルのカンマ区切りリスト |
## メッセージの例
```json theme={null}
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"api_version": "websocket/v1",
"kind": "news",
"data": {
"action": "created",
"id": 36444586,
"timestamp": "2024-01-01T13:35:14Z",
"content": {
"id": 36444586,
"author": "Benzinga Insights",
"created": "Mon, 01 Jan 2024 13:35:14 -0400",
"updated": "Mon, 01 Jan 2024 13:35:15 -0400",
"title": "10 Information Technology Stocks With Whale Alerts In Today's Session",
"teaser": "",
"body": "Full article content...",
"url": "https://www.benzinga.com/markets/options/24/01/36444586/...",
"image": [
{
"size": "thumb",
"url": "https://cdn.benzinga.com/files/imagecache/250x187xUP/..."
}
],
"channels": [
{
"name": "Options"
}
],
"stocks": [
{
"name": "AAPL",
"cusip": "037833100",
"isin": "US0378331005",
"exchange": "NASDAQ"
}
],
"tags": [
{
"name": "BZI-AUOA"
}
]
}
}
}
```
### メッセージアクション
| アクション | 説明 |
| --------------------- | ------------- |
| `created` / `Created` | 新しい記事が公開されたとき |
| `updated` / `Updated` | 既存の記事が更新されたとき |
| `deleted` / `Deleted` | 記事が削除されたとき |
## インタラクティブコマンド
| Command | Description |
| -------- | -------------------------------- |
| `ping` | 接続を維持します（`pong` で応答します） |
| `replay` | 直近のキャッシュ済みメッセージを最大 100 件まで再送信します |
## ベストプラクティス
* **重複排除**: 重複したメッセージを処理しないように `id` フィールドを使用する
* **ハートビート**: 接続を維持するために 30〜60 秒ごとに `ping` コマンドを送信する
* **エラー処理**: 指数バックオフを用いた再接続ロジックを実装する
* **フィルタリング**: 帯域幅を削減するために ticker/チャネルのフィルターを使用する
## AsyncAPI
````yaml asyncapi/news-stream.yml news
id: news
title: News
description: Send action commands; receive real-time news updates
servers:
- id: production
protocol: wss
host: api.benzinga.com/api/v1/news
bindings: []
variables: []
address: stream
parameters: []
bindings: []
operations:
- &ref_2
id: news.publish
title: News.publish
description: Send commands to the server
type: receive
messages:
- &ref_4
id: publish
contentType: text/plain
payload:
- type: string
enum: &ref_0
- ping
- replay
description: Send action commands (ping, replay)
x-parser-schema-id:
name: publish
headers: []
jsonPayloadSchema:
type: string
enum: *ref_0
description: Action to perform (ping for heartbeat, replay for message history)
x-parser-schema-id:
title: Publish
description: Send action commands (ping, replay)
example: '{}'
bindings: []
extensions:
- id: x-parser-unique-object-id
value: publish
- id: x-parser-message-name
value: ActionRequest
bindings: []
extensions: &ref_1
- id: x-parser-unique-object-id
value: news
- &ref_3
id: news.subscribe
title: News.subscribe
description: Receive real-time news updates
type: send
messages:
- &ref_5
id: subscribe
contentType: application/json
payload:
- name: News Update
description: A news article or update message
type: object
properties:
- name: id
type: string
description: Unique message identifier
required: false
- name: api_version
type: string
description: API version
required: false
- name: kind
type: string
description: Message type
required: false
- name: data
type: object
required: false
properties:
- name: action
type: string
description: Action type
enumValues:
- created
- updated
- deleted
required: false
- name: id
type: integer
description: News article ID
required: false
- name: timestamp
type: string
description: Message timestamp
required: false
- name: content
type: object
required: false
properties:
- name: id
type: integer
description: Article ID
required: false
- name: author
type: string
description: Article author
required: false
- name: created
type: string
description: Article creation timestamp
required: false
- name: updated
type: string
description: Article update timestamp
required: false
- name: title
type: string
description: Article headline
required: false
- name: teaser
type: string
description: Article teaser text
required: false
- name: body
type: string
description: Full article body
required: false
- name: url
type: string
description: Article URL
required: false
- name: image
type: array
required: false
properties:
- name: size
type: string
required: false
- name: url
type: string
required: false
- name: channels
type: array
required: false
properties:
- name: name
type: string
required: false
- name: stocks
type: array
required: false
properties:
- name: name
type: string
required: false
- name: cusip
type: string
required: false
- name: isin
type: string
required: false
- name: exchange
type: string
required: false
- name: tags
type: array
required: false
properties:
- name: name
type: string
required: false
headers: []
jsonPayloadSchema:
type: object
properties:
id:
type: string
description: Unique message identifier
x-parser-schema-id:
api_version:
type: string
description: API version
example: websocket/v1
x-parser-schema-id:
kind:
type: string
description: Message type
example: news
x-parser-schema-id:
data:
type: object
properties:
action:
type: string
description: Action type
enum:
- created
- updated
- deleted
x-parser-schema-id:
id:
type: integer
description: News article ID
x-parser-schema-id:
timestamp:
type: string
format: date-time
description: Message timestamp
x-parser-schema-id:
content:
type: object
properties:
id:
type: integer
description: Article ID
x-parser-schema-id:
author:
type: string
description: Article author
x-parser-schema-id:
created:
type: string
description: Article creation timestamp
x-parser-schema-id:
updated:
type: string
description: Article update timestamp
x-parser-schema-id:
title:
type: string
description: Article headline
x-parser-schema-id:
teaser:
type: string
description: Article teaser text
x-parser-schema-id:
body:
type: string
description: Full article body
x-parser-schema-id:
url:
type: string
description: Article URL
x-parser-schema-id:
image:
type: array
items:
type: object
properties:
size:
type: string
x-parser-schema-id:
url:
type: string
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
channels:
type: array
items:
type: object
properties:
name:
type: string
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
stocks:
type: array
items:
type: object
properties:
name:
type: string
x-parser-schema-id:
cusip:
type: string
x-parser-schema-id:
isin:
type: string
x-parser-schema-id:
exchange:
type: string
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
tags:
type: array
items:
type: object
properties:
name:
type: string
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
x-parser-schema-id:
title: News Update
description: A news article or update message
example: No examples found
bindings: []
extensions:
- id: x-parser-unique-object-id
value: subscribe
bindings: []
extensions: *ref_1
sendOperations:
- *ref_2
receiveOperations:
- *ref_3
sendMessages:
- *ref_4
receiveMessages:
- *ref_5
extensions:
- id: x-parser-unique-object-id
value: news
securitySchemes:
- id: tokenAuth
name: token
type: httpApiKey
description: Benzinga WebSocket API token (bz.production***)
in: query
extensions: []
````