Skip to content
API Reference

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

Launch execution

Fund the wallets of a launch, launch it and follow its progress.

Once a launch has a plan, fund its wallets from the funder, then launch it. The launch and snipe calls answer with a stream of Launch progress events instead of a single JSON body, so read the response incrementally.

A scheduled launch (scheduled_mode) deploys first and buys later with Snipe a scheduled launch. The remaining calls prepare platform accounts before a launch or recover funds afterwards.

One data: line of the launch and snipe event streams. The stream ends after the last step or the first failure.

Attributes

  • step integer
    Current step, starting at 1.
  • total integer
    Number of steps.
  • ok boolean
    false when this step failed.
  • message string
    What the step did.
  • token_address string
    Token address, once deployed.
  • bundle3_failed_mevs array<integer>
    Indexes of front MEV wallets whose bundle failed.
  • bundle4_failed_temps array<integer>
    Indexes of temporary holders whose bundle failed.
  • proxies_rescued integer
    Proxy contracts emptied back to their owners.
POST /launch/distribute/{launch_id}

Starts sending native from the funder to every wallet of the launch plan.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying A repeat only tops up wallets still below target, but on EVM nothing refuses it while an earlier job is still sending, so the wallets can be funded twice. Read Retrieve required funding and the funding.execute event in List a launch's activity events first.

On Solana, and on EVM when the plan has a funding_delay, funding runs in the background after the call returns and the response carries its funding_job_id. On EVM with no delay, the transfers are sent before the call returns. For a Cex launch, plan lists the exchange sources to route through.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Body parameters application/json

  • plan array<string> Optional
    IDs of the exchange sources to fund through. Sent only when non-empty.
  • cex_provider enum Optional
    Exchange route provider.
    Possible values husher

Returns 200 OK · application/json

  • ok boolean
    true when the funding started or nothing was needed.
  • message string
    Human-readable outcome, for example No funding needed when every wallet is already at its target. Absent from an immediate EVM transfer.
  • funding_job_id string
    ID of the funding job started in the background. Absent when nothing was needed and from an immediate EVM transfer.
  • tx_hash string
    EVM with no funding_delay: hash of the first transfer.
  • tx_hashes array<string>
    EVM with no funding_delay: hashes of every transfer, sent before the call returned.

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 EVM: the token is already deployed. A staged scheduled launch can still fund its holders. Fund launch wallets before the launch; afterwards, move native with Create a funding draft.
400 bad_request EVM: the saved plan has no wallet to fund. Add wallets to the plan with Update the launch plan, then fund again.
400 bad_request A Cex launch was funded with no exchange in plan. Send at least one exchange in plan, chosen from List funding sources.
422 unprocessable Solana: the funder cannot cover the transfers plus its safety reserve. Nothing was sent. The existing typo is the API's. Top up the funder or lower the planned buys, then fund again.
422 unprocessable EVM: the node refused the transfers because the funder cannot pay for them. Top up the funder named in the message, check Retrieve required funding, then fund again.
422 unprocessable Solana Cex launch: a wallet's amount is below the minimum of every exchange in plan. Add an exchange with a lower minimum to plan (see List funding sources) or raise the wallet's planned buy.
422 unprocessable Solana: a plan wallet's account was turned into a durable nonce or carries data, so it cannot send. The message lists each wallet with its role. Replace the listed wallets in the plan with Update the launch plan and stop using their keys.
500 internal_error Solana: a funding job started by an earlier call is still running. Wait for the running job to finish, then read Retrieve required funding before funding again.
500 internal_error Solana: no launch plan has been saved for this launch yet. 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.distribute(launchId, cexs?, cexProvider?) src/lib/proxima/endpoints/launch/launch.ts

POST /launch/sol/stoxes/prepare-config/{launch_id}

Lands the per-token Stoxes config on Solana before an instant Mev launch.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Resumable: a repeat continues from the step where the previous call stopped, and once the config landed it answers already_landed: true without sending anything.

The dev wallet pays the config rent. Calling it again after the config landed is safe and answers already_landed: true with only ok, config and already_landed.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • config string
    Stoxes config account.
  • damm_config string
    Meteora DAMM config account.
  • token_decimals integer
    Token decimals.
  • already_landed boolean
    The config existed before this call.

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 The launch was not created on Stoxes. Call it only for launches created with dex set to stoxes.
400 bad_request The launch was imported: its market already has a config. Skip this step for imported launches.
404 not_found No launch plan has been saved for this launch yet. Save a plan with Update the launch plan first.
422 unprocessable Stoxes is not accepting launches right now. Retry later.
422 unprocessable The config did not finish, or Stoxes failed it. Other messages come from the same step, such as the platform never read the config as finalized or the platform's own failure reason. Call this endpoint again: it resumes from the step that did not finish.

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.prepareStoxesConfig(launchId) src/lib/proxima/endpoints/launch/launch.ts

Prepare a Lesgo config

Bearer JWT deprecated
POST /launch/sol/lesgo/prepare-config/{launch_id}

Lands the per-token Lesgo config on Solana before the launch.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Resumable: a repeat continues from the step where the previous call stopped, and once the config landed it answers already_landed: true without sending anything.

Lesgo launches are being withdrawn: recent API builds no longer serve this route or the other /launch/sol/lesgo/* routes.

Calling it again after the config landed is safe and answers already_landed: true with only ok, config and already_landed.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • config string
    Lesgo config account.
  • damm_config string | null
    Meteora DAMM config account.
  • pool string | null
    Pool account.
  • token_decimals integer | null
    Token decimals.
  • already_landed boolean
    The config existed before this call.

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 The launch was not created on Lesgo. Call it only for launches created with dex set to lesgo.
400 bad_request The launch was imported: its market already has a config. Skip this step for imported launches.
404 not_found No launch plan has been saved for this launch yet. Save a plan with Update the launch plan first.
422 unprocessable The config transaction was sent but did not land. Other messages come from the same step, such as the lesgo config could not be sent: <reason>. Call this endpoint again: it reads a config already on chain instead of creating a second one.

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.prepareLesgoConfig(launchId) src/lib/proxima/endpoints/launch/launch.ts

Launch a token

Bearer JWT
POST /launch/{launch_id}

Deploys the token and runs the launch plan, streaming progress.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying A launch never deploys twice: a repeat is refused while it runs and once the token is deployed. After a dropped stream, read launch_status in List the license's launches and the deploy events in List a launch's activity events before launching again.

Send no body. On success the response is a server-sent event stream: each data: line carries a Launch progress event.

An Allowlist launch answers once with JSON {"ok": true, "launch_method": "Allowlist"} instead of a stream.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · text/event-stream

Streams Launch progress events, one data: line each.

  • step integer
    Current step, starting at 1.
  • total integer
    Number of steps.
  • ok boolean
    false when this step failed.
  • message string
    What the step did.
  • token_address string
    Token address, once deployed.
  • bundle3_failed_mevs array<integer>
    Indexes of front MEV wallets whose bundle failed.
  • bundle4_failed_temps array<integer>
    Indexes of temporary holders whose bundle failed.
  • proxies_rescued integer
    Proxy contracts emptied back to their owners.

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.
403 forbidden The launch has a script plan and your session has no script access. EVM answers admin role required. Launch script plans from an admin session, or save a regular plan with Update the launch plan.
409 conflict A launch of this token is already running. Do not launch again: follow the running launch in List a launch's activity events.
409 conflict Solana: the wallets do not hold the plan's minimum funding. Fund the wallets with Fund the launch wallets and launch once Retrieve required funding reports the funding in place.
400 bad_request EVM: the token is already deployed. Do not launch again; read the launch with Retrieve a launch.
500 internal_error Solana: the token is already deployed. Do not launch again; read the launch with Retrieve a launch.
500 internal_error Solana: no launch plan has been saved for this launch yet. Save a plan with Update the launch plan first.
422 unprocessable Solana: the plan's launch_method is Mev on a platform that does not support it. Set launch_method to Stagger or Manual with Update the launch plan.
422 unprocessable Solana: an instant Mev Stoxes launch whose per-token config is not on chain yet. Call Prepare a Stoxes config, fund the wallets again with Fund the launch wallets, then launch.
422 unprocessable Solana: a Lesgo launch whose per-token config is not on chain yet. Call Prepare a Lesgo config, fund the wallets again with Fund the launch wallets, then launch.
422 unprocessable Solana: a plan wallet's account was turned into a durable nonce or carries data, so it cannot send. The message lists each wallet with its role. Replace the listed wallets in the plan with Update the launch plan and stop using their keys.

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.launch(launchId) src/lib/proxima/endpoints/launch/launch.ts

POST /snipe/{launch_id}

Runs the buys of a scheduled launch whose token is already deployed, streaming progress.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying A snipe runs once: as soon as it starts, the launch leaves Staged and a repeat is refused. After a dropped stream, read launch_status in List the license's launches and the buys in List a launch's activity events.

For launches saved with scheduled_mode. The bundle runs without the deploy and dev buy, which already happened. On Solana the snipe can also fire on its own after auto_snipe_delay_ms.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · text/event-stream

Streams Launch progress events, one data: line each.

  • step integer
    Current step, starting at 1.
  • total integer
    Number of steps.
  • ok boolean
    false when this step failed.
  • message string
    What the step did.
  • token_address string
    Token address, once deployed.
  • bundle3_failed_mevs array<integer>
    Indexes of front MEV wallets whose bundle failed.
  • bundle4_failed_temps array<integer>
    Indexes of temporary holders whose bundle failed.
  • proxies_rescued integer
    Proxy contracts emptied back to their owners.

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 not a scheduled launch waiting to be sniped, for example because it was already sniped. Snipe only a scheduled_mode launch whose launch_status in List the license's launches is Staged.
400 bad_request EVM: the launch is not a scheduled launch waiting to be sniped. Snipe only a scheduled_mode launch whose launch_status in List the license's launches is Staged.
400 bad_request EVM: the plan has no holder wallet to buy with. Add holders to the plan with Update the launch plan.
409 conflict Solana: a launch or snipe of this token is already running. EVM answers snipe already running. Do not snipe again: follow the running one in List a launch's activity events.
409 conflict Solana: the holder wallets do not hold their minimum funding. EVM answers Holder funding not completed, or Launch funding not completed on a pons Mev launch. Fund the wallets with Fund the launch wallets, then snipe.
422 unprocessable Solana: the launch has a script plan, which snipes as part of its own run. Run it with Launch a script plan.
422 unprocessable Solana: allowlist launches are never sniped. Follow the allowlist run with Retrieve allowlist run status instead.

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.snipe(launchId) src/lib/proxima/endpoints/launch/launch.ts

Deploy from the X tracker

Admin JWT internal
POST /tracker/deploy/{chain_id}/{dex}

Creates the token, saves its launch plan and launches it in one request.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying A repeat creates and launches a second token. If the stream dropped, look for the new launch in List the license's launches (the created stage carries its launch_id) before deploying again.

Used by the admin X tracker. The body is the create-launch metadata plus a plan part. The response is an event stream once the upload is accepted: stage events report each phase and are interleaved with Launch progress events.

Stages: created (with launch_id), planned, media, short (some wallets lack funds; the stream ends) and error (with message).

Path parameters

  • chain_id enum Required
    Chain to deploy on. The tracker uses sol.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • dex string Required
    Launch platform ID in lowercase, for example pumpfun, bonkfun, meteoradbc, fourmeme, flap or uniswapv2.
    Examplepumpfun

Form fields multipart/form-data

  • name string Required
    Token name.
  • symbol string Required
    Token ticker.
  • image file Required
    Token image.
  • plan string Required
    Launch plan as JSON, shaped like the body of Update the launch plan.
  • tracker string Optional
    true: the launch comes from the X tracker.
  • description string Optional
    Token description.

Returns 200 OK · text/event-stream

Streams stage events, then Launch progress events.

  • stage enum
    Phase reported by a stage event.
    Possible values createdplannedmediashorterror
  • launch_id integer | null
    Public ID of the launch, on created, short and error (null when creation failed).
  • message string
    Error text, on error.

Errors

Only the common errors: 401 for a missing or expired session, 403 forbidden without the admin role, 403 read_only_token and 429 when rate limited.

Web client proxima.launch.trackerDeploy(chainId, metadata, launchPlan) src/lib/proxima/endpoints/launch/launch.ts

POST /launch/streamflow/resume/{launch_id}

Resumes the Streamflow airdrop of an airdrop MEV launch on Solana.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Idempotent: wallets that already claimed are counted in skipped and receive nothing more.

Safe to call again: wallets already claimed are skipped. The SDK waits up to 120 seconds for the answer.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

  • ok boolean
    false when at least one wallet failed to claim. The status is still 200.
  • distributor string
    Streamflow distributor account.
  • claimed integer
    Wallets claimed in this run.
  • skipped integer
    Wallets skipped, already claimed.
  • failed integer
    Wallets that failed to claim.

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. Call this endpoint only for Solana airdrop launches.
422 unprocessable Direct airdrop: no holder has a target supply. Check the holders' planned amounts with Retrieve a launch; there is nothing to resume.
422 unprocessable Airdrop through temporary holders: no temporary holder has a target supply. Check the temporary holders with Retrieve a launch; there is nothing to resume.

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.resumeStreamflowAirdrop(launchId) src/lib/proxima/endpoints/launch/launch.ts

List MEV contracts

Bearer JWT
GET /launch/get-mev-contract/{launch_id}

Lists the MEV proxy contracts of an EVM launch with their balances.

Token
Upgraded session token, bound to a license.
Read-only tokens
Allowed.
Retry
Safe to retry

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

  • ok boolean
    true when the request succeeded.
  • mev_contracts array<object>
    Proxy contracts of the launch. Empty when it has none.
    Child attributes 5
    • address string
      Proxy contract address.
    • role enum
      Wallet role the proxy serves.
      Possible values front_mevtemp_holder
    • owner string
      Wallet that owns the proxy.
    • token_balance string
      Token balance in base units.
    • native_balance string
      Native balance in wei.

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 on Solana, which has no MEV proxy contracts. Call this endpoint only for EVM launches.
400 bad_request The token is not deployed yet, so it has no proxies. Call it after the launch.

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.getMevContract(launchId) src/lib/proxima/endpoints/launch/launch.ts

POST /launch/rescue-mev-contract/{launch_id}

Moves the tokens and native left in the MEV proxy contracts back to their owners.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A repeat only sends for proxies that still hold tokens or native, so value is never moved twice. Read what is left with List MEV contracts.

Tokens that can be transferred freely are sent back; tokens still on a bonding curve are sold through the proxy, then the native is swept to the owner.

Path parameters

  • launch_id string Required
    Public ID of the launch.
    Example101482937561204

Returns 200 OK · application/json

  • ok boolean
    Always true. A proxy whose send failed is skipped, not reported.
  • rescued integer
    Proxies whose tokens were sent back or sold.
  • rescued_native integer
    Proxies whose native was swept to the dev wallet.
  • strategy enum
    direct_transfer when the token transfers freely, mev_sell_then_sweep when it is still on a bonding curve.
    Possible values direct_transfermev_sell_then_sweep

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 on Solana, which has no MEV proxy contracts. Call this endpoint only for EVM launches.
400 bad_request The token is not deployed yet, so it has no proxies. Call it after the launch.
400 bad_request The launch has no MEV or temporary holder wallets. Nothing to rescue: only launches with front MEV or temporary holder wallets have proxies.

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.rescueMevContract(launchId) src/lib/proxima/endpoints/launch/launch.ts