Skip to content
API Reference

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

Sniper Guard

Watch a launch for buys from outside wallets and react when they cross a threshold.

Sniper Guard counts the quote that wallets outside the launch spend buying the token. When the total crosses max_external_quote, or when an auto-nuke timer runs out, it sells the launch wallets or finalizes the launch early, depending on trigger_mode.

A guard is planned for a launch and runs with it. The web app polls its status every 5 seconds.

The launch's Sniper Guard session and, while the guard runs, its live counters.

Attributes

  • status enum
    Session state.
    Possible values NonePlannedRunningCompletedFailedCancelled
  • is_live boolean
    true while the guard task is running on the server.
  • info object
    Session details. Absent when status is None.
    Child attributes 4
    • params object
      The configuration saved by the plan call; same fields as its request body.
    • started_at integer | null
      Unix timestamp the session started. 0 on Solana and null on EVM until it starts.
    • ended_at integer | null
      Unix timestamp the session ended. 0 on Solana and null on EVM until it ends.
    • status_reason string | null
      Why the session ended or failed, when known.
  • live_stats object
    Live counters, present while the guard runs.
    Child attributes 7
    • external_quote_bought integer | string
      Quote bought by external wallets so far, raw units.
    • max_external_quote integer | string
      Configured threshold, raw units.
    • remaining_quote integer | string
      Quote left before the guard triggers, raw units.
    • auto_nuke_remaining_secs integer | null
      Seconds left before an auto-nuke timer fires.
    • external_sol_bought integer | string
      Legacy name of external_quote_bought.
    • max_external_sol integer | string
      Legacy name of max_external_quote.
    • remaining_sol integer | string
      Legacy name of remaining_quote.

Plan a Sniper Guard

Bearer JWT
POST /launch/sniper-guard/plan/{launch_id}

Saves a Sniper Guard configuration for the launch as Planned.

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 saved configuration of the Planned guard. While the guard runs, a repeat answers 409.

Calling it again before the guard runs replaces the saved configuration. The backend rejects an enabled guard with neither a positive max_external_quote nor an auto_nuke_delay_secs, an auto_nuke_delay_secs of 0, and complete_early combined with an auto-nuke timer.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Body parameters application/json

  • enabled boolean Required
    Whether the guard is active. A disabled guard skips every other check.
  • max_external_quote integer | string Optional
    Quote amount external wallets may buy before the guard triggers, raw quote units (lamports on SOL-quoted launches). Must be greater than 0 when enabled, unless auto_nuke_delay_secs is set.
  • max_external_sol integer | string Optional
    Legacy name of max_external_quote, still accepted.
  • trigger_mode enum Optional Default nuke
    What the guard does when it triggers. nuke sells every launch wallet including the dev and finalizes the launch; nuke_keep_dev sells all but the dev; nuke_dev_only sells the dev only and finalizes; nuke_dev_only_continue sells the dev only and keeps the launch running; complete_early stops holder buys and finalizes without selling.
    Possible values nukenuke_keep_devnuke_dev_onlynuke_dev_only_continuecomplete_early
  • whitelist array<string> Optional
    Additional wallets whose buys are not counted as external. The launch's own wallets are always excluded.
  • end_condition object | string Optional Default until_complete
    When monitoring stops: "until_complete" (until the launch finishes) or { "timed": { "duration_secs": N } }.
  • auto_nuke_delay_secs integer | null Optional
    Triggers after this many seconds instead of watching external buys. Must be greater than 0, and cannot be combined with complete_early.

Returns 200 OK · application/json

Returns ok and a confirmation message.

  • ok boolean
    Always true on success.
  • message string
    Human-readable confirmation.

Errors

StatusCodeWhen 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 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.
400 bad_request EVM launches and launch groups: enabled is true with no auto_nuke_delay_secs and a max_external_quote of 0 or missing. Send a positive max_external_quote, or set auto_nuke_delay_secs instead.
400 bad_request EVM launches and launch groups: auto_nuke_delay_secs is 0. Send a positive auto_nuke_delay_secs, or null to watch external buys instead.
400 bad_request EVM launches and launch groups: trigger_mode is complete_early together with an auto_nuke_delay_secs. Pick another trigger_mode, or drop auto_nuke_delay_secs.
500 internal_error Solana: the same three validation rules fail. Solana answers them with 500 and the same messages: max_external_quote must be greater than 0 when enabled, auto_nuke_delay_secs must be greater than 0, complete_early trigger mode is not allowed with auto-nuke timer. Fix the parameter named in message; do not retry the same body.
409 conflict The launch's guard is already running (EVM: also when its saved session is Running). Leave the running guard as it is, or stop it with Cancel a Sniper Guard before planning a new one.
400 bad_request launch_id is a multi-launch group container whose plan is no longer a draft. Plan the guard before the group launches; once it resolves, plan it on the winning member's launch ID.

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.sniperGuard.planSniperGuard(launchId, params) src/lib/proxima/endpoints/launch/sniper-guard.ts

GET /launch/sniper-guard/status/{launch_id}

Returns the launch's Sniper Guard session and its live counters.

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

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

Returns a Sniper Guard status object.

  • status enum
    Session state.
    Possible values NonePlannedRunningCompletedFailedCancelled
  • is_live boolean
    true while the guard task is running on the server.
  • info object
    Session details. Absent when status is None.
    Child attributes 4
    • params object
      The configuration saved by the plan call; same fields as its request body.
    • started_at integer | null
      Unix timestamp the session started. 0 on Solana and null on EVM until it starts.
    • ended_at integer | null
      Unix timestamp the session ended. 0 on Solana and null on EVM until it ends.
    • status_reason string | null
      Why the session ended or failed, when known.
  • live_stats object
    Live counters, present while the guard runs.
    Child attributes 7
    • external_quote_bought integer | string
      Quote bought by external wallets so far, raw units.
    • max_external_quote integer | string
      Configured threshold, raw units.
    • remaining_quote integer | string
      Quote left before the guard triggers, raw units.
    • auto_nuke_remaining_secs integer | null
      Seconds left before an auto-nuke timer fires.
    • external_sol_bought integer | string
      Legacy name of external_quote_bought.
    • max_external_sol integer | string
      Legacy name of max_external_quote.
    • remaining_sol integer | string
      Legacy name of remaining_quote.

Errors

StatusCodeWhen 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.sniperGuard.getSniperGuardStatus(launchId) src/lib/proxima/endpoints/launch/sniper-guard.ts

POST /launch/sniper-guard/cancel/{launch_id}

Stops the launch's planned or running Sniper Guard.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Cancelling again leaves the guard Cancelled and stops nothing more.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

Returns ok and a confirmation message.

  • ok boolean
    Always true on success.
  • message string
    Human-readable confirmation.

Errors

StatusCodeWhen 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), 403 read_only_token and 429 when rate limited.

Web client proxima.launch.sniperGuard.cancelSniperGuard(launchId) src/lib/proxima/endpoints/launch/sniper-guard.ts

POST /launch/sniper-guard/discard/{launch_id}

Clears a finished Sniper Guard 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 Discarding again finds nothing to clear and answers 200.

Path parameters

  • launch_id string Required
    Launch ID: the 15-digit chain-encoded ID. Its first three digits name the chain (101 Solana, 201 BSC, 202 Base, 204 Ethereum).
    Example101000000004217

Returns 200 OK · application/json

Returns ok and a confirmation message.

  • ok boolean
    Always true on success.
  • message string
    Human-readable confirmation.

Errors

StatusCodeWhen 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 guard task is still running. Stop the guard with Cancel a Sniper Guard first, then discard.
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.sniperGuard.discardSniperGuard(launchId) src/lib/proxima/endpoints/launch/sniper-guard.ts