Introduction
Purpose
This document describes dxFeed News Web Service API based on REST protocol.
To get acquainted with News API based on Java, see this documentation.
Scope
dxFeed news feed obtains its updates from a number of sources. Data is organized as a JSON object and information is represented in the News Industry Text Format.
API specification
We provide a simple RESTful API. All calls are GETs and should be called via https.
To access a news feed, make a single API call and it will be returned with the news headers or a news body.
News Web Service API consists of one main API call that retrieves a list of headers or a specific news body.
Please use /news?help to list help.
This is a pull-based service that returns a list of news headers along with the last available ID. Use lastId field with the subsequent API calls to receive a consistent news feed and to avoid losses.
Get a list of news headers
Call /news to get a list of news headers.
The result will contain 2 fields:
-
news- the list of news messages -
lastId- latest available news ID
Parameters
| Parameter | Required | Description |
|---|---|---|
last |
Optional |
Get news with an ID greater than the specified ID. If |
source |
Optional |
Get news from the specified news provider. |
symbol |
Optional |
Get news based on the specified symbol. |
limit |
Optional |
Limit news count by the specified number (default=100). 100 is the highest possible number. |
timeout |
Optional |
Limit time in seconds to wait for a response (default=60). |
Examples of a request
| Request | Description |
|---|---|
|
Wait no longer than 10 seconds to receive news after the last specified ID. |
|
Show the two latest news headers for symbol CBZ. |
Response
Service will return a result if available, or an empty list:
{
"news" : [ {
"id" : "[news_id]",
"sourceId" : "[source_id]",
"title" : "[news_title]",
"time" : "[timestamp]",
"source" : "[source_name]",
"symbols" : "[list_of_symbols]"
}, {
"id" : "[news_id]",
"sourceId" : "[source_id]",
"title" : "[news_title]",
"time" : "[timestamp]",
"source" : "[source_name]",
"symbols" : "[list_of_symbols]"
} ],
"lastId" : "[id_of_the_last_news]"
}
The response may also contain different tags.
See the list of sample tags here.
Get body of a particular news
Get news body of the specified news.
Parameters
| Parameter | Required | Description |
|---|---|---|
id |
Required |
Get news body of the specified news |
Examples of a request
/news?id=[ID_value] – show contents of news with the specified ID
Response
This request returns the same response with body field added.
{
"id" : "[id_number]",
"sourceId" : "[source_id]",
"title" : ,
"time" : "[timestamp]",
"source" : "[source_name]",
"symbols" : "[list_of_symbols]",
"body" : "[news text]"
}
The response may also contain different tags. See the list of sample tags here.
Appendix A. Sample tag values
This table lists sample tag values for the news feed:
| Code | Description |
|---|---|
GC |
Publication Geo Focus - Country |
GR |
Publication Geo Focus - Region |
GB |
Publication Geo Focus - Regional Subdivision |
GS |
Publication Geo Focus - State/Province |
GU |
Publication Geo Focus - Urban Area |
HT |
Hash Tag |
II |
Industry code (from the ACME Taxonomy) |
IN |
Publisher/Vendor’s Industry Code |
IS |
Subject code (from the ACME Taxonomy) |
IX |
Industry code (from the ACME Taxonomy) |
LA |
Geo Area |
LB |
Geo SubRegion |
LC |
Geo Country |
LP |
Geo Location in Byline/Placeline |
LR |
Geo Region |
LS |
Geo States/Subdivisions/Provinces |
LT |
Geo County LU/ Geo "Urban" and "Unified" (Cities, States, Countries) |
LZ |
Zip Code |
MC |
Misc Code and "Market Impact" code HOT, DUP, NRC, EDGE |
PC |
Misc. "Publisher Code" |
PI |
Publisher Industry |
PR |
Publisher/Vendor Special Geo Region Code |
PS |
Publisher Source |
PT |
Publisher Type |
PX |
Publisher/Vendor Special Subject |
RE |
Publisher/Vendor’s Original Location (Region) Code - all types |
RC |
Publication Origin Geo Code - Country RR/ Publication Origin Geo Code - Region |
RB |
Publication Origin Geo Code - Subregion |
RS |
Publication Origin Geo Code - State/Province |
RU |
Publication Origin Geo Code - Urban SU/ Publisher/Vendor’s Subject Code |
TN |
"Top News" Indicator |
XC |
Stock Exchange |
XI |
Stock Exchange of Press Release Issuer (used in press releases only) |
Z |
Slugs and other Special Codes |