API Documentation

Live Hourly Event Metrics for a Batch of Tickers

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

Retrieves the latest live (hourly) event metrics data for a batch of tickers over the last 5 hours, offering real-time insights into event build up and sentiment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
tickers
array of strings
required
length between 1 and 5

List of tickers to retrieve event metrics data for. Get these from GET /ticker endpoints.

Tickers*

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

Type of event to use in the event metrics analysis. Options are Combined, Asset, Macro, Sector

string
Defaults to ALL_ACTIVE

Method to aggregate event metrics. Options are NEW_EVENT, ADDED_VOLUME, STATE_CHANGE, ALL_ACTIVE

string
Defaults to topic

Type of sentiment to analyze. Options are 'topic' or 'geolocation'

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