Skip to content
API Reference

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

Platform

Check API health and load the platform constants the web app configures itself from.

The platform endpoints describe the API rather than an account. GET /health is a public liveness probe. GET /get-constants returns the configuration the web app builds its forms and limits from: supported chains and their launch platforms, funding and launch bounds, and feature switches.

Constants depend on the caller: some launch platforms and platform fields are only returned to beta licenses. Request them with the license's own token rather than sharing one copy across licenses.

Platform configuration returned by GET /get-constants.

Attributes

  • launch_scripts_only boolean
    When true, launch scripts are the single source of launches and a plan's owner steers it live.
  • fee_activation object
    Fee programme switches.
    Child attributes 2
    • active boolean
      Cashback is on. The web app shows the Rewards section only when this is true.
    • referral boolean
      Referral fee switch.
  • usepaid object
    usepaid integration switches.
    Child attributes 2
    • pumpfun_enabled boolean
      Enabled for Pump.fun launches.
    • pons_enabled boolean
      Enabled for Pons launches.
  • zaio object
    Zaio integration settings.
    Child attributes 4
    • live boolean
      Whether the integration is live.
    • platforms array<string>
      Launch platforms it applies to.
    • fee_wallet string
      Fee wallet address.
    • zaio_share_bps integer
      Zaio share of fees, in basis points.
  • funding object
    Funding bounds.
    Child attributes 3
    • buyback_min_fund_multiplier number
      Minimum funding multiplier for buybacks.
    • max_funding_delay number
      Maximum funding delay.
    • min_holder_base_funding number
      Minimum base funding per holder wallet.
  • aged_wallets object
    Aged wallet generation bounds.
    Child attributes 3
    • max_delay number
      Maximum delay between ageing steps.
    • max_loops number
      Maximum ageing loops.
    • min_balance_multiplier number
      Minimum balance multiplier.
  • launch object
    Launch plan bounds used to validate the launch form.
    Child attributes 11
    • min_buy_delay_mev number
      Minimum MEV buy delay.
    • max_buy_delay_mev number
      Maximum MEV buy delay.
    • min_buy_delay_stagger number
      Minimum staggered buy delay.
    • max_buy_delay_stagger number
      Maximum staggered buy delay.
    • min_holders_count integer
      Minimum number of holder wallets.
    • max_holders_count integer
      Maximum number of holder wallets.
    • max_total_buy_percentage object
      Default maximum share of supply a launch may buy, keyed by launch platform.
    • default_front_to_back_delay_ms integer
      Default delay between front and back MEV buys, in milliseconds.
    • default_back_to_temp_delay_ms integer
      Default delay between back MEV and temporary holder buys, in milliseconds.
    • max_mev_step_delay_ms integer
      Maximum delay of one MEV step, in milliseconds.
    • autosell object
      Autosell bounds: max_autosell_session_duration, min_replication_factor, max_replication_factor, min_swap_back_rate, min_timed_exact_in_delay, max_timed_exact_in_delay.
  • chains object
    Per-chain configuration, keyed by chain id.
    Child attributes 22
    • network_type enum
      Network of the chain.
      Possible values svmevm
    • chainId string
      Chain id.
    • name string
      Display name.
    • symbol string
      Native token symbol.
    • decimals integer
      Native token decimals.
    • live boolean
      Whether the chain is enabled.
    • dexs object
      Launch platforms on this chain, keyed by platform id. Platform-specific fields (fee tiers, snipe tax, supply bounds) appear only on the platforms that use them.
      Child attributes 12
      • id string
        Launch platform id, e.g. pumpfun.
      • name string
        Display name.
      • decimals integer
        Token decimals of coins launched on this platform.
      • live boolean
        Whether the platform is open for launches.
      • available_quotes array<string>
        Quote token mints or addresses a launch can pair with.
      • versions object
        Per-generation quote lists. The root available_quotes is the v1-safe subset.
      • graduation_mcap_usd number
        Market cap, in USD, at which the bonding curve graduates.
      • max_total_buy_percentage number
        Maximum share of supply a launch bundle may buy, in percent.
      • max_dev_buy_percentage number
        Maximum dev buy, in percent of supply.
      • custom_quote boolean
        Pump.fun only: any pump coin can be used as quote once the quote check admits it.
      • launch_modes array<string>
        Launch modes beyond the standard one, listed only for licenses allowed them.
      • dev_buy_modes array<string>
        Supported dev buy modes.
    • tokens object
      Quote tokens keyed by mint or lowercase address. Each entry has symbol and decimals; on EVM, decimals is the 10^d multiplier as a string because it exceeds JavaScript number precision.
    • lock_token object | false
      Token lock settings (fee_bps, min_native_balance), or false when locking is not available.
    • volume_bundle boolean
      Whether a bundle relay is configured, which the volume bot's atomic bundle mode requires.
  • ocp object
    Shield settings.
    Child attributes 1
    • minimum_funder_balance integer
      Minimum funder balance needed to deploy a Shield, in lamports.
GET /health

Returns a liveness flag and the server time.

Token
None. This endpoint is public.
Retry
Safe to retry

Parameters

No parameters.

Returns 200 OK · application/json

  • ok boolean
    Always true when the API is up.
  • ts integer
    Server time, in Unix milliseconds.

Errors

Only the common errors: 429 when rate limited.

Web client proxima.getHealth() src/lib/proxima/proxima.ts

GET /get-constants

Returns the platform configuration for the current license.

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

The web app loads constants once a license is selected and refetches them every 30 seconds. It reads chain and platform availability, launch and funding bounds, the Shield funder minimum and the fee_activation switch that opens the Rewards section.

Parameters

No parameters.

Returns 200 OK · application/json

Returns a Constants object.

Errors

Only the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.

Web client proxima.getConstants() src/lib/proxima/proxima.ts