> ## 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.

# News Stream

> Real-time news articles and updates from Benzinga.

## Overview

Subscribe to real-time news updates and receive instant notifications when new articles are published or existing articles are updated.

### Key Features

* **Real-time Updates**: Get instant notifications when news articles are published or updated
* **Filter by Security**: Subscribe to specific tickers or ISINs to receive only relevant news
* **Comprehensive Data**: Includes article content, author information, images, and associated securities
* **Action Tracking**: Monitor when articles are created, updated, or removed

### Use Cases

* Build real-time news feeds for specific securities
* Create alerts for breaking news on portfolio holdings
* Aggregate news across multiple tickers
* Track news sentiment and volume for trading signals

## Quick Start

Use the interactive WebSocket tester above to connect and test the stream in real-time.

### Connection URL

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

### Query Parameters

| Parameter  | Required | Description                                                |
| ---------- | -------- | ---------------------------------------------------------- |
| `token`    | Yes      | Your Benzinga WebSocket API token (bz.production\*\*\*)    |
| `tickers`  | No       | Comma-separated list of ticker symbols (e.g., `AAPL,MSFT`) |
| `channels` | No       | Comma-separated list of news channels to filter            |

## Message Example

```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"
        }
      ]
    }
  }
}
```

### Message Actions

| Action                | Description               |
| --------------------- | ------------------------- |
| `created` / `Created` | New article published     |
| `updated` / `Updated` | Existing article modified |
| `deleted` / `Deleted` | Article removed           |

## Interactive Commands

| Command  | Description                                  |
| -------- | -------------------------------------------- |
| `ping`   | Keep connection alive (responds with `pong`) |
| `replay` | Replay up to the last 100 cached messages    |

## Best Practices

* **Deduplication**: Use the `id` field to prevent processing duplicate messages
* **Heartbeat**: Send `ping` commands every 30-60 seconds to maintain connection
* **Error Handling**: Implement reconnection logic with exponential backoff
* **Filtering**: Use ticker/channel filters to reduce bandwidth


## 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: <anonymous-schema-1>
            name: publish
        headers: []
        jsonPayloadSchema:
          type: string
          enum: *ref_0
          description: Action to perform (ping for heartbeat, replay for message history)
          x-parser-schema-id: <anonymous-schema-1>
        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
                      - name: channels
                        type: array
                        required: false
                      - name: stocks
                        type: array
                        required: false
                      - name: tags
                        type: array
                        required: false
        headers: []
        jsonPayloadSchema:
          type: object
          properties:
            id:
              type: string
              description: Unique message identifier
              x-parser-schema-id: <anonymous-schema-3>
            api_version:
              type: string
              description: API version
              example: websocket/v1
              x-parser-schema-id: <anonymous-schema-4>
            kind:
              type: string
              description: Message type
              example: news
              x-parser-schema-id: <anonymous-schema-5>
            data:
              type: object
              properties:
                action:
                  type: string
                  description: Action type
                  enum:
                    - created
                    - updated
                    - deleted
                  x-parser-schema-id: <anonymous-schema-7>
                id:
                  type: integer
                  description: News article ID
                  x-parser-schema-id: <anonymous-schema-8>
                timestamp:
                  type: string
                  format: date-time
                  description: Message timestamp
                  x-parser-schema-id: <anonymous-schema-9>
                content:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Article ID
                      x-parser-schema-id: <anonymous-schema-11>
                    author:
                      type: string
                      description: Article author
                      x-parser-schema-id: <anonymous-schema-12>
                    created:
                      type: string
                      description: Article creation timestamp
                      x-parser-schema-id: <anonymous-schema-13>
                    updated:
                      type: string
                      description: Article update timestamp
                      x-parser-schema-id: <anonymous-schema-14>
                    title:
                      type: string
                      description: Article headline
                      x-parser-schema-id: <anonymous-schema-15>
                    teaser:
                      type: string
                      description: Article teaser text
                      x-parser-schema-id: <anonymous-schema-16>
                    body:
                      type: string
                      description: Full article body
                      x-parser-schema-id: <anonymous-schema-17>
                    url:
                      type: string
                      description: Article URL
                      x-parser-schema-id: <anonymous-schema-18>
                    image:
                      type: array
                      items:
                        type: object
                        properties:
                          size:
                            type: string
                            x-parser-schema-id: <anonymous-schema-21>
                          url:
                            type: string
                            x-parser-schema-id: <anonymous-schema-22>
                        x-parser-schema-id: <anonymous-schema-20>
                      x-parser-schema-id: <anonymous-schema-19>
                    channels:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            x-parser-schema-id: <anonymous-schema-25>
                        x-parser-schema-id: <anonymous-schema-24>
                      x-parser-schema-id: <anonymous-schema-23>
                    stocks:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            x-parser-schema-id: <anonymous-schema-28>
                          cusip:
                            type: string
                            x-parser-schema-id: <anonymous-schema-29>
                          isin:
                            type: string
                            x-parser-schema-id: <anonymous-schema-30>
                          exchange:
                            type: string
                            x-parser-schema-id: <anonymous-schema-31>
                        x-parser-schema-id: <anonymous-schema-27>
                      x-parser-schema-id: <anonymous-schema-26>
                    tags:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            x-parser-schema-id: <anonymous-schema-34>
                        x-parser-schema-id: <anonymous-schema-33>
                      x-parser-schema-id: <anonymous-schema-32>
                  x-parser-schema-id: <anonymous-schema-10>
              x-parser-schema-id: <anonymous-schema-6>
          x-parser-schema-id: <anonymous-schema-2>
        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: []

````