Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.binibit.com/llms.txt

Use this file to discover all available pages before exploring further.

The Launchpad API is part of the broader Binibit ecosystem API. The endpoints below are documented per the canonical spec. Final base URL and auth requirements ship with mainnet.

Endpoints

MethodPathDescription
POST/api/launchpad/spawnSpawn a new Agent Token
GET/api/launchpad/tokensList all Agent Tokens
GET/api/launchpad/tokens/:idGet details for one Agent Token
GET/api/launchpad/tokens/:id/poolGet pool details for one Agent Token
GET/api/launchpad/tokens/:id/workerGet Worker info for one Agent Token
Base URL: TBD (production), pending mainnet.

POST /api/launchpad/spawn

Spawn a new Agent Token. Requires authenticated user (HMAC signature, see Authentication).

Request

{
  "name": "PepeAgent",
  "symbol": "PEPEA",
  "totalSupply": "1000000000",
  "decimals": 18,
  "poolSide": "USBI",
  "metadata": {
    "description": "An agent-managed Pepe-themed token",
    "logoUri": "ipfs://...",
    "website": "https://example.com"
  }
}

Parameters

FieldTypeRequiredDescription
namestringYesDisplay name (max 50 chars)
symbolstringYesTicker (3-5 uppercase chars)
totalSupplystringNoDefault: 1,000,000,000
decimalsintegerNoDefault: 18 (fixed)
poolSideenumNoUSBI (default) or wBINI
metadataobjectNoFree-form metadata stored on-chain

Response

{
  "token": {
    "address": "0xAgent...",
    "name": "PepeAgent",
    "symbol": "PEPEA",
    "totalSupply": "1000000000",
    "owner": "0xCreator..."
  },
  "pool": {
    "address": "0xPool...",
    "side": "USBI",
    "feeTier": 10000
  },
  "worker": {
    "id": 12345,
    "agentNftId": 67890
  },
  "txHash": "0xtx..."
}

Errors

CodeMessage
400 INVALID_SYMBOLSymbol does not match [A-Z]{3,5}
400 SYMBOL_TAKENSymbol already exists on BiniChain
400 COOLDOWN_ACTIVESpawn cooldown still active for this address
402 INSUFFICIENT_FEEBINI sent does not cover the spawn fee
500 SPAWNER_FAILEDSpawner contract reverted (rare; retry)

GET /api/launchpad/tokens

List Agent Tokens with pagination and filters.

Query parameters

ParamTypeDescription
pageintegerPage number (1-indexed)
pageSizeintegerItems per page (max 100)
sortenumrecent / volume / tvl / holders
boostedbooleanFilter to boosted tokens only
poolSideenumUSBI / wBINI filter

Response

{
  "items": [
    {
      "address": "0x...",
      "symbol": "PEPEA",
      "name": "PepeAgent",
      "spawnedAt": 1762344000,
      "tvl": "12345.67",
      "volume24h": "5432.10",
      "holders": 42,
      "workerStatus": "active",
      "boosted": false
    }
  ],
  "page": 1,
  "pageSize": 20,
  "totalItems": 156
}

GET /api/launchpad/tokens/:id

Detailed info for one Agent Token. :id can be the Agent Token address or its registry NFT ID.

Response

{
  "token": {
    "address": "0x...",
    "name": "PepeAgent",
    "symbol": "PEPEA",
    "decimals": 18,
    "totalSupply": "1000000000",
    "owner": "0x...",
    "spawnedAt": 1762344000
  },
  "pool": {
    "address": "0x...",
    "side": "USBI",
    "feeTier": 10000,
    "tvl": "12345.67",
    "volume24h": "5432.10",
    "lastTradeAt": 1762430000
  },
  "worker": {
    "id": 12345,
    "agentNftId": 67890,
    "status": "active",
    "lastActionAt": 1762429000,
    "actionCount": 27
  },
  "metadata": {
    "description": "...",
    "logoUri": "ipfs://...",
    "website": "..."
  },
  "boost": {
    "active": false,
    "tier": null,
    "expiresAt": null
  }
}

GET /api/launchpad/tokens/:id/worker

Detailed Worker info plus action log.
{
  "worker": {
    "id": 12345,
    "agentNftId": 67890,
    "status": "active",
    "deployedAt": 1762344000
  },
  "recentActions": [
    {
      "txHash": "0x...",
      "actionType": "param_update",
      "params": { "...": "..." },
      "blockNumber": 12345678,
      "blockTimestamp": 1762429000
    }
  ],
  "stats": {
    "totalActions": 27,
    "lastActiveAt": 1762429000
  }
}

Rate limits

Standard public-API rate limits apply (60 req/min per IP, see Rate Limits). For builder integrations needing higher throughput, contact api@binibit.com.

Spawn flow

What POST /spawn triggers

Authentication

HMAC for authenticated routes

Agent Hive API

Worker / governance endpoints

Registry

The NFT data model