Skip to content
API Reference

Search is only available in production builds. Try building and previewing the site to test it out locally.

Launches

Create, configure and inspect token launches and their wallet plans.

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).

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_id enum
    Chain the launch lives on.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • launch_method enum
    How the wallets buy. The app shows Mev as Block-0 and Stagger as Organic; its Quick mode is Stagger with a buy_delay of 0.
    Possible values MevStaggerManualAllowlist
  • funding_type enum
    How the funder spreads native to the wallets: direct transfers (Classic) or through an exchange route (Cex).
    Possible values ClassicCex
  • funding_delay integer | null
    Gap between Cex funding transfers, in seconds.
  • is_graduated boolean
    The token has graduated from its bonding curve.
  • is_imported boolean
    The launch was created with Import a launch around an existing token.
  • scheduled_mode boolean
    The token is deployed first and the wallets buy later, through Snipe a scheduled launch.
  • mev_type enum | null
    Variant of a Mev launch. airdrop distributes through a Streamflow airdrop on Solana.
    Possible values buybackairdrop
  • buy_delay integer
    Delay between holder buys, in milliseconds.
  • buy_delay_max integer | null
    Solana Stagger only: each gap between holder buys is drawn between buy_delay and this value, in milliseconds.
  • initial_buy_delay integer | null
    Delay before the first holder buy, in milliseconds.
  • auto_snipe_delay_ms integer | null
    Solana scheduled launches: the snipe fires on its own this long after the launch is staged, in milliseconds.
  • auto_snipe_at string | null
    ISO 8601 time the pending auto-snipe fires, or null when none is armed.
  • front_to_back_delay_ms integer | null
    Delay between the front MEV and back MEV buys, in milliseconds.
  • back_to_temp_delay_ms integer | null
    Delay between the back MEV and temporary holder buys, in milliseconds.
  • slippage integer
    Slippage tolerance in basis points.
  • fake_tip_pct number
    Fake-tip setting of the launch, in percent.
  • fee_target integer | null
    Fee target in native base units.
  • routing_override object | null
    Share 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_mint string
    Mint of the quote token. Always set on Solana, where native-quoted launches carry WSOL.
  • total_supply integer
    Total token supply.
  • creator_fees integer
    Uncollected creator fees, in base units of the native or quote token. See Collect creator fees.
  • creator_fee_bps integer | null
    pump.fun creator-fee override, from 1 to 300 (0.01% to 3%). null keeps the pump.fun default.
  • is_pump_holder_reward boolean
    pump.fun Holder Rewards: true sends creator fees to holders, false keeps them with the creator.
  • unclaimed_cashback integer | null
    pump.fun cashback waiting to be claimed. See Claim pump.fun cashback.
  • fee_share_config array<object> | null
    pump.fun fee-share legs of the live token.
    Child attributes 4
    • address string
      Recipient wallet.
    • github string
      Recipient GitHub username.
    • charity_id string
      Recipient charity ID.
    • share_bps integer
      Share of the creator fees, in basis points.
  • is_fee_share_admin boolean | null
    Whether the launch's dev administers the pump.fun fee-share config.
  • pumpfun_prelaunch_fee_shares array<object> | null
    Fee-share legs saved on a draft and applied when the token is created. Each leg has share_bps and one of dev: true, address, github or charity_id.
  • dev object | null
    Dev wallet, a Launch wallet. It deploys the token and makes the dev buy.
  • funder object
    Funder wallet, a Launch wallet that funds every other wallet of the plan.
  • holder array<object>
    Holder wallets, as Launch wallets.
  • front_mev array<object>
    Front MEV wallets of a Mev launch.
  • back_mev array<object>
    Back MEV wallets of a Mev launch.
  • temp_holder array<object>
    Temporary holder wallets of a Mev launch.
  • wallets_being_funded integer
    Wallets whose funding is in progress.
  • wallets_funded integer
    Wallets already funded.
  • pnl_native string
    Profit and loss in native base units, as a string.
  • pnl_usd string
    Profit and loss, in micro-USD, as an integer string.
  • gross_volume_native string
    Gross traded volume in native base units, as a string.
  • gross_volume_usd string
    Gross traded volume, in micro-USD, as an integer string.
  • extra_rewards_native string
    Extra rewards in native base units, as a string.
  • extra_rewards_usd string
    Extra rewards, in micro-USD, as an integer string.
  • mm_pnl_native string
    Market-making profit and loss in native base units, as a string.
  • mm_pnl_usd string
    Market-making profit and loss, in micro-USD, as an integer string.
  • total_buy_native string | null
    Total bought, in native base units.
  • total_buy_tokens string | null
    Total bought, in token base units.
  • total_buy_usd string | null
    Total bought, in micro-USD, as an integer string.
  • total_sell_native string | null
    Total sold, in native base units.
  • total_sell_tokens string | null
    Total sold, in token base units.
  • total_sell_usd string | null
    Total sold, in micro-USD, as an integer string.
  • current_buy_fee_bps integer | null
    Current buy fee of the token, in basis points.
  • current_sell_fee_bps integer | null
    Current sell fee of the token, in basis points.
  • mcap_live number | null
    Current market cap. Number or numeric string.
  • mcap_before_cleanup number | null
    Market cap before cleanup. Number or numeric string.
  • mcap_post_cleanup number | null
    Market cap after cleanup. Number or numeric string.
  • mcap_migration number | null
    Market cap at migration. Number or numeric string.
  • ansem object | null
    pump.fun Ansem launch settings.
    Child attributes 2
    • tier enum
      Ansem tier.
      Possible values freegolddiamond
    • airdrop_buy_sol string
      Airdrop buy, in SOL. Number or numeric string.
  • otcdesks object | null
    OTC desks reward settings.
    Child attributes 3
    • reward_mint string
      Mint holders are rewarded in.
    • reward_symbol string | null
      Symbol of the reward token.
    • reward_basket array<string> | null
      Mints of a reward basket.
  • usepaid object | null
    UsePaid launch settings.
    Child attributes 2
    • handle string
      X handle the launch is made for.
    • x_user_id string | null
      X user ID of the handle.
  • zaio object | null
    zaio.fun launch: a pump.fun coin whose creator fees are split 50/50 with zaio's fee wallet.
    Child attributes 4
    • recipient string
      zaio fee wallet.
    • launch_fee_lamports string
      Launch fee in lamports. Number or numeric string.
    • imported boolean
      The coin was imported.
    • slug string | null
      The coin's page on zaio, zaio.fun/@<slug>, once zaio lists it.
  • printr_fee_sink enum
    Printr fee sink.
    Possible values devstake_poolbuyback
  • printr_max_supply enum
    Printr maximum supply.
    Possible values 100_million1_billion10_billion
  • printr_initial_market_cap number
    Printr initial market cap.
  • bonk_mode_type string
    bonk.fun mode. Boolean or string.
  • meteora_dbc_config string | null
    Meteora DBC config account of the launch.
  • meteora_damm_config string | null
    Meteora DAMM config account of the launch.
  • meteora_damm_info object | null
    Meteora DAMM pool details.
  • meteora_dlmm_info object | null
    Meteora DLMM pool details.
  • fourmeme_options object
    Four.meme options.
  • stonkfun_info object | null
    Stonkfun details: quote, mode, pool fee, reward tax, dev buy and pool.
  • stoxes_info object | null
    Stoxes details.
  • lesgo_info object | null
    Lesgo details: kind, fees, config, pool and listing state.
  • is_multi boolean
    The launch is a multi-launch container that runs several attempts.
  • kind string
    group for a multi-launch container.
  • count integer
    Number of launches in a multi-launch.
  • state object
    Progress of a multi-launch.
    Child attributes 4
    • attempts_planned integer
      Attempts planned.
    • attempts_executed integer
      Attempts executed so far.
    • winner_launch_id string | null
      Public ID of the winning attempt.
    • total_cost_native string
      Total cost in native base units.
  • members array<object>
    Attempts of a multi-launch.
    Child attributes 11
    • launch_id string
      Public ID of the attempt.
    • group_disposition enum
      Role of the attempt in the group.
      Possible values attemptwinnerdisposed
    • group_signals object | null
      Signals recorded for the attempt.
    • mint_pubkey string
      Token address of the attempt.
    • launch_status string
      Status of the attempt.
    • pnl_native string
      Profit and loss in native base units.
    • pnl_usd string
      Profit and loss, in micro-USD, as an integer string.
    • gross_volume_native string
      Gross volume in native base units.
    • gross_volume_usd string
      Gross volume, in micro-USD, as an integer string.
    • created_at integer
      Creation time.
    • tag_ids array<integer>
      Tags on the attempt.
  • reserve string | null
    Reserve of a multi-launch.
  • script_plan object | null
    The stored script plan, returned only to sessions with script access. See Launch scripts.

One wallet of a launch plan: its key, planned buy and balances. Amounts are integer strings in base units.

Attributes

  • key object
    Wallet key. The string "None" instead of an object marks a slot the API fills with a generated wallet.
    Child attributes 3
    • pubkey string
      Wallet address (base58 on Solana, 0x on EVM).
    • secret string
      Secret key. Only present in payloads you send and in the plan echoed by Update the launch plan; never returned by Retrieve a launch.
    • can_export boolean
      true when you can reveal this key with Reveal launch keys.
  • aged boolean
    The wallet comes from your aged wallets rather than being generated for this launch.
  • archived boolean
    The wallet is archived.
  • is_universal boolean
    Funder slot only: the funder is one of your universal funder wallets.
  • buy_supply string
    Planned buy in token base units, as an integer string.
  • buy_native string
    Planned buy in native base units (lamports or wei), as an integer string.
  • native_balance string
    Native balance in base units.
  • token_balance string
    Token balance in base units.
  • quote_balance string
    Quote token balance in base units, for launches paired with a non-native quote.
  • proxy_address string | null
    Proxy contract the wallet trades through, when it has one.
  • proxy_native_balance string
    Native balance held by the proxy contract, in base units.
  • proxy_token_balance string
    Token balance held by the proxy contract, in base units.
  • expected_supply string
    Tokens the wallet is expected to hold after its planned buy, in base units.
  • required_native string
    Native amount the wallet needs for its planned buy, in base units.
  • min_native_funding string
    Minimum native funding for the wallet, in base units.
  • min_quote_funding string
    Minimum quote token funding for the wallet, in base units.

Create a launch

Bearer JWT
POST /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_id enum Required
    Chain to create the token on.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • dex string Required
    Launch platform ID in lowercase, for example pumpfun, bonkfun, meteoradbc, fourmeme, flap or uniswapv2.
    Examplepumpfun

Query parameters

  • version integer Optional Default 2
    Pons contract version. Sent only when dex is pons, taken from create_params.version.
    Possible values 12

Form fields multipart/form-data

  • name string Required
    Token name.
  • symbol string Required
    Token ticker.
  • image file Required
    Token image. A file part, or a string the app reuses from an existing token.
  • description string Optional
    Token description.
  • twitter string Optional
    X (Twitter) link.
  • telegram string Optional
    Telegram link.
  • website string Optional
    Website link.
  • launch_platform string Optional
    Platform name stored with the launch.
  • video file Optional
    pump.fun only. MP4 or WebM, up to 10 MiB. Not sent for Ansem launches.
  • quote_mint string Optional
    Mint of the quote token the token pairs with. See List quote tokens.
  • host enum Optional Default ipfs
    Where the image and metadata JSON are published.
    Possible values ipfsproxima
  • tracker string Optional
    true when the launch is deployed from the X tracker.
  • mint string Optional
    Base58 secret key of a custom mint keypair, for a chosen token address. Not sent for Ansem launches nor for stoxes, flywheel, coinbarrel, knot, realm, stonksexchange, pangea, genius and ignix.
  • is_mayhem_mode boolean Optional
    pump.fun, not Ansem: Mayhem mode, sent as true or false.
  • is_pump_cashback boolean Optional
    pump.fun, not Ansem: cashback, sent as true or false.
  • is_offchain_create boolean Optional
    pump.fun, not Ansem: off-chain create, sent as true or false.
  • is_pump_holder_reward boolean Optional
    pump.fun Holder Rewards: true sends creator fees to holders, false keeps them with the creator.
  • creator_fee_bps string Optional
    pump.fun creator-fee override, 1 to 300 (0.01% to 3%). Omit to keep the pump.fun default.
  • pumpfun_fee_shares string Optional
    pump.fun, not Ansem: JSON array of fee-share legs {share_bps, dev?, address?, github?, charity_id?}. Not sent with otcdesks, usepaid or zaio.
  • ansem string Optional
    pump.fun Ansem launch, as JSON {"tier": "free" | "gold" | "diamond", "airdrop_buy_sol"?}. See Retrieve the Ansem config.
  • otcdesks string Optional
    JSON {reward_mint, reward_basket?}: rewards holders in a token or basket. See List OTC desk rewards.
  • usepaid string Optional
    JSON {handle}: a UsePaid launch for an X handle.
  • zaio string Optional
    true launches on zaio.fun (pump.fun, creator fees split 50/50 with zaio).
  • bonk_mode_type string Optional
    bonk.fun mode.
  • fourmeme_template_id string Optional
    Four.meme template ID.
  • fee_claimers array<object> Optional
    Bags fee claimers, sent as indexed parts such as fee_claimers[0][provider].
    Child attributes 3
    • provider enum Optional
      Where username lives.
      Possible values twittertiktokkickgithubaddress
    • username string Optional
      Handle, or wallet address for address.
    • bps integer Optional
      Share in basis points.
  • printr_graduation_threshold number Optional
    Printr graduation threshold.
  • fee_sink enum Optional
    Printr fee sink.
    Possible values devstake_poolbuyback
  • max_supply enum Optional
    Printr maximum supply.
    Possible values 100_million1_billion10_billion
  • initial_market_cap number Optional
    Printr initial market cap.
  • bc_fee_bps integer Optional
    Printr bonding-curve fee, in basis points.
  • amm_fee_bps integer Optional
    Printr AMM fee, in basis points.
  • api_key string Optional
    Anoncoin API key.
  • dbc_config string Optional
    Meteora DBC config account. See List DBC configs.
  • create_params string Optional
    Platform create parameters as a JSON string, for uniswapv2, uniswapv3, uniswapv4, hoodfun, pons, real, flap, meteoradamm, meteoradlmm, fourmeme, stonkfun, long, argus, foci, stoxes, flywheel, coinbarrel, knot, realm, stonksexchange, pangea, genius, ignix and anoncoin, and for meteoradbc and launchlab drafts.
  • stoxes string Optional
    Stoxes create body, as a JSON string.
  • lesgo string Optional
    Lesgo create body, as JSON {"kind": "burn" | "dev", "fee_bps", "burn_base"?}.

Returns 200 OK · application/json

Returns the new launch ID.

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.
  • launch_id string
    Public ID of the new launch.
  • chain_id enum
    Chain of the launch.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • mint_pubkey string | null
    Token address, when already known.
  • quote_mint string
    Mint of the quote token.
  • quote_symbol string
    Symbol of the quote token.
  • launch_fee_lamports string
    Platform launch fee in lamports. Number or numeric string.
  • dev_buy_lamports_per_percent string
    Cost of each percent of supply for the dev buy, in lamports. Number or numeric string.
  • max_dev_buy_percent string
    Largest dev buy allowed, in percent of supply. Number or numeric string.
  • mode enum
    Stonkfun mode.
    Possible values standardreward
  • fee_tier enum
    Fee tier.
    Possible values 1%2%
  • reward_tax_bps integer
    Reward tax in basis points.
    Possible values 100300

Errors

StatusCodeWhen 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

Bearer JWT
POST /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_id enum Required
    Chain the token lives on.
    Possible values solethbscbaserobinhoodmonadarcxlayer

Body parameters application/json

  • mint string Required
    Address of the existing token.

Returns 200 OK · application/json

Returns the new launch ID.

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.
  • launch_id string
    Public ID of the new launch.
  • chain_id enum
    Chain of the launch.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • mint_pubkey string | null
    Token address, when already known.

Errors

StatusCodeWhen 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

Bearer JWT
GET /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_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

Returns a Launch object.

Errors

StatusCodeWhen 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

POST /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 key gets 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_id string Required
    Public ID of the launch.
    Example101482937561204

Body parameters application/json

  • launch_method enum Optional
    How the wallets buy.
    Possible values MevStaggerManualAllowlist
  • funding_type enum Optional
    How the funder spreads native to the wallets.
    Possible values ClassicCex
  • funding_delay integer Optional
    Gap between Cex funding transfers, in seconds.
  • scheduled_mode boolean Optional
    Deploy first and let the wallets buy later through Snipe a scheduled launch. The app always sets it for imported launches.
  • auto_snipe_delay_ms integer Optional
    Solana scheduled launches: fire the snipe on its own this long after staging, in milliseconds.
  • mev_type enum Optional
    Variant of a Mev launch.
    Possible values buybackairdrop
  • buy_delay integer Optional
    Delay between holder buys, in milliseconds.
  • buy_delay_max integer Optional
    Solana Stagger only: upper bound of the random gap between holder buys, in milliseconds.
  • initial_buy_delay integer Optional
    Delay before the first holder buy, in milliseconds.
  • front_to_back_delay_ms integer Optional
    Delay between front MEV and back MEV buys, in milliseconds.
  • back_to_temp_delay_ms integer Optional
    Delay between back MEV and temporary holder buys, in milliseconds.
  • slippage integer Optional
    Slippage tolerance in basis points.
  • fake_tip_pct number Optional
    Fake-tip setting, in percent.
  • fee_target integer Optional
    Fee target in native base units.
  • is_multi boolean Optional
    Make the launch a multi-launch.
  • count string Optional
    Number of launches of a multi-launch. The SDK sends it as a string.
  • dev object Optional
    Dev wallet slot.
    Child attributes 3
    • key string | object Optional
      "None" to generate a wallet, {"pubkey"} to use one of your aged wallets, or {"secret"} to bring a key.
    • buy_supply string Optional
      Planned buy in token base units, as an integer string.
    • buy_native string Optional
      Planned buy in native base units, as an integer string.
  • funder object Optional
    Funder wallet slot. Its key usually names one of your funder wallets.
  • holder array<object> Optional
    Holder wallet slots, shaped like dev.
  • front_mev array<object> Optional
    Front MEV wallet slots, shaped like dev.
  • back_mev array<object> Optional
    Back MEV wallet slots, shaped like dev.
  • temp_holder array<object> Optional
    Temporary holder wallet slots, shaped like dev.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • funder_required_native integer
    Native amount the funder needs for the whole plan, in base units.
  • plan object
    The saved plan, a Launch. Wallet slots can still carry the secrets you sent.

Errors

StatusCodeWhen 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

POST /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_id string Required
    Public ID of the launch.
    Example101482937561204

Form fields multipart/form-data

  • name string Optional
    Token name.
  • symbol string Optional
    Token ticker.
  • image file Optional
    Token image. A file part, or a string the app reuses from an existing token.
  • description string Optional
    Token description.
  • twitter string Optional
    X (Twitter) link.
  • telegram string Optional
    Telegram link.
  • website string Optional
    Website link.
  • launch_platform string Optional
    Platform name stored with the launch.
  • video file Optional
    pump.fun only. MP4 or WebM, up to 10 MiB. Not sent for Ansem launches.
  • remove_video boolean Optional
    pump.fun only. Sent as true to drop the current video; not combined with video.
  • quote_mint string Optional
    Mint of the quote token the token pairs with. See List quote tokens.
  • is_mayhem_mode boolean Optional
    pump.fun, not Ansem: Mayhem mode, sent as true or false.
  • is_pump_cashback boolean Optional
    pump.fun, not Ansem: cashback, sent as true or false.
  • is_offchain_create boolean Optional
    pump.fun, not Ansem: off-chain create, sent as true or false.
  • is_pump_holder_reward boolean Optional
    pump.fun Holder Rewards: true sends creator fees to holders, false keeps them with the creator.
  • creator_fee_bps string Optional
    pump.fun creator-fee override, 1 to 300 (0.01% to 3%). null clears it; omit to keep the current value.
  • pumpfun_fee_shares string Optional
    pump.fun, not Ansem: JSON array of fee-share legs {share_bps, dev?, address?, github?, charity_id?}. Not sent with otcdesks, usepaid or zaio.
  • ansem string Optional
    pump.fun Ansem launch, as JSON {"tier": "free" | "gold" | "diamond", "airdrop_buy_sol"?}. See Retrieve the Ansem config.
  • bonk_mode_type string Optional
    bonk.fun mode.
  • fourmeme_template_id string Optional
    Four.meme template ID.
  • fee_claimers array<object> Optional
    Bags fee claimers, sent as indexed parts such as fee_claimers[0][provider]. Up to 15.
    Child attributes 3
    • provider enum Optional
      Where username lives.
      Possible values twittertiktokkickgithubaddress
    • username string Optional
      Handle, or wallet address for address.
    • bps integer Optional
      Share in basis points.
  • printr_graduation_threshold number Optional
    Printr graduation threshold.
  • fee_sink enum Optional
    Printr fee sink.
    Possible values devstake_poolbuyback
  • max_supply enum Optional
    Printr maximum supply.
    Possible values 100_million1_billion10_billion
  • initial_market_cap number Optional
    Printr initial market cap.
  • bc_fee_bps integer Optional
    Printr bonding-curve fee, in basis points.
  • amm_fee_bps integer Optional
    Printr AMM fee, in basis points.
  • api_key string Optional
    Anoncoin API key.
  • dbc_config string Optional
    Meteora DBC config account. See List DBC configs.
  • create_params string Optional
    Platform create parameters as a JSON string, for uniswapv2, uniswapv3, uniswapv4, hoodfun, pons, real, flap, meteoradamm, meteoradlmm, fourmeme, stonkfun, long, argus, foci, stoxes, flywheel, coinbarrel, knot, realm, stonksexchange, pangea, genius, ignix and anoncoin.
  • stoxes string Optional
    Stoxes create body, as a JSON string.
  • lesgo string Optional
    Lesgo create body, as JSON {"kind": "burn" | "dev", "fee_bps", "burn_base"?}.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome. Sent for Solana launches only.

Errors

StatusCodeWhen 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

POST /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; null clears it.

Path parameters

  • launch_id string Required
    Public ID of the launch. Solana launches only.
    Example101482937561204

Body parameters application/json

  • routing object | null Optional
    Share 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

  • ok boolean
    true when the request succeeded.
  • routing object | null
    The override now in place, keyed by platform ID in lowercase; null when cleared.

Errors

StatusCodeWhen 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

POST /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 funder with Retrieve a launch first: once the new funder holds SOL, a repeat answers 409 even though the change went through.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Body parameters application/json

  • pubkey string Required
    Address of the new funder, one of your wallets.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.

Errors

StatusCodeWhen 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

POST /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_generate more 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_id string Required
    Public ID of the launch.
    Example101482937561204

Body parameters application/json

  • amount_to_generate integer Optional
    Number of new wallets to generate.
  • aged_wallet_pubkeys array<string> Optional
    Addresses of aged wallets to add.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • wallet_pubkeys array<string>
    Addresses of the wallets added.

Errors

StatusCodeWhen 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

Bearer JWT
POST /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 archived value again changes nothing.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Body parameters application/json

  • archived boolean Required
    true to archive, false to restore.

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome. Sent for Solana launches only.

Errors

StatusCodeWhen 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

POST /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_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • message string
    Human-readable outcome.

Errors

StatusCodeWhen 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

Bearer JWT 2FA
POST /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_key when 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_id string Required
    Public ID of the launch.
    Example101482937561204

Body parameters application/json

  • pubkeys array<string> Optional
    Only reveal these wallets. Omit to reveal every exportable wallet. Up to 100.

Returns 200 OK · application/json

  • keys array<object>
    Revealed keys.
    Child attributes 3
    • role string
      Role of the wallet in the launch, such as dev.
    • pubkey string
      Wallet address.
    • secret string
      Secret key.

Errors

StatusCodeWhen 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

GET /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

  • address string Required
    Token address (base58 mint or 0x address).
    ExampleHtSTV4r6EZBnJfTQkWLf1ZbTC8UjUxL9evrE67EmuzyF

Returns 200 OK · application/json

  • results array<object>
    One entry per chain where the address resolves, shaped like the create-launch metadata.
    Child attributes 10
    • chain_id enum
      Chain of the token.
      Possible values solethbscbaserobinhoodmonadarcxlayer
    • dex string
      Platform ID.
    • launch_platform string
      Platform name.
    • name string
      Token name.
    • symbol string
      Token ticker.
    • image string
      Image URL.
    • description string
      Description.
    • twitter string
      X (Twitter) link.
    • telegram string
      Telegram link.
    • website string
      Website link.

Errors

StatusCodeWhen 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

GET /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

  • source enum Required
    Fomoscan feed to read.
    Possible values pumpfunfomo
  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

  • source enum
    Feed that was read.
    Possible values pumpfunfomo
  • mint string
    Token address.
  • items array<object>
    Theses, normalized across both feeds. Fields a feed doesn't provide are null.
    Child attributes 16
    • id string
      Item ID.
    • source enum
      Feed the item came from.
      Possible values pumpfunfomo
    • author_handle string | null
      Author handle.
    • author_name string | null
      Author display name.
    • x_username string | null
      Author X username.
    • verified boolean | null
      Author is verified.
    • is_dev boolean | null
      Author is the token's dev.
    • text string
      Thesis text.
    • media_url string | null
      Attached media.
    • created_at integer
      Creation time, in epoch milliseconds.
    • likes integer | null
      Likes.
    • mcap_at_call number | null
      Market cap when the call was made (pumpfun only).
    • multiple number | null
      Multiple realized since the call (pumpfun only).
    • pnl_usd number | null
      Author profit and loss in USD (fomo only).
    • author_avatar_url string | null
      Author avatar.
    • token_image_url string | null
      Token image (fomo only).

Errors

StatusCodeWhen 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