Skip to main content
GET
Search stored news by query, symbol or monitor

Authorizations

Authorization
string
header
required

Itoflow access token issued for the Itoflow API.

Query Parameters

symbols
string

Comma-separated Itoflow symbols, at most 20. A model first rates the news for each company over the window, then an item matches when it has a rating for one of them. Symbols with no company name are skipped and listed in unknown_symbols.

Example:

"ASML.AS,NVDA.US"

q
string

What the news should be about, in plain words, up to 200 characters. Itoflow selects possible matches by similarity, then a model judges those candidates by meaning in any language, including items that never name the subject. Each row is then a story, and match_p carries the model's chance that it bears on the query. It can't be combined with symbols or monitor_id (400 query_with_symbols).

Maximum string length: 200
Example:

"chip export rules"

monitor_id
string<uuid>

Search the current holdings of one of your monitors, rated as with symbols, with their weights. With symbols as well, only the holdings named.

days
integer

How many days back to search, by when Itoflow stored the item: 1 to 90, default 7. With q, 1 to 3, default 1; more returns 400 days_exceeds_query_window.

Required range: 1 <= x <= 90
order
enum<string>
default:newest

How to order a read without q, symbols or monitor_id. newest lists items newest first by published_at. stories folds repeats into one row per story and lists stories by the UTC day of their first report, then impact, then published_at, newest first. stories_newest folds the same stories and orders by the shown row’s published_at descending, then id descending. Either story order with q, symbols or monitor_id returns 400 order_with_query.

Available options:
newest,
stories,
stories_newest
hide_commentary
enum<string>
default:false

Hide stories whose shown row has is_event_p < 0.5, before applying limit. Default false. True requires order=stories or order=stories_newest; otherwise returns 400 filter_without_stories.

Available options:
true,
false
country
string

With order=stories or order=stories_newest, only the stories with an article in the period that names this country, as an ISO 3166-1 alpha-2 code. Without a story order it returns 400 filter_without_stories.

Pattern: ^[A-Z]{2}$
Example:

"JP"

sector
enum<string>

With order=stories or order=stories_newest, only the stories whose shown article has this sector. Combines with country. Without a story order it returns 400 filter_without_stories.

Available options:
economy,
energy,
materials,
industrials,
consumer_discretionary,
consumer_staples,
health_care,
financials,
information_technology,
communication_services,
utilities,
real_estate
min_level
enum<string>
default:minor

The lowest level to return. It applies to the ratings' materiality when the call names symbols or a monitor, and to the item's impact otherwise.

Available options:
minor,
notable,
material
limit
integer
default:20

Most rows to return. With q, order=stories or order=stories_newest, it counts stories.

Required range: 1 <= x <= 50

Response

With q, stories ranked by score. With order=stories, stories by first report day, then impact, then publish time. With order=stories_newest, the same stories by the shown row’s publish time. Otherwise matching items, newest first.

coverage
object
required
items
object[]
required

With q, stories ranked by match_p × impact ÷ 3, newest first on ties. With order=stories, stories by the UTC day of their first report, then impact, then published_at, newest first. With order=stories_newest, the same stories by the shown row’s published_at descending, then id descending. With q or either story order, limit counts stories. Otherwise, matching items newest first by published_at.

unknown_symbols
string[]
required

Asked symbols, or with monitor_id the holdings, skipped because Itoflow has no company name for them.