Skip to main content

Getting started

Elfa is our flagship finance agent, powered by our real-time intelligence stack (Iris). Iris synthesises signals across social, on-chain, and off-chain market data, then traces their second and third-order effects, so agents act on greater context.

This REST API gives you the same signals Elfa is powered by, with full endpoint references and code samples below.

If you're working with AI (Codex, Claude Code, Cursor, Copilot), install the Elfa skill:

npx skills add elfa-ai/skills

For the complete agent setup path — skills, llms.txt, endpoint metadata, and product-surface routing — use Agent Quickstart.

Explore More

REST Reference

Browse every REST endpoint across API-key and x402 surfaces, with parameters, response schemas, and interactive "Try it".

Market Intelligence

Measure market attention and ask Elfa for interpretation over REST: trending assets, mentions, account quality, news, narratives, and chat.

Auto

A managed condition engine and trigger pipeline: describe what to watch, and get notified or execute when it fires.

Widget

Embed Elfa's AI intelligence in your own product with the drop-in widget or the headless Widget API.

x402

Pay-per-request access in USDC. No API key, no signup. Built for autonomous agents.

Authenticate Your Request

Before you can access Elfa data, you need your unique API key.

Obtaining Your API Key

  1. Visit the Elfa Developer Portal and sign up or log in.
  2. Open the API Key tab to find your API key.
  3. Keep your API key secure and do not share it publicly.

Include your API key in the x-elfa-api-key header on every request:

x-elfa-api-key: your_api_key_here
Never print or log ELFA_API_KEY, ELFA_HMAC_SECRET, or complete auth headers — for debugging, log only redacted metadata (for example route and status code), never secret values.

Making Your First API Request

Let's make a simple request to the Trending Tokens endpoint to list the tokens gaining the most social attention. Pick your preferred language:

curl -X GET "https://api.elfa.ai/v2/aggregations/trending-tokens" \
-H "x-elfa-api-key: your_api_key_here"