API docs by Redocly

News Sentiment API (1.0.0)

Download OpenAPI specification: [News_Sentiment_API.yaml]

API Request Authentication

Our APIs require the following url parameters on every call:

brokerid – your customer ID on our systems (provided to you)
user – a unique ID of the end-user consuming the information. For server-2-Server integrations this would typically be your company name
accounttype – 0 = LIVE, 1 = DEMO
expiry – Unix timestamp of when this token will expire________token – a token generated by MD5(user|[accounttype]|[expiry][secretkey])

in which secretkey is the secret key provided to you, not to be shared with the end-user

Note the ‘|’ (Pipe) character before and after the AccountType parameter

$expiryDate = time() + (3 * 24 * 60 * 60);
$userid = “myuserid”;
$accountType = “0”;
$secretKey = “secretkey”;
$token = md5(“${userid}|${accountType}|${expiryDate}${secretKey }”);
echo $token;
?>

import hashlib
import time
expiry_date = int(time.time()) + (3 * 24 * 60 * 60)
userid = "myuserid"
account_type = "0"
secret_key = "secretkey"
token = hashlib.md5(f"{userid}|{account_type}|{expiry_date}{secret_key}".encode("utf-8")).hexdigest()
print(token)

News Sentiment

Get Sentiment

This endpoint uses filtering to search for the latest sentiment data for tickers in the database. By default, this endpoint will return the general sentiment information for tickers in the database. To change the default behaviour and retrieve detailed sentiment information, set the "include_detail" parameter to 'true'

query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

search
string
Example: search={{search}}

search by ticker code or company name (e.g. 'TSLA' or 'Tesla')

sector
string
Example: sector={{sector}}

filter by sector. Available values : Financial, Technology, Currencies, Industrial Goods, Healthcare, Consumer Goods, Services

sentiment
string
Example: sentiment={{sentiment}}

filter by sentiment. Available values : positive, negative, neutral, very positive, very negative

strong_sentiment
string
Example: strong_sentiment={{strong_sentiment}}

filter by strong sentiment. Available values : true, false

include_detail
string
Example: include_detail={{include_detail}}

include all sentiment detail

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "AAPL": {
    },
  • "ADM": {
    },
  • "AMPL": {
    },
  • "AMZN": {
    },
  • "AUD-USD": {
    },
  • "AVGO": {
    },
  • "BA": {
    },
  • "BRK-A": {
    },
  • "BTI": {
    },
  • "CRM": {
    },
  • "DIS": {
    },
  • "DKS": {
    },
  • "EUR-GBP": {
    },
  • "EUR-USD": {
    },
  • "GBP-JPY": {
    },
  • "GBP-USD": {
    },
  • "GOOGL": {
    },
  • "HUT": {
    },
  • "INOD": {
    },
  • "IRTC": {
    },
  • "JPM": {
    },
  • "KR": {
    },
  • "M": {
    },
  • "META": {
    },
  • "MSFT": {
    },
  • "NOVA": {
    },
  • "NVDA": {
    },
  • "NZD-USD": {
    },
  • "PANW": {
    },
  • "PARA": {
    },
  • "RIVN": {
    },
  • "SMCI": {
    },
  • "SNOW": {
    },
  • "TSLA": {
    },
  • "USD-CAD": {
    },
  • "USD-CHF": {
    },
  • "USD-JPY": {
    },
  • "WBD": {
    },
  • "WMT": {
    },
  • "XAG-USD": {
    },
  • "XAU-USD": {
    },
  • "XPOF": {
    }
}

Get Extreme Score Change

An extreme score change is a sentiment score that changes by or by more than 30 points. For example, if yesterday's score was 30 and it increases to 70, or if yesterday's score was -10 and it decreases to -40, this would be considered an extreme score change. Retrieve extreme score changes by date_input

Parameters:

  • date_input (str): YYYY-MM-DD is the required date format

Returns:

  • dict: A dictionary containing the all the significant change values sorted by ticker.
query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

date_input
string
Example: date_input={{date_input}}

(Required) Retrieve by date in YYYY-MM-DD format (e.g. '2024-01-17')

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "2024-02-21T00:00:00Z": {
    }
}

Get Significant Sentiment

A significant sentiment is when the overall sentiment changes from neutral, negative, or positive to either very negative or very positive, i.e. when the sentiment score falls below -60 or rises above 60, respectively. Retrieve significant sentiments by date_input

Parameters:

  • date_input (str): YYYY-MM-DD is the required date format

Returns:

  • dict: A dictionary containing the all the extreme change values sorted by ticker.
query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

date_input
string
Example: date_input={{date_input}}

(Required) Retrieve by date in YYYY-MM-DD format (e.g. '2024-01-17')

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "2024-02-21T00:00:00Z": {
    },
  • "2024-02-22T00:00:00Z": {
    }
}

Get History

This endpoint is used to retrieve historical sentiment data for tickers in the database

query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

days_back
string
Example: days_back={{days_back}}

(Required) filter history by days back

ticker
string
Example: ticker={{ticker}}

(Required) enter ticker code

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
{
  • "AAPL": {
    }
}

Get Sectors

This endpoint is used to retrieve the distinct sectors from the ticker data in the database

query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • "CONSUMER_GOODS",
  • "CURRENCIES",
  • "FINANCIAL",
  • "HEALTHCARE",
  • "INDUSTRIAL_GOODS",
  • "SERVICES",
  • "TECHNOLOGY"
]

Get Sources

This endpoint is used to retrieve the distinct sources from the sentiment data in the database

query Parameters
broker_id
string
Example: broker_id={{broker_id}}

(Required) enter broker id for authentication

user
string
Example: user={{user}}

(Required) for authentication

token
string
Example: token={{token}}

(Required) for authentication

expire
string
Example: expire={{expire}}

(Required) for authentication

header Parameters
Accept
string
Example: application/json

Responses

Response samples

Content type
application/json
[
  • "Fast Company",
  • "Bloomberg Technology",
  • "CNBC Television",
  • "Seeking Alpha",
  • "24/7 Wall Street",
  • "Proactive Investors",
  • "New York Post",
  • "See It Market",
  • "Schwab Network",
  • "Business Wire",
  • "Market Watch",
  • "Business Insider",
  • "FXEmpire",
  • "Invezz",
  • "MarketBeat",
  • "Investors Business Daily",
  • "DailyFX",
  • "The Street",
  • "Huffington Post",
  • "GeekWire",
  • "Bloomberg Markets and Finance",
  • "TechXplore",
  • "FX Street",
  • "NYTimes",
  • "Forbes",
  • "The Guardian",
  • "Action Forex",
  • "MarijuanaStocks",
  • "Investopedia",
  • "GlobeNewsWire",
  • "Orbex",
  • "Schaeffers Research",
  • "Kiplinger",
  • "Benzinga",
  • "TechCrunch",
  • "WSJ",
  • "The Motley Fool",
  • "GuruFocus",
  • "Barrons",
  • "PRNewsWire",
  • "Babypips",
  • "InvestorPlace",
  • "XM",
  • "Fox Business",
  • "Zacks Investment Research",
  • "Accesswire",
  • "VentureBeat",
  • "Finbold",
  • "Deadline",
  • "Reuters",
  • "Yahoo Finance",
  • "Forexcom",
  • "Newsfile Corp",
  • "Stockmarketcom"
]