v3 Events

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.

get/v3/events

Request

  • Base URL: https://api.elfa.ai
  • URL: https://api.elfa.ai/v3/events
  • Auth: API key in header x-elfa-api-key

Query parameters

qstring

Topic to search for, up to 500 characters. Ranks by relevance; see above.

fromnumber double

Unix seconds. Required unless eventIds or q is sent.

tonumber double

Unix seconds. Default now.

eventIdsstring[]

Up to 30. An id we do not hold, or older than the plan's history, is skipped.

eventClass'market' | 'asset' | 'call'

What the event is about: the market at large, one asset, or somebody's call.

eventType'security' | 'listing' | 'regulatory' | 'macro' | 'protocol' | 'company' | 'marketFlow' | 'price' | 'social' | 'spam' | 'other'

What kind of development it is. Anything the model cannot place becomes other.

implication'bullish' | 'bearish' | 'mixed' | 'unclear'

Which way the event cuts. On a call, derived from the side taken.

entityIdsstring[]

Up to 30 family or entity UUIDs. Matches events naming any of them.

assetClass'crypto' | 'equity'

Market-wide events with no asset come through either way.

novelty'new' | 'update'

new skips second readings of a story already served.

alertActionAlertActionV3[]

Repeatable, or comma separated.

sort'latest' | 'relevant'

Default latest, newest first. relevant ranks the last 24 hours.

hasStoryline'true' | 'false'

true keeps events that belong to a storyline, false those that do not.

arcIdstring

Events in one arc's storylines. Not with sort=relevant. An arc id we do not hold is a 400.

notable'true' | 'false'

true drops events a storyline marked as not material.

order'desc' | 'asc'
limitnumber double

Default 10, maximum 30.

cursorstring

nextCursor from the previous response.

Response

Ok

nextCursorstring nullable required

Pass back as cursor for the next page. Null on the last page.

hasMoreboolean required
servedFromnumber double nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.