1.InfoTrie IFeed API Manual #

1.1.Getting Started #

Getting Started with the IFeed Sentiment Analysis API by InfoTrie

  1. Get familiar with how to call an API
  2. Detailed explanations of general definitions of the sentiment data
  3. Have your first try on an API

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.2.Call An API #

Example:

curl -H "AppKey:<app-key>" -H "Accept: application/json" https://feed.finsents.com/idata/get_articles?class_nameid=c_1389

 

All Request Should follow the following:

  • All Request should have AppKey in Request Header

example AppKey : 480881f124a5427bb3324642fbc2f5bf

  • All Request should specify “Accept” Header as

Accept : application/json

  • All request should have correct API call and params as detailed in the doc

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.3.Try Your First API #

Here is an example for you first try on calling our API.

You can call the API through Postman following the simple steps which are shown as below:

  1. Log in/Sign up Postman

 

  1. Input the URL and APPKEY

a. Type the URL to point a specific API: https://feed.finsents.com/idata/get_articles?class_nameid=c_1389

b. Type the your APPKEY in Headers:

key: APPKEY             value: 480881f124a5427bb3324642fbc2f5bf

 

  1. Send and get the response

The APPKEY is only used for testing your first API. Please contact us to get a stronger APPKEY with more permission!

 

Any comments, questions, suggestions or concerns please feel free to email: contact@infotrie.com.

 

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.ID of Sentiment Data #

Since our system can analyse various types of sentiment data, we provider ID for the user to access details of a specific sentiment data through our APIs.

The general format for the ID is x_<id> where x represents the type of the sentiment data and id can specify the exact element. The symbol of different types is illustrated in the table.

Type nameid
sector s_<ID>
industry i_<ID>
subindustry si_<ID>
company c_<ID>
tag t_<ID>
source o_<ID>
index in_<ID>
place pl_<ID>
category ca_<ID>

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.1.Sector: s_<ID> #

IFeed API Industries Sector Classification by InfoTrie

Sector ID Sector Name
10  Energy
15  Materials
20  Industrials
30  Consumer Discretionary
40  Financials

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.2.Industry: i_<ID> #

IFeed API Sectors, Industry, Sub-Industries Classification by InfoTrie

List of Industry identifiers and names:

Industry ID Industry Name
101020  Oil, Gas & Consumable Fuels
151010  Chemicals
151020  Construction Materials
201060  Machinery
203050  Transportation Infrastructure

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.3.Sub-industry: si_<ID> #

IFeed API Sectors, Industries, Sub-Industries Classification by InfoTrie

Sub-Industry ID Sub-Industry Name
15104010 Aluminum
20101010 Aerospace & Defense
20104010 Electrical Components & Equipment
20107010 Trading Companies & Distributors
20304010 Railroads

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.4.Company: c_<ID> #

Company Sentiment Analysis

 

Company ID Company Name
1 AAR CORP
2 AFP IMAGING CORP
84 APPLE INC
280 COCA-COLA BTLNG CONS
41815 ASIA UNITED BANK
     

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.5.Source: o_<ID> #

Source ID Source Name
58 Ticker Sense
72  Economix (NYT)
75  WSJ Blog
111  myweekendinvestment
134  forexcrunch

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.6.Index: in_<ID> #

Stock Index Sentiment

 

Index ID Index Short Name Index Long Name
1 DAX30 DAX 30
2 CAC40 Cac 40
3 FTSE100 FTSE 100
4 STOXX50E Eurostoxx 50
5 DJ30 DJ 30
6 HSI40 Hang Seng Index
7 STI30 Straits Times Index (STI) 30
8 BSE30 BSE Sensex
9 SP500 S&P 500

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.7.Place: pl_<ID> #

Place ID Place Name
USA United States of America
GBR United Kingdom
CHN China
HKG Hong Kong
SGP Singapore

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.4.8.Category: ca_<ID> #

Category ID Category Name
1 Market News
5 Blogs
8 Oil and Gas
17 Forex
19  Financial Technology
 …

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.5.API Status Code #

Sentiment Analysis API Error

API Status Code is used to present the status of the response after calling a specific API. It could help you quickly know/debug the exact problem.

All status codes in our APIs are standard HTTP status codes. Specifically, the five types of the status code are listed in the following.

Usually, codes in the 2xx range indicate success, codes in the 4xx range are for client-related failures, and 5xx codes are for server-related issues (these are rare).

  • 200 OK Successful request.
  • 201 Created New resource created.
  • 202 Accepted The request has been accepted for processing, but the processing has not been completed.
  • 400 Bad Request The request is malformed. Check the parameters or the syntax.
  • 401 Unauthorized Couldn’t authenticate the request.
  • 403 Forbidden The request is not allowed.
  • 404 Not Found No such resource.
  • 405 Not Allowed The method is not allowed.
  • 409 Conflict The resource already exists.
  • 412 Failed The precondition is invalid.
  • 413 Too Large Requests Too large requests entity hit the API too quickly.
  • 500 Internal Server Error Something went wrong on our end (these are rare).
  • 501 Not Implemented Something went wrong on our end (these are rare).
  • 503 Service Unavailable Something went wrong on our end (these are rare).

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

1.6.Choose Timezone #

Timezone Sentiment Analysis InfoTrie FinSentS IFeed

 

Timezone Sentiment Analysis  Get accurate sentiment analysis by timezone.

By default, the API returns data for the European timezone (Berlin).

This option is not available on all functions, so please refer to the API list for details. Where available, users can choose between 3 time zones:
1/ “America/New_York”
2/ “Asia/Singapore”
3/ “Europe/Berlin”

More precisely, the standard cutoffs for the daily sentiment scores (and the corresponding news corpuses) are computed using the following time ranges:

  • “America/New_York”: New York Time Zone (Eastern Daylight Time or EST or GMT -4) from 00:00 to 23:59 local time,
  • “Europe/Berlin”: Berlin Time Zone (Central European Standard Time or CET or GMT +2) from 00:00 to 23:59 local time,
  • Singapore Time Zone (Singapore Standard Time or SGT or GMT+8) from 00:00 to 23:59 local time.
Timezone Sentiment Analysis: Sample call

To choose the Asia/Singapore timezone for company Microsoft (c_1389), simply add ‘&timezone=Asia/Singapore‘ as parameter : https://feed.finsents.com/idata/get_articles?class_nameid=c_1389&timezone=Asia/Singapore

Note that ‘ ‘ can be required. For instance a proper “get_article” call (to retrieve a list of articles with corresponding snippets and URLs) between the 05th July 2019 and the 10th July 2019 using curl would be:

curl -H “AppKey:< Your Key >” -H “Accept: application/json” https://feed.finsents.com/idata/get_articles?class_nameid=c_1389″&timezone=Asia/Singapore&start_date=2019-07-10&end_date=2019-07-05″

Similarly, to call the New York time zone, you may specify:

curl -H “AppKey:< Your Key >” -H “Accept: application/json” https://feed.finsents.com/idata/get_articles?class_nameid=c_1389″&timezone=America/New_York&start_date=2019-07-10&end_date=2019-07-05″

and to call the Berlin time zone, you will have to enter:

curl -H “AppKey:< Your Key >” -H “Accept: application/json” https://feed.finsents.com/idata/get_articles?class_nameid=c_1389″&timezone=Europe/Berlin&start_date=2019-07-10&end_date=2019-07-05″

It is also possible to follow market hours (opening and close). This service is offered to corporate customers or on demand (premium service). For instance an adjusted New York Time Zone daily score could be computed using a cut-off from 17:00 to 16:59 local Time (EST).

Contact our support team to know more (support@infotrie.com).

Read our blog to find more! | Discover FinSentS! | Check our I-Feed API| Try our Excel Plugin

2.API List #

2.1.Get Articles #

Get Articles Sentiment Analysis

Get the articles for sector, industry, sub-industry and companies.

Timezone parameter

By default, this API returns data for Europe/Berlin timezone. Users can choose from 3 timezones:

1/ America/New_York
2/ Asia/Singapore
3/ Europe/Berlin

Request

Method URL           
GET idata/get_articles/

 

Params Values  
class_nameid string “nameid” will be concat of class type and id. eg: x_<id>

 

where x is:

●    in : index

●    pl: place

●    c: company

●    o:source

●    bl:blog (use bl_all for all blogs)

●    cm: commodity

●    top: topic

subclass_nameid string This is an optional field.

 

“nameid” will be concat of class type and id. eg: x_<id>

where x is:

  • s : sector
  • i: industry
  • si: subindustry
  • c: company
  • t: tag
  • o:source
offset number Default value is 0
count number default value is 15
start_date number This is the maximum value. The format is “YYYY-MM-DD”
end_date number This is the minimum value. The format is “YYYY-MM-DD

 

If start_date is given, then the default end_date is 24 hours past start_date.

last_update number values:

 

  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client

Note: for retrieving news just for a day, provide values just for the start_date.

The table shows the possible values of subclass_nameid for a given class_nameid

 

class nameid subclass_nameid
in : index
  • s: sector
  • i: industry
  • si: subindustry
  • c: company
  • t: tag
  • o:source
pl: place
  • s : sector
  • i: industry
  • si : subindustry
  • c: company
  • t: tag
  • o:source
c: company
  • t: tag
  • o:source
  • tp:static tag
o:source  

Response

Status Response
200 Response will have the JSON structure as below

 

[ { “last_update”: <integer timestamp> value ‘0’ will return current data

“data”: {

title: <article title>,

hms: <hour:min:sec>

teaser: <teaser>,

image_name: <image name>

url:<url>

date: <string in dd-mm-yyyy format>

domain: <domain name>

domain_id: <name id for the domain>

sentiment: <between 1 to 10>

relevance: <high,medium,low> }, { … } ] }

400 {“error”:”Invalid params”}
401 {“error”:”Invalid Auth key.”}
500 {“error”:”Something went wrong. Please try again later.”}

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.2.Get Treemap #

Treemap Sentiment in IFeed API by InfoTrie

Get Treemap data.

Request

Method URL           
GET idata/get_treemap/
Params Values  
asset string This shows which asset class data has to be returned.

values :

●    equities

place string values : values : refer to Appendix B
sector string values : [not supported]
market string values : [not supported]
index string values : refer the Appendix A
exchange string values:  name OR name_id for the exchange

Values for supported exchanges can be retrieved using the get_data method

companies string values: company_id’s in csv format
last_update number values:
  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client
view_all boolean  [not supported]

values : 0 and 1

default: 0

If set to 1, then the return data will contain all companies which includes companies with zero buzz score and sentiment score

count number Return one batch of result by default. Parameter “count” can return several batches of result in reverse time order

Response

Status Response
200 Response will have following default structure.

“nameid” will be concatenation of class type and id. eg: x_<id>

where x is:

  • s: sector
  • i: industry
  • si: subindustry
  • c: company

 {“last_update”: <integer timestamp> value ‘0’ will return current data

“data”:

[{“name”: <sector name>,

“nameid”: <sector name id>,

“buzz”: <score in range of 0 -10>

“sentiment”: <score in range of 0 -10>

“change”: <change in %>

“children”: [{

“name”: <industry name>,

“nameid”: <industry name id>,

“buzz”: <score in range of 0 -10>

“sentiment”: <score in range of 0 -10>

“change”: <change in %>

“children”: [{

“name”: <subindustry name>,

“nameid”: <subindustry name id>,

“buzz”: <score in range of 0 -10>

“sentiment”: <score in range of 0 -10>

“change”: <change in %>

“children”: [{

“name”: <company name>,

“ticker”: <ticker>,

“price”: <current stock price>,

“nameid”: <company name id>,

“buzz”: <score in range of 0 -10>

“raw_buzz”: <not normalized value>

“sentiment”: <score in range of 0 -10>

“raw_sentiment”: <not normalized value>

“change”: <change in %> }, { … }] }, { … } ]}, { …} ]},{…}]}

400 {“error”:”Invalid param.”}
401 {“error”:”Invalid API token.”}
500 {“error”:”Something went wrong. Please try again later.”}

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.3.Get Tags #

Tag Cloud Sentiment Analysis Articles | Sentiment News Tag CloudAPI to Create Sentiment Tags Cloud generally ran on Stock Index

Request

Method URL           
GET idata/get_tags/
Params Values  
class_nameid string “class_nameid” will be concat of class type and id. eg: x_<id>where x is:

  • in : index
  • pl: place
  • gen:general (gen_0)
subclass_nameid string “subclass_nameid” will be concat of class type and id. eg: x_<id>where x is:

  • s : sector
  • i: industry
  • si : subindustry
  • c: company
last_update number values:

  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client
count number Return one batch of result by default. Parameter “count” can return several batches of result in reverse time order

For values of id : Refer the InfoTrie classification document of id’s of each of class members

Response

Status Response
200 Response will have the JSON structure as below{last_update: <integer timestamp> value ‘0’ will return current datadata: [{

name: <tagname>

weight: <number in range of  0- 10> },{ … }]}

400 {“error”:”Invalid params”}
401 {“error”:”Invalid Auth key.”}
500 {“error”:”Something went wrong. Please try again later.”}

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.4.Get Sentiment History #

Stock Sentiment Analysis History

Sentiment Analysis History

Timezone parameter

By default, this API returns data for Europe/Berlin timezone. Users can choose from 3 timezones:

1/ America/New_York
2/ Asia/Singapore
3/ Europe/Berlin

Request

Method URL           
GET idata/get_sentiment_history/
Params Values  
nameid string “nameid” will be concat of class type and id. eg: x_<id>

 

where x is:

  • c: company (in case of company, the result would be single company data)
  • in:index
  • pl:place
  • cm: <commodity> eg: cm_51
  • top : topic

Multiple name id’s can be specified in csv format

start_date string The start date in format YYYY-MM-DD. Default  is  “today”
end_date string The end date in format YYYY-MM-DD. Default is  90 days from start date
ndays number Default is  90 days from date
last_update number values:

 

  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client

Response

status nameid Response
200 c_<company_id> Response will have the JSON structure as below

{ last_update: <integer timestamp> value ‘0’ will return current data

data: [{

name:<company name>

ticker:<company ticker>

start_date: <YYYY/MM/DD>

end_date: <YYYY/MM/DD>

sentiment: [{

high: <score in range 0 – 10>

low : <score in range 0 – 10>

sentiment : <score in range 0 – 10>

buzz : <score in range 0 – 10>

date : <DD/MM/YYYY> } … , …]},

{ name:<company name>

ticker:<company ticker> …}]}

where ;

sentiment data is in ascending date format

  • First element is the max date (start date)
  • Last element  is the min date (end date)

sentiment = “0” means no data found for the date

200 cm_<commodity_id> Response will have the JSON structure as below

{ last_update: <integer timestamp> value ‘0’ will return current data

data:

[{ name:<commodity name>

class:

type:

subtype:

start_date: <YYYY/MM/DD>

end_date: <YYYY/MM/DD>

sentiment: [{

high: <score in range 0 – 10>

low : <score in range 0 – 10>

sentiment : <score in range 0 – 10>

buzz : <score in range 0 – 10>

date : <DD/MM/YYYY> } … , …]},

{name:<commodity name>

class: …}]}

where ;

sentiment data is in ascending date format

  • First element is the max date (start date)
  • Last element  is the min date (end date)

Sentiment = “0” means no data found for the date

  400 {“error”:”Invalid params”}
  401 {“error”:”Invalid Auth key.”}
  500 {“error”:”Something went wrong. Please try again later.”}

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.5.Get News Buzz #

Get News Buzz Sentiment Analysis

Request

Method URL           
GET idata/get_news_buzz/

 

Params Values  
type

 

 

string

 

 

Type

values :

  • “gen_0”
  • “twitter”
last_update number last_update

values:

  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client

Response

Status Type Response
200 “gen_0” Response will have the JSON structure as below

{last_update: <integer timestamp> value ‘0’ will return current data

data: [{

title: <title>,

url: <url>,

weight: <weight of article in range 0-10>,

teaser: <teaser>,

image_name: <image name>

}, {…} ] }

  “twitter” Response will have the JSON structure as below

{last_update: <integer timestamp> value ‘0’ will return current data

data: [ {

tweet: <text>,

id: <tweetid>

}, {…} ] }

400   {“error”:”Invalid params”}
401   {“error”:”Invalid Auth key.”}
500   {“error”:”Something went wrong. Please try again later.”}

 

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.6.Get Data #

Request

Method URL           
GET idata/get_data/
Params Values  
type string Type

Data type. Valid values are :

  • “company_list”,
  • “company_list_all”
  • ”sources”
  • “source_categories”
  • “indexes”
  • “exchanges”
version number Version

Current version of the data.

Server will return the data only if the version reported is older than currently available at server.

last_update number last_update

values:

  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client

Response

Status Response
200 Data structure for the response will depend on the data type. Refer the table below for each data type
400 {“error”:”Invalid params”}
401 {“error”:”Invalid Auth key.”}
500 {“error”:”Something went wrong. Please try again later.”}

 

Data Type Response Data Structure
company_list

 

company_list_all

{ last_update: <integer timestamp> value ‘0’ will return current data

data: {

version:<version>,

data: [{

name:<company name>

nameid:  i_<company_id>

ticker:<company ticker>

place:<place name>

exchange:<exchange name>

  }, { … } ] } }

commodity_list {last_update: <integer timestamp> value ‘0’ will return current data

data: {

version:<version>,

data: [ {

name:<commodity name>

nameid:  cm_<commodity_id>

class:<commodity class Symbol>

type:<commodity class Type>

subtype:<commodity class SubType>

  }, { … } ] } }

sources { last_update: <integer timestamp> value ‘0’ will return current data

data: {

version:<version>,

data:[ {

name: <source name>,

nameid: o_<source_id>,

category: <comma separated category id’s (ca_)>

}, {…} ] } }

NOTE:  Refer to the get_data   source_categories for the supported categories

source_categories NOTE:
  • Maximum support of 3 levels. Means “parent category”, “child category” and “child of child category”.
  • The priority can be used to decide the order of  listing

{ last_update: <integer timestamp> value ‘0’ will return current data

data: {

version:<version>,

data:[ {

name: <category name>,

name_id: ca_<category id>,

priority: <number in 0 -10>

children : [

name:  ,

priority: ,

children: [ … ] ] }, {…} ] } }

indexes { last_update: <integer timestamp> value ‘0’ will return current data

data: {

version:<version>,

data:[ {

name: <index name>,

nameid: in_<index_id>,

place_name:<place_name>,

placeid:pl_<place_id>

regionid: pl_<region_id>

region_name:<region name>

scoreid:sc_<score_id> }, {…} ] } }

exchanges { last_update: <integer timestamp> value ‘0’ will return current data

data: {

version:<version>,

data:[ {

name: <exchange name>,

name_id: <exchange id> }, {…} ] } }

places { last_update: <integer timestamp> value ‘0’ will return current data

data: {

version:<version>,

data:[ {

place: <place name>,

nameid: pl_<place_id>,

}, {…} ] } }

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.7.Get Articles Tag #

Articles | Sentiment News Tag CloudGet the articles for sector, industry, sub-industry and companies

Timezone parameter

By default, this API returns data for Europe/Berlin timezone. Users can choose from 3 timezones:

1/ America/New_York
2/ Asia/Singapore
3/ Europe/Berlin

Request

Method URL           
GET idata/get_articles_tag/
Params Values  
class_nameid string “nameid” will be concat of class type and id. eg: x_<id>where x is:

  • in : index
  • pl: place
  • gen:general (use gen_0 )
last_update number values:

  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client
count number Return one batch of result by default. Parameter “count” can return several batches of result in reverse time order
tag name of the tag return top articles for one single tag only

Response

Status Response
200 Response will have the JSON structure as below{ last_update: <integer timestamp> value ‘0’ will return current data

data: [ {

name: <tag name>

articles: [ {

title: <article title>,

teaser: <teaser>,

image_name: <image name>

url:<url>

time: string in dd:mm:yyyy format

domain: <domain name> }, ] }, { … } ] }

400 {“error”:”Invalid params”}
401 {“error”:”Invalid Auth key.”}
500 {“error”:”Something went wrong. Please try again later.”}

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.8.Get Leaders Laggers #

Leaders Laggers Laggards Sentient

Timezone parameter

By default, this API returns data for Europe/Berlin timezone. Users can choose from 3 timezones:

1/ America/New_York
2/ Asia/Singapore
3/ Europe/Berlin

Request

Method URL           
GET idata/get_leaders_laggers/

Example : /get_leaders_laggers?nameid=in_9&count=3

Params Values  
nameid string Type

values :

  • <index_id>
count number Max number of companies in each of leader/lagger

Default is 5

last_update number last_update

values:

  • 0 means, there is no valid last updated data
  • In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client

Response

Status Response
200 Response will have the JSON structure as below

{ last_update: <integer timestamp> value ‘0’ will return current data

data: {

leaders : [ {

nameid: <company id>,

sentiment : <sentiment score>

ticker : <news volume>

name :<company name>

}, … ] 

laggers : [{

nameid: <company ticker>,

sentiment : <sentiment score>

ticker : <news volume>

name :<company name> },… ] }

400 {“error”:”Invalid params”}
401 {“error”:”Invalid Auth key.”}
500 {“error”:”Something went wrong. Please try again later.”}

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.9.Search #

Search Financial News Sentiment Analysis

Timezone parameter

By default, this API returns data for Europe/Berlin timezone. Users can choose from 3 timezones:

1/ America/New_York
2/ Asia/Singapore
3/ Europe/Berlin

Request

Method URL           
GET idata/search/

 

Example : /search?app=finsents&q=microsoft&date_max=2017-10-22&date_min=2017-09-22

Params Values  
app string Valid values

 

●    finsents

●    bahasa (default)

q

 

 

string

 

 

Type

 

values :

Supported formats:

+”word” +”this phrase” -“exclude” AND ( word1 OR word2 OR word3 ) NOT (word4 OR word5)

count number Number of results to return

 

Default is 50

offset number Result offset

 

Default is 0

date_max string date in format yyyy-mm-dd

 

eg: 2013-06-01

date_min string date in format yyyy-mm-dd

 

eg: 2013-06-01

last_update number last_update

 

values:

●    0 means, there is no valid last updated data

●    In case of any non zero value, the response will have valid “data” only if the current data at server is newer than the last updated version reported by the client

region(case insensitive) asia, europe, africa, north america, south america, oceania default  all included
category(case insensitive) politics, economics, health, legal, security, sports, technology default  all included

 

 

Response

Status Response
200 Response will have the JSON structure as below

{ last_update: <integer timestamp> value ‘0’ will return current data,

data: {

total   : <total number of results>

offset :  <offset of the current result set,  in the total results >

count : <number of entries in the current result set>

results :[ {

title : <title>

source_type : <source_type>

ticker : <ticker>

bloomberg_tickers : <bloomberg_tickers>

category : <category>

region : <region>

entities : <entities>

cid : <cid>

image_name : <image_name>

url : <url>

date : <date string in format dd:mm:yyyy hh:mm>

teaser : <teaser text>

domain : domain_name

}, { … } ] } }

400 {“error”:”Invalid params”}
401 {“error”:”Invalid Auth key.”}
500 {“error”:”Something went wrong. Please try again later.”}

 

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

2.10.Get Company ID #

Company Sentiment AnalysisGet Company id.

*Note:

This API works based on query. User can give ticker for a company also as part of query. This API will return companies that are satisfying the query condition. Ie, if you give ‘FB’, it will return ‘FaceBook’ company detail and company(s) that have FB in their names. For query with ticker, it will result only one company.

 

Request

Method URL           
GET https://feed.finsents.com/search_company?query=company name

 

Params Values  
nameid string “nameid” will be concat of class type and id. eg: x_<id>

where x is:

  • c: <company>

 

Response

Status Response
200 Response will have following default structure.

{“country”:

“name”: “

“nameid”:

“is_active”:

“default_ticker”:

“ticker”: } ] }

400 {“error”:”Invalid param.”}
401 {“error”:”Invalid API token.”}
500 {“error”:”Something went wrong. Please try again later.”}

 

Read our blog to find more! | Check our FAQ | Check our I-Feed API| Try our Excel Plugin

Help Guide Powered by Documentor
Suggest Edit