This article describe how to filter the response from out API. We assume you are already familiar with connecting to the API. If you are not, we recommend checking our REST API Overview first.
The data feed resulting from the API can be filtered on the following fields, using them as URL parameters. Parameters can be combined with the & symbol as separator.
Filter by date: Add the date parameter to the query. This will return the articles from that specific day. (Entry Format: UTC Date, i.e. YYYYMMDD)
https://DOMAIN/feed/FEED_ID?token=ACCESS_TOKEN&date=20220509
Filter by entity ticker: When entities are selected as part of your models you can filter the API by adding the entity_ticker parameter to the URL.
https://DOMAIN/feed/FEED_ID?token=ACCESS_TOKEN&entity_ticker=AAPL
Filter by theme/event: When Theme Extraction is selected as part of your use case models, you can filter by themes using the event parameter.
https://DOMAIN/feed/FEED_ID?token=ACCESS_TOKEN&event=ESG
Filter by event group: When Theme Extraction is selected as part of your use case models, you can filter by event groups, which represents a series of related events, using the event_group parameter.
https://DOMAIN/feed/FEED_ID?token=ACCESS_TOKEN&event_group=ESG
You can use the same techniques shown above to filter by other fields in your output. You can just use the name of the field as parameter.
https://DOMAIN/feed/FEED_ID?token=ACCESS_TOKEN&doc_source=InfoNews.ca
https://DOMAIN/feed/FEED_ID?token=ACCESS_TOKEN&event_group=entity_type=international_equity