hookr_build_launch · Build a token launch
read-onlyBuilds a new token's launch as hookr.fun's Launch button does: one pool on ETH or a reviewed quote (HOOKR, USDG and the rest of the list) with the site's default Hook Blocks and arbitrage recapture, holding the whole supply from the opening price up, so the wallet seeds no quote: buyers bring it. Checked and simulated from the wallet, it returns ok with the launch call (and any notes to show the creator before they sign), needs_approval with an approval to send first and build again with the same salt, or refused or unknown with the reasons and no calls.
Input schema
{
"type": "object",
"properties": {
"wallet": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$",
"description": "The wallet that signs, pays and creates the token."
},
"name": {
"type": "string",
"maxLength": 48,
"description": "The token's name, at most 48 bytes."
},
"symbol": {
"type": "string",
"maxLength": 12,
"description": "The token's ticker, at most 12 bytes."
},
"supply": {
"type": "string",
"pattern": "^[1-9][0-9]{0,20}$",
"description": "The token's supply in whole tokens (default 1000000000)."
},
"logoURI": {
"type": "string",
"maxLength": 300,
"pattern": "^(?:ipfs|https)://\\S+$",
"description": "The token's logo, written into the token for good: an ipfs:// address or an https:// image link, at most 300 bytes. Hookr checks it is an image before it builds the launch."
},
"quote": {
"type": "string",
"pattern": "^(?:[A-Za-z0-9]{1,20}|0x[0-9a-fA-F]{40})$",
"description": "What the pool trades the token against (default ETH): ETH, or a reviewed quote by its symbol or address: WETH, USDG, HOOKR, WTH, NOVAAI, PONS, USDe, CASHCAT, UP, syrupUSDG, AI, BUN, ORBIO, BONER, CHUMP, SIF, U, HOODCHAN, MEME, Index, PIPEDOG, STATICS."
},
"price": {
"type": "string",
"pattern": "^(?:0|[1-9][0-9]{0,30})(?:\\.[0-9]{1,36})?$",
"description": "The opening price: how much of the quote one whole token costs, such as 0.000001 (default: the price that gives the token a $20,000 market cap at the quote's USD price, as hookr.fun's Create sets it)."
},
"lower": {
"type": "string",
"pattern": "^(?:0|[1-9][0-9]{0,30})(?:\\.[0-9]{1,36})?$",
"description": "The range's lower price, in the quote per token, set with upper or in place of both as fullRange; with neither, the pool holds the token alone from the opening price up."
},
"upper": {
"type": "string",
"pattern": "^(?:0|[1-9][0-9]{0,30})(?:\\.[0-9]{1,36})?$",
"description": "The range's upper price, in the quote per token."
},
"fullRange": {
"type": "boolean",
"description": "Seed every price the pool can hold, in place of lower and upper: a full range takes both sides, so pass quoteSeed too. Without it or a range, the pool holds the token alone from the opening price up."
},
"tokenSeed": {
"type": "string",
"pattern": "^(?:0|[1-9][0-9]{0,30})(?:\\.[0-9]{1,36})?$",
"description": "Whole tokens the pool is seeded with, at most the supply (default: the whole supply); the wallet keeps the rest."
},
"quoteSeed": {
"type": "string",
"pattern": "^(?:0|[1-9][0-9]{0,30})(?:\\.[0-9]{1,36})?$",
"description": "How much of the quote the wallet seeds the pool with, none by default: buyers bring it. It needs a range: lower and upper, or fullRange."
},
"salt": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{64}$",
"description": "The salt that fixes the token's address. Pass back the salt a build returned to keep the same token."
},
"blocks": {
"type": "string",
"pattern": "^[a-z0-9-]{2,40}(,[a-z0-9-]{2,40}){0,15}$",
"description": "Hook Blocks to add at their defaults, comma-separated, by the ids hookr_blocks gives."
},
"kingOfThePool": {
"type": "boolean",
"description": "Turn King of the Pool on, inside arbitrage recapture. Needs lp-rewards or auto-burn in blocks."
},
"arbRecapture": {
"type": "boolean",
"description": "Put arbitrage recapture on the pool (default true): the arbitrage profit between this pool and the token's other markets then goes to its LPs, What The Hook and Hookr instead of outside bots. A pool launched without it never gets it."
},
"creatorTaxBps": {
"type": "integer",
"minimum": 10,
"maximum": 1000,
"description": "Creator tax: a cut of every buy and every sell, in bps in steps of 10 (200 is 2%, at most 1000), fixed at launch and paid to the launch's owner less Hookr's share of the pool (20% at its floor). Off unless set."
},
"agentGateMinScore": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295,
"description": "Agent gate, Score to enter: the reputation score from the pool's reviewer that buys and adds need (default 0, none). Needs agent-gate in blocks and a reviewer."
},
"agentGateTierScore": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295,
"description": "Agent gate, Score for the base fee: agents scored at or above it pay the base fee, the rest pay the surcharge. Set it with agentGateTierPips, or neither."
},
"agentGateTierPips": {
"type": "integer",
"minimum": 0,
"maximum": 50000,
"description": "Agent gate, Fee tier surcharge, in pips (10000 is 1%): paid to the pool's LPs by agents below the base-fee score or with no score. At most 50000."
},
"agentGateMinAge": {
"type": "integer",
"minimum": 0,
"maximum": 2592000,
"description": "Agent gate, Age to enter: the seconds a wallet's link on the gate must have stood before it buys or adds, up to 30 days (one hour unless set, 0 for none). Needs agent-gate in blocks."
},
"agentGateReviewer": {
"type": "string",
"pattern": "^(?:priors|0x[0-9a-fA-F]{64})$",
"description": "Agent gate, Reviewer: priors for Priors, whose scores are whole numbers, or a reviewer set id registered on the gate. Needed with a Score to enter or a fee tier, and refused without one."
},
"agentGateChecks": {
"type": "string",
"enum": [
"recipient",
"uniswapRouter",
"recipient,uniswapRouter",
"none"
],
"description": "Agent gate, Checks: recipient (a buyer's recipient must be an agent too; the default), uniswapRouter (swaps through the Uniswap router are let in, checked on the wallet that sent them), recipient,uniswapRouter for both, or none. Needs agent-gate in blocks."
},
"integrator": {
"type": "string",
"pattern": "^0x[0-9a-fA-F]{40}$",
"description": "Builder credit: the account the pool names as its integrator, which earns the rate the treasury lists it at, up to half, of Hookr's share of the pool's rule fees and, on Hookr's core, of Hookr's arbitrage recapture cut. It must be on the treasury's integrator list, and the pool freezes the rate when it opens."
},
"integratorBps": {
"type": "integer",
"minimum": 1,
"maximum": 5000,
"description": "The rate you expect the treasury lists the integrator at, in bps of Hookr's share (at most 5,000, which is 50%); the launch is refused if the list says otherwise. Needs integrator."
}
},
"required": [
"wallet",
"name",
"symbol"
],
"additionalProperties": false
}