A launch is a token together with its launch plan: the dev, funder, holder and MEV wallets, how much each one buys, and the method used to buy. You create a launch as a draft with the token metadata, save a launch plan, fund the wallets, then launch it. Once live, the same object tracks balances, profit and loss, and volume.
Launches are addressed by their public ID (launch_id), a 15-digit number whose first three digits encode the chain: 101 Solana, 201 BSC, 202 Base, 204 Ethereum, 205 Robinhood, 206 Arc, 207 X Layer. Native and token amounts are integer strings in base units (lamports or wei).
- POST
/launch/{chain_id}/{dex}/create-mint - POST
/launch/{chain_id}/import-mint - GET
/launch/get-launch-info/{launch_id} - POST
/launch/update-launch-plan/{launch_id} - POST
/launch/update-metadata/{launch_id} - POST
/launch/routing-override/{launch_id} - POST
/launch/set-funder/{launch_id} - POST
/launch/add-wallets/{launch_id} - POST
/launch/set-archive-status/{launch_id} - POST
/launch/delete-launch-plan/{launch_id} - POST
/launch/reveal-key/{launch_id} - GET
/launch/get-metadata/{address} - GET
/launch/{source}/thesis/{launch_id}
The Launch object
The launch plan and live state of a launch, as returned by Retrieve a launch. Platform-specific fields are only present for their platform, and multi-launch containers add kind, count, state and members.
Attributes
-
chain_idenumChain the launch lives on.Possible valuessolethbscbaserobinhoodmonadarcxlayer -
launch_methodenumHow the wallets buy. The app showsMevas Block-0 andStaggeras Organic; its Quick mode isStaggerwith abuy_delayof0.Possible valuesMevStaggerManualAllowlist -
funding_typeenumHow the funder spreads native to the wallets: direct transfers (Classic) or through an exchange route (Cex).Possible valuesClassicCex -
funding_delayinteger | nullGap betweenCexfunding transfers, in seconds. -
is_graduatedbooleanThe token has graduated from its bonding curve. -
is_importedbooleanThe launch was created with Import a launch around an existing token. -
scheduled_modebooleanThe token is deployed first and the wallets buy later, through Snipe a scheduled launch. -
mev_typeenum | nullVariant of aMevlaunch.airdropdistributes through a Streamflow airdrop on Solana.Possible valuesbuybackairdrop -
buy_delayintegerDelay between holder buys, in milliseconds. -
buy_delay_maxinteger | nullSolanaStaggeronly: each gap between holder buys is drawn betweenbuy_delayand this value, in milliseconds. -
initial_buy_delayinteger | nullDelay before the first holder buy, in milliseconds. -
auto_snipe_delay_msinteger | nullSolana scheduled launches: the snipe fires on its own this long after the launch is staged, in milliseconds. -
auto_snipe_atstring | nullISO 8601 time the pending auto-snipe fires, ornullwhen none is armed. -
front_to_back_delay_msinteger | nullDelay between the front MEV and back MEV buys, in milliseconds. -
back_to_temp_delay_msinteger | nullDelay between the back MEV and temporary holder buys, in milliseconds. -
slippageintegerSlippage tolerance in basis points. -
fake_tip_pctnumberFake-tip setting of the launch, in percent. -
fee_targetinteger | nullFee target in native base units. -
routing_overrideobject | nullShare of each trade's wallets per routing platform, in whole percents summing to 100, overriding each wallet's default. See Set the routing override. -
quote_mintstringMint of the quote token. Always set on Solana, where native-quoted launches carry WSOL. -
total_supplyintegerTotal token supply. -
creator_feesintegerUncollected creator fees, in base units of the native or quote token. See Collect creator fees. -
creator_fee_bpsinteger | nullpump.fun creator-fee override, from 1 to 300 (0.01% to 3%).nullkeeps the pump.fun default. -
is_pump_holder_rewardbooleanpump.fun Holder Rewards:truesends creator fees to holders,falsekeeps them with the creator. -
unclaimed_cashbackinteger | nullpump.fun cashback waiting to be claimed. See Claim pump.fun cashback. -
fee_share_configarray<object> | nullpump.fun fee-share legs of the live token.Child attributes 4
-
addressstringRecipient wallet. -
githubstringRecipient GitHub username. -
charity_idstringRecipient charity ID. -
share_bpsintegerShare of the creator fees, in basis points.
-
-
is_fee_share_adminboolean | nullWhether the launch's dev administers the pump.fun fee-share config. -
pumpfun_prelaunch_fee_sharesarray<object> | nullFee-share legs saved on a draft and applied when the token is created. Each leg hasshare_bpsand one ofdev: true,address,githuborcharity_id. -
devobject | nullDev wallet, a Launch wallet. It deploys the token and makes the dev buy. -
funderobjectFunder wallet, a Launch wallet that funds every other wallet of the plan. -
holderarray<object>Holder wallets, as Launch wallets. -
front_mevarray<object>Front MEV wallets of aMevlaunch. -
back_mevarray<object>Back MEV wallets of aMevlaunch. -
temp_holderarray<object>Temporary holder wallets of aMevlaunch. -
wallets_being_fundedintegerWallets whose funding is in progress. -
wallets_fundedintegerWallets already funded. -
pnl_nativestringProfit and loss in native base units, as a string. -
pnl_usdstringProfit and loss, in micro-USD, as an integer string. -
gross_volume_nativestringGross traded volume in native base units, as a string. -
gross_volume_usdstringGross traded volume, in micro-USD, as an integer string. -
extra_rewards_nativestringExtra rewards in native base units, as a string. -
extra_rewards_usdstringExtra rewards, in micro-USD, as an integer string. -
mm_pnl_nativestringMarket-making profit and loss in native base units, as a string. -
mm_pnl_usdstringMarket-making profit and loss, in micro-USD, as an integer string. -
total_buy_nativestring | nullTotal bought, in native base units. -
total_buy_tokensstring | nullTotal bought, in token base units. -
total_buy_usdstring | nullTotal bought, in micro-USD, as an integer string. -
total_sell_nativestring | nullTotal sold, in native base units. -
total_sell_tokensstring | nullTotal sold, in token base units. -
total_sell_usdstring | nullTotal sold, in micro-USD, as an integer string. -
current_buy_fee_bpsinteger | nullCurrent buy fee of the token, in basis points. -
current_sell_fee_bpsinteger | nullCurrent sell fee of the token, in basis points. -
mcap_livenumber | nullCurrent market cap. Number or numeric string. -
mcap_before_cleanupnumber | nullMarket cap before cleanup. Number or numeric string. -
mcap_post_cleanupnumber | nullMarket cap after cleanup. Number or numeric string. -
mcap_migrationnumber | nullMarket cap at migration. Number or numeric string. -
ansemobject | nullpump.fun Ansem launch settings.Child attributes 2
-
tierenumAnsem tier.Possible valuesfreegolddiamond -
airdrop_buy_solstringAirdrop buy, in SOL. Number or numeric string.
-
-
otcdesksobject | nullOTC desks reward settings.Child attributes 3
-
reward_mintstringMint holders are rewarded in. -
reward_symbolstring | nullSymbol of the reward token. -
reward_basketarray<string> | nullMints of a reward basket.
-
-
usepaidobject | nullUsePaid launch settings.Child attributes 2
-
handlestringX handle the launch is made for. -
x_user_idstring | nullX user ID of the handle.
-
-
zaioobject | nullzaio.fun launch: a pump.fun coin whose creator fees are split 50/50 with zaio's fee wallet.Child attributes 4
-
recipientstringzaio fee wallet. -
launch_fee_lamportsstringLaunch fee in lamports. Number or numeric string. -
importedbooleanThe coin was imported. -
slugstring | nullThe coin's page on zaio,zaio.fun/@<slug>, once zaio lists it.
-
-
printr_fee_sinkenumPrintr fee sink.Possible valuesdevstake_poolbuyback -
printr_max_supplyenumPrintr maximum supply.Possible values100_million1_billion10_billion -
printr_initial_market_capnumberPrintr initial market cap. -
bonk_mode_typestringbonk.fun mode. Boolean or string. -
meteora_dbc_configstring | nullMeteora DBC config account of the launch. -
meteora_damm_configstring | nullMeteora DAMM config account of the launch. -
meteora_damm_infoobject | nullMeteora DAMM pool details. -
meteora_dlmm_infoobject | nullMeteora DLMM pool details. -
fourmeme_optionsobjectFour.meme options. -
stonkfun_infoobject | nullStonkfun details: quote, mode, pool fee, reward tax, dev buy and pool. -
stoxes_infoobject | nullStoxes details. -
lesgo_infoobject | nullLesgo details: kind, fees, config, pool and listing state. -
is_multibooleanThe launch is a multi-launch container that runs several attempts. -
kindstringgroupfor a multi-launch container. -
countintegerNumber of launches in a multi-launch. -
stateobjectProgress of a multi-launch.Child attributes 4
-
attempts_plannedintegerAttempts planned. -
attempts_executedintegerAttempts executed so far. -
winner_launch_idstring | nullPublic ID of the winning attempt. -
total_cost_nativestringTotal cost in native base units.
-
-
membersarray<object>Attempts of a multi-launch.Child attributes 11
-
launch_idstringPublic ID of the attempt. -
group_dispositionenumRole of the attempt in the group.Possible valuesattemptwinnerdisposed -
group_signalsobject | nullSignals recorded for the attempt. -
mint_pubkeystringToken address of the attempt. -
launch_statusstringStatus of the attempt. -
pnl_nativestringProfit and loss in native base units. -
pnl_usdstringProfit and loss, in micro-USD, as an integer string. -
gross_volume_nativestringGross volume in native base units. -
gross_volume_usdstringGross volume, in micro-USD, as an integer string. -
created_atintegerCreation time. -
tag_idsarray<integer>Tags on the attempt.
-
-
reservestring | nullReserve of a multi-launch. -
script_planobject | nullThe stored script plan, returned only to sessions with script access. See Launch scripts.
The Launch wallet object
One wallet of a launch plan: its key, planned buy and balances. Amounts are integer strings in base units.
Attributes
-
keyobjectWallet key. The string"None"instead of an object marks a slot the API fills with a generated wallet.Child attributes 3
-
pubkeystringWallet address (base58 on Solana,0xon EVM). -
secretstringSecret key. Only present in payloads you send and in the plan echoed by Update the launch plan; never returned by Retrieve a launch. -
can_exportbooleantruewhen you can reveal this key with Reveal launch keys.
-
-
agedbooleanThe wallet comes from your aged wallets rather than being generated for this launch. -
archivedbooleanThe wallet is archived. -
is_universalbooleanFunder slot only: the funder is one of your universal funder wallets. -
buy_supplystringPlanned buy in token base units, as an integer string. -
buy_nativestringPlanned buy in native base units (lamports or wei), as an integer string. -
native_balancestringNative balance in base units. -
token_balancestringToken balance in base units. -
quote_balancestringQuote token balance in base units, for launches paired with a non-native quote. -
proxy_addressstring | nullProxy contract the wallet trades through, when it has one. -
proxy_native_balancestringNative balance held by the proxy contract, in base units. -
proxy_token_balancestringToken balance held by the proxy contract, in base units. -
expected_supplystringTokens the wallet is expected to hold after its planned buy, in base units. -
required_nativestringNative amount the wallet needs for its planned buy, in base units. -
min_native_fundingstringMinimum native funding for the wallet, in base units. -
min_quote_fundingstringMinimum quote token funding for the wallet, in base units.
Create a launch
/launch/{chain_id}/{dex}/create-mint Creates a draft launch from the token metadata.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying Each call creates a new draft launch. Look for it in List the license's launches before sending the request again.
Uploads the token metadata and image and creates a draft launch on chain_id for the platform dex. Nothing is deployed yet: save a plan with Update the launch plan, fund the wallets, then launch.
Platform-specific parts are only sent for their platform. The app also clones a launch by sending the copied metadata to this endpoint.
Path parameters
-
chain_idenum RequiredChain to create the token on.Possible valuessolethbscbaserobinhoodmonadarcxlayer -
dexstring RequiredLaunch platform ID in lowercase, for examplepumpfun,bonkfun,meteoradbc,fourmeme,flaporuniswapv2.Examplepumpfun
Query parameters
-
versioninteger OptionalPons contract version. Sent only whendexispons, taken fromcreate_params.version.Possible values12
Form fields multipart/form-data
-
namestring RequiredToken name. -
symbolstring RequiredToken ticker. -
imagefile RequiredToken image. A file part, or a string the app reuses from an existing token. -
descriptionstring OptionalToken description. -
twitterstring OptionalX (Twitter) link. -
telegramstring OptionalTelegram link. -
websitestring OptionalWebsite link. -
launch_platformstring OptionalPlatform name stored with the launch. -
videofile Optionalpump.fun only. MP4 or WebM, up to 10 MiB. Not sent for Ansem launches. -
quote_mintstring OptionalMint of the quote token the token pairs with. See List quote tokens. -
hostenum OptionalWhere the image and metadata JSON are published.Possible valuesipfsproxima -
trackerstring Optionaltruewhen the launch is deployed from the X tracker. -
mintstring OptionalBase58 secret key of a custom mint keypair, for a chosen token address. Not sent for Ansem launches nor forstoxes,flywheel,coinbarrel,knot,realm,stonksexchange,pangea,geniusandignix. -
is_mayhem_modeboolean Optionalpump.fun, not Ansem: Mayhem mode, sent astrueorfalse. -
is_pump_cashbackboolean Optionalpump.fun, not Ansem: cashback, sent astrueorfalse. -
is_offchain_createboolean Optionalpump.fun, not Ansem: off-chain create, sent astrueorfalse. -
is_pump_holder_rewardboolean Optionalpump.fun Holder Rewards:truesends creator fees to holders,falsekeeps them with the creator. -
creator_fee_bpsstring Optionalpump.fun creator-fee override, 1 to 300 (0.01% to 3%). Omit to keep the pump.fun default. -
pumpfun_fee_sharesstring Optionalpump.fun, not Ansem: JSON array of fee-share legs{share_bps, dev?, address?, github?, charity_id?}. Not sent withotcdesks,usepaidorzaio. -
ansemstring Optionalpump.fun Ansem launch, as JSON{"tier": "free" | "gold" | "diamond", "airdrop_buy_sol"?}. See Retrieve the Ansem config. -
otcdesksstring OptionalJSON{reward_mint, reward_basket?}: rewards holders in a token or basket. See List OTC desk rewards. -
usepaidstring OptionalJSON{handle}: a UsePaid launch for an X handle. -
zaiostring Optionaltruelaunches on zaio.fun (pump.fun, creator fees split 50/50 with zaio). -
bonk_mode_typestring Optionalbonk.fun mode. -
fourmeme_template_idstring OptionalFour.meme template ID. -
fee_claimersarray<object> OptionalBags fee claimers, sent as indexed parts such asfee_claimers[0][provider].Child attributes 3
-
providerenum OptionalWhereusernamelives.Possible valuestwittertiktokkickgithubaddress -
usernamestring OptionalHandle, or wallet address foraddress. -
bpsinteger OptionalShare in basis points.
-
-
printr_graduation_thresholdnumber OptionalPrintr graduation threshold. -
fee_sinkenum OptionalPrintr fee sink.Possible valuesdevstake_poolbuyback -
max_supplyenum OptionalPrintr maximum supply.Possible values100_million1_billion10_billion -
initial_market_capnumber OptionalPrintr initial market cap. -
bc_fee_bpsinteger OptionalPrintr bonding-curve fee, in basis points. -
amm_fee_bpsinteger OptionalPrintr AMM fee, in basis points. -
api_keystring OptionalAnoncoin API key. -
dbc_configstring OptionalMeteora DBC config account. See List DBC configs. -
create_paramsstring OptionalPlatform create parameters as a JSON string, foruniswapv2,uniswapv3,uniswapv4,hoodfun,pons,real,flap,meteoradamm,meteoradlmm,fourmeme,stonkfun,long,argus,foci,stoxes,flywheel,coinbarrel,knot,realm,stonksexchange,pangea,genius,ignixandanoncoin, and formeteoradbcandlaunchlabdrafts. -
stoxesstring OptionalStoxes create body, as a JSON string. -
lesgostring OptionalLesgo create body, as JSON{"kind": "burn" | "dev", "fee_bps", "burn_base"?}.
Returns 200 OK · application/json
Returns the new launch ID.
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome. -
launch_idstringPublic ID of the new launch. -
chain_idenumChain of the launch.Possible valuessolethbscbaserobinhoodmonadarcxlayer -
mint_pubkeystring | nullToken address, when already known. -
quote_mintstringMint of the quote token. -
quote_symbolstringSymbol of the quote token. -
launch_fee_lamportsstringPlatform launch fee in lamports. Number or numeric string. -
dev_buy_lamports_per_percentstringCost of each percent of supply for the dev buy, in lamports. Number or numeric string. -
max_dev_buy_percentstringLargest dev buy allowed, in percent of supply. Number or numeric string. -
modeenumStonkfun mode.Possible valuesstandardreward -
fee_tierenumFee tier.Possible values1%2% -
reward_tax_bpsintegerReward tax in basis points.Possible values100300
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | chain_id is not a chain the API serves. Use one of sol, bsc, base, eth, robinhood, arc or xlayer. |
| 400 | bad_request | dex is a Solana platform and chain_id is another chain. Send Solana platforms with chain_id set to sol. |
| 400 | bad_request | dex has no Solana create route, so a sol request reached the EVM route. Check dex against the platforms the chain supports. |
| 400 | bad_request | EVM: dex is not a known platform, or the Pons version does not exist. Use a platform ID the app lists for this chain, in lowercase. |
| 400 | bad_request | EVM: the platform does not deploy on this chain. Create the launch on one of the chains the message lists. |
| 400 | bad_request | name or symbol is missing or empty. Send both name and symbol as non-empty parts. |
| 400 | bad_request | No image part was sent. Send the token image as the image file part. |
| 400 | bad_request | Solana: name is longer than the platform allows (32 bytes on pump.fun). An over-long symbol answers Token symbol too long. Shorten name and symbol to the platform's limits. |
| 400 | bad_request | EVM: name is longer than the platform allows. An over-long symbol answers symbol too long (max <max>). Shorten name and symbol to the maximum the message gives. |
| 400 | bad_request | A mint part was sent to a platform that assigns the token address itself, which includes every EVM platform. Remove the mint part. |
| 400 | bad_request | Solana: mint is not a valid base58 keypair secret. Send the base58 secret key of the mint keypair, or omit mint to get a generated address. |
| 409 | conflict | A usepaid launch was requested while UsePaid has pump.fun turned off. On Pons the message is UsePaid has not enabled pons.family yet. Create the launch without usepaid, or try again once UsePaid enables the platform. |
| 422 | upstream_failure | Solana: the image and metadata could not be pinned to IPFS. No launch was created. Send the request again; nothing was saved. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.createMint(chainId, metadata) src/lib/proxima/endpoints/launch/launch.ts
Import a launch
/launch/{chain_id}/import-mint Creates a launch around a token that already exists on-chain.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying Each call creates a new launch, even for a token already imported. Look for the mint in List the license's launches before sending it again.
The new launch is flagged is_imported. Save a plan for it like any other launch.
Path parameters
-
chain_idenum RequiredChain the token lives on.Possible valuessolethbscbaserobinhoodmonadarcxlayer
Body parameters application/json
-
mintstring RequiredAddress of the existing token.
Returns 200 OK · application/json
Returns the new launch ID.
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome. -
launch_idstringPublic ID of the new launch. -
chain_idenumChain of the launch.Possible valuessolethbscbaserobinhoodmonadarcxlayer -
mint_pubkeystring | nullToken address, when already known.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | chain_id is not a chain the API serves. Use one of sol, bsc, base, eth, robinhood, arc or xlayer. |
| 400 | bad_request | Solana: mint is not a valid base58 address. Send the token's mint address. |
| 400 | bad_request | EVM: mint is not a valid 0x address. Send the token's contract address. |
| 500 | internal_error | Solana: no supported launchpad or pool trades this mint, or the mint does not exist. This refusal is answered as a 500. Check the mint and chain_id; only tokens on a supported launchpad or pool can be imported. |
| 400 | bad_request | EVM: no supported launchpad or pool was found for this token. Check the address and chain_id; only tokens on a supported launchpad or pool can be imported. |
| 400 | bad_request | Solana: the token trades against a quote token Proxima cannot fund. Import only tokens paired with a quote token from List quote tokens. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.importMint(chainId, mint) src/lib/proxima/endpoints/launch/launch.ts
Retrieve a launch
/launch/get-launch-info/{launch_id} Retrieves the launch plan, wallets, balances and performance of a launch.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Allowed.
- Retry
- Safe to retry
Wallet secrets are never included; use Reveal launch keys. For a multi-launch container the response describes the group, with kind, count, state and members.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Returns 200 OK · application/json
Returns a Launch object.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 404 | not_found | Solana: no plan was saved for this launch yet. Save a plan with Update the launch plan first. |
| 400 | bad_request | EVM: no plan was saved for this launch yet. A partly saved plan answers the same way, for example No funder wallet configured or No holder wallets saved. Save a complete plan with Update the launch plan first. |
Also the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.
Web client proxima.launch.getLaunchInfo(launchId) src/lib/proxima/endpoints/launch/launch.ts
Update the launch plan
/launch/update-launch-plan/{launch_id} Saves the launch plan: launch method, timings and the wallets with their planned buys.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Saving the same plan again stores the same values. A wallet slot sent without a
keygets a new wallet on each call, so read the wallets from the response.
Send the plan fields to set; the body is a partial Launch. Wallet slots take a key and a planned buy. The response echoes the saved plan and the native amount the funder needs.
The SDK method then re-reads the launch with Retrieve a launch and copies back the wallet secrets the update response returned.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Body parameters application/json
-
launch_methodenum OptionalHow the wallets buy.Possible valuesMevStaggerManualAllowlist -
funding_typeenum OptionalHow the funder spreads native to the wallets.Possible valuesClassicCex -
funding_delayinteger OptionalGap betweenCexfunding transfers, in seconds. -
scheduled_modeboolean OptionalDeploy first and let the wallets buy later through Snipe a scheduled launch. The app always sets it for imported launches. -
auto_snipe_delay_msinteger OptionalSolana scheduled launches: fire the snipe on its own this long after staging, in milliseconds. -
mev_typeenum OptionalVariant of aMevlaunch.Possible valuesbuybackairdrop -
buy_delayinteger OptionalDelay between holder buys, in milliseconds. -
buy_delay_maxinteger OptionalSolanaStaggeronly: upper bound of the random gap between holder buys, in milliseconds. -
initial_buy_delayinteger OptionalDelay before the first holder buy, in milliseconds. -
front_to_back_delay_msinteger OptionalDelay between front MEV and back MEV buys, in milliseconds. -
back_to_temp_delay_msinteger OptionalDelay between back MEV and temporary holder buys, in milliseconds. -
slippageinteger OptionalSlippage tolerance in basis points. -
fake_tip_pctnumber OptionalFake-tip setting, in percent. -
fee_targetinteger OptionalFee target in native base units. -
is_multiboolean OptionalMake the launch a multi-launch. -
countstring OptionalNumber of launches of a multi-launch. The SDK sends it as a string. -
devobject OptionalDev wallet slot.Child attributes 3
-
keystring | object Optional"None"to generate a wallet,{"pubkey"}to use one of your aged wallets, or{"secret"}to bring a key. -
buy_supplystring OptionalPlanned buy in token base units, as an integer string. -
buy_nativestring OptionalPlanned buy in native base units, as an integer string.
-
-
funderobject OptionalFunder wallet slot. Itskeyusually names one of your funder wallets. -
holderarray<object> OptionalHolder wallet slots, shaped likedev. -
front_mevarray<object> OptionalFront MEV wallet slots, shaped likedev. -
back_mevarray<object> OptionalBack MEV wallet slots, shaped likedev. -
temp_holderarray<object> OptionalTemporary holder wallet slots, shaped likedev.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
funder_required_nativeintegerNative amount the funder needs for the whole plan, in base units. -
planobjectThe saved plan, a Launch. Wallet slots can still carry thesecrets you sent.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Solana: the plan breaks a rule of its launch method or platform. Each rule has its own message, for example At least one holder must have a non-zero buy amount or Imported launches must be in scheduled mode. Fix the plan field the message names and save again. |
| 400 | bad_request | EVM: back_mev is not empty. EVM launches use front_mev and optional temp_holder wallets. Send back_mev empty on EVM launches. |
| 404 | not_found | Solana: a wallet slot names a key that is not one of your wallets. Use a wallet from List wallets. |
| 500 | internal_error | Solana: the launch is no longer a draft. This refusal is answered as a 500. Save plans only while the launch is a draft. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.updateLaunchPlan(launchId, launchPlan) src/lib/proxima/endpoints/launch/launch.ts
Update launch metadata
/launch/update-metadata/{launch_id} Changes the token metadata of a draft launch.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Sending the same fields again stores the same values.
Send only the parts to change. On Solana, metadata can only change while the launch is a draft and not imported. On EVM, the stored metadata can change at any time, but launch_platform and quote_mint are fixed once the token is launched.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Form fields multipart/form-data
-
namestring OptionalToken name. -
symbolstring OptionalToken ticker. -
imagefile OptionalToken image. A file part, or a string the app reuses from an existing token. -
descriptionstring OptionalToken description. -
twitterstring OptionalX (Twitter) link. -
telegramstring OptionalTelegram link. -
websitestring OptionalWebsite link. -
launch_platformstring OptionalPlatform name stored with the launch. -
videofile Optionalpump.fun only. MP4 or WebM, up to 10 MiB. Not sent for Ansem launches. -
remove_videoboolean Optionalpump.fun only. Sent astrueto drop the current video; not combined withvideo. -
quote_mintstring OptionalMint of the quote token the token pairs with. See List quote tokens. -
is_mayhem_modeboolean Optionalpump.fun, not Ansem: Mayhem mode, sent astrueorfalse. -
is_pump_cashbackboolean Optionalpump.fun, not Ansem: cashback, sent astrueorfalse. -
is_offchain_createboolean Optionalpump.fun, not Ansem: off-chain create, sent astrueorfalse. -
is_pump_holder_rewardboolean Optionalpump.fun Holder Rewards:truesends creator fees to holders,falsekeeps them with the creator. -
creator_fee_bpsstring Optionalpump.fun creator-fee override, 1 to 300 (0.01% to 3%).nullclears it; omit to keep the current value. -
pumpfun_fee_sharesstring Optionalpump.fun, not Ansem: JSON array of fee-share legs{share_bps, dev?, address?, github?, charity_id?}. Not sent withotcdesks,usepaidorzaio. -
ansemstring Optionalpump.fun Ansem launch, as JSON{"tier": "free" | "gold" | "diamond", "airdrop_buy_sol"?}. See Retrieve the Ansem config. -
bonk_mode_typestring Optionalbonk.fun mode. -
fourmeme_template_idstring OptionalFour.meme template ID. -
fee_claimersarray<object> OptionalBags fee claimers, sent as indexed parts such asfee_claimers[0][provider]. Up to 15.Child attributes 3
-
providerenum OptionalWhereusernamelives.Possible valuestwittertiktokkickgithubaddress -
usernamestring OptionalHandle, or wallet address foraddress. -
bpsinteger OptionalShare in basis points.
-
-
printr_graduation_thresholdnumber OptionalPrintr graduation threshold. -
fee_sinkenum OptionalPrintr fee sink.Possible valuesdevstake_poolbuyback -
max_supplyenum OptionalPrintr maximum supply.Possible values100_million1_billion10_billion -
initial_market_capnumber OptionalPrintr initial market cap. -
bc_fee_bpsinteger OptionalPrintr bonding-curve fee, in basis points. -
amm_fee_bpsinteger OptionalPrintr AMM fee, in basis points. -
api_keystring OptionalAnoncoin API key. -
dbc_configstring OptionalMeteora DBC config account. See List DBC configs. -
create_paramsstring OptionalPlatform create parameters as a JSON string, foruniswapv2,uniswapv3,uniswapv4,hoodfun,pons,real,flap,meteoradamm,meteoradlmm,fourmeme,stonkfun,long,argus,foci,stoxes,flywheel,coinbarrel,knot,realm,stonksexchange,pangea,genius,ignixandanoncoin. -
stoxesstring OptionalStoxes create body, as a JSON string. -
lesgostring OptionalLesgo create body, as JSON{"kind": "burn" | "dev", "fee_bps", "burn_base"?}.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome. Sent for Solana launches only.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | The request carries no field to change. Send at least one field to change. |
| 409 | conflict | Solana: the launch is no longer a draft. Change Solana metadata before launching the token. |
| 409 | conflict | Solana: the launch was imported, so its metadata is the existing token's. Leave the metadata of imported Solana launches unchanged. |
| 409 | conflict | EVM: launch_platform changed on a launched token. A changed quote_mint answers Cannot change the payment token after launch. Send launch_platform and quote_mint only while the launch is a draft. |
| 400 | bad_request | Solana: a video part was sent for a platform other than pump.fun. Send video only for pump.fun launches. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.updateMetadata(launchId, metadata) src/lib/proxima/endpoints/launch/launch.ts
Set the routing override
/launch/routing-override/{launch_id} Sets how a Solana launch page's buys and sells are routed across platforms, over each wallet's default.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Setting the same routing again stores the same value;
nullclears it.
Path parameters
-
launch_idstring RequiredPublic ID of the launch. Solana launches only.Example101482937561204
Body parameters application/json
-
routingobject | null OptionalShare of each trade's wallets per routing platform ID, in whole percents summing to 100. Platform IDs are matched case-insensitively.null, or leaving the field out, clears the override.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
routingobject | nullThe override now in place, keyed by platform ID in lowercase;nullwhen cleared.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | The launch is not on Solana; only Solana trades are routed through platforms. Set a routing override only on Solana launches (IDs starting with 101). |
| 400 | bad_request | The body is not valid JSON, or a share is not a whole number from 0 to 255. Send routing as an object of whole-percent shares, or null. |
| 400 | bad_request | A key of routing is not a platform that builds trades on Solana. Use platform IDs whose chains include sol in Retrieve the routing config. |
| 400 | bad_request | The same platform appears twice in routing, in different letter cases. Name each platform once. |
| 400 | bad_request | The shares do not add up to 100. Make the shares add up to exactly 100. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.setRoutingOverride(launchId, routing) src/lib/proxima/endpoints/launch/launch.ts
Set the launch funder
/launch/set-funder/{launch_id} Replaces the funder wallet of a launch that hasn't launched yet.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying Read
funderwith Retrieve a launch first: once the new funder holds SOL, a repeat answers 409 even though the change went through.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Body parameters application/json
-
pubkeystring RequiredAddress of the new funder, one of your wallets.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 400 | unsupported_chain | The launch is not on Solana. The body adds chain. Call this endpoint only for Solana launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | pubkey is not a valid Solana address. Send the base58 address of one of your wallets. |
| 500 | internal_error | The launch is no longer a draft. This refusal is answered as a 500. Change the funder only before launching. |
| 409 | conflict | The current funder still holds SOL. Empty the current funder first, for example with Execute a withdrawal. |
| 404 | not_found | pubkey is not a wallet of your license with a stored secret key. Use a wallet from List wallets or List funders. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.setFunder(launchId, pubkey) src/lib/proxima/endpoints/launch/launch.ts
Add wallets to a launch
/launch/add-wallets/{launch_id} Adds generated or aged wallets to a launch as holders.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying A repeat generates
amount_to_generatemore wallets, and aged wallets already added answer 409. Read the launch wallets with Retrieve a launch before sending it again.
New wallets join the holder list with no planned buy. Aged wallets must be aged or archived ones from your wallets; archived wallets are reactivated.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Body parameters application/json
-
amount_to_generateinteger OptionalNumber of new wallets to generate. -
aged_wallet_pubkeysarray<string> OptionalAddresses of aged wallets to add.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
wallet_pubkeysarray<string>Addresses of the wallets added.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Neither amount_to_generate nor aged_wallet_pubkeys was sent. Send amount_to_generate, aged_wallet_pubkeys, or both. |
| 400 | bad_request | amount_to_generate is over 500. A longer aged_wallet_pubkeys answers aged_wallet_pubkeys cannot exceed 500. Add at most 500 wallets per call. |
| 400 | bad_request | Solana: an entry of aged_wallet_pubkeys is not a valid address (EVM: Invalid aged wallet address). A repeated entry answers Duplicate aged wallet pubkey: <pubkey>. Send each aged wallet address once. |
| 409 | conflict | An aged wallet is already part of this launch, in any role. Remove the wallets already on the launch from aged_wallet_pubkeys. |
| 422 | unprocessable | The launch would have more than 500 wallets across all roles. Add fewer wallets so the launch stays at 500 or fewer. |
| 422 | unprocessable | An aged wallet is not one of your aged or archived wallets. Use aged wallets listed by List wallets. |
| 500 | internal_error | Solana: no plan was saved for the launch yet. This refusal is answered as a 500; EVM answers 400 bad_request with the same message. Save a plan with Update the launch plan first. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.addWallets(launchId, request) src/lib/proxima/endpoints/launch/launch.ts
Archive a launch
/launch/set-archive-status/{launch_id} Archives or unarchives a launch.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Setting the same
archivedvalue again changes nothing.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Body parameters application/json
-
archivedboolean Requiredtrueto archive,falseto restore.
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome. Sent for Solana launches only.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.archive(launchId, archived) src/lib/proxima/endpoints/launch/launch.ts
Delete a launch plan
/launch/delete-launch-plan/{launch_id} Deletes a launch before it is launched.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Deleting again clears a plan that is already empty.
Also clears the automations planned for it (auto sell, auto buy, volume, cleanup and sniper guard) and revokes its share grants.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Returns 200 OK · application/json
-
okbooleantruewhen the request succeeded. -
messagestringHuman-readable outcome.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 500 | internal_error | Solana: the launch is no longer a draft. This refusal is answered as a 500. Delete plans only while the launch is a draft. |
| 400 | bad_request | EVM: the launch is no longer a draft. Delete plans only while the launch is a draft. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.launch.deleteLaunchPlan(launchId) src/lib/proxima/endpoints/launch/launch.ts
Reveal launch keys
/launch/reveal-key/{launch_id} Returns the secret keys of the launch wallets you can export.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Two-factor
- Step-up for
launch.reveal_keywhen the user protects it. How it works - Retry
- Safe to retry Revealing again returns the same keys and records another reveal in history.
The dev key can be revealed by the launch owner; sub-wallet keys only by licenses that manage their keys. Wallets you can reveal carry key.can_export on the Launch wallet. Every reveal is recorded in your history.
Path parameters
-
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Body parameters application/json
-
pubkeysarray<string> OptionalOnly reveal these wallets. Omit to reveal every exportable wallet. Up to 100.
Returns 200 OK · application/json
-
keysarray<object>Revealed keys.Child attributes 3
-
rolestringRole of the wallet in the launch, such asdev. -
pubkeystringWallet address. -
secretstringSecret key.
-
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | pubkeys lists more than 300 keys. Ask for at most 300 keys per call. |
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | The launch is an EVM multi-launch container. Reveal the keys on each member launch. |
| 404 | not_found | None of the launch wallets can be exported by you, or none matches pubkeys. Ask only for wallets that carry key.can_export in Retrieve a launch. |
| 403 | forbidden | Shared launch: a key in pubkeys is outside what the grant exports. A grant that exports no key answers this share exports no key. Ask only for the keys the grant lists in List grants on a launch. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token, 401 2fa_required and 429 when rate limited.
Web client proxima.launch.revealKey(launchId, request) src/lib/proxima/endpoints/launch/launch.ts
Retrieve token metadata
/launch/get-metadata/{address} Looks up the metadata of any token address, on every chain where it resolves.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Allowed.
- Retry
- Safe to retry
The app uses it to prefill a clone or an import.
Path parameters
-
addressstring RequiredToken address (base58 mint or0xaddress).ExampleHtSTV4r6EZBnJfTQkWLf1ZbTC8UjUxL9evrE67EmuzyF
Returns 200 OK · application/json
-
resultsarray<object>One entry per chain where the address resolves, shaped like the create-launch metadata.Child attributes 10
-
chain_idenumChain of the token.Possible valuessolethbscbaserobinhoodmonadarcxlayer -
dexstringPlatform ID. -
launch_platformstringPlatform name. -
namestringToken name. -
symbolstringToken ticker. -
imagestringImage URL. -
descriptionstringDescription. -
twitterstringX (Twitter) link. -
telegramstringTelegram link. -
websitestringWebsite link.
-
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | address is neither a Solana mint nor a 0x address, or no chain returned metadata for it. A miss is remembered for 60 seconds. Check the address; for a token created moments ago, ask again after a minute. |
Also the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.
Web client proxima.launch.getMetadata(mint) src/lib/proxima/endpoints/launch/launch.ts
Retrieve the launch thesis feed
/launch/{source}/thesis/{launch_id} Lists the Fomoscan theses and callouts posted about the launch's token.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Allowed.
- Retry
- Safe to retry Each call also keeps new items relayed on the realtime channel for 90 seconds; repeating it only extends that.
Only the launch owner can read it. The app shows the items as marks on the price chart and polls every 30 seconds.
Path parameters
-
sourceenum RequiredFomoscan feed to read.Possible valuespumpfunfomo -
launch_idstring RequiredPublic ID of the launch.Example101482937561204
Returns 200 OK · application/json
-
sourceenumFeed that was read.Possible valuespumpfunfomo -
mintstringToken address. -
itemsarray<object>Theses, normalized across both feeds. Fields a feed doesn't provide arenull.Child attributes 16
-
idstringItem ID. -
sourceenumFeed the item came from.Possible valuespumpfunfomo -
author_handlestring | nullAuthor handle. -
author_namestring | nullAuthor display name. -
x_usernamestring | nullAuthor X username. -
verifiedboolean | nullAuthor is verified. -
is_devboolean | nullAuthor is the token's dev. -
textstringThesis text. -
media_urlstring | nullAttached media. -
created_atintegerCreation time, in epoch milliseconds. -
likesinteger | nullLikes. -
mcap_at_callnumber | nullMarket cap when the call was made (pumpfunonly). -
multiplenumber | nullMultiple realized since the call (pumpfunonly). -
pnl_usdnumber | nullAuthor profit and loss in USD (fomoonly). -
author_avatar_urlstring | nullAuthor avatar. -
token_image_urlstring | nullToken image (fomoonly).
-
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | source is not pumpfun or fomo. Use pumpfun or fomo as source. |
| 400 | bad_request | launch_id is not a valid launch ID. Pass the launch_id returned when the launch was created, as listed by List the license's launches. |
| 404 | not_found | No launch with this ID belongs to your license. Check the ID, and that your token is upgraded onto the license that owns the launch. |
| 422 | upstream_failure | The Fomoscan feed could not be read. A failure is cached for 5 minutes. Other causes read fomoscan request failed or failed to parse fomoscan response. The body adds service. Try again after 5 minutes. |
Also the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.
Web client proxima.launch.getThesis(source, launchId) src/lib/proxima/endpoints/launch/launch.ts