GET Stream

GET

stream

curl --request GET \
  --url wss://api.benzinga.com/api/v1/news/stream

{
  "api_version": "<string>",
  "kind": "<string>",
  "data": {
    "id": 123,
    "action": "Created",
    "timestamp": "<string>",
    "content": {
      "id": 123,
      "revision_id": 123,
      "type": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "title": "<string>",
      "body": "<string>",
      "authors": {},
      "teaser": "<string>",
      "url": "<string>",
      "channels": [
        "<string>"
      ],
      "securities": [
        "<any>"
      ]
    }
  }
}

Our docs do not yet support Websocket streaming. To test the Newsfeed Websocket stream, please use Postman or websocketking.com.

Response

101

*/*

OK, WebSocket connection established and ready. *Note messages are sent as single messages, not an array, but the documentation spec does not have support for WebSocket message type.

api_version

string

required

Indicates the message API version. Currently websocket/v1.

kind

string

required

Indicates the message data Kind. Currently News/v1.

data

object

required

Message payload

data.id

integer

required

The unique identifier of the event that triggered the action.

data.action

enum<string>

required

Indicates what type of status change has occurred for this news item.

Available options:

Created,

Updated,

Removed

data.timestamp

string

required

Indicates event time. (RFC3339Milli)

data.content

object

data.content.id

integer

The unique identifier of the article. This identifier is also found in the path of the URL on Benzinga.com. Does not change when the story is updated.

data.content.revision_id

integer

The unique identifier of the article revision. Changes when the story is updated.

data.content.type

string

Article type/source. e.g., 'story'.

data.content.created_at

string

The moment the article is first published. This timestamp will not change on revisions. (RFC3339Milli)

data.content.updated_at

string

The timestamp of the last update to the article. This timestamp is updated for each revision. (RFC3339Milli)

data.content.title

string

The headline of the article. This will only be plain text. May be updated with revisions.

data.content.body

string

The article content. This field can contain HTML and HTML encoded characters such as &amp or &#46 etc. You may request plaintext only with HTML removed, but this may impact formatting/style and produce results different from what the source intended.

data.content.authors

object

The authors of the article. This could be a Benzinga journalist, news desk analyst, or contributor on Benzinga.com.

data.content.teaser

string

Depending on where the content is originated from (Benzinga.com or Benzinga Pro terminal) the teaser functions in different ways. If the article is a full-length article from Benzinga.com, where the body field is filled out, this will be the first sentence of the article up to 256 characters. If this is a Benzinga Pro headline, this will function like the body of an article and provide additional context to the headline, usually no more than a few paragraphs.

data.content.url

string

The URL where the article lives on Benzinga.com. If this is a pro headline, it will take the user to a shortened headline with a paywall to purchase the Benzinga Pro terminal, so use with caution.

data.content.channels

string[]

The topic(s) or categories that relate to the article. Channels can have sub-channels, but they will all be listed as their own item and not as a sub-level of the array. Why Is It Moving (WIIM) data will be labeled with the WIIM channel.

data.content.securities

any[]

The securities that are listed within the article body. This will not display competitor symbols unless they are specifically

Was this page helpful?

Suggest edits Raise issue

GET Movers SEC Filings API Reference

curl --request GET \
  --url wss://api.benzinga.com/api/v1/news/stream

{
  "api_version": "<string>",
  "kind": "<string>",
  "data": {
    "id": 123,
    "action": "Created",
    "timestamp": "<string>",
    "content": {
      "id": 123,
      "revision_id": 123,
      "type": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "title": "<string>",
      "body": "<string>",
      "authors": {},
      "teaser": "<string>",
      "url": "<string>",
      "channels": [
        "<string>"
      ],
      "securities": [
        "<any>"
      ]
    }
  }
}

Introduction

Benzinga APIs

Libraries

Response