product-guide

Files (2)

• SKILL.md
• supported-chains.md · references/

SKILL.md (first lines)

# Allium Product Guide

Allium offers four core products for accessing blockchain data. Each serves a
different access pattern, latency requirement, and integration style. Explorer,
Datashares, and Datastreams share one historical data platform; the Realtime
APIs serve a smaller, separate set of chains.

> **Answering "what chains does Allium support?" (grounding rule)**
>
> Chain names and counts must come from the canonical list, never from memory —
> generating them from memory produces unstable totals and invented chains.
>
> 1. Fetch the **Allium Supported Chains — Canonical List** reference file (see
>    "Reference files" below) and quote it. For an up-to-the-minute Realtime
>    figure, call the `get_realtime_supported_chains` tool.
> 2. Always say **which product** a count refers to — the historical data
>    platform (Explorer / Datashares / Datastreams) and the Realtime APIs have
>    different totals.
> 3. The headline total must equal the number of rows for that product in the
>    canonical list. Do not round to a vague "80+/130+/150+" — cite the exact
>    count and state the list's snapshot date in the answer, so a reader can see
>    how current it is (e.g. "**[N]** chains on the historical data platform, as
>    of **[snapshot date]**"). Pull both **[N]** and the date from the fetched
>    reference file — never from this instruction or from memory.
> 4. If a chain is not in the canonical list, say it is not currently supported
>    rather than guessing.

## Product Overview

| Product           | Access Pattern                      | Latency                                | Pricing Model              | Best For                                            |
| ----------------- | ----------------------------------- | -------------------------------------- | -------------------------- | --------------------------------------------------- |
| **Explorer**      | SQL queries via web UI or API       | ~1 hour freshness, ~4-5s query time    | Query compute time         | Ad-hoc analysis, dashboards, research               |
| **Realtime APIs** | REST API (pull)                     | 50-100ms response, 3-5s data freshness | API call volume            | Application backends, wallets, trading UIs          |
| **Datastreams**   | Push via Kafka/PubSub/SNS/WebSocket | 3-5s data freshness                    | Data destinations & egress | Event-driven architectures, real-time pipelines     |
| **Datashares**    | Native tables in your warehouse     | 1-3 hours batch, sub-minute streaming  | Number of chains & schemas | Institutional analytics, joining with internal data |

## Explorer

**What it is:** A SQL-based analytics workspace at `app.allium.so/explorer` that
lets users query, visualize, and share blockchain data across every chain on the
historical data platform (see the canonical chain list for the exact count). Powered
by Snowflake (OLAP).

**Key capabilities:**

- Full SQL interface with cross-chain queries (e.g., `crosschain.dex.trades`)
- 1,000+ enriched schemas: raw, decoded, DEX, DeFi, NFTs, stablecoins, wallet 360, metrics, bridges, prices, PnL
- Interactive chart builder with public sharing and embed links
- CSV and API data upload — join your own data with on-chain data
- Parameterized queries for reusable, dynamic SQL
- AI Assistant for natural-language-to-SQL
- Explorer API — programmatic query lifecycle (create, run, fetch results, cancel)
- Curated metrics dashboards for stablecoins, DEXs, bridges, etc.

**Target users:**

- Analytics teams at crypto companies (foundations, protocols, wallets)
- Data analysts and researchers
- Audit, accounting, and compliance teams (Big 4 firms)
- Growth and marketing teams tracking ecosystem metrics

**Common use cases:**

- User behavior analytics and wallet activity patterns
- Ecosystem metrics and competitive intelligence
- Sybil detection for airdrop eligibility (used by Jito, Wormhole)
- Account reconciliation and auditing (used by Big 4 firms)
- DEX adoption dashboards (Uniswap Foundation)
- Financial monitoring and tax reporting (TaxBit)

**When to recommend Explorer:**

- Customer wants to explore data interactively with SQL
- Ad-hoc analysis, research, or one-off investigations
- Building shareable dashboards and visualizations
- Uploading proprietary data to join with on-chain data
- Needs the broadest chain coverage (the full historical data platform; see the
  canonical chain list) and deepest schema library (1,000+)
- Hourly data freshness is acceptable

## Realtime APIs

**What it is:** Production-grade REST APIs delivering real-time, enriched
blockchain data with 50-100ms response times and 3-5 second data freshness.
Realtime covers fewer chains than the historical data platform — quote the
canonical chain list (or the live `get_realtime_supported_chains` tool) for the
exact set and count.

**Key capabilities:**

- **Prices** — real-time and historical token prices from on-chain DEX trades (not centralized exchanges). OHLC candles, VWAP, z-score outlier filtering. New tokens priced within seconds of first DEX trade (including pump.fun launches)
- **Tokens** — metadata, type, price, decimals, FDV, volume, trade count, holders, ATH/ATL, liquidity, creation time. Sortable and searchable
- **Wallets** — current balances (native + ERC-20/SPL), historical balances at any point in time, full transaction history with activity labels (swaps, transfers, DEX trades)
- **Holdings** — real-time and historical USD portfolio holdings with built-in PnL using average cost basis. Multi-granularity (15s/5m/1h/1d)
- **Assets** — batch-fetch asset details by chain + address
- **Hyperliquid** — dedicated endpoints for the Hyperliquid protocol
- Custom endpoints backed by your own SQL queries

**Performance:**

- 50-100ms response time
- 1-1.2s raw block freshness, 3-5s enriched data freshness
- Tested to 90,000 RPS (Phantom/Jupiter airdrop: 477M requests in 4 hours)
- 99.9% uptime SLA

**Authentication:** API key via `X-API-KEY` header. Generate at Settings > API Keys.

**Target users:**

- Application developers building crypto products
- Wallet teams (Phantom, MetaMask)
- DEX/trading platforms (Uniswap, Fomo)
- Payment providers (MoonPay, Bridge.xyz)
- Fraud detection systems (Cube3.ai, Blowfish)
- AI agent builders

**When to recommend Realtime APIs:**

- Customer is building an application that needs to pull data on demand

From allium-labs/allium-claude-plugin, MIT.

More from allium-labs/allium-claude-plugin