Auto Buy buys the launch's token from its wallets following one or more strategies: replication of external sells, timed buys and a market-cap ladder. A session is either planned (saved as Planned and started with the launch) or run on a token that is already live, and it ends on its time or spend budget. Sessions last at most 30 days.
Amounts are raw units sent as integers or integer strings; market caps are micro-USD and ratios basis points. The web app polls the status endpoint every 5 seconds.
On an EVM multi-launch container, the session endpoints answer 400 (multi-launch container: sessions run on the winner launch once it resolves); call them on the winning launch instead.
- POST
/launch/autobuy/plan/{launch_id} - POST
/launch/autobuy/run/{launch_id} - POST
/launch/autobuy/update/{launch_id} - GET
/launch/autobuy/status/{launch_id} - POST
/launch/autobuy/cancel/{launch_id} - POST
/launch/autobuy/pause/{launch_id} - POST
/launch/autobuy/resume/{launch_id} - POST
/launch/autobuy/discard/{launch_id}
The Auto buy status object
The launch's Auto Buy session as the API sends it. Solana launches report totals under auto_buy_* and progress under modes; EVM launches report totals under plain names and progress under engine.
Attributes
-
statusenumSession state.Possible valuesNonePlannedRunningPausedCompletedCancelledFailed -
infoobjectSession details. Absent whenstatusisNone.Child attributes 33
-
paramsobjectThe session parameters as stored: the body of the last plan, run or update call. -
started_atinteger | nullUnix timestamp (seconds) the session started. -
ended_atinteger | nullUnix timestamp (seconds) the session ended. -
status_reasonstring | nullWhy the session ended or failed, when known. -
auto_buy_native_spentintegerSolana: amount spent by the session, raw units. -
auto_buy_usd_spentintegerSolana: USD spent, micro-USD. -
auto_buy_token_boughtintegerSolana: tokens bought, raw units. -
modesarray<object>Solana: progress per mode.Child attributes 7
-
idenumMode.Possible valuesreplicationtimedmcap_ladder -
accumulatedintegerReplication only: amount accumulated toward the next trade, summed over layers. -
layersarray<object>Progress per layer.Child attributes 4
-
idstringLayer ID:ab_4217_l0for timed and replication layers,ab_4217_0for market-cap ladder steps. Pass it aslayer_idto cancel, pause or resume one layer. -
stateenumLayer state. The client also accepts lowercase values.Possible valuesActivePausedExhausted -
token_soldintegerTokens this layer has bought, raw units. The field keeps this name on both sides. -
sol_spentintegerNative or quote amount this layer has traded, raw units.
-
-
-
token_boughtstringEVM: tokens bought, raw units, as a decimal string. -
native_spentstringEVM: native spent, wei, as a decimal string. -
usd_spentintegerEVM: USD spent, micro-USD. -
engineobject | nullEVM: live engine snapshot.Child attributes 14
-
cached_mcap_usdnumberMarket cap the engine last read, USD. -
swapback_layersarray<object>Replication layers.Child attributes 5
-
idstringLayer ID. -
statestringLayer state. -
accumulatedinteger | stringAmount accumulated toward the next trade. -
native_spentinteger | stringNative spent by the layer, wei. -
token_boughtinteger | stringTokens bought by the layer, raw units.
-
-
timed_layersarray<object>Timed layers.Child attributes 5
-
idstringLayer ID. -
statestringLayer state. -
accumulatedinteger | stringAmount accumulated toward the next trade. -
native_spentinteger | stringNative spent by the layer, wei. -
token_boughtinteger | stringTokens bought by the layer, raw units.
-
-
mcap_levelsarray<object>Ladder steps: the layer fields plustarget_mcap_usdandbuy_amount.
-
-
The Auto buy mode object
One Auto Buy strategy. Exactly one key is set: SwapBack (replication), TimedExactIn (timed) or McapLadder (market-cap ladder). The replication and timed modes take either single-layer fields or layers; a session takes at most 5 replication and 5 timed layers.
Attributes
-
SwapBackobjectReplication. Watches external sells of the token and accumulatesreplication_factorof each qualifying swap; a buy fires once the accumulated amount reachesmin_sol_per_swap.Child attributes 15
-
replication_factorintegerSingle-layer form: share to replicate, in basis points (10–100000). -
trigger_conditionobjectSingle-layer form: which external swaps count. Same shape as inlayers. -
min_sol_per_swapinteger | stringSingle-layer form: minimum size of one buy, raw quote units (lamports on SOL-quoted launches). -
whitelistarray<string>Payer addresses whose swaps are ignored. The launch's own wallets are always ignored. -
layersarray<object>Layered form: up to 5 replication layers.Child attributes 10
-
replication_factorintegerShare of each qualifying external swap to replicate, in basis points (10000= 100%). Accepted range 10–100000. -
trigger_conditionobjectWhich external swaps count.Child attributes 2
-
typeenumRate: each qualifying swap triggers with probabilityvalue/ 10000 (10–10000).MinSol: only swaps of at leastvaluenative, raw units.MinToken: only swaps of at leastvaluetokens, raw units.Possible valuesRateMinSolMinToken -
valueintegerThreshold fortype.
-
-
min_sol_per_swapinteger | stringMinimum size of one buy, raw quote units (lamports on SOL-quoted launches). -
min_mcapintegerLower market-cap bound of this layer, micro-USD. Layer ranges must not overlap. -
max_mcapintegerUpper market-cap bound of this layer, micro-USD. -
end_conditionobjectPer-layer budget and lifetime; falls back to the session's.Child attributes 2
-
amountinteger | stringBudget of this layer, raw quote units. -
timeintegerLifetime of this layer, in seconds.
-
-
-
-
TimedExactInobjectTimed. Buys a random amount betweenmin_amountandmax_amounteverydelaymilliseconds.Child attributes 12
-
min_amountinteger | stringSingle-layer form: smallest buy, raw quote units. -
max_amountinteger | stringSingle-layer form: largest buy, raw quote units. -
delayintegerSingle-layer form: interval in milliseconds (1500–86400000). -
layersarray<object>Layered form: up to 5 timed layers.Child attributes 8
-
min_amountinteger | stringSmallest buy, raw quote units. -
max_amountinteger | stringLargest buy, raw quote units. -
delayintegerInterval in milliseconds (1500–86400000). -
min_mcapintegerLower market-cap bound of this layer, micro-USD. Layer ranges must not overlap. -
max_mcapintegerUpper market-cap bound of this layer, micro-USD. -
end_conditionobjectPer-layer budget and lifetime; falls back to the session's.Child attributes 2
-
amountinteger | stringBudget of this layer, raw quote units. -
timeintegerLifetime of this layer, in seconds.
-
-
-
-
McapLadderarray<object>Market-cap ladder. Each step buys once when the market cap reachestarget_mcap. Targets must be strictly decreasing and amounts greater than 0.Child attributes 2
-
target_mcapintegerMarket cap that fires the step, micro-USD. -
buy_amountinteger | stringQuote to spend at this step, raw units.
-
Plan an Auto Buy session
/launch/autobuy/plan/{launch_id} Saves an Auto Buy session as Planned so that it starts with the launch.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Planning again overwrites the parameters of the
Plannedsession. Once the session runs, a repeat answers409.
Replaces a previously planned session. Refused while a session is running or paused. Buy ladder targets must be strictly decreasing, and layer market-cap ranges must not overlap.
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Body parameters application/json
-
modeobject Optional -
modesarray<object> OptionalSeveral strategies run together, each shaped like the Auto buy mode object. The web app sends this form. -
end_conditionobject RequiredSession-wide limits.Child attributes 2
-
timeinteger RequiredSession duration in seconds;0uses the maximum of 30 days. -
amountinteger | string RequiredQuote the session may spend, raw units.0means no limit.
-
-
slippageinteger OptionalSlippage tolerance in basis points, at most 10000. Defaults to 500 on Solana. -
min_mcapinteger | null OptionalIgnored: neither chain applies a session-wide lower bound, although the web app sends it when set. Setmin_mcapon each layer instead. -
max_mcapinteger | null OptionalIgnored, likemin_mcap. Setmax_mcapon each layer instead. -
start_delayinteger OptionalSeconds to wait before the first trade, at most 30 days. -
wallet_pubkeysarray<string> | null OptionalLaunch wallets that trade. Omit or sendnullfor all of them; an empty array is rejected.
Returns 200 OK · application/json
Returns ok and a confirmation message.
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Solana: wallet_pubkeys is an empty array. Omit wallet_pubkeys to trade from every launch wallet. |
| 400 | bad_request | Solana: an entry of wallet_pubkeys is not a valid address. Send the base58 addresses of the launch's wallets. |
| 404 | not_found | Solana: an entry of wallet_pubkeys is not a wallet of this launch. Send only addresses of the launch's own wallets, as listed by Retrieve a launch. |
| 409 | conflict | A session for this launch is Running or Paused. Change the live session with Update an Auto Buy session, or cancel it with Cancel an Auto Buy session before planning again. |
| 422 | unprocessable | No wallet is left to trade: the launch has no wallets, or (EVM) wallet_pubkeys is empty or names none of them. Omit wallet_pubkeys to use every launch wallet, or add wallets with Add wallets to a launch. |
| 500 | internal_error | The parameters fail validation; message names the rule, e.g. Invalid delay, Too many timed layers, Swapback layer mcap ranges must not overlap, Invalid levels array (must be decreasing mcap) or Slippage must be <= 10000 bps. On a multi-launch container the same messages come back as 400 bad_request. Fix the parameter named in message within the limits listed on Auto buy mode. |
| 400 | bad_request | launch_id is a multi-launch group container whose plan is no longer a draft. Plan the session on the winning member launch instead. |
| 500 | internal_error | Solana: the launch has no funder, holder or MEV wallets saved yet. Finish the plan with Update the launch plan and Set the launch funder, then retry. |
| 400 | bad_request | EVM: the launch plan is incomplete; message names the missing part, e.g. No launch method saved, No mev wallets saved, No holder wallets saved or No holder amounts saved. Finish the plan with Update the launch plan and Set the launch funder, then retry. |
| 400 | bad_request | The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again. |
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.autobuy.planAutoBuy(launchId, modeInput, endCondition, options) src/lib/proxima/endpoints/launch/autobuy.ts
Start an Auto Buy session
/launch/autobuy/run/{launch_id} Starts an Auto Buy session right away on a launched token.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying Read Retrieve Auto Buy status first:
RunningorPausedmeans the first call went through, and a repeat answers409while the session lasts.
Refused while a session is running or paused. If a session is Planned for the launch, it starts with the planned parameters and the body is ignored.
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Body parameters application/json
-
modeobject Optional -
modesarray<object> OptionalSeveral strategies run together, each shaped like the Auto buy mode object. The web app sends this form. -
end_conditionobject RequiredSession-wide limits.Child attributes 2
-
timeinteger RequiredSession duration in seconds;0uses the maximum of 30 days. -
amountinteger | string RequiredQuote the session may spend, raw units.0means no limit.
-
-
slippageinteger OptionalSlippage tolerance in basis points, at most 10000. Defaults to 500 on Solana. -
min_mcapinteger | null OptionalIgnored: neither chain applies a session-wide lower bound, although the web app sends it when set. Setmin_mcapon each layer instead. -
max_mcapinteger | null OptionalIgnored, likemin_mcap. Setmax_mcapon each layer instead. -
start_delayinteger OptionalSeconds to wait before the first trade, at most 30 days. -
wallet_pubkeysarray<string> | null OptionalLaunch wallets that trade. Omit or sendnullfor all of them; an empty array is rejected.
Returns 200 OK · application/json
Returns ok and a confirmation message.
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Solana: wallet_pubkeys is an empty array. Omit wallet_pubkeys to trade from every launch wallet. |
| 400 | bad_request | Solana: an entry of wallet_pubkeys is not a valid address. Send the base58 addresses of the launch's wallets. |
| 404 | not_found | Solana: an entry of wallet_pubkeys is not a wallet of this launch. Send only addresses of the launch's own wallets, as listed by Retrieve a launch. |
| 400 | bad_request | launch_id is a multi-launch group container; sessions run on the winning member launch. Call it with the winning member's launch ID once the group resolves. |
| 500 | internal_error | Solana: the launch is still a draft. Launch the token with Launch a token first, or save the session with Plan an Auto Buy session so it starts with the launch. |
| 400 | bad_request | EVM: the launch is still a draft. Imported tokens are accepted. Launch the token with Launch a token first, or save the session with Plan an Auto Buy session so it starts with the launch. |
| 409 | conflict | A session for this launch is already Running or Paused. Change the running session with Update an Auto Buy session instead of starting another. |
| 400 | bad_request | EVM: no wallet can trade, because wallet_pubkeys is an empty array or the launch holds no wallets. Omit wallet_pubkeys to trade from every launch wallet. |
| 500 | internal_error | EVM: none of wallet_pubkeys is a wallet of this launch. Send only addresses of the launch's own wallets, as listed by Retrieve a launch. |
| 500 | internal_error | The parameters fail validation; message names the rule, e.g. Invalid delay, Too many timed layers, Swapback layer mcap ranges must not overlap, Invalid levels array (must be decreasing mcap) or Slippage must be <= 10000 bps. When a session is Planned, its saved parameters are checked instead of the body. Fix the parameter named in message within the limits listed on Auto buy mode. |
| 500 | internal_error | Solana: the launch has no funder, holder or MEV wallets saved yet. Finish the plan with Update the launch plan and Set the launch funder, then retry. |
| 400 | bad_request | EVM: the launch plan is incomplete; message names the missing part, e.g. No launch method saved, No mev wallets saved, No holder wallets saved or No holder amounts saved. Finish the plan with Update the launch plan and Set the launch funder, then retry. |
| 500 | internal_error | Solana: the price of the launch's quote token is not known yet, so the engine cannot start. Send the request again in a few seconds. |
| 422 | venue_ungated | EVM: replication layers or market-cap bounds need a known pool for the token and none is recorded; message names what is missing. Use timed layers without market-cap bounds, or retry once the pool is recorded. |
| 409 | conflict | The launch trades on the pace engine, which already runs an Auto Buy session for it. Change that session with Update an Auto Buy session or cancel it with Cancel an Auto Buy session. |
| 422 | unprocessable | The launch's platform trades on the pace engine and a rule has no pace equivalent; message names it, e.g. a Rate trigger, a MinSol trigger on a non-native quote, or a replication layer with no amount to stop at. Change the rule named in message and send the request again. |
| 503 | pace_unavailable | The launch's platform trades on the pace engine and pace could not be reached. Send the request again after a short wait. |
| 400 | bad_request | The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again. |
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.autobuy.runAutoBuy(launchId, modeInput, endCondition, options) src/lib/proxima/endpoints/launch/autobuy.ts
Update an Auto Buy session
/launch/autobuy/update/{launch_id} Replaces the parameters of a planned, running or paused Auto Buy session.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Layers are matched by ID and keep their progress, so sending the same parameters again changes nothing.
On a live session, layers whose IDs survive the update keep their progress.
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Body parameters application/json
-
modeobject Optional -
modesarray<object> OptionalSeveral strategies run together, each shaped like the Auto buy mode object. The web app sends this form. -
end_conditionobject RequiredSession-wide limits.Child attributes 2
-
timeinteger RequiredSession duration in seconds;0uses the maximum of 30 days. -
amountinteger | string RequiredQuote the session may spend, raw units.0means no limit.
-
-
slippageinteger OptionalSlippage tolerance in basis points, at most 10000. Defaults to 500 on Solana. -
min_mcapinteger | null OptionalIgnored: neither chain applies a session-wide lower bound, although the web app sends it when set. Setmin_mcapon each layer instead. -
max_mcapinteger | null OptionalIgnored, likemin_mcap. Setmax_mcapon each layer instead. -
start_delayinteger OptionalSeconds to wait before the first trade, at most 30 days. -
wallet_pubkeysarray<string> | null OptionalLaunch wallets that trade. Omit or sendnullfor all of them; an empty array is rejected.
Returns 200 OK · application/json
Returns ok and a confirmation message.
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Solana: an entry of wallet_pubkeys is not a valid address. Send the base58 addresses of the launch's wallets. |
| 404 | not_found | Solana: the session is Running or Paused but its engine is gone, for example after a restart. Cancel the session with Cancel an Auto Buy session and start a new one with Start an Auto Buy session. |
| 409 | conflict | The session is not Planned, Running or Paused. Start a session with Start an Auto Buy session or plan one with Plan an Auto Buy session. |
| 400 | bad_request | launch_id is a multi-launch group container; sessions run on the winning member launch. Call it with the winning member's launch ID once the group resolves. |
| 404 | not_found | EVM: the launch has no session to update. Start a session with Start an Auto Buy session or plan one with Plan an Auto Buy session. |
| 500 | internal_error | Solana: the launch has no session to update. Start a session with Start an Auto Buy session or plan one with Plan an Auto Buy session. |
| 400 | bad_request | The parameters fail validation; message names the rule, e.g. Invalid delay, Too many timed layers, Swapback layer mcap ranges must not overlap, Invalid levels array (must be decreasing mcap) or Slippage must be <= 10000 bps. Fix the parameter named in message within the limits listed on Auto buy mode. |
| 400 | bad_request | Solana: an entry of wallet_pubkeys is not a wallet that can trade this launch. Send only addresses of the launch's own wallets, as listed by Retrieve a launch. |
| 400 | bad_request | EVM: none of wallet_pubkeys is a wallet of this launch. Send only addresses of the launch's own wallets, as listed by Retrieve a launch. |
| 400 | bad_request | EVM: wallet_pubkeys is an empty array. Omit wallet_pubkeys to keep the current wallets. |
| 404 | not_found | EVM: the session is Running or Paused but its engine is gone, for example after a restart. Cancel the session with Cancel an Auto Buy session and start a new one with Start an Auto Buy session. |
| 422 | unprocessable | The launch's platform trades on the pace engine and a rule has no pace equivalent; message names it, e.g. a Rate trigger, a MinSol trigger on a non-native quote, or a replication layer with no amount to stop at. Change the rule named in message and send the request again. |
| 404 | not_found | The launch trades on the pace engine and pace no longer runs a session for it. Start a new session with Start an Auto Buy session. |
| 404 | not_found | The launch trades on the pace engine and pace no longer holds the session. Start a new session with Start an Auto Buy session. |
| 409 | conflict | The launch trades on the pace engine and pace already moved the session to another state. Read Retrieve Auto Buy status for the current state before acting again. |
| 503 | pace_unavailable | The launch's platform trades on the pace engine and pace could not be reached. Send the request again after a short wait. |
| 400 | bad_request | The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again. |
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.autobuy.modifyAutoBuy(launchId, modeInput, endCondition, options) src/lib/proxima/endpoints/launch/autobuy.ts
Retrieve Auto Buy status
/launch/autobuy/status/{launch_id} Returns the launch's Auto Buy session, its totals and per-layer progress.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Allowed.
- Retry
- Safe to retry
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Returns 200 OK · application/json
Returns an Auto buy status object.
-
statusenumSession state.Possible valuesNonePlannedRunningPausedCompletedCancelledFailed -
infoobjectSession details. Absent whenstatusisNone.Child attributes 33
-
paramsobjectThe session parameters as stored: the body of the last plan, run or update call. -
started_atinteger | nullUnix timestamp (seconds) the session started. -
ended_atinteger | nullUnix timestamp (seconds) the session ended. -
status_reasonstring | nullWhy the session ended or failed, when known. -
auto_buy_native_spentintegerSolana: amount spent by the session, raw units. -
auto_buy_usd_spentintegerSolana: USD spent, micro-USD. -
auto_buy_token_boughtintegerSolana: tokens bought, raw units. -
modesarray<object>Solana: progress per mode.Child attributes 7
-
idenumMode.Possible valuesreplicationtimedmcap_ladder -
accumulatedintegerReplication only: amount accumulated toward the next trade, summed over layers. -
layersarray<object>Progress per layer.Child attributes 4
-
idstringLayer ID:ab_4217_l0for timed and replication layers,ab_4217_0for market-cap ladder steps. Pass it aslayer_idto cancel, pause or resume one layer. -
stateenumLayer state. The client also accepts lowercase values.Possible valuesActivePausedExhausted -
token_soldintegerTokens this layer has bought, raw units. The field keeps this name on both sides. -
sol_spentintegerNative or quote amount this layer has traded, raw units.
-
-
-
token_boughtstringEVM: tokens bought, raw units, as a decimal string. -
native_spentstringEVM: native spent, wei, as a decimal string. -
usd_spentintegerEVM: USD spent, micro-USD. -
engineobject | nullEVM: live engine snapshot.Child attributes 14
-
cached_mcap_usdnumberMarket cap the engine last read, USD. -
swapback_layersarray<object>Replication layers.Child attributes 5
-
idstringLayer ID. -
statestringLayer state. -
accumulatedinteger | stringAmount accumulated toward the next trade. -
native_spentinteger | stringNative spent by the layer, wei. -
token_boughtinteger | stringTokens bought by the layer, raw units.
-
-
timed_layersarray<object>Timed layers.Child attributes 5
-
idstringLayer ID. -
statestringLayer state. -
accumulatedinteger | stringAmount accumulated toward the next trade. -
native_spentinteger | stringNative spent by the layer, wei. -
token_boughtinteger | stringTokens bought by the layer, raw units.
-
-
mcap_levelsarray<object>Ladder steps: the layer fields plustarget_mcap_usdandbuy_amount.
-
-
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | launch_id is a multi-launch group container; sessions run on the winning member launch. Call it with the winning member's launch ID once the group resolves. |
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.autobuy.getAutoBuyStatus(launchId) src/lib/proxima/endpoints/launch/autobuy.ts
Cancel an Auto Buy session
/launch/autobuy/cancel/{launch_id} Cancels the whole Auto Buy session, one mode, or one layer.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry A cancel with no body answers
200in any state, so repeating it changes nothing.
Send layer_id or mode to cancel part of the session; send no body to cancel all of it.
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Body parameters application/json
-
layer_idstring OptionalTarget one layer, e.g.ab_4217_l0(frommodes[].layers[].idin the status). -
modeenum OptionalTarget every layer of one mode.Possible valuesreplicationtimedmcap_ladder
Returns 200 OK · application/json
Returns ok and a message (Layer cancelled when one layer was targeted).
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Solana: layer_id lacks the prefix of this launch's Auto Buy layer IDs. EVM accepts any value and changes nothing. Pass a layer id from modes[].layers[] in Retrieve Auto Buy status. |
| 400 | bad_request | Solana: mode is not replication, timed or mcap_ladder, checked only while the engine runs. EVM accepts any value and changes nothing. Send replication, timed or mcap_ladder. |
| 409 | conflict | layer_id or mode was sent and the session is not Running. A cancel with no body works in any state. Send no body to cancel the whole session. |
| 400 | bad_request | launch_id is a multi-launch group container; sessions run on the winning member launch. Call it with the winning member's launch ID once the group resolves. |
| 404 | not_found | EVM: layer_id or mode was sent and the launch has no Auto Buy session. Send no body to clear the session state. |
| 500 | internal_error | Solana: layer_id or mode was sent and the launch has no Auto Buy session. Send no body to clear the session state. |
| 422 | unprocessable | The launch trades on the pace engine, which cancels whole sessions only, and layer_id or mode was sent. Send no layer_id or mode to cancel the whole session. |
| 503 | pace_unavailable | The launch's platform trades on the pace engine and pace could not be reached. Send the request again after a short wait. |
| 400 | bad_request | The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again. |
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.autobuy.cancelAutoBuy(launchId, options) src/lib/proxima/endpoints/launch/autobuy.ts
Pause an Auto Buy session
/launch/autobuy/pause/{launch_id} Pauses the whole Auto Buy session, one mode, or one layer.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Once the session is
Paused, a repeat answers409and changes nothing.
Send layer_id or mode to pause part of the session; the client sends {} to pause all of it.
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Body parameters application/json
-
layer_idstring OptionalTarget one layer, e.g.ab_4217_l0(frommodes[].layers[].idin the status). -
modeenum OptionalTarget every layer of one mode.Possible valuesreplicationtimedmcap_ladder
Returns 200 OK · application/json
Returns ok and a message (Layer paused when one layer was targeted).
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Solana: layer_id lacks the prefix of this launch's Auto Buy layer IDs. EVM accepts any value and changes nothing. Pass a layer id from modes[].layers[] in Retrieve Auto Buy status. |
| 400 | bad_request | Solana: mode is not replication, timed or mcap_ladder. EVM accepts any value and changes nothing. Send replication, timed or mcap_ladder. |
| 404 | not_found | Solana: the session is Running or Paused but its engine is gone, for example after a restart. Cancel the session with Cancel an Auto Buy session and start a new one with Start an Auto Buy session. |
| 409 | conflict | The session is not Running, for example because it is already Paused. Read Retrieve Auto Buy status, and resume a paused session with Resume an Auto Buy session. |
| 400 | bad_request | launch_id is a multi-launch group container; sessions run on the winning member launch. Call it with the winning member's launch ID once the group resolves. |
| 404 | not_found | EVM: the launch has no session to pause. Start a session with Start an Auto Buy session or plan one with Plan an Auto Buy session. |
| 500 | internal_error | Solana: the launch has no session to pause. Start a session with Start an Auto Buy session or plan one with Plan an Auto Buy session. |
| 404 | not_found | EVM: the session is Running or Paused but its engine is gone, for example after a restart. Cancel the session with Cancel an Auto Buy session and start a new one with Start an Auto Buy session. |
| 422 | unprocessable | The launch trades on the pace engine, which pauses whole sessions only, and layer_id or mode was sent. Send no layer_id or mode to pause the whole session. |
| 404 | not_found | The launch trades on the pace engine and pace no longer holds the session. Start a new session with Start an Auto Buy session. |
| 409 | conflict | The launch trades on the pace engine and pace already moved the session to another state. Read Retrieve Auto Buy status for the current state before acting again. |
| 503 | pace_unavailable | The launch's platform trades on the pace engine and pace could not be reached. Send the request again after a short wait. |
| 400 | bad_request | The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again. |
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.autobuy.pauseAutoBuy(launchId, options) src/lib/proxima/endpoints/launch/autobuy.ts
Resume an Auto Buy session
/launch/autobuy/resume/{launch_id} Resumes a paused Auto Buy session, mode, or layer.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Resuming a session that already runs answers
200and changes nothing.
Send layer_id or mode to resume part of the session; the client sends {} to resume all of it.
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Body parameters application/json
-
layer_idstring OptionalTarget one layer, e.g.ab_4217_l0(frommodes[].layers[].idin the status). -
modeenum OptionalTarget every layer of one mode.Possible valuesreplicationtimedmcap_ladder
Returns 200 OK · application/json
Returns ok and a message (Layer resumed when one layer was targeted).
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 400 | bad_request | Solana: layer_id lacks the prefix of this launch's Auto Buy layer IDs. EVM accepts any value and changes nothing. Pass a layer id from modes[].layers[] in Retrieve Auto Buy status. |
| 400 | bad_request | Solana: mode is not replication, timed or mcap_ladder. EVM accepts any value and changes nothing. Send replication, timed or mcap_ladder. |
| 404 | not_found | Solana: the session is Running or Paused but its engine is gone, for example after a restart. Cancel the session with Cancel an Auto Buy session and start a new one with Start an Auto Buy session. |
| 409 | conflict | Solana: the session is neither Paused nor Running. Start a new session with Start an Auto Buy session. |
| 400 | bad_request | launch_id is a multi-launch group container; sessions run on the winning member launch. Call it with the winning member's launch ID once the group resolves. |
| 409 | conflict | EVM: the session is neither Paused nor Running. Start a new session with Start an Auto Buy session. |
| 404 | not_found | EVM: the launch has no session to resume. Start a session with Start an Auto Buy session or plan one with Plan an Auto Buy session. |
| 500 | internal_error | Solana: the launch has no session to resume. Start a session with Start an Auto Buy session or plan one with Plan an Auto Buy session. |
| 404 | not_found | EVM: the session is Running or Paused but its engine is gone, for example after a restart. Cancel the session with Cancel an Auto Buy session and start a new one with Start an Auto Buy session. |
| 422 | unprocessable | The launch trades on the pace engine, which resumes whole sessions only, and layer_id or mode was sent. Send no layer_id or mode to resume the whole session. |
| 404 | not_found | The launch trades on the pace engine and pace no longer holds the session. Start a new session with Start an Auto Buy session. |
| 409 | conflict | The launch trades on the pace engine and pace already moved the session to another state. Read Retrieve Auto Buy status for the current state before acting again. |
| 503 | pace_unavailable | The launch's platform trades on the pace engine and pace could not be reached. Send the request again after a short wait. |
| 400 | bad_request | The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again. |
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.autobuy.resumeAutoBuy(launchId, options) src/lib/proxima/endpoints/launch/autobuy.ts
Discard an Auto Buy session
/launch/autobuy/discard/{launch_id} Clears a planned or finished Auto Buy session from the launch.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Once the session state is cleared, a repeat answers
200and changes nothing.
Path parameters
-
launch_idstring RequiredLaunch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101Solana,201BSC,202Base,204Ethereum).Example101000000004217
Returns 200 OK · application/json
Returns ok and a confirmation message.
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | launch_id is not a chain-encoded launch ID. Pass the 15-digit chain-encoded launch ID exactly as the API returned it. |
| 404 | not_found | No launch with this ID belongs to the license in your token. Check the launch ID and that your token is upgraded onto the license that owns the launch. |
| 409 | conflict | Solana: the session is Running or Paused. EVM answers 200 and keeps the live session. Stop the session with Cancel an Auto Buy session first. |
| 400 | bad_request | launch_id is a multi-launch group container; sessions run on the winning member launch. Call it with the winning member's launch ID once the group resolves. |
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.autobuy.discardAutoBuy(launchId) src/lib/proxima/endpoints/launch/autobuy.ts