{"openapi":"3.1.0","info":{"title":"Femtos API","version":"1.0.0","description":"REST + WebSocket data for Elysium (testnet, chain 99801), HyperEVM and HyperCore: launches, candles, trades, holders, launch lifecycle, bridges, cross-layer wallets. Decimals are exact strings, times Unix ms, addresses lowercase 0x. A named wallet's address (the KOLs, traders and funds of /v1/entities) never appears as such: every field, string, URL and WebSocket frame gives its handle `.` (e.g. `loraclexyz.3f9a1c2e`, stable), and a handle is accepted as input anywhere an address is (path, query, WebSocket filters). Auth: `Authorization: Bearer ` or `X-API-KEY: ` (WebSocket: `POST /v1/ws-ticket` with the key, then `/v1/ws?ticket=`; `/v1/ws?token=` still works but is deprecated: proxies log URLs, so the key would be written in their logs). A source that cannot answer = 503 {error, unavailable}; unknown token / market / launch = 404. While a layer syncs (`state: syncing` in /v1/status), answers hold what is indexed: objects carry `syncing: true, dataUntil`, arrays the headers `X-Layer-State: syncing`, `X-Data-Until`. Provenance: a row cites the chain event it comes from by `block` + `tx` (the transaction hash) + `logIndex` (EVM layers: the log) — HyperCore: the block and the hash of the transaction whose fills made it; rows of several layers say which in `layer`. An aggregate (candles, holders, volume, NFT holdings) cites the head it is cut at: `height` = a block every event up to which is counted, `asOf` = its time."},"servers":[{"url":"https://api.femtos.xyz/v1"}],"security":[{"bearer":[]},{"apiKey":[]}],"tags":[{"name":"Launches"},{"name":"Market data"},{"name":"Liquidations & positions"},{"name":"Holders"},{"name":"Bridges"},{"name":"NFTs"},{"name":"Wallet"},{"name":"Meta"}],"paths":{"/whoami":{"get":{"tags":["Meta"],"summary":"The key used: name, tier, billing state, limits in force","operationId":"whoami","description":"Answers the key this request authenticated with (never the key itself): the name it is registered under, its tier, its billing state and the limits in force. The cheapest way to check a key works; never metered.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":["string","null"],"description":"Name the key is registered under (never the key itself)","example":"acct_3f9a"},"tier":{"type":["string","null"],"enum":["free","builder","pro","scale","enterprise","partner",null],"description":"null: internal key"},"billing":{"type":["string","null"],"enum":["ok","exhausted","capped",null],"description":"exhausted / capped: the key runs at the free tier limits (and heavy calls may answer 402)"},"limits":{"type":["object","null"],"description":"Limits in force (the free row while billing is exhausted / capped); null: no limit (internal key)","properties":{"rps":{"type":"number","description":"Requests per second (refill of the bucket)","example":30},"burst":{"type":"integer","description":"Bucket capacity","example":60},"maxConns":{"type":"integer","description":"WebSocket connections at once","example":5}}}},"required":["key","tier","billing","limits"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/ws-ticket":{"post":{"tags":["Meta"],"summary":"A single-use WebSocket ticket (30 s): open `/ws?ticket=` with it","operationId":"wsTicket","description":"The key goes in a header here, the ticket in the WebSocket URL: the key never travels in a URL (tunnels and proxies log URLs, query included). One ticket opens one connection, within ttlS seconds. Counts against the key's rps / burst, never billed. `/ws?token=` still works but is deprecated.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ticket":{"type":"string","description":"Pass as /ws?ticket=","example":"wst_9mX2…"},"ttlS":{"type":"integer","description":"Seconds to use it","example":30},"expiresAt":{"type":"integer","description":"Unused after (Unix ms)","example":1792236158000}},"required":["ticket","ttlS","expiresAt"]}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Over the key's rps / burst (Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/status":{"get":{"tags":["Meta"],"summary":"Layer heads and lag","operationId":"status","description":"Measured now, per layer: state (live, or syncing while its indexer is behind the chain), indexed head block and time, lag behind real time; on the EVM layers the node's own head and how far the indexed head is behind it; Elysium's network (testnet / mainnet). Also the state of the live feeds and the HyperCore <> HyperEVM bridge matching coverage. Check it when an answer looks stale. Free (never metered).","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/audit":{"get":{"tags":["Meta"],"summary":"Public correctness audit (no key)","description":"Every few minutes per layer, random items of what we serve are compared with their source of truth: HyperCore fills, trades, positions and spot balances vs Hyperliquid public API (same request, same instant); HyperEVM and Elysium blocks, transactions, logs and balances vs the archive node at the same block, block hashes vs a public RPC; HyperEVM balances, supplies and pools by hyperevm-verify. Counts over 24 h and 7 d, each mismatch with both values.","operationId":"audit","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Audit"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/audit/open":{"get":{"tags":["Meta"],"summary":"Open audit mismatches and their triage (no key)","description":"The items of the audit that differed from their source of truth and are neither corrected nor explained yet (last 7 days, newest first), each with its latest triage. Polled every minute by the triage runner and the notifications; 503 (same body, with reason) when the audit store does not answer.","operationId":"auditOpen","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditOpen"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Audit store unavailable: the same body with reason, counts 0","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditOpen"}}}}}}},"/audit/triage":{"get":{"tags":["Meta"],"summary":"Triages of audit mismatches, newest first (no key)","operationId":"auditTriage","description":"The latest triages of the audit's mismatches, newest first: for each, the cause found, whether it was corrected or explained, and when. Public, no key; cached 15 s.","security":[],"parameters":[{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"example":50}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AuditTriage"}}},"required":["items"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/x402/networks":{"get":{"tags":["Meta"],"summary":"x402: the networks USDC is accepted on, cheapest settlement first (no key)","description":"The networks a keyless agent can buy a credit pack on with x402 (scheme `exact`, USDC, EIP-3009), ranked by what one settlement costs Femtos now (refreshed every minute). A network is offered for a pack only when that cost is at most `maxFeeRatio` of the pack: `packsUsd` per network. The 402 lists the same networks in the same order, the first one `recommended`. `{enabled: false, networks: []}` while x402 is off.","operationId":"x402Networks","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean"},"x402Version":{"type":"array","items":{"type":"integer"},"description":"Protocol versions spoken (1, 2)"},"scheme":{"type":"string","description":"exact"},"packsUsd":{"type":"array","items":{"type":"number"},"description":"Credit packs (USD), ascending"},"packParam":{"type":"string","description":"Query parameter asking a 402 for a bigger pack (x402_pack=)"},"maxFeeRatio":{"type":"number","description":"Largest settlement cost / pack offered"},"networks":{"type":"array","items":{"type":"object","properties":{"network":{"type":"string","description":"CAIP-2 (x402 v2 `network`)","example":"eip155:8453"},"id":{"type":"string","description":"Short name","example":"base"},"name":{"type":"string","description":"Chain","example":"Base"},"chainId":{"type":"integer","description":"EVM chain id"},"v1Network":{"type":["string","null"],"description":"x402 v1 network name (null: v2 only)"},"asset":{"type":"string","description":"USDC contract (6 decimals)"},"decimals":{"type":"integer","description":"6"},"eip712":{"type":"object","properties":{"name":{"type":"string","description":"EIP-712 domain name of the token"},"version":{"type":"string","description":"EIP-712 domain version"}},"required":["name","version"]},"payTo":{"type":"string","description":"Femtos address receiving the USDC on that chain"},"settleCostUsd":{"type":"number","description":"Estimated cost of one settlement (USD)"},"costSource":{"type":"string","description":"live (gas price × gas × native price), fallback (static, conservative) or facilitator (its fee)"},"gasPriceGwei":{"type":"number"},"offered":{"type":"boolean","description":"In the 402 now"},"recommended":{"type":"boolean","description":"The cheapest: the first `accepts` entry"},"packsUsd":{"type":"array","items":{"type":"number"},"description":"Packs offered on this network"},"reason":{"type":"string","description":"Why not offered"}},"required":["network","id","name","chainId","v1Network","asset","decimals","eip712","payTo","settleCostUsd","costSource","gasPriceGwei","offered","recommended","packsUsd","reason"]}}},"required":["enabled","x402Version","scheme","packsUsd","packParam","maxFeeRatio","networks"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/openapi.json":{"get":{"tags":["Meta"],"summary":"This document (public)","operationId":"openapi","description":"This OpenAPI 3.1 document, no key needed. The same API in Markdown for agents: https://femtos.xyz/agents.md (index: https://femtos.xyz/llms.txt).","security":[],"responses":{"200":{"description":"OpenAPI 3.1"}}}},"/launches":{"get":{"tags":["Launches"],"summary":"Latest launches, newest first","operationId":"listLaunches","description":"Elysium (Ascend) by default; launchpad=liquidlaunch (or layer=hyperevm): HyperEVM LiquidLaunch. While the layer syncs (`state: syncing` in /v1/status: its indexer is behind the chain) the array holds what is indexed and the response carries the headers `X-Layer-State: syncing` and `X-Data-Until: ` (indexed head time).","parameters":[{"name":"launchpad","in":"query","required":false,"description":"Launchpad name: ascend (Elysium), liquidlaunch (HyperEVM)","schema":{"type":"string"},"example":"ascend"},{"name":"layer","in":"query","required":false,"description":"hyperevm = LiquidLaunch","schema":{"type":"string","enum":["elysium","hyperevm"]}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":200,"default":50},"example":20},{"name":"creator","in":"query","required":false,"description":"Elysium: launched by this wallet (creator at launch or current creator)","schema":{"type":"string"}},{"name":"quote","in":"query","required":false,"description":"Elysium: quote token of the pool (USDC, an RWA token…)","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"Elysium: symbol or name contains (case ignored)","schema":{"type":"string","maxLength":64}},{"name":"since","in":"query","required":false,"description":"Elysium: launched at or after (ms)","schema":{"type":"integer"}},{"name":"until","in":"query","required":false,"description":"Elysium: launched before (ms)","schema":{"type":"integer"}},{"name":"before","in":"query","required":false,"description":"Elysium: cursor block:logIndex, the X-Next-Cursor header of the previous page","schema":{"type":"string"}},{"name":"includeSpam","in":"query","required":false,"description":"Show spam tokens (tokens.spam: homoglyph, impostor, phishing name, fake transfers…) flagged spam / spamReason; left out of the list by default","schema":{"type":"boolean","default":false}},{"name":"minMcapUsd","in":"query","required":false,"description":"Ascended criterion: minimum market cap, USD (decimal string)","schema":{"type":"string"},"example":"100000"},{"name":"minHolders","in":"query","required":false,"description":"Ascended criterion: minimum unique holders (system excluded)","schema":{"type":"integer","minimum":1},"example":300},{"name":"minVolumeUsd","in":"query","required":false,"description":"Ascended criterion: minimum volume since launch, USD","schema":{"type":"string"}},{"name":"maxTop10Share","in":"query","required":false,"description":"Ascended criterion: maximum top-10 share of the supply","schema":{"type":"number","exclusiveMinimum":0,"maximum":1}}],"responses":{"200":{"description":"OK; X-Next-Cursor (block:logIndex) when the page is full","headers":{"X-Next-Cursor":{"schema":{"type":"string"},"description":"Pass as `before` for the next page"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LaunchRow"}}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/launches/{token}":{"get":{"tags":["Launches"],"summary":"One launch: Ascended metrics, dev wallet, early buyers, signals, fees","operationId":"getLaunch","description":"The full story of one launched token: the launch event, current market cap and 24 h volume, holders and concentration, the dev wallet and its funding before the launch, early buyers (first `earlyWindowSec` seconds) with their flags, coordination signals, the fees (exact from the launchpad ledger when indexed) and, on Elysium, the progress toward the derived \"Ascended\" status. Elysium first, then HyperEVM LiquidLaunch. Ascend publishes no threshold and its launchpad contract has no graduation state or event (checked on chain): `ascend.status` is derived from the thresholds of the request, else of the server (none configured: null).","parameters":[{"name":"token","in":"path","required":true,"description":"Launched token address","schema":{"type":"string"},"example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},{"name":"earlyWindowSec","in":"query","required":false,"description":"Early-buyer window after the launch block","schema":{"type":"integer","minimum":1,"maximum":3600,"default":60}},{"name":"fundingLookbackSec","in":"query","required":false,"description":"Funding lookback before the launch","schema":{"type":"integer","minimum":1,"maximum":604800,"default":86400}},{"name":"layer","in":"query","required":false,"description":"Default: Elysium, then HyperEVM LiquidLaunch when Elysium has no launch for the token","schema":{"type":"string","enum":["elysium","hyperevm"]}},{"name":"minMcapUsd","in":"query","required":false,"description":"Ascended criterion: minimum market cap, USD (decimal string)","schema":{"type":"string"},"example":"100000"},{"name":"minHolders","in":"query","required":false,"description":"Ascended criterion: minimum unique holders (system excluded)","schema":{"type":"integer","minimum":1},"example":300},{"name":"minVolumeUsd","in":"query","required":false,"description":"Ascended criterion: minimum volume since launch, USD","schema":{"type":"string"}},{"name":"maxTop10Share","in":"query","required":false,"description":"Ascended criterion: maximum top-10 share of the supply","schema":{"type":"number","exclusiveMinimum":0,"maximum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchDetail"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"No launch for this token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/tokens/{address}/lifecycle":{"get":{"tags":["Launches"],"summary":"One token across the 3 layers, from launch to perp: stages, addresses, links (exact or inferred)","operationId":"getTokenLifecycle","description":"Any layer's id in: an Elysium or HyperEVM address, `core:`, a HyperCore token id (0x + 32 hex), a token name or a perp coin (`dex:COIN`). Out: the token on each layer and its stages: Elysium launch (Ascend Launched), listing desk (Registered, Enrolled, Committed), HyperEVM mirror (bridge registry, on-chain checks), HyperCore spot (token registry, or the desk's Delivered relayed by CoreListingVerifier), perps (HIP-3: same name = inferred; dex collateral = exact). Each stage: `at` = chain evidence, `observedAt` = first seen by our registry. A link that cannot be proven is not made: the layer is null and `unavailable` says why. Testnet Elysium (99801) links to HyperEVM / HyperCore testnet.","parameters":[{"name":"address","in":"path","required":true,"description":"Elysium / HyperEVM address, core:, HyperCore token id, name or perp coin","schema":{"type":"string"},"example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},{"name":"minMcapUsd","in":"query","required":false,"description":"Ascended criterion: minimum market cap, USD (decimal string)","schema":{"type":"string"},"example":"100000"},{"name":"minHolders","in":"query","required":false,"description":"Ascended criterion: minimum unique holders (system excluded)","schema":{"type":"integer","minimum":1},"example":300},{"name":"minVolumeUsd","in":"query","required":false,"description":"Ascended criterion: minimum volume since launch, USD","schema":{"type":"string"}},{"name":"maxTop10Share","in":"query","required":false,"description":"Ascended criterion: maximum top-10 share of the supply","schema":{"type":"number","exclusiveMinimum":0,"maximum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lifecycle"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"No layer knows this token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/launches/{token}/holders":{"get":{"tags":["Launches"],"summary":"Holders of a launched token: page, concentration, dev / early-buyer tags","operationId":"getLaunchHolders","description":"Largest first, system addresses apart (PancakeSwap Infinity vault and PoolManager, AscendLaunchpad and its treasuries / listing desk, zero/dead). Tags and signal flags from the launch detail (default windows). Same resolution as /v1/launches/{token}.","parameters":[{"name":"token","in":"path","required":true,"description":"Launched token address","schema":{"type":"string"},"example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100},"example":20},{"name":"offset","in":"query","required":false,"description":"Rows to skip (`next`)","schema":{"type":"integer","minimum":0,"default":0}},{"name":"layer","in":"query","required":false,"description":"Default: Elysium, then HyperEVM","schema":{"type":"string","enum":["elysium","hyperevm"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaunchHolders"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"No launch for this token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/launches/{token}/timeline":{"get":{"tags":["Launches"],"summary":"Replayable life of a launch: launch, swaps, transfers with running holders / market cap, graduation links","operationId":"getLaunchTimeline","description":"Same resolution as /v1/launches/{token}. LiquidLaunch: holders replayed from the swaps (holdersFrom: swaps, approximate: wallet-to-wallet transfers not seen).","parameters":[{"name":"token","in":"path","required":true,"description":"Launched token address","schema":{"type":"string"},"example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},{"name":"layer","in":"query","required":false,"description":"Default: Elysium, then HyperEVM","schema":{"type":"string","enum":["elysium","hyperevm"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Timeline"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"No launch for this token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/markets":{"get":{"tags":["Market data"],"summary":"Tradable markets; EVM pools most traded first, paged","operationId":"listMarkets","description":"EVM pools (elysium, hyperevm) sorted by 24 h USD volume; default limit: elysium 5000 (whole list), hyperevm 100 (13k pools). X-Total-Count = pools matching q on the layer asked. While the layer syncs (`state: syncing` in /v1/status: its indexer is behind the chain) the array holds what is indexed and the response carries the headers `X-Layer-State: syncing` and `X-Data-Until: ` (indexed head time).","parameters":[{"name":"layer","in":"query","required":false,"description":"Layer (none: HyperCore + Elysium + top 100 HyperEVM pools)","schema":{"type":"string","enum":["hypercore","hyperevm","elysium"]},"example":"hyperevm"},{"name":"q","in":"query","required":false,"description":"EVM pools: substring of symbol, base, quote, addresses or protocol","schema":{"type":"string","maxLength":64}},{"name":"limit","in":"query","required":false,"description":"EVM pools per layer (default: elysium 5000, hyperevm 100)","schema":{"type":"integer","minimum":1,"maximum":5000},"example":50},{"name":"offset","in":"query","required":false,"description":"EVM pools to skip","schema":{"type":"integer","minimum":0,"default":0}},{"name":"includeOutcomes","in":"query","required":false,"description":"HyperCore outcome markets","schema":{"type":"integer","enum":[0,1],"default":0}},{"name":"includeSpam","in":"query","required":false,"description":"EVM pools of spam tokens (base or quote flagged in tokens.spam), flagged spam / spamReason; left out by default (and out of X-Total-Count)","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Market"}}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/candles":{"get":{"tags":["Market data"],"summary":"OHLCV candles (EVM pools: in quote, plus usd / mcap; from the first trade)","operationId":"getCandles","description":"HyperEVM while syncing: without `to` the window ends at the indexed head, the gap fill stops there, and the answer carries syncing / dataUntil. asOf / height: the head the candles are cut at (every trade up to that block is in them).","parameters":[{"name":"layer","in":"query","required":true,"description":"Layer","schema":{"type":"string","enum":["elysium","hyperevm","hypercore"]},"example":"elysium"},{"name":"market","in":"query","required":true,"description":"Elysium / HyperEVM: pair address (pool key); HyperCore: coin","schema":{"type":"string"},"example":"0x12e84206cb53ae0df055482ebc4658635096e1aa:0x8a9480e70c99d18d9bde3a7f5cd565be58064945963f62e0c5cc303b6b627847"},{"name":"tf","in":"query","required":true,"description":"Candle unit","schema":{"type":"string","enum":["1s","15s","1m","5m","15m","1h","4h","1d"]},"example":"1m"},{"name":"from","in":"query","required":false,"description":"Start (ms, inclusive)","schema":{"type":"integer"}},{"name":"to","in":"query","required":false,"description":"End (ms, exclusive; default now)","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Candles","schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000}},{"name":"fill","in":"query","required":false,"description":"1: flat candles for units without trade","schema":{"type":"integer","enum":[0,1],"default":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"market":{"type":"string","description":"Market"},"tf":{"type":"string","description":"Unit"},"candles":{"type":"array","items":{"$ref":"#/components/schemas/Candle"},"description":"Ascending"},"asOf":{"type":"integer","description":"Time of `height` (HyperCore: ingested head; EVM: indexed head, committed with the candles) (Unix ms)","example":1792236158000},"height":{"type":"integer","description":"Head block of the layer the answer is cut at: every event up to it is counted (HyperCore: ingested head; EVM: indexed head, committed with the candles)"},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","market","tf","candles"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/trades":{"get":{"tags":["Market data"],"summary":"Latest trades / swaps, newest first","operationId":"getTrades","description":"EVM: px = pool price after the swap as the indexer computes it (V3: sqrtPriceX96), not the amount ratio. While the layer syncs (`state: syncing` in /v1/status: its indexer is behind the chain) the array holds what is indexed and the response carries the headers `X-Layer-State: syncing` and `X-Data-Until: ` (indexed head time).","parameters":[{"name":"layer","in":"query","required":true,"description":"Layer","schema":{"type":"string","enum":["elysium","hyperevm","hypercore"]},"example":"elysium"},{"name":"market","in":"query","required":true,"description":"Pair address (pool key) or coin","schema":{"type":"string"},"example":"0x12e84206cb53ae0df055482ebc4658635096e1aa:0x8a9480e70c99d18d9bde3a7f5cd565be58064945963f62e0c5cc303b6b627847"},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trade"}}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/holders":{"get":{"tags":["Holders"],"summary":"Holders and concentration (system addresses excluded by default)","operationId":"getHolders","description":"Current balances of a token, largest first, with concentration (total holders, top-10 share). Elysium and HyperEVM: ERC-20 balances at the indexed head, `token` = 0x address. HyperCore: `token` = token name (HYPE) for spot balances, or a perp coin with kind=positions for open interest by account. System addresses (pools, PoolManager, hooks, bridges, launchpad, zero / dead) are counted apart unless excludeSystem=0. Named wallets carry `entity`.","parameters":[{"name":"layer","in":"query","required":false,"description":"Layer","schema":{"type":"string","enum":["hypercore","hyperevm","elysium"],"default":"hypercore"},"example":"hyperevm"},{"name":"token","in":"query","required":true,"description":"Token address (Elysium, HyperEVM), token name or perp coin (HyperCore)","schema":{"type":"string"},"example":"0x5555555555555555555555555555555555555555"},{"name":"kind","in":"query","required":false,"description":"HyperCore: spot balances of a token, or perp positions (open interest by account) of a coin","schema":{"type":"string","enum":["balances","positions"],"default":"balances"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"excludeSystem","in":"query","required":false,"description":"1: pools, PoolManager, hooks, gateways, bridge system addresses, LiquidLaunch curve, zero/dead counted apart","schema":{"type":"integer","enum":[0,1],"default":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Holders"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"Unknown token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/coins":{"get":{"tags":["Market data"],"summary":"Tokens and their links Elysium <-> HyperEVM <-> HyperCore (HyperEVM: every ERC-20 of the indexer)","operationId":"listCoins","description":"While the layer syncs (`state: syncing` in /v1/status: its indexer is behind the chain) the array holds what is indexed and the response carries the headers `X-Layer-State: syncing` and `X-Data-Until: ` (indexed head time).","parameters":[{"name":"layer","in":"query","required":false,"description":"Layer","schema":{"type":"string","enum":["hypercore","hyperevm","elysium"]}},{"name":"q","in":"query","required":false,"description":"Symbol, name or address (an exact address always answers its token, flagged)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows per layer","schema":{"type":"integer","maximum":1000,"default":100}},{"name":"includeSpam","in":"query","required":false,"description":"Show spam tokens (tokens.spam: homoglyph, impostor, phishing name, fake transfers…) flagged spam / spamReason; left out of the list by default","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"{layer, id, symbol, name, decimals, totalSupply, priceUsd, links:{core?, evm?, elysium?}, coverage?, spam, spamReason} (spam / spamReason on HyperEVM and Elysium coins)"}}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/bridges":{"get":{"tags":["Bridges"],"summary":"Bridge movements and 24 h stats (route=evm_elysium: HyperEVM <-> Elysium)","operationId":"getBridges","description":"Bridge movements, newest first (at most 7 days), with 24 h stats. route=core_evm: HyperCore <> HyperEVM transfers, each leg paired with its other leg (`matched_by`: nonce = exact, order = same key in order), deposit wallets resolved to their depositor and final beneficiary (Circle's CoreDepositWallet forwards, CCTP mints with their source chain). route=evm_elysium: HyperEVM <> Elysium (Arbitrum Orbit) deposits and withdrawals in their latest state; Kinetiq's system retryables counted apart (`system`). Heavy call.","parameters":[{"name":"route","in":"query","required":true,"description":"Bridge","schema":{"type":"string","enum":["evm_elysium","core_evm"]},"example":"evm_elysium"},{"name":"direction","in":"query","required":false,"description":"Direction","schema":{"type":"string","enum":["to_child","to_parent","evm_to_core","core_to_evm"]}},{"name":"token","in":"query","required":false,"description":"Token address (`hype` for native HYPE)","schema":{"type":"string"}},{"name":"account","in":"query","required":false,"description":"Sender or recipient","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"system","in":"query","required":false,"description":"Kinetiq system retryables (evm_elysium)","schema":{"type":"string","enum":["exclude","include","only"],"default":"exclude"}},{"name":"includeSpam","in":"query","required":false,"description":"evm_elysium: rows of spam parent tokens (HyperEVM tokens.spam), left out by default","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bridges"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/bridges/coverage":{"get":{"tags":["Bridges"],"summary":"HyperCore <> HyperEVM matching coverage: matched legs per direction and token, why the others are not, latency","operationId":"getBridgeCoverage","description":"Every HyperCore <> HyperEVM bridge leg since our data starts (HyperCore and HyperEVM from 2026-06-01) is paired with its other leg: EVM -> Core deposits with their HyperCore credit, Core -> EVM sends with the HyperEVM system transaction crediting them (exact by nonce for coreReceiveWithData, else same system address, account and amount in order). Counts per direction and per token, the reason of each unmatched leg, the credits no leg took, and the latency distribution of the matched ones. Cached 60 s.","parameters":[{"name":"window","in":"query","required":false,"description":"Legs of the window (by sending time)","schema":{"type":"string","enum":["all","30d","7d","24h"],"default":"all"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coverage"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/coins/{layer}/{id}":{"get":{"tags":["Market data"],"summary":"One coin: links, the markets it trades on, its 5 largest holders","operationId":"getCoin","description":"HyperCore: spot + perp markets of the same name, `id` = name, index or tokenId; HyperEVM: the linked HyperCore markets + its 20 most traded pools; Elysium: its pools. holders = {unavailable} when the source cannot answer.","parameters":[{"name":"layer","in":"path","required":true,"description":"Layer","schema":{"type":"string","enum":["hypercore","hyperevm","elysium"]},"example":"hypercore"},{"name":"id","in":"path","required":true,"description":"HyperCore token name (HYPE) or 0x address (HyperEVM, Elysium)","schema":{"type":"string"},"example":"HYPE"},{"name":"includeSpam","in":"query","required":false,"description":"Pools of spam tokens in `markets` (a spam coin always lists its own pools)","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"coin":{"type":"object","description":"/v1/coins item; a spam token still answers, flagged spam / spamReason"},"markets":{"type":"array","items":{"$ref":"#/components/schemas/Market"}},"holders":{"type":"object","description":"Holders (5 largest) or {unavailable}"}},"required":["coin","markets","holders"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"Unknown coin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nfts/collections":{"get":{"tags":["NFTs"],"summary":"Most active NFT collections over the last 1 h or 24 h (transfers, mints, burns)","operationId":"listNftCollections","description":"Window ending at the indexed head (HyperEVM while syncing) or now. Read from the block range of nft_transfers, top 200 kept 60 s.","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"window","in":"query","required":false,"description":"Window","schema":{"type":"string","enum":["1h","24h"],"default":"24h"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"window":{"type":"string","description":"Window"},"from":{"type":"integer","description":"Window start (Unix ms)","example":1792236158000},"to":{"type":"integer","description":"Window end (Unix ms)","example":1792236158000},"fromBlock":{"type":"integer","description":"First block"},"toBlock":{"type":"integer","description":"Last block"},"collections":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"transfers":{"type":"integer","description":"Transfers in the window"},"mints":{"type":"integer","description":"Mints"},"burns":{"type":"integer","description":"Burns"},"lastBlock":{"type":"integer","description":"Last transfer block"}},"required":["transfers","mints","burns","lastBlock"]}]}},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","window","collections"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nfts/collections/{address}":{"get":{"tags":["NFTs"],"summary":"One NFT collection: metadata, tokens seen (counted up to 1,000), 24 h activity","operationId":"getNftCollection","description":"One NFT collection of an EVM layer: its metadata (name, symbol, standard), how many token ids were seen (counted up to 1,000) and its transfers, mints and burns over the 24 h before the indexed head.","parameters":[{"name":"address","in":"path","required":true,"description":"Collection contract","schema":{"type":"string"},"example":"0x9ea4459c8defbf561495d95414b9cf1e2242a3e2"},{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"collection":{"$ref":"#/components/schemas/Collection"},"standards":{"type":"array","items":{"type":"string"}},"tokens":{"type":"object","properties":{"count":{"type":"integer","description":"Tokens seen, at most 1000"},"capped":{"type":"boolean","description":"true: 1000 or more"}},"required":["count","capped"]},"activity24h":{"type":"object","properties":{"from":{"type":"integer","description":"Start (Unix ms)","example":1792236158000},"to":{"type":"integer","description":"End (Unix ms)","example":1792236158000},"fromBlock":{"type":"integer","description":"First block read"},"toBlock":{"type":"integer","description":"Last block read (indexed head)"},"transfers":{"type":"integer","description":"Transfers"},"mints":{"type":"integer","description":"Mints"},"burns":{"type":"integer","description":"Burns"},"lastBlock":{"type":["integer","null"]}},"required":["from","to","fromBlock","toBlock","transfers","mints","burns","lastBlock"]},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","collection","tokens","activity24h"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"Unknown collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nfts/tokens":{"get":{"tags":["NFTs"],"summary":"Tokens of a collection by id: current ERC-721 owner, metadata URI","operationId":"listNftTokens","description":"Tokens of one collection by token id, ascending: the current owner (ERC-721; null for ERC-1155) and the metadata URI as the contract returned it. Page with `after` = the `next` of the previous page.","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"collection","in":"query","required":true,"description":"Collection contract","schema":{"type":"string"},"example":"0x9ea4459c8defbf561495d95414b9cf1e2242a3e2"},{"name":"after","in":"query","required":false,"description":"Last token id of the previous page (`next`)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$","description":"Collection","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"tokens":{"type":"array","items":{"type":"object","properties":{"tokenId":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Token id (exact decimal string)"},"standard":{"type":"string","description":"erc721 | erc1155"},"owner":{"type":["string","null"],"description":"ERC-721 owner (0x0 once burnt); null for ERC-1155"},"uri":{"type":["string","null"],"description":"tokenURI / uri as returned; null when it reverted or is longer than 2048 characters (then uriLength)"},"uriLength":{"type":"integer","description":"Length of a URI left out"},"firstSeenBlock":{"type":"integer","description":"First block"},"lastTransferBlock":{"type":["integer","null"]}},"required":["tokenId","standard","owner","uri","firstSeenBlock","lastTransferBlock"]}},"next":{"type":["string","null"]},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","collection","tokens","next"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nfts/owned":{"get":{"tags":["NFTs"],"summary":"NFTs held by an address: ERC-721 ownership and ERC-1155 balances","operationId":"getNftsOwned","description":"NFTs an address holds on an EVM layer at the indexed head: ERC-721 tokens it owns and ERC-1155 token ids with a positive balance, counted per collection (100 largest collections), the tokens listed up to `limit`.","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"owner","in":"query","required":true,"description":"Holder address","schema":{"type":"string"},"example":"0x1b86c68e4003a8e139d71a9f06a1b1cc18678626"},{"name":"limit","in":"query","required":false,"description":"Tokens listed","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"owner":{"type":"string","pattern":"^(0x[0-9a-f]{40}|[a-z0-9][a-z0-9_.-]{0,63}\\.[0-9a-f]{8,64})$","description":"Holder: 0x address, or a named wallet's handle","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"erc721":{"type":"integer","description":"ERC-721 tokens owned (counted up to 10,000)"},"erc1155":{"type":"integer","description":"ERC-1155 token ids with a positive balance (up to 10,000)"},"capped":{"type":"boolean"},"collections":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[0-9a-f]{40}$","description":"Collection","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"name":{"type":["string","null"]},"symbol":{"type":["string","null"]},"erc721":{"type":"integer","description":"Tokens"},"erc1155":{"type":"integer","description":"Token ids"}},"required":["address","name","symbol","erc721","erc1155"]},"description":"100 largest"},"tokens":{"type":"array","items":{"type":"object","description":"{collection, tokenId, standard, amount, uri, lastTransferBlock}"}},"asOf":{"type":"integer","description":"Time of `height` (indexed head the holdings include) (Unix ms)","example":1792236158000},"height":{"type":"integer","description":"Head block of the layer the answer is cut at: every event up to it is counted (indexed head the holdings include)"},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","owner","erc721","erc1155","collections","tokens"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/nfts/transfers":{"get":{"tags":["NFTs"],"summary":"Transfers of a collection or one token, newest first","operationId":"listNftTransfers","description":"scope = all: whole history (index by token). scope = 24h | 7d: the block window before the indexed head, while that index is missing (a layer still syncing).","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"collection","in":"query","required":true,"description":"Collection contract","schema":{"type":"string"},"example":"0x9ea4459c8defbf561495d95414b9cf1e2242a3e2"},{"name":"tokenId","in":"query","required":false,"description":"One token","schema":{"type":"string"}},{"name":"window","in":"query","required":false,"description":"Window when scope is not all","schema":{"type":"string","enum":["24h","7d"],"default":"24h"}},{"name":"before","in":"query","required":false,"description":"Cursor block:logIndex:batchIndex (`next`)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"collection":{"type":"string","pattern":"^0x[0-9a-f]{40}$","description":"Collection","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"tokenId":{"type":["string","null"]},"scope":{"type":"string","enum":["all","24h","7d"]},"fromBlock":{"type":["integer","null"],"description":"First block read when scope is a window"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/NftTransfer"}},"next":{"type":["string","null"]},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","collection","scope","rows","next"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/volume":{"get":{"tags":["Market data"],"summary":"Daily USD swap volume of a token (both sides of every priced swap), oldest first","operationId":"getTokenVolume","description":"UTC days up to the indexed head; the head day is partial. Elysium: testnet pool prices (testnet: true).","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"token","in":"query","required":true,"description":"Token address","schema":{"type":"string"},"example":"0x5555555555555555555555555555555555555555"},{"name":"days","in":"query","required":false,"description":"Days","schema":{"type":"integer","minimum":1,"maximum":365,"default":30}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"token":{"type":"string","pattern":"^0x[0-9a-f]{40}$","description":"Token","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"symbol":{"type":["string","null"]},"spam":{"type":"boolean","description":"Flagged spam by the indexer (tokens.spam). GET /v1/tokens/spam lists them"},"spamReason":{"type":["string","null"],"description":"Why the indexer flags it, comma list, strongest first: homoglyph: (looks like token T), impostor: (claims to be T; never alone), phishing_name, fake_transfers, unreadable_balance (balanceOf reverts: no ERC-20 behind its Transfer logs), verifier_ignore; null when not spam","example":"homoglyph:USDC"},"from":{"type":"integer","description":"First day (Unix ms)","example":1792236158000},"to":{"type":"integer","description":"End (exclusive) (Unix ms)","example":1792236158000},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer","description":"UTC day (Unix ms)","example":1792236158000},"volumeUsd":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"USD, to the cent (exact decimal string)"},"partial":{"type":"boolean","description":"The indexed head day"},"suspect":{"type":"boolean","description":"Over 1e12 USD for the day: a mispriced swap upstream, left out of totalUsd"}},"required":["day","volumeUsd"]},"description":"Days with volume only"},"totalUsd":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Sum of the days not suspect (exact decimal string)"},"suspectDays":{"type":"integer","description":"Days flagged suspect"},"testnet":{"type":"boolean"},"asOf":{"type":"integer","description":"Time of `height` (indexed head: the partial day counts every swap up to it) (Unix ms)","example":1792236158000},"height":{"type":"integer","description":"Head block of the layer the answer is cut at: every event up to it is counted (indexed head: the partial day counts every swap up to it)"},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","token","days","totalUsd"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/token-families":{"get":{"tags":["Holders"],"summary":"Tokens whose balance moves without Transfer logs (Aave aTokens / debt tokens, stHYPE, wstHYPE, xStocks, rebasing)","operationId":"listTokenFamilies","description":"Tokens whose balances change without Transfer logs, so a Transfer-based holder count is wrong for them: Aave aTokens and variable debt tokens (scaled balances x index), stHYPE / wstHYPE (shares), xStocks and other backed or rebasing tokens. Each with its family and how balanceOf follows from what the contract stores.","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"family","in":"query","required":false,"description":"One family","schema":{"type":"string","enum":["aave_atoken","aave_vtoken","sthype","wrapped_shares","backed","scaling_factor"]}},{"name":"includeSpam","in":"query","required":false,"description":"Show spam tokens (tokens.spam: homoglyph, impostor, phishing name, fake transfers…) flagged spam / spamReason; left out of the list by default","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"families":{"type":"object","additionalProperties":{"type":"integer"},"description":"Tokens per family"},"tokens":{"type":"array","items":{"type":"object","properties":{"token":{"type":"string","pattern":"^0x[0-9a-f]{40}$","description":"Token","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"family":{"type":"string","description":"Family"},"description":{"type":["string","null"],"description":"How balanceOf follows from the base"},"symbol":{"type":["string","null"]},"name":{"type":["string","null"]},"decimals":{"type":["integer","null"]},"params":{"type":"object"},"firstSeenBlock":{"type":"integer","description":"First block"}},"required":["token","family","description","symbol","name","decimals","params","firstSeenBlock"]}},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","families","tokens"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/token-families/{token}":{"get":{"tags":["Holders"],"summary":"One family token: state, holders, largest holders with balanceOf at the indexed head","operationId":"getTokenFamily","description":"One family token (see /token-families): the state its balance formula reads, the number of holders with a positive base, and the largest holders with the base the contract keeps and balanceOf computed at the indexed head.","parameters":[{"name":"token","in":"path","required":true,"description":"Family token","schema":{"type":"string"},"example":"0xffaa4a3d97fe9107cef8a3f48c069f577ff76cc1"},{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"limit","in":"query","required":false,"description":"Holders listed","schema":{"type":"integer","minimum":1,"maximum":200,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"token":{"type":"string","pattern":"^0x[0-9a-f]{40}$","description":"Token","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"family":{"type":"string","description":"Family"},"state":{"type":["object","null"],"description":"Token state the formula reads, as the indexer stores it"},"stateBlock":{"type":["integer","null"]},"balancesAt":{"type":"object","properties":{"block":{"type":"integer","description":"Indexed head"},"t":{"type":"integer","description":"Its time (Unix ms)","example":1792236158000}},"required":["block","t"]},"holders":{"type":"integer","description":"Holders with a positive base"},"top":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^(0x[0-9a-f]{40}|[a-z0-9][a-z0-9_.-]{0,63}\\.[0-9a-f]{8,64})$","description":"Holder: 0x address, or a named wallet's handle","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"base":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Base the contract keeps (scaled balance, shares, internal balance), raw integer (exact decimal string)"},"balance":{"type":["string","null"],"description":"balanceOf at the head, token units (exact decimal string, null when unknown)"},"lastBlock":{"type":"integer","description":"Block of its last base change"}},"required":["address","base","balance","lastBlock"]}},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","token","family","holders","top"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"Not a family token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/transfers":{"get":{"tags":["Market data"],"summary":"ERC-20 Transfer events of a token, newest first","operationId":"listErc20Transfers","description":"Needs the events index by contract: a layer whose index is not built yet answers 503.","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"token","in":"query","required":true,"description":"Token address","schema":{"type":"string"},"example":"0xcd57f65c2b0e5881cfc2e609f7cd53b746e1f234"},{"name":"before","in":"query","required":false,"description":"Cursor block:logIndex (`next`)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"token":{"type":"string","pattern":"^0x[0-9a-f]{40}$","description":"Token","example":"0xf122277ba28a959d2c1b675f6f76570696c9d819"},"symbol":{"type":["string","null"]},"decimals":{"type":["integer","null"]},"spam":{"type":"boolean","description":"Flagged spam by the indexer (tokens.spam). GET /v1/tokens/spam lists them"},"spamReason":{"type":["string","null"],"description":"Why the indexer flags it, comma list, strongest first: homoglyph: (looks like token T), impostor: (claims to be T; never alone), phishing_name, fake_transfers, unreadable_balance (balanceOf reverts: no ERC-20 behind its Transfer logs), verifier_ignore; null when not spam","example":"homoglyph:USDC"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/Erc20Transfer"}},"next":{"type":["string","null"]},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","token","rows","next"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/liquidity":{"get":{"tags":["Market data"],"summary":"Liquidity added to / removed from a pool, newest first","operationId":"listLiquidity","description":"V2 / V3: token amounts and the USD value the indexer computed; V4: the liquidity delta and ticks (the event has no token amounts). Needs the events index by contract: a layer whose index is not built yet answers 503.","parameters":[{"name":"layer","in":"query","required":true,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"]},"example":"hyperevm"},{"name":"pair","in":"query","required":true,"description":"Pool address or :","schema":{"type":"string"},"example":"0x889a96eedb1df35a012d7e48baf7f9c780f1243b:0xfd93e1ba852feba3f05d7089513049c168a87fd058f64f4eb15f1c0bd3534467"},{"name":"before","in":"query","required":false,"description":"Cursor block:logIndex (`next`)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"pair":{"type":"string","description":"Pool"},"protocol":{"type":"string","description":"DEX protocol"},"token0":{"type":"object","description":"{address, symbol, decimals, spam, spamReason}"},"token1":{"type":"object","description":"{address, symbol, decimals, spam, spamReason}"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/LiquidityEvent"}},"next":{"type":["string","null"]},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","pair","protocol","rows","next"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"Unknown pool","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/tokens/spam":{"get":{"tags":["Market data"],"summary":"Tokens flagged spam on an EVM layer and the latest flag changes (what the lists leave out)","operationId":"listSpamTokens","description":"The indexer flags homoglyph / impostor / phishing-name tokens, fake transfer campaigns and tokens its verifier ignores (tokens.spam). Every EVM list (markets, coins, launches, wallet balances and moves, KOL activity, token families, evm_elysium bridges, WS launch channels) leaves them out unless includeSpam=true / include_spam: true; a detail of a spam token still answers, flagged. available = false: the layer has no spam flags yet (nothing flagged, nothing hidden).","parameters":[{"name":"layer","in":"query","required":false,"description":"EVM layer","schema":{"type":"string","enum":["hyperevm","elysium"],"default":"hyperevm"}},{"name":"limit","in":"query","required":false,"description":"Changes listed","schema":{"type":"integer","minimum":1,"maximum":500,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer","example":"hyperevm"},"available":{"type":"boolean","description":"The layer has the spam columns (migration 020)"},"count":{"type":"integer","description":"Tokens flagged now"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/SpamToken"},"description":"Newest flag first"},"changes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SpamChange"},"description":"Newest first (token_spam_log); null when the layer has no log"},"syncing":{"type":"boolean","const":true,"description":"Present while the layer syncs: data only up to dataUntil"},"dataUntil":{"type":"integer","description":"Indexed head time while the layer syncs (Unix ms)","example":1792236158000}},"required":["layer","available","count","tokens","changes"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/book":{"get":{"tags":["Market data"],"summary":"L2 order book of one HyperCore market, with order counts, from our node","operationId":"getBook","description":"Live L2 order book of one HyperCore market (perp, spot `@index`, HIP-3 `dex:COIN`) from our own node: price levels best first with size and order count, and the block it was read at. 503 when the book service does not answer.","parameters":[{"name":"coin","in":"query","required":true,"description":"HyperCore coin (perp name, spot @index, HIP-3 dex:COIN)","schema":{"type":"string"},"example":"BTC"},{"name":"depth","in":"query","required":false,"description":"Levels per side","schema":{"type":"integer","minimum":1,"maximum":100000,"default":20},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"height":{"type":"integer","description":"Block of the book"},"bids":{"type":"array","items":{"type":"array","description":"[px, sz, n]: price, size (exact decimal strings), order count"},"description":"Best first"},"asks":{"type":"array","items":{"type":"array","description":"[px, sz, n]: price, size (exact decimal strings), order count"},"description":"Best first"}},"required":["height","bids","asks"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"Unknown coin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/liquidations":{"get":{"tags":["Liquidations & positions"],"summary":"Perp liquidations, newest first: one row per account, coin and block","operationId":"listLiquidations","description":"Window: the last 24 h by default; `from` older than the lookback (7 days, 30 with `coin`) is clamped to it, the answer's `from` says where it starts.","parameters":[{"name":"coin","in":"query","required":false,"description":"One coin","schema":{"type":"string"},"example":"BTC"},{"name":"user","in":"query","required":false,"description":"One liquidated account (0x)","schema":{"type":"string"}},{"name":"minNotional","in":"query","required":false,"description":"Smallest notional (USD, decimal string)","schema":{"type":"string"},"example":"100000"},{"name":"from","in":"query","required":false,"description":"Window start (ms)","schema":{"type":"integer"}},{"name":"to","in":"query","required":false,"description":"Window end (ms, exclusive)","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":1000,"default":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"integer","description":"Start of the window read (Unix ms)","example":1792236158000},"events":{"type":"array","items":{"type":"object","description":"{block, time, coin, user, side (long | short: of the liquidated position), method (market | backstop), trades, sz, notional, avgPx, markPx}; userEntity for a named wallet"}}},"required":["from","events"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Too many caller-ranged scans queued: retry after Retry-After","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/liquidations/stats":{"get":{"tags":["Liquidations & positions"],"summary":"Liquidations over a window: totals, per coin, per time bucket, the largest and the most liquidated accounts","operationId":"liquidationStats","description":"Liquidations of every HyperCore perp (or one coin) over 1 h, 24 h, 7 d or 30 d: totals (notional, count, accounts, long / short, market / backstop), per coin, per time bucket, the 20 most liquidated accounts and the 10 largest events.","parameters":[{"name":"window","in":"query","required":false,"description":"Window","schema":{"type":"string","enum":["1h","24h","7d","30d"],"default":"24h"}},{"name":"coin","in":"query","required":false,"description":"One coin","schema":{"type":"string"},"example":"BTC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"window":{"type":"string","description":"Window","example":"24h"},"from":{"type":"integer","description":"Window start (Unix ms)","example":1792236158000},"to":{"type":"integer","description":"Window end (Unix ms)","example":1792236158000},"bucketMs":{"type":"integer","description":"Bucket width"},"total":{"type":"object","description":"{notional, count, accounts, longNotional, shortNotional, market, backstop}"},"byCoin":{"type":"array","items":{"type":"object","description":"{coin, notional, count, longNotional, shortNotional}"},"description":"Largest first (30)"},"buckets":{"type":"array","items":{"type":"object","description":"{t, longNotional, shortNotional, count}"},"description":"bucketMs apart"},"topAccounts":{"type":"array","items":{"type":"object","description":"{user, notional, count}"},"description":"20 most liquidated accounts"},"largest":{"type":"array","items":{"type":"object","description":"Liquidation events (same shape as /v1/liquidations)"},"description":"10 largest"}},"required":["window","from","to","bucketMs","total","byCoin","buckets","topAccounts","largest"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/positions":{"get":{"tags":["Liquidations & positions"],"summary":"Open positions of one perp, with leverage and liquidation price","operationId":"listPositions","description":"Open positions of one HyperCore perp at the latest holders snapshot: size, side, entry price, notional and unrealized PnL at the mark (last trade), with leverage, margin mode and liquidation price when the snapshot has them. Sort by notional, upnl or distance to liquidation.","parameters":[{"name":"coin","in":"query","required":true,"description":"Perp coin","schema":{"type":"string"},"example":"BTC"},{"name":"side","in":"query","required":false,"description":"One side","schema":{"type":"string","enum":["long","short"]},"example":"long"},{"name":"sort","in":"query","required":false,"description":"Sort","schema":{"type":"string","enum":["notional","upnl","liqDistance"],"default":"notional"}},{"name":"order","in":"query","required":false,"description":"Order (default: desc, liqDistance asc)","schema":{"type":"string","enum":["desc","asc"]}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"asOf":{"type":"integer","description":"Snapshot time (Unix ms)","example":1792236158000},"height":{"type":"integer","description":"Snapshot block"},"coin":{"type":"string","description":"Coin","example":"BTC"},"markPx":{"type":["string","null"],"description":"Mark used (exact decimal string, null when unknown)"},"sort":{"type":"string","description":"Sort applied"},"order":{"type":"string","description":"Order applied"},"positions":{"type":"array","items":{"type":"object","description":"{address, szi, side, entryPx, notional, upnl, leverage?, marginMode?, liqPx?, liqDistancePct?, label?}; entity for a named wallet"}}},"required":["asOf","height","coin","markPx","sort","order","positions"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/positions/overview":{"get":{"tags":["Liquidations & positions"],"summary":"Open interest, accounts and unrealized PnL per perp","operationId":"positionsOverview","description":"Per HyperCore perp at the latest holders snapshot: long and short open interest, accounts on each side, unrealized PnL of each side at the mark, and the biggest position.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"asOf":{"type":"integer","description":"Snapshot time (Unix ms)","example":1792236158000},"height":{"type":"integer","description":"Snapshot block"},"coins":{"type":"array","items":{"type":"object","description":"{coin, markPx, longOi, shortOi, longAccounts, shortAccounts, upnlLong, upnlShort, biggest: {address, szi, notional}}"}}},"required":["asOf","height","coins"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/positions/liqmap":{"get":{"tags":["Liquidations & positions"],"summary":"Notional that would be liquidated at each price around the mark","operationId":"liquidationMap","description":"Where liquidations would happen: the notional of open positions whose liquidation price falls in each price bucket around the mark (± range), long and short apart, from the latest holders snapshot.","parameters":[{"name":"coin","in":"query","required":true,"description":"Perp coin","schema":{"type":"string"},"example":"BTC"},{"name":"range","in":"query","required":false,"description":"Half-width around the mark (0.3 = ±30 %)","schema":{"type":"number","exclusiveMinimum":0,"maximum":1,"default":0.3}},{"name":"buckets","in":"query","required":false,"description":"Price buckets","schema":{"type":"integer","minimum":1,"maximum":400,"default":80}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"coin":{"type":"string","description":"Coin","example":"BTC"},"markPx":{"type":["string","null"],"description":"Centre (exact decimal string, null when unknown)"},"asOf":{"type":"integer","description":"Snapshot time (Unix ms)","example":1792236158000},"height":{"type":"integer","description":"Snapshot block"},"range":{"type":"number","description":"Half-width"},"buckets":{"type":"array","items":{"type":"object","description":"{px (bucket centre), longNotional, shortNotional, accounts}"}},"unavailable":{"type":"string","description":"Present when no liquidation price is known for this coin (buckets empty)"}},"required":["coin","markPx","asOf","height","range","buckets","unavailable"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/wallet/{address}":{"get":{"tags":["Wallet"],"summary":"One address on HyperCore, HyperEVM and Elysium","operationId":"getWallet","description":"One address (or a named wallet's handle) on the three layers at once: HyperCore perp account (value, positions with liquidation price) and spot balances; HyperEVM and Elysium token balances with USD values and NFTs; bridge legs in flight and journeys across the layers; latest events (fills, ledger, swaps, transfers, bridges). Each section carries its freshness. Heavy call.","parameters":[{"name":"address","in":"path","required":true,"description":"0x address, or a named wallet's handle .","schema":{"type":"string"},"example":"0xabd08eb33d972302d0b3fc588e4676cb8514f547"},{"name":"includeSpam","in":"query","required":false,"description":"Show spam tokens (tokens.spam: homoglyph, impostor, fake transfers…), flagged spam / spamReason; hidden from lists and USD totals by default","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wallet"}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/entities":{"get":{"tags":["Named wallets"],"summary":"Named wallets: KOLs, traders, funds and their wallets","operationId":"listEntities","description":"Names come from public lists (`sources`): who they attribute a wallet to, not a verified identity. X-Total-Count = entities matching. A named wallet's address (the KOLs, traders and funds of /v1/entities) never appears as such: every field, string, URL and WebSocket frame gives its handle `.` (e.g. `loraclexyz.3f9a1c2e`, stable), and a handle is accepted as input anywhere an address is (path, query, WebSocket filters).","parameters":[{"name":"kind","in":"query","required":false,"description":"Kind contains (whale, market maker…)","schema":{"type":"string"}},{"name":"q","in":"query","required":false,"description":"Name, X handle, alias, wallet address or handle","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Entities","schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"offset","in":"query","required":false,"description":"Skip","schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"integer","description":"Entities matching"},"entities":{"type":"array","items":{"$ref":"#/components/schemas/Entity"}}},"required":["total","entities"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/entities/{id}":{"get":{"tags":["Named wallets"],"summary":"One entity: its wallets on HyperCore, HyperEVM and Elysium, totals, 30 days of HyperCore trading","operationId":"getEntity","description":"One named wallet (KOL, trader, fund, market maker) from public attribution lists: its wallets with their HyperCore account value, positions and spot, HyperEVM and Elysium holdings, latest moves; the totals across its wallets; 30 days of HyperCore trading (fills, volume, realized and net PnL, fees, win rate).","parameters":[{"name":"id","in":"path","required":true,"description":"Entity id","schema":{"type":"string"},"example":"loraclexyz"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/Entity"},"totals":{"type":"object","properties":{"hypercoreAccountValue":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Σ perp account value (exact decimal string)"},"hypercoreSpotUsd":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Σ spot balances, USD (exact decimal string)"},"hyperevmUsd":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Σ HyperEVM token balances, USD (exact decimal string)"},"openPerpNotional":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?$","description":"Σ open perp notional (exact decimal string)"}},"required":["hypercoreAccountValue","hypercoreSpotUsd","hyperevmUsd","openPerpNotional"]},"hypercore30d":{"type":["object","null"],"description":"{fills, volume, realizedPnl, fees, netPnl, winRate} over 30 days"},"wallets":{"type":"array","items":{"type":"object","description":"{address, notes?, hypercore:{accountValue, perpNotional, spotUsd, positions[]}, hyperevm:{totalUsd, count, balances[≤10]}, elysium:{…}, recent[≤10]} (the /v1/wallet answer, summed up)"}}},"required":["entity","totals","hypercore30d","wallets"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"404":{"description":"Unknown entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/kols/leaderboard":{"get":{"tags":["Named wallets"],"summary":"Named wallets ranked by their trading on a layer: HyperCore PnL / volume / positions, or HyperEVM / Elysium swaps, transfers, bridge legs, holdings","operationId":"kolLeaderboard","description":"Per entity (its wallets summed). hypercore: fills of the window from the per-user fills table, open perp positions of the latest snapshot at mark (rows: KolRow; sorts netPnl, realizedPnl, volume, fills, winRate, openNotional; default window 7d). hyperevm / elysium: swaps sent by its wallets, ERC-20 transfers, bridge legs and HyperEVM holdings (rows: EvmKolRow; sorts volume, swaps, transfers, netBuy, holdings, bridges, lastActivity; default window 24h). An address is the same account on every layer: every named wallet counts on each. Without the address indexes on the indexer database, an EVM layer answers 24h only (7d / 30d: 503). hypercore: cached 60 s. EVM layers: every window computed in the background (24h every minute, 7d every 5 min, 30d every 15 min) and answered at once from the last one, `computedAt` / `asOfBlock` saying how fresh; right after a restart, a window not computed yet answers 503 with Retry-After (seconds) within ~2 s.","parameters":[{"name":"layer","in":"query","required":false,"description":"Layer","schema":{"type":"string","enum":["hypercore","hyperevm","elysium"],"default":"hypercore"}},{"name":"window","in":"query","required":false,"description":"Window (hypercore: 7d by default, EVM layers: 24h)","schema":{"type":"string","enum":["24h","7d","30d"]}},{"name":"sort","in":"query","required":false,"description":"Sort (per layer, see above; default netPnl / volume)","schema":{"type":"string","enum":["netPnl","realizedPnl","volume","fills","winRate","openNotional","swaps","transfers","netBuy","holdings","bridges","lastActivity"]}},{"name":"order","in":"query","required":false,"description":"Order","schema":{"type":"string","enum":["desc","asc"],"default":"desc"}},{"name":"kind","in":"query","required":false,"description":"Kind contains (whale, market maker…)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Rows","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"includeSpam","in":"query","required":false,"description":"Show spam tokens (tokens.spam: homoglyph, impostor, fake transfers…), flagged spam / spamReason; hidden from lists and USD totals by default","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"layer":{"type":"string","description":"Layer"},"window":{"type":"string","description":"Window"},"from":{"type":"integer","description":"Window start (Unix ms)","example":1792236158000},"to":{"type":"integer","description":"Window end (EVM: the indexed head) (Unix ms)","example":1792236158000},"positionsAsOf":{"type":["integer","null"],"description":"hypercore"},"scope":{"$ref":"#/components/schemas/EvmScope"},"holdingsAsOf":{"type":["integer","null"],"description":"EVM layers: time of the holdings (indexed head)"},"computedAt":{"type":"integer","description":"EVM layers: when this leaderboard was computed (background, see above) (Unix ms)","example":1792236158000},"asOfBlock":{"type":"integer","description":"EVM layers: indexed head block it was computed at"},"testnet":{"type":"boolean","description":"Elysium testnet: no USD values"},"entities":{"type":"integer","description":"Entities with activity"},"sort":{"type":"string","description":"Sort"},"order":{"type":"string","description":"Order"},"rows":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/KolRow"},{"$ref":"#/components/schemas/EvmKolRow"}]}}},"required":["layer","window","rows"]}}}},"400":{"description":"Invalid parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing, unknown, disabled or expired key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Payment required. A heavy call of a key whose credits are used up (billing on): top up (`checkoutUrl`). With x402 on (pay with USDC, disabled until announced): a request with no key at all gets the x402 payment requirements, a credit pack to buy on each network accepted (Base, Arbitrum One, HyperEVM; cheapest settlement first, the first `recommended`), in the `PAYMENT-REQUIRED` header (x402 v2, base64 JSON) and in this body (x402 v1 for the networks that have a v1 name, every network in `x402Networks`); packs start at $0.01, a bigger one is asked with `?x402_pack=` on the same URL; the same request sent again with the signed payment (`PAYMENT-SIGNATURE`, or `X-PAYMENT` in v1) is served, its answer carrying the new key in `X-Femtos-Key` and the settlement in `PAYMENT-RESPONSE` (`X-PAYMENT-RESPONSE`). An exhausted key's 402 offers the same packs: paid, they credit that key's account. Prices: the body, never fixed here.","headers":{"PAYMENT-REQUIRED":{"description":"x402 v2 PaymentRequired, base64 JSON (x402 on only)","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequired"}}}},"502":{"description":"Upstream database error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Source not available (database or table missing, no snapshot yet): {error, unavailable}","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unavailable"}}}}}}},"/kols/activity":{"get":{"tags":["Named wallets"],"summary":"Recent moves of the named wallets, newest first: HyperCore fills, HyperEVM / Elysium swaps and transfers","operationId":"kolActivity","description":"hypercore: fills of at least minNotional (default 1000), cursor