0% found this document useful (0 votes)
35 views

RBG API DOC Updated

This document provides documentation on accessing financial news data through APIs from RedboxGlobal. It describes getting started, required attribution, API endpoints for real-time news from Twitter, crawlers, and RedboxGlobal analysts, response formats, categories, and requirements for streaming APIs.

Uploaded by

Ankur Shah
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
35 views

RBG API DOC Updated

This document provides documentation on accessing financial news data through APIs from RedboxGlobal. It describes getting started, required attribution, API endpoints for real-time news from Twitter, crawlers, and RedboxGlobal analysts, response formats, categories, and requirements for streaming APIs.

Uploaded by

Ankur Shah
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 13

API Documentation

___________________________________________________________________

Getting Started Updated 2022, Feb


We are the most accurate financial news data API out there.

We provide real time financial news from Twitter, Crawler & RedboxGlobal.

Attribution is required for all users. It is as simple putting “News Data provided by RedboxGlobal” somewhere on
your site or app and linking that text to https://redboxglobal.com.

As a warranty in RedboxGlobal Publishing Agreement you make with us, you must obtain the necessary permission
to include material in your application, software or website.

RedboxGlobal will be responsible for any patent infringement and copyright infringement raised by any third party.
RedboxGlobal will be solely responsible for any legal disputes; neither vendors nor client will be responsible for the
same.

Important Points!

Base URL

https://apidata.redboxglobal.com/api/<region>/<token>

Headers

It is required to set Header for each request. It helps us to determine your personal environment. No
headless request will be accepted and it will be blocked by server after certain rate limits.

Polling

RedboxGlobal Feeds Polling Frequency: 5 Seconds | Crawler Feeds: 5 Minutes | Twitter Feeds: 20
Seconds | All News: 10 Seconds | Stock Tickers: 10 Seconds.

Data Consume

Your client will poll to your servers. Your client should not poll directly or indirectly to our servers.
Token will be blacklisted for violating regulations.
REDBOXGLOBAL FEEDS
RedboxGlobal News by our analysts JSON

https://apidata.redboxglobal.com/api/global/redboglobal/YOUR_API_KEY

RESPONSE

https://apidata.redboxglobal.com/api/global/redboglobal/YOUR_API_KEY

[{"_id":"62035beded35de4862a8f20b",

"type":"RedboxGlobal",

"category":"Global",

"description":"BELLWAY PLC: CITIGROUP RAISES PRICE TARGET TO 4176P FROM 4153P",

"company":[{"_id":"620140108969c7fddea5bc28",

"symbol":"C",

"name":"Citigroup Inc. Common Stock",

"exchangeShortName":0}],

"createdAt":"2022-02-09T06:15:09.290Z"}

Reference:-

type: This field indicates source of news

1) RedboxGlobal
2) Crawler
3) Twitter

category: This field indicates categories

1) Global
2) Commodities
3) Fixed Income
4) Block Details (Rename to Analysis from your end)
5) Default
description: This field shows headlines

company: This field stores company name (max 3 companies)

symbol: This field stores companies stock exchanges symbol

exchangeShortName: Please ignore this field.

createdAt: This field stores data arrival date with time

Note:-

Equities news will be in “Global” and ‘Default’ categories.

Geopolitical news will be in “Global” categories.

Metals, Gold, Grains, Oil, Energy News will be in “commodities” categories.

Currencies, Crypto, Bonds, Central Banks, Finance Ministry, Live Press Conference from Ministry of
Finance, Central Banks will be in “Fixed Income” categories.

STREAMING

const io = require(“socket.io-client”);

var socket =io (“https://apidata.redboxglobal.com/api/socket”, {

query: {

token:

“Your_Token_Here”,

},

});

Socket Listener

socket.on ("newGlobalRedboxFeed", (data) => {

console.log (data);

});
socket.on ("disconnect", () => {

console.log ("listening stopped...");

});

Same response will be printed.

Note:- You will get JavaScript Software development Kit for the streaming APIs.

Prerequiresite for the streaming APIs

1) LTS Nodejs with latest LTS NPM


2) Socket.io client

Steps to run Streaming APIs

Navigate “RedboxGlobal” folder on your console terminal

1) npm install
2) Now edit app.js file paste your token at “paste_token_here_” save the file.
3) Now run in your cmd or terminal window following command
4) node app
5) There would be no handshake or connection establish message due to security reasons.
6) As soon as the data will arrive it will get started to print on your console terminal.
7) All response will be similar to the “REST”.

CRAWLER FEEDS

Crawler Feeds from Multiple Sources Clickable News JSON

https://apidata.redboxglobal.com/api/global/crawler/YOUR_API_KEY

{"_id":"62038743ed35de4862a8f7c9",

"type":"Crawler",

"category":"Default",

"article":{"title":"Toyota Motor's third-quarter net profit falls 5.6% as parts shortage hurts sales - Fox
Business",
"link":"https://www.foxbusiness.com/markets/toyota-motors-third-quarter-net-profit-falls-5-6-as-parts-
shortage-hurts-sales"},

"sentiment":{"score":-2},

"company":[{"_id":"620140108969c7fddea5c1f2",

"symbol":"TM",

"name":"Toyota Motor Corporation Common Stock",

"exchangeShortName":0}],

"createdAt":"2022-02-09T09:19:59.747Z"},

Reference:-

type: This field indicates source of news

1) RedboxGlobal
2) Crawler
3) Twitter

category: This field indicates categories

1) Global
2) Commodities
3) Fixed Income
4) Block Details (Rename to Analysis from your end)
5) Default

article: This field shows headlines

link: This field stores article links

sentiment: This field shows News sentiment if integer in “–“ news is negative, 1, 2, 3 shows news is
positive if 0 news is neutral.

company: This field stores company name with stock symbol (max 3 companies)

symbol: This field stores companies stock exchanges symbol

exchangeShortName: Please ignore this field.

createdAt: This field stores data arrival date with time


Note:-

Equities news will be in “Global” and ‘Default’ categories.

Geopolitical news will be in “Global” categories.

Metals, Gold, Grains, Oil, Energy News will be in “commodities” categories.

Currencies, Crypto, Bonds, Central Banks, Finance Ministry, Live Press Conference from Ministry of
Finance, Central Banks will be in “Fixed Income” categories.

STREAMING

const io = require(“socket.io-client”);

var socket =io (“https://apidata.redboxglbal.com/api/socket”, {

query: {

token:

“Your_Token_Here”,

},

});

Socket Listener

socket.on ("newGlobalCrawlerFeed", (data) => {

console.log (data);

});

socket.on ("disconnect", () => {

console.log ("listening stopped...");

});

Same response will be printed.

Note:- You will get JavaScript Software development Kit for the streaming APIs.

Prerequiresite for the streaming APIs


1) LTS Nodejs with latest LTS NPM
2) Socket.io client

Steps to run Streaming APIs

Navigate “RedboxGlobal” folder on your console terminal

1) npm install
2) Now edit app.js file paste your token at “paste_token_here_” save the file.
3) Now run in your cmd or terminal window following command
4) node app
5) There would be no handshake or connection establish message due to security reasons.
6) As soon as the data will arrive it will get started to print on your console terminal.
7) All response will be similar to the “REST”.

TWITTER FEEDS
Twitter Feeds from Multiple Business Channels

https://apidata.redboxglobal.com/api/global/twitter/YOUR_API_KEY JSON

{"_id":"62038751ed35de4862a8f7df",

"type":"Twitter",

"category":"Default",

"topic":"Reuters:",

"description":"From @Breakingviews: Frontier and Spirit Airlines say their merger would help
passengers by creating cut-price alternatives to pricier carriers. @johnsfoley explains why the market’s
muted response suggests their logic is running on fumes https://t.co/0evdNx6jdn
https://t.co/x11DzUTfYz",

"links":

["https://t.co/0evdNx6jdn",

"https://t.co/x11DzUTfYz"],
"company":

[{"_id":"620140108969c7fddea5c12f",

"symbol":"SAVE",

"name":"Spirit Airlines Inc. Common Stock",

"exchangeShortName":0}],

"createdAt":"2022-02-09T09:20:16.866Z"},

Reference:-

type: This field indicates source of news

1) RedboxGlobal
2) Crawler
3) Twitter

category: This field indicates categories

1) Global
2) Commodities
3) Fixed Income
4) Block Details (Rename to Analysis from your end)
5) Default

topic: This field shows Twitter handle

description: This field shows tweet from Twitter handle

link: This field stores article links

company: This field stores company name with stock symbol (max 3 companies)

symbol: This field stores companies stock exchanges symbol

exchangeShortName: Please ignore this field.

createdAt: This field stores data arrival date with time


Note:-

Equities news will be in “Global” and ‘Default’ categories.

Geopolitical news will be in “Global” categories.

Metals, Gold, Grains, Oil, Energy News will be in “commodities” categories.

Currencies, Crypto, Bonds, Central Banks, Finance Ministry, Live Press Conference from Ministry of
Finance, Central Banks will be in “Fixed Income” categories.

STREAMING

const io = require(“socket.io-client”);

var socket =io (“https://apidata.redboxglbal.com/api/socket”, {

query: {

token:

“Your_Token_Here”,

},

});

Socket Listener

socket.on ("newGlobalTwitterFeed", (data) => {

console.log (data);

});

socket.on ("disconnect", () => {

console.log ("listening stopped...");

});

Same response will be printed.


Note:- You will get JavaScript Software development Kit for the streaming APIs.

Prerequiresite for the streaming APIs

1) LTS Nodejs with latest LTS NPM


2) Socket.io client

Steps to run Streaming APIs

Navigate “RedboxGlobal” folder on your console terminal

1) npm install
2) Now edit app.js file paste your token at “paste_token_here_” save the file.
3) Now run in your cmd or terminal window following command
4) node app
5) There would be no handshake or connection establish message due to security reasons.
6) As soon as the data will arrive it will get started to print on your console terminal.
7) All response will be similar to the “REST”.

ALL FEEDS (CONSOLIDATED)

All Feeds (Consolidated)

https://apidata.redboxglobal.com/api/global/YOUR_API_KEY JSON

{"_id":"62038751ed35de4862a8f7df",

"type":"Twitter",

"category":"Default",

"topic":"Reuters:",

"description":"From @Breakingviews: Frontier and Spirit Airlines say their merger would help
passengers by creating cut-price alternatives to pricier carriers. @johnsfoley explains why the market’s
muted response suggests their logic is running on fumes https://t.co/0evdNx6jdn
https://t.co/x11DzUTfYz",

"links":

["https://t.co/0evdNx6jdn",
"https://t.co/x11DzUTfYz"],

"company":

[{"_id":"620140108969c7fddea5c12f",

"symbol":"SAVE",

"name":"Spirit Airlines Inc. Common Stock",

"exchangeShortName":0}],

"createdAt":"2022-02-09T09:20:16.866Z"},

Reference:-

type: This field indicates source of news

1) RedboxGlobal
2) Crawler
3) Twitter

category: This field indicates categories

1) Global
2) Commodities
3) Fixed Income
4) Block Details (Rename to Analysis from your end)
5) Default

topic: This field shows Twitter handle

description: This field shows tweet from Twitter handle

link: This field stores article links

company: This field stores company name with stock symbol (max 3 companies)

symbol: This field stores companies stock exchanges symbol

exchangeShortName: Please ignore this field.

createdAt: This field stores data arrival date with time


Note:-

Equities news will be in “Global” and ‘Default’ categories.

Geopolitical news will be in “Global” categories.

Metals, Gold, Grains, Oil, Energy News will be in “commodities” categories.

Currencies, Crypto, Bonds, Central Banks, Finance Ministry, Live Press Conference from Ministry of
Finance, Central Banks will be in “Fixed Income” categories.

STREAMING

const io = require(“socket.io-client”);

var socket =io (“https://apidata.redboxglbal.com/api/socket”, {

query: {

token:

“Your_Token_Here”,

},

});

Socket Listener

socket.on("newGlobalRedboxFeed", (data) => {

console.log(data);

});

socket.on("newGlobalTwitterFeed", (data) => {

console.log (data);

});

socket.on("newGlobalCrawlerFeed", (data) => {

console.log(data);

});
socket.on("disconnect", () => {

console.log ("listening stopped...");

});

Same response will be printed.

Note:- You will get JavaScript Software development Kit for the streaming APIs.

Prerequiresite for the streaming APIs

1) LTS Nodejs with latest LTS NPM


2) Socket.io client

Steps to run Streaming APIs

Navigate “RedboxGlobal” folder on your console terminal

1) npm install
2) Now edit app.js file paste your token at “paste_token_here_” save the file.
3) Now run in your cmd or terminal window following command
4) node app
5) There would be no handshake or connection establish message due to security reasons.
6) As soon as the data will arrive it will get started to print on your console terminal.
7) All response will be similar to the “REST”.

Regards,

You might also like