Skip to content

Build

Integrations, events, and API

Canonical launch events, rebuildable REST reads, and realtime Server-Sent Events.

Canonical launch event

event TokenLaunched(
  address indexed token,
  address indexed creator,
  address indexed pool,
  uint256 positionId,
  uint256 restrictionExpiry, // always 0 for V3
  uint256 initialBuyWeth,
  bytes32 metadataHash
);

V3 retains restrictionExpiry in the event for indexer compatibility, but always emits zero. V3 tokens have no transfer-restriction timer.

REST API

GET /v1/tokens?stage=&sort=&window=&cursor=
GET /v1/tokens/{address}
GET /v1/tokens/{address}/trades
GET /v1/tokens/{address}/candles
GET /v1/tokens/{address}/holders
GET /v1/creators/{address}/overview?window=all
GET /v1/creators/{address}/launches?window=&cursor=
GET /v1/search?q=
GET /v1/rankings/trending?window=24h
GET /v1/king
GET /v1/protocol/config

Lists use context-bound cursor pagination. Token responses identify protocolVersion, factoryAddress, and lockerAddress so V2 history and V3 launches resolve against the correct contracts. Responses distinguish pending and confirmed data and include freshness.

Hosted creation, portfolio, and moderation

GET  /v1/wallets/{address}/portfolio?cursor=
POST /v1/uploads/presign
POST /v1/uploads/finalize
POST /v1/agreements/creator/challenge
POST /v1/agreements/creator/accept
POST /v1/metadata
POST /v1/reports
POST /v1/appeals

Uploads remain quarantined until signature, dimension, malware/content, re-encoding, and immutable pinning checks complete. Creator agreement and metadata registration are separate signed hosted-service evidence; neither changes ERC-20 identity or makes the operator custodian.

Typed errors and readiness scopes

{
  "error": {
    "code": "TOKEN_NOT_FOUND",
    "message": "No canonical launch was found for this address.",
    "details": { "requestId": "…" }
  }
}
  • /health is process liveness; never use it to authorize writes.
  • /ready/serve checks database access and the exact migration ledger for load-balancer read traffic.
  • /ready covers transaction-critical chain freshness; /ready/creation additionally requires object storage, scanners, re-encoding, IPFS, and metadata capabilities.
  • Stable public codes include INVALID_CURSOR, INVALID_ADDRESS, TOKEN_NOT_FOUND, INDEXER_DEGRADED, RATE_LIMITED, scanner/pinning failures, and transaction simulation failures.

Signed theses and leaderboards

GET  /v1/tokens/{address}/comments?cursor=
POST /v1/tokens/{address}/comments/challenge
POST /v1/comments/submit
GET  /v1/leaderboards/creators?window=7d
GET  /v1/leaderboards/traders?window=7d

A wallet-signed thesis is bound to wallet, token, body, optional top-level parent, chain ID, nonce, and expiry through an EIP-191 signature. It is not a transaction. Hidden posts retain a moderation tombstone and thread position without returning hidden body text.

Realtime rules

  • Subscribe to /v1/events for launches, trades, prices, graduation progress, rankings, comments, King changes, and health.
  • Reconnect with backoff and reconcile through REST after gaps.
  • Expect reorg corrections before confirmation.
  • Never infer pool legitimacy from symbol or metadata.
  • Contracts and logs remain truth; API is rebuildable convenience.
Integrations, events, and API · Documentation