Welcome to the TickerTick API!
The TickerTick API provides fresh and relevant stock news stories based on a powerful query language. The API covers all companies listed in US stock markets. The source websites of the news stories include a lot of well-known websites and all company filings.
Take a look at an example web app that uses TickerTick API.
- The API is free of commercial/non-commercialuse use.
- All endpoints have a rate limit of 6 requests per minute from the same IP. This is enforced by the service.
- You are welcome to file an issue if you see any problem, like irrelevant stories.
This API returns a feed of the lastest news stories relevant to the query in reverse chronological order.
GET https://api.tickertick.com/feed
Stock news feed for Apple Inc. - https://api.tickertick.com/feed?q=f3:aapl&lang=en
Rendered stock news feed for Apple Inc.
| Parameter | Description | Options | Example value |
|---|---|---|---|
| q | The query string | Any query string in a query language (explained below) |
f3:aapl |
| lang | Comma-separated languages of requested feed stories | en: Englishcn: Chineseen,cn: Both |
en,cn |
| n | How many latest news stories to fetch | Any number between 1 and 1000 | 42 |
| last | A story id for pagination. Fetch news stories older than the story with this id. |
A 64 bit integer. Each returned news story has such an id. | 6844326865886118959 |
| excl | Comma-separated types of stories to exclude from the requested feed | filings: exclude company filingsugc: exclude user generated content |
filings,ugc |
The query language is a Context free language following the grammar below
query => term | (and query_list) | (or query_list) | (diff query query)
query_list => query query_list | term
term => f_term:any_stock_ticker | tx:any_string | s:any_website_domain_name
f_term => f0 | f1 | f2 | f3
| operator | semantics |
|---|---|
(and query_list) |
request news stories matching all queries in query_list |
(or query_list) |
request news stories matching any query in query_list |
(diff query1 query2) |
request news stories matching query1 but not query2 |
| term | semantics |
|---|---|
f0:stock_ticker |
Request company filings only about stock_ticker |
f1:stock_ticker |
Request most relevant stories about stock_ticker |
f2:stock_ticker |
Request most relevant and medium relevant stories about stock_ticker |
f3:stock_ticker |
Request all stories about stock_ticker |
tx:any_string |
request news story matching text any_string. ( any_string can have whitespaces) |
s:domain_name |
request news story from websites on domain domain_name ( domain_name shouldn't contain '.' or '/') |
| Example query | Semantics | URL |
|---|---|---|
f0:aapl |
Relevant level 0 news stories about Apple Inc. (ticker: aapl) | https://api.tickertick.com/feed?q=f0:aapl |
(or f3:fb f3:amzn f3:nflx f3:goog) |
Relevant level 3 news stories about FANG stocks | https://api.tickertick.com/feed?q=(or%20f3:fb%20f3:amzn%20f3:nflx%20f3:goog) |
(diff tx:elon musk s:nytimes) |
Stories about Elon Musk not from NY times | https://api.tickertick.com/feed?q=(diff%20tx:elon%20musk%20s:nytimes) |
The response is a json blob consisting of an array of stories in reverse chronological order. Each story has the following fields
| Story field | Description |
|---|---|
id |
A unique string id of the story. The id can be used for pagination as the value of parameter last. |
title |
The title of the news story in HTML format. |
url |
The url of the news story. |
site |
The source website of the news story. |
time |
The timestamp of the news story. It's the number of milliseconds since the "Unix epoch", 1970-01-01T00:00:00Z (UTC). The same semantics as Date.now() in Javascript. |
favicon_url |
The url of the favicon of the source website. |
tags |
An array of strings. Each string is the ticker the story is about. |
An example response from reqeust URL https://api.tickertick.com/feed?q=(or%20f1:fb%20f1:aapl)&lang=en&n=2
{
"stories": [
{
"id": "-8234495239863619632",
"title": "Apple Inc.: Form FWP - 2020-08-13",
"url": "https://www.sec.gov/Archives/edgar/data/320193/0001193125-20-219289-index.html",
"site": "www.sec.gov",
"time": 1597302000000,
"favicon_url": "https://www.sec.gov/themes/custom/secgov/favicon.ico",
"tags": [
"aapl"
]
},
{
"id": "3888876773322702496",
"title": "Facebook Inc: Form 4 - 2020-08-13",
"url": "https://www.sec.gov/Archives/edgar/data/1326801/0000950103-20-015792-index.html",
"site": "www.sec.gov",
"time": 1597302000000,
"favicon_url": "https://www.sec.gov/themes/custom/secgov/favicon.ico",
"tags": [
"fb"
]
}
],
"last_id": "3888876773322702496"
}
GET https://api.tickertick.com/tickers
| Parameter | Description | Options | Example value |
|---|---|---|---|
| p | The query string to match the company name or the stock ticker. | Any string. | Tesl |
| n | How many tickers to return at most. | Any integer. | 4 |
The returned result is a JSON string consisting of all matched stock tickers.
Search for any tickers matching Ama - https://api.tickertick.com/tickers?p=Ama&n=2
{
"tickers": [
{
"ticker": "amzn",
"company_name": "Amazon.com, Inc."
},
{
"ticker": "amag",
"company_name": "AMAG Pharmaceuticals, Inc."
}
]
}
Search for any tickers matching aa - https://api.tickertick.com/tickers?p=aa&n=2
{
"tickers": [
{
"ticker": "aapl",
"company_name": "Apple Inc."
},
{
"ticker": "aal",
"company_name": "American Airlines Group, Inc."
}
]
}