Newsfeed API Reference

Benzinga Newsfeed REST API

API Endpoint
https://api.benzinga.com/api/v2
Schemes

https, http

Version

2.0.0

Authentication

token authentication

Type:
apiKey
Name:
token
In:
query

Playground

Endpoints

GET /news

Get the news items

Parameters

NameTypeLocationDescription
acceptstring , x ∈ { application/json , application/xml }header

Specify return format.

pageSizeinteger 15query

The number of results returned per query.

pageintegerquery

The page offset.

displayOutputstring , x ∈ { full , abstract , headline (default) }query

Specify headline only, headline + teaser, or headline + full body text

datestring (yyyy-mm-dd)query

The date to query for calendar data. Shorthand for date_from and date_to if they are the same.

dateFromstring (yyyy-mm-dd)query

Date to query from point in time and sorted by published date.

dateTostring (yyyy-mm-dd)query

Date to query to point in time and sorted by published date.

lastIdintegerquery

The last ID to start paging from and sorted by and sorted by the last updated date.

updatedSinceinteger (Unix timestamp)query

The last updated Unix timestamp (UTC) to pull and sort by.

publishedSinceinteger (Unix timestamp)query

The last published Unix timestamp (UTC) to pull and sort by.

tickersstring (csv)query

One or more ticker symbols separated by a comma

channelsstring (csv)query

One or more channels separated by a comma

Responses

CodeModelDescription
200 OKBenzingaStory

success

Response (200 OK)

[
  {
    "id": "integer",
    "author": "string",
    "created": "string (Wed, 17 May 2017 14:20:15 -0400)",
    "updated": "string (Wed, 17 May 2017 14:20:15 -0400)",
    "title": "string",
    "teaster": "string",
    "body": "string",
    "url": "string",
    "image": [
      {
        "size": "string",
        "url": "string"
      }
    ],
    "channels": [
      {
        "name": "string"
      }
    ],
    "stocks": [
      {
        "name": "string"
      }
    ],
    "tags": [
      {
        "name": "string"
      }
    ]
  }
]

Models

BenzingaStory: object

PropertyTypeDescription
idinteger

The unique identifier of the article. This identifier is also found in the path of url on benzinga.com.

authorstring

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

createdstring (Wed, 17 May 2017 14:20:15 -0400)

The moment the article is created. The time zone is Greenwich Mean Time (GMT) - 4:00, commonly know as Eastern Time (ET). This time stamp will not change.

updatedstring (Wed, 17 May 2017 14:20:15 -0400)

The timestamp of the last update to the article. The time zone is Greenwich Mean Time (GMT) - 4:00, commonly know as Eastern Time (ET). This time stamp has the ability to change one or many times, updating each time an update is pushed to the article.

titlestring

The headline of the article. This will only be plain text.

teasterstring

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. This field can contain html and html encoded characters such as '"' etc.

bodystring

The article content. This field can contain html and html encoded characters such as 'quot' etc.

urlstring

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.

imageobject[]

The featured image related to the article, if applicable. Benzinga Pro headlines will not contain a featured image.

image[].sizestring-
image[].urlstring-
channelsobject[]

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.

channels[].namestring-
stocksobject[]

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

stocks[].namestring-
tagsobject[]

Additional tags that are not channels or categories, but are reoccuring themes including, but not limited to; analyst names, bills being talked about in Congress (Dodd-Frank), specific products (iPhone), politicians, celebrities, stock movements (i.e. 'Mid-day Losers' & 'Mid-day Gainers').

tags[].namestring-
Structure (JSON)
{
  "id": "integer",
  "author": "string",
  "created": "string (Wed, 17 May 2017 14:20:15 -0400)",
  "updated": "string (Wed, 17 May 2017 14:20:15 -0400)",
  "title": "string",
  "teaster": "string",
  "body": "string",
  "url": "string",
  "image": [
    {
      "size": "string",
      "url": "string"
    }
  ],
  "channels": [
    {
      "name": "string"
    }
  ],
  "stocks": [
    {
      "name": "string"
    }
  ],
  "tags": [
    {
      "name": "string"
    }
  ]
}