/v1/stocks Request Parameters
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ticker | string | REQUIRED |
STRING
Ticker of a company from NASDAQ or NYSE indices |
| key_people
| string | | OPTIONAL
STRING
False
by default. Set to True
to add names of people on high positions in this company, such as CEO, Founder, VP, COO, CFO, etc. |
| lang
| string | | OPTIONAL
STRING
Specifies the language of the search. Allowed values are:
af
, ar
, bg
, bn
, ca
, cn
, cs
, cy
, da
, de
, el
, en
, es
, et
, fa
, fi
, fr
, gu
, he
, hi
, hr
, hu
, id
, it
, ja
, kn
, ko
, lt
, lv
, mk
, ml
, mr
, ne
, nl
, no
, pa
, pl
,pt
, ro
, ru
, sk
, sl
, so
, sq
, sv
, sw
, ta
, te
, th
, tl
, tr
, tw
, uk
, ur
, vi
.
Specifying the language will make your search more relevant
|
| from
| string | | OPTIONAL
STRING
From which point in time to start the search. No specific format is required. E.g. (2020/05/01
, 2020-05-01
, 2020-05-01 12:54:14
, 2020-05-01 4:15am
, yesterday 2:02 am
, 2020/05/01 12:55 EST
) Default timezone is UTC. Defaults to one week ago at midnight UTC. |
| to
| string | | OPTIONAL
STRING
Until which point in time to search for. Default timezone is UTC |
| sources
| string | | OPTIONAL
STRING
One or more news resources to filter your search. It should be the normal form of the URL, for example, nytimes.com, theguardian.com
> Comma separated string, for example sources=nytimes.com,cnn.com,wsj.com
|
| not_sources
| string | | OPTIONAL
STRING
One or more sources to be excluded from the search.
> Comma separated string, for example not_sources=nytimes.com,cnn.com,wsj.com
|
| ranked_only
| string | | OPTIONAL
STRING
Limit the search only for the sources which are in top 1 million online websites. Defaults to True
(False
if you want to turn it off). Unranked sources are assigned a rank that equals to 999999
|
| from_rank
| number | | OPTIONAL
INTEGER
Lowest boundary of the rank of news website to filter by. Important: lower rank means that a source is more popular |
| to_rank
| number | | OPTIONAL
INTEGER
Upper boundary of the rank of news website to filter by |
| page
| number | | OPTIONAL
INTEGER
The number of the page. Use it to scroll through the results. Defaults to 1 |
| page_size
| number | | OPTIONAL
INTEGER
How many articles to return per page. Defaults to 50, max is 100 |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
x-rapidapi-key | string | REQUIRED |
STRING
Your Rapid API key |
| Content-Type
| string | | OPTIONAL
STRING
Output as JSON |
RESPONSES
status: OK
{"status":"ok","total_hits":2,"page":1,"total_pages":1,"page_size":2,"articles":[{"summary":"SEOUL (May 30): Zoom Video Communications Inc plans to strengthen encryption for paying clients and institutions, but not for users with free accounts, Reuters reported,...","country":"NA","clean_url":"theedgemarkets.com","author":"Jihye Lee","rights":"Copyright (C) 2017 www.theedgemarkets.com","link":"http://www.theedgemarkets.com/article/zoom-strengthen-encryption-paying-customers-only","rank":"23308","topic":"NA","language":"en","title":"Zoom to strengthen encryption for paying customers only","published_date":"2020-05-30 04:15:23","_id":"f766f54e362bf0479a66bc701edc917b"},{"summary":"Zoom Video Communications Inc. on Thursday announced it had hired its first chief diversity officer, an executive who had the same position at eBay. Damien Hooper-Campbell, who had been with eBay since 2016 and who has a long history focused on corporate diversity, will help San Jose-based Zoom further develop diversity and inclusion initiatives. 'Our core value as a company is to care – we care for our community, our customers, our company, our teammates, and ourselves. Damien embodies this…","country":"NA","clean_url":"bizjournals.com","author":"SVBJ staff","rights":"American City Business Journals, Inc. and its licensors. All rights. reserved.","link":"http://feeds.bizjournals.com/~r/bizj_sanjose/~3/cCU6Glqvj94/zoom-damien-hooper-campbell-diversity-officer-ebay.html","rank":"408","topic":"business","language":"en","title":"Zoom snags new C-suite hire away from eBay","published_date":"2020-05-28 21:59:58","_id":"ca8ff611bc20c6db97fd581af14ef637"}],"user_input":{"ticker":"ZM","key_people":"True","lang":"en","from":"2020-05-01 00:00:00","to":"2020-06-01 00:00:00","ranked_only":"False","from_rank":1,"to_rank":100000,"sort_by":"date","page":1,"size":25,"sources":["theedgemarkets.com","bizjournals.com"],"not_sources":["asiaone.com"]}}