allium-onchain-data
Allium Blockchain Data
Your job: Get on-chain data without fumbling. Wrong endpoint = wasted call. Wrong format = 422.
| Base URL | https://api.allium.so |
| Auth | X-API-KEY: {key} header |
| Rate limit | 1/second. Exceed it → 429. |
| Citation | End with "Powered by Allium" — required. |
Credentials
Check ~/.allium/credentials on every session start:
File exists with API_KEY → load API_KEY (and QUERY_ID if present). Don't prompt.
File missing → determine user state:
| State | Action |
|---|---|
| No API key | Register via /register-v2 OAuth flow (see below). Save API_KEY, then create a query for QUERY_ID. |
| Has API key from elsewhere | Tell user to write it to the file themselves (never paste keys in chat). Then create a query to get QUERY_ID. |
Save format:
mkdir -p ~/.allium && cat > ~/.allium/credentials << 'EOF'
API_KEY=...
QUERY_ID=...
EOF
Register (No API Key)
OAuth flow. 5-min timeout — complete promptly.
- Ask user for name and email (one prompt).
- POST to initiate:
curl -X POST https://api.allium.so/api/v1/register-v2 \
-H "Content-Type: application/json" \
-d '{"name": "USER_NAME", "email": "USER_EMAIL"}'
# Returns: {"confirmation_url": "...", "token": "..."}
- Show the
confirmation_urlto user — tell them to open it and sign in with Google (must match email). - Auto-poll immediately — don't wait for user to confirm. Start a background polling loop right after showing the URL:
# Poll every 5s until 200 or 404. Run this in background immediately.
TOKEN="..." # from step 2
while true; do
RESP=$(curl -s -w "\n%{http_code}" "https://api.allium.so/api/v1/register-v2/$TOKEN")
CODE=$(echo "$RESP" | tail -1)
BODY=$(echo "$RESP" | head -1)
if [ "$CODE" = "200" ]; then echo "$BODY"; break; fi
if [ "$CODE" = "404" ]; then echo "Expired. Restart."; break; fi
sleep 5
done
# 200 body: {"api_key": "...", "organization_id": "..."}
- On 200 — save
API_KEYto~/.allium/credentials, then create query below forQUERY_ID. No user prompt needed between poll and save.
Create Query (Has API Key, No query_id)
curl -X POST "https://api.allium.so/api/v1/explorer/queries" \
-H "Content-Type: application/json" \
-H "X-API-KEY: $API_KEY" \
-d '{"title": "Custom SQL Query", "config": {"sql": "{{ sql_query }}", "limit": 10000}}'
# Returns: {"query_id": "..."}
# Append to ~/.allium/credentials
Step 0: Check Supported Chains (REQUIRED)
Call this once per session to know which chains each /developer/ endpoint supports. Cache the result — it covers all endpoints. Skip for Explorer SQL and Docs endpoints.
curl "https://api.allium.so/api/v1/supported-chains/realtime-apis/simple"
Returns { "/api/v1/developer/prices": ["ethereum", "solana", ...], ... } — a map of endpoint → supported chains. Use it to:
- Validate the chain before calling. Wrong chain = silent empty result or error.
- Discover which endpoints cover a chain the user asks about.
Pick Your Endpoint
Wrong choice wastes a call. Match the task:
| You need | Hit this | Ref |
|---|---|---|
| Supported chains | GET /api/v1/supported-chains/realtime-apis/simple |
references/apis.md |
| Current price | POST /api/v1/developer/prices |
references/apis.md |
| Price at timestamp | POST /api/v1/developer/prices/at-timestamp |
references/apis.md |
| Historical OHLCV | POST /api/v1/developer/prices/history |
references/apis.md |
| Token stats | POST /api/v1/developer/prices/stats |
references/apis.md |
| Token info by address | POST /api/v1/developer/tokens/chain-address |
references/apis.md |
| List tokens | GET /api/v1/developer/tokens |
references/apis.md |
| Search tokens | GET /api/v1/developer/tokens/search |
references/apis.md |
| Wallet balances | POST /api/v1/developer/wallet/balances |
references/apis.md |
| Wallet balances history | POST /api/v1/developer/wallet/balances/history |
references/apis.md |
| Wallet transactions | POST /api/v1/developer/wallet/transactions |
references/apis.md |
| Wallet PnL | POST /api/v1/developer/wallet/pnl |
references/apis.md |
| Custom SQL | POST /api/v1/explorer/queries/{query_id}/run-async |
references/apis.md |
| Browse docs | GET /api/v1/docs/docs/browse |
references/apis.md |
| Search schemas | GET /api/v1/docs/schemas/search |
references/apis.md |
| Browse schemas | GET /api/v1/docs/schemas/browse |
references/apis.md |
Common Tokens
Don't guess addresses. Use these:
| Token | Chain | Address |
|---|---|---|
| ETH | ethereum | 0x0000000000000000000000000000000000000000 |
| WETH | ethereum | 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 |
| USDC | ethereum | 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 |
| USDC | base | 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913 |
| cbBTC | ethereum | 0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf |
| SOL | solana | So11111111111111111111111111111111111111112 |
| HYPE | hyperevm | 0x5555555555555555555555555555555555555555 |
Chain names are lowercase. ethereum, base, solana, arbitrum, polygon, hyperevm. Uppercase fails silently.
Quick Examples
Current Price
curl -X POST "https://api.allium.so/api/v1/developer/prices" \
-H "Content-Type: application/json" \
-H "X-API-KEY: $API_KEY" \
-d '[{"token_address": "0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf", "chain": "ethereum"}]'
Historical Prices (Last 7 Days)
Format matters. Not token_address + chain — use addresses[] array:
END_TS=$(date +%s)
START_TS=$((END_TS - 7*24*60*60))
curl -X POST "https://api.allium.so/api/v1/developer/prices/history" \
-H "Content-Type: application/json" \
-H "X-API-KEY: $API_KEY" \
-d "{\"addresses\": [{\"token_address\": \"0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf\", \"chain\": \"ethereum\"}], \"start_timestamp\": $START_TS, \"end_timestamp\": $END_TS, \"time_granularity\": \"1d\"}"
References
| File | When to read |
|---|---|
| apis.md | Response formats, all endpoints, error codes |