Skip to main content
Get API Key

API Reference

Every Elfa REST endpoint in one table. API v3 is the newest set of endpoints; API v2 keeps working alongside it. Click any endpoint for full parameters, responses, and an interactive "Try it" console.

VersionBaseAuthStart here
v3api.elfa.ai/v3x-elfa-api-keyAPI v3 overview
v2api.elfa.ai/v2x-elfa-api-keyAPI v2 overview
v2 x402api.elfa.ai/x402/v2No key. Pay per request in USDCx402 Payments

See Authentication for keys and access, and Rate Limits for limits, including x402.

MethodPathVersionLink
v3 · Events
GET/v3/eventsv3Events
GET/v3/events/arcsv3Arcs
GET/v3/events/storylinesv3Storylines
v3 · Market
GET/v3/market/crypto/call-bookv3Crypto call book
GET/v3/market/crypto/mindsharev3Crypto mindshare
GET/v3/market/crypto/trending-contractsv3Trending contracts
GET/v3/market/equity/call-bookv3Equity call book
GET/v3/market/equity/mindsharev3Equity mindshare
v3 · Calls
GET/v3/callsv3Calls
GET/v3/calls/episodesv3Call episodes
GET/v3/calls/positioningv3Positioning
v3 · People
GET/v3/people/accountsv3Top accounts
v3 · Entities
GET/v3/entitiesv3Entities
v3 · Account
GET/v3/key-statusv3Key status
v2 · Chat
POST/v2/chatv2AI chat
POST/v2/chat/streamv2AI chat stream
v2 · Mentions
GET/v2/data/keyword-mentionsv2Multi keyword mentions search
GET/v2/data/token-newsv2Token news mentions (tweet source only)
GET/v2/data/top-mentionsv2Top mentions
v2 · Trending
GET/v2/aggregations/trending-cas/telegramv2Trending contract addresses on Telegram
GET/v2/aggregations/trending-cas/twitterv2Trending contract addresses on Twitter
GET/v2/aggregations/trending-tokensv2Trending tokens
v2 · Narratives
GET/v2/data/event-summaryv2Event summary from keyword mentions (5 credits total)
GET/v2/data/trending-narrativesv2Trending narratives (5 credits total)
v2 · Accounts
GET/v2/account/smart-statsv2Smart stats of accounts (legacy, removed 28 Oct 2026)
v2 · Account
GET/v2/key-statusv2API key status
GET/v2/pingv2Health check endpoint
v2 x402 · Chat
POST/x402/v2/chatv2 x402AI chat
v2 x402 · Mentions
GET/x402/v2/data/keyword-mentionsv2 x402Multi keyword mentions search
GET/x402/v2/data/token-newsv2 x402Token news mentions (tweet source only)
GET/x402/v2/data/top-mentionsv2 x402Top mentions
v2 x402 · Trending
GET/x402/v2/aggregations/trending-cas/telegramv2 x402Trending contract addresses on Telegram
GET/x402/v2/aggregations/trending-cas/twitterv2 x402Trending contract addresses on Twitter
GET/x402/v2/aggregations/trending-tokensv2 x402Trending tokens
v2 x402 · Narratives
GET/x402/v2/data/event-summaryv2 x402Event summary from keyword mentions (5 credits total)
GET/x402/v2/data/trending-narrativesv2 x402Trending narratives (5 credits total)
v2 x402 · Accounts
GET/x402/v2/account/smart-statsv2 x402Smart stats of accounts (legacy, removed 28 Oct 2026)
v2 Auto · Auto
DELETE/v2/auto/queries/{queryId}v2 AutoDelete Query
DELETE/v2/auto/queries/drafts/{draftId}v2 AutoDelete Query Draft
GET/v2/auto/executionsv2 AutoList Executions
GET/v2/auto/executions/{executionId}v2 AutoGet Execution
GET/v2/auto/queriesv2 AutoList Queries
GET/v2/auto/queries/{queryId}v2 AutoPoll Query
GET/v2/auto/queries/{queryId}/sessionsv2 AutoList LLM Sessions
GET/v2/auto/queries/{queryId}/sessions/{sessionId}v2 AutoLLM Session Details
GET/v2/auto/queries/{queryId}/streamv2 AutoStream Notifications
GET/v2/auto/queries/draftsv2 AutoList Query Drafts
GET/v2/auto/queries/drafts/{draftId}v2 AutoGet Query Draft
GET/v2/auto/queries/streamv2 AutoStream All Notifications
GET/v2/auto/validate-symbol/{exchange}/{symbol}v2 AutoValidate Symbol
POST/v2/auto/chatv2 AutoBuilder Chat
POST/v2/auto/queriesv2 AutoCreate Query
POST/v2/auto/queries/{queryId}/cancelv2 AutoCancel Query
POST/v2/auto/queries/draftsv2 AutoUpsert Query Draft
POST/v2/auto/queries/drafts/{draftId}/convertv2 AutoConvert Query Draft
POST/v2/auto/queries/drafts/{draftId}/validatev2 AutoValidate Query Draft
POST/v2/auto/queries/validatev2 AutoValidate Query
v2 Auto x402 · Auto
GET/x402/v2/auto/queries/{queryId}/streamv2 Auto x402Stream Notifications
POST/x402/v2/auto/chatv2 Auto x402Builder Chat
POST/x402/v2/auto/queriesv2 Auto x402Create Query
POST/x402/v2/auto/queries/{queryId}v2 Auto x402Poll Query
POST/x402/v2/auto/queries/{queryId}/cancelv2 Auto x402Cancel Query
POST/x402/v2/auto/queries/{queryId}/sessionsv2 Auto x402List LLM Sessions
POST/x402/v2/auto/queries/{queryId}/sessions/{sessionId}v2 Auto x402LLM Session Details
POST/x402/v2/auto/queries/validatev2 Auto x402Validate Query

Response Compatibility​

Response bodies and headers are extensible. We add optional fields and response headers without a version bump. That is a backwards-compatible change, and your client should ignore what it does not recognise. Removals, renames, retypes and semantic changes are not made this way: those get a deprecation window, Deprecation / Sunset headers on the affected routes, and an entry in the Changelog.

Practically, when integrating:

  • Do not pin an Elfa response with an exact-shape assertion: z.strictObject, Zod .strict(), JSON Schema additionalProperties: false, Pydantic extra="forbid", or an exhaustive discriminated union. The next additive field will break your client even though the API stayed compatible.
  • Do parse leniently and select the fields you use. The official SDKs already behave this way: @elfa-ai/sdk types responses without validating them, and elfa-sdk (Python) sets extra="allow" on every model.
  • Subscribe to the Changelog for additions worth adopting, for example the credits field and x-elfa-credits header that report what a call cost.