API Documentation

Live Headline Index for a Ticker

get
https://dev-copilot-api.permutable.ai/v1/headlines/index/ticker/live/

Retrieves the latest live headline index data for a ticker over the past 2 hours, offering real-time insights into headline sentiment build up.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Ticker to retrieve headline sentiment data for. Get these from GET /ticker endpoints.

Query Params
string
Defaults to ALL

Topic preset to filter by. Can be preset or individual topic name. Use GET /headlines/topics/ticker/presets to get the available presets and /headlines/topics/ticker to get the available topics.

Only return the datapoints that had associated headlines. Useful for memory saving as less data points returned. WARNING: If you set this to False, the response will be very large and may exceed the maximum response size. Best practice is to set this to True and fill null values client side.

Align date timestamps to the end of each time period instead of the start. For example, hourly data collected during the 09:00:00 - 10:00:00 period would be aligned to 10:00:00 instead of 09:00:00.

string
Defaults to COMBINED

How the asset is found to be relevant to the headline. Explicit means the asset is explicitly mentioned in the headline, Implicit means the asset is implied or inferred from the headline. Options are COMBINED, EXPLICIT, IMPLICIT

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 6 days ago