Events
GET/v3/events
What happened, to what, and when. Newest first, with a cursor. Filter with
entityIds: a family UUID for an asset, or an entity UUID for a person, project or
organisation. Or fetch events you already hold with eventIds.
from is required unless eventIds is sent, and to defaults to now. A range that
starts before the plan's history is cut, and servedFrom says where it started.
sort=relevant ranks the last 24 hours by how newsworthy each event is, the order the
app's feed shows, instead of newest first. It takes no range: from, to,
eventIds, eventClass, eventType, implication, novelty, arcId and
order=asc are refused with it, and entityIds must be assets. Every page is ranked
as of the first, and servedFrom is null.
q searches by topic instead: events ranked by how closely they match it, best first.
Write a theme or a phrase ("stablecoin regulation in the US", "solana outage"); for
everything about one asset or company, resolve it with /v3/entities and pass
entityIds, since a bare ticker is a poor topic. q takes from (optional, default
the plan's history), to, entityIds, alertAction, eventType and
hasStoryline; anything else is refused with it. A search serves its first 100
matches that clear a minimum relevance, so a query nothing matches well returns an
empty page, and a page can be shorter than limit while more follow.
Cost: 1 credit. Requires x-elfa-api-key.
Request
Responses
- 200
- 400
- 401
- 403
- 429
- 503
Ok
Invalid parameter, or an id we do not hold
Missing or invalid API key
Key is not scoped for this endpoint
Rate limit exceeded
Search with q is unavailable; retry