Structured real-time and historical financial news from the Benzinga newsroom, with channel filters, removed-news deltas, and Why Is It Moving (WIIM) one-line explanations of price action, queried by tickers, date, and channels.
openapi: 3.0.0
info:
contact: {}
description: This REST API provides endpoints to get analyst report details.
termsOfService: http://swagger.io/terms/
title: Analyst Reports Raw Text Analyst Insights News API
version: 1.0.0
servers:
- url: https://api.benzinga.com
description: PROD
tags:
- name: News
paths:
/api/v2/news:
get:
description: This REST API returns structured data for news. For optimal performance, limit the scope of the query using parameters such as tickers, date, and channels, or use updatedSince for deltas. Page offsets are limited from 0 - 100000.
operationId: get-news
parameters:
- description: Specify return format
in: header
name: accept
required: true
schema:
type: string
enum:
- application/json
- application/xml
default: application/json
- description: Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.
in: query
name: page
schema:
type: integer
default: 0
- description: Number of results returned. Maximum 100.
in: query
name: pageSize
schema:
type: integer
maximum: 100
default: 15
- description: Specify headline only (headline), headline + teaser (abstract), or headline + full body (full) text
in: query
name: displayOutput
schema:
type: string
enum:
- full
- abstract
- headline
default: headline
- description: 'The date to query for news. Shorthand for dateFrom and dateTo if they are the same. Format: yyyy-mm-dd'
in: query
name: date
schema:
type: string
- description: 'Date to query from point in time. Sorted by published date. Format: yyyy-mm-dd'
in: query
name: dateFrom
schema:
type: string
- description: 'Date to query to point in time. Sorted by published date. Format: yyyy-mm-dd'
in: query
name: dateTo
schema:
type: string
- description: The last updated Unix timestamp (UTC) to pull and sort by
in: query
name: updatedSince
schema:
type: integer
- description: The last published Unix timestamp (UTC) to pull and sort by
in: query
name: publishedSince
schema:
type: integer
- description: 'Allows control of results sorting. Default is created, DESC. Format: field:direction. Sort Fields: id, created, updated. Sort Order: asc (ascending), desc (descending)'
in: query
name: sort
schema:
type: string
enum:
- id:asc
- id:desc
- created:asc
- created:desc
- updated:asc
- updated:desc
- description: 'One or more ISINs separated by a comma. Maximum 50. Format: csv'
in: query
name: isin
schema:
type: string
- description: 'One or more CUSIPs separated by a comma. Maximum 50. License agreement required. Format: csv'
in: query
name: cusips
schema:
type: string
- description: 'One or more ticker symbols separated by a comma. Maximum 50. Format: csv'
in: query
name: tickers
schema:
type: string
- description: 'One or more primary ticker symbols separated by a comma. Filters by primary ticker association only. Format: csv'
in: query
name: primaryTickers
schema:
type: string
- description: 'One or more channel names or IDs separated by a comma. Format: csv'
in: query
name: channels
schema:
type: string
- description: 'One or more words/phrases separated by a comma; searches Title, Tags, and Body in order of priority. Format: csv'
in: query
name: topics
schema:
type: string
- description: Logical operator for topics query. Use 'and' to require all topics, 'or' to require any topic
in: query
name: topic_group_by
schema:
type: string
enum:
- and
- or
default: or
- description: 'One or more authors separated by a comma. Format: csv'
in: query
name: authors
schema:
type: string
- description: 'One or more content types separated by a comma. Format: csv'
in: query
name: content_types
schema:
type: string
- description: Specify the desired format for the api response
in: query
name: format
schema:
type: string
enum:
- text
- description: Filter by importance level
in: query
name: importance
schema:
type: string
- description: Filter by importance rank (1-5)
in: query
name: importanceRank
schema:
type: integer
- description: Filter by region (e.g., 'ca' or 'canada' for Canadian content)
in: query
name: region
schema:
type: string
responses:
'200':
description: success
content:
application/json:
schema:
items:
$ref: '#/components/schemas/api.NewsItem'
type: array
text/xml:
schema:
items:
$ref: '#/components/schemas/api.NewsItem'
type: array
'400':
description: Invalid or Missing Query Parameters
content:
application/json:
schema:
type: string
text/xml:
schema:
type: string
'499':
description: Request Context Cancelled
content:
application/json:
schema:
type: string
text/xml:
schema:
type: string
'500':
description: Internal Error
content:
application/json:
schema:
type: string
text/xml:
schema:
type: string
security:
- ApiKeyAuth: []
summary: Get the news items
tags:
- News
/api/v2/news-removed:
get:
description: Returns the removed news data. Filters the results to only include items that have been updated since the specified timestamp.
operationId: get-removed-news
parameters:
- description: Specifies return format
in: header
name: accept
required: true
schema:
type: string
enum:
- application/json
default: application/json
- description: Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date.
in: query
name: page
schema:
type: integer
default: 0
- description: Number of results returned. Maximum 100.
in: query
name: pageSize
schema:
type: integer
maximum: 100
default: 15
- description: Filters the results to only include items that have been updated since the specified Unix timestamp (UTC)
in: query
name: updatedSince
schema:
type: integer
responses:
'200':
description: success
content:
application/json:
schema:
additionalProperties:
items:
$ref: '#/components/schemas/api.NewsRemovedItem'
type: array
type: object
'400':
description: Invalid or Missing Query Parameters
content:
application/json:
schema:
type: string
'499':
description: Request Context Cancelled
content:
application/json:
schema:
type: string
'500':
description: Internal Error
content:
application/json:
schema:
type: string
security:
- ApiKeyAuth: []
summary: Returns the removed news data
tags:
- News
components:
schemas:
api.Stock:
description: Stock information with ticker symbol and identifiers
properties:
cusip:
example: 037833100
type: string
exchange:
example: NASDAQ
type: string
gics:
example: Semiconductors & Semiconductor Equipment
type: string
gics_code:
example: '45301020'
type: string
isin:
example: US0378331005
type: string
name:
example: AAPL
type: string
sector:
example: Equity
type: string
type: object
api.NewsRemovedItem:
description: Removed news article with ID and update timestamp
properties:
id:
example: 123456
type: integer
updated:
example: Wed, 17 May 2017 14:20:15 -0400
type: string
type: object
api.NewsItem:
description: News article item with full metadata
properties:
author:
example: Benzinga Newsdesk
type: string
body:
type: string
channels:
items:
$ref: '#/components/schemas/api.ChannelTag'
type: array
created:
example: Wed, 17 May 2017 14:20:15 -0400
type: string
id:
example: 123456
type: integer
image:
items:
$ref: '#/components/schemas/api.Image'
type: array
importance_rank:
example: 1
type: integer
original_id:
type: integer
stocks:
items:
$ref: '#/components/schemas/api.Stock'
type: array
tags:
items:
$ref: '#/components/schemas/api.ChannelTag'
type: array
teaser:
type: string
title:
example: Apple Announces New iPhone
type: string
updated:
example: Wed, 17 May 2017 14:20:15 -0400
type: string
url:
example: https://www.benzinga.com/news/123456
type: string
type: object
api.Image:
description: Article image with size and URL
properties:
alt:
example: Apple logo on a storefront
type: string
size:
example: large
type: string
url:
example: https://cdn.benzinga.com/files/images/story/2024/example.jpg
type: string
type: object
api.ChannelTag:
description: Channel or tag name
properties:
name:
example: Technology
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: query
name: token
type: apiKey