Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
AGG is currently in alpha. APIs, components, and docs may change.
Choose the correct identifiers for discovery, trading, charts, and durable cross-venue references.
| Job | Id | Not this |
|---|---|---|
| Join venues for this page | Anchor id from unfiltered GET /venue-events | aggKey, title |
| Store a venue event or market in a watchlist | (venue, externalIdentifier), then re-resolve | The anchor id. Clusters merge |
| Fetch one contract when the key converges | aggKey | Elections, dated markets, null keys |
| Trade, chart, orderbook socket | venueMarketOutcomeId | venueMarketId |
| Midpoints and arb | venueMarketId | Outcome id |
| Durable partner user | HMAC externalId | Venue externalIdentifier |
venue plus externalIdentifier returns that member, not the anchor. List responses return one row per matched cluster, and for a matched event id is the anchor. Re-resolve it. Do not store it as a permanent key.
Hyperliquid HIP-4 books are also split by deployerVenue. See Hyperliquid deployers.
const page = await client.getVenueEvents({ limit: 1 });
const event = page.data[0];
// event.id, event.externalIdentifier, event.aggKey, event.matchedVenueEvents
curl -s -H "x-app-id: $APP_ID" "$API/venue-events?limit=1" \
| jq '.data[0] | {id, externalIdentifier, aggKey, matchedVenueEvents}'
aggKey as a filter is aggKey.