Skip to content
API Reference

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

Launches

List every account's launches with revenue and referral figures, and read any launch.

Admin launch endpoints read launches across all accounts, for the admin launches table, the dashboard and the launch setup inspector.

Amounts come in pairs: *_usd in micro-USD and *_native in lamports or wei, all as integer strings.

A launch as listed in the admin launches table, with its owner, trading figures and the revenue and referral it produced.

Attributes

  • chain_id string
    Proxima chain id.
  • launch_id string
    Launch id.
  • mint_pubkey string
    Token address.
  • launch_platform string
    Launchpad.
  • launch_method string | null
    Launch method.
  • launch_status string
    Launch status.
  • created_at integer
    Creation time, Unix seconds.
  • launched_at integer
    Launch time, Unix seconds.
  • archived boolean
    Whether the owner archived the launch.
  • scheduled_mode boolean
    Whether the launch was scheduled.
  • has_launch_plan boolean
    Whether the launch has a launch plan.
  • is_imported boolean
    Whether the token was imported rather than launched through Proxima.
  • holder_count integer | null
    Token holder count.
  • name string
    Token name.
  • symbol string
    Token symbol.
  • description string
    Token description.
  • image_url string | null
    Token image URL.
  • token_decimals integer
    Token decimals.
  • total_supply string | null
    Total supply, as a string.
  • quote_mint string | null
    Quote token address.
  • website string | null
    Website link.
  • twitter string | null
    X link.
  • telegram string | null
    Telegram link.
  • kind enum
    launch for a single launch, group for a launch group, member for a launch inside a group.
    Possible values launchgroupmember
  • group_id string | null
    Launch group id.
  • group_disposition enum | null
    Outcome of a group member.
    Possible values winnerdisposedattempt
  • tag_ids array<integer>
    Ids of the owner's tags on the launch.
  • pnl_native string
    P&L, in lamports or wei, as an integer string.
  • pnl_usd string
    P&L, in micro-USD, as an integer string.
  • gross_volume_native string
    Gross volume, in lamports or wei, as an integer string.
  • gross_volume_usd string
    Gross volume, in micro-USD, as an integer string.
  • total_buy_native string
    Total bought, in lamports or wei, as an integer string.
  • total_buy_usd string
    Total bought, in micro-USD, as an integer string.
  • total_sell_native string
    Total sold, in lamports or wei, as an integer string.
  • total_sell_usd string
    Total sold, in micro-USD, as an integer string.
  • mm_pnl_native string
    Market-making P&L, in lamports or wei, as an integer string.
  • mm_pnl_usd string
    Market-making P&L, in micro-USD, as an integer string.
  • extra_rewards_native string
    Extra rewards, in lamports or wei, as an integer string.
  • extra_rewards_usd string
    Extra rewards, in micro-USD, as an integer string.
  • gross_revenue_native string
    Fees Proxima earned on the launch, in lamports or wei, as an integer string.
  • gross_revenue_usd string
    Fees Proxima earned on the launch, in micro-USD, as an integer string.
  • license_key string
    Owner's license key.
  • referrer_license_key string | null
    License key of the owner's referrer.
  • referrer_username string | null
    Username of the owner's referrer.
  • referrer_account_id string | null
    Account id of the owner's referrer.
  • referral_paid_native string
    Referral paid on the launch, in lamports or wei, as an integer string.
  • referral_paid_usd string
    Referral paid on the launch, in micro-USD, as an integer string.
  • referral_unpaid_native string
    Referral still owed on the launch, in lamports or wei, as an integer string.
  • referral_unpaid_usd string
    Referral still owed on the launch, in micro-USD, as an integer string.
  • referral_unpaid_status enum
    settling while a queued sweep will still pay the unpaid referral.
    Possible values settledsettlingrequires_reconciliation
  • revenue_net_native string
    Revenue after referral, in lamports or wei, as an integer string.
  • revenue_net_usd string
    Revenue after referral, in micro-USD, as an integer string.
  • referral_fee_rate_current integer
    Rate the owner earns on its referrals, in basis points. Do not recompute paid or net amounts with it.
  • owner_account_id string | null
    Owner's account id.
  • owner_username string | null
    Owner's username.
  • owner_display_name string | null
    Owner's display name.
  • owner_avatar_url string | null
    Owner's avatar URL.
  • shared boolean
    At least one live sharing grant on the launch.
  • sharing object | null
    Present when the launch has live grants or pending invites.
    Child attributes 2
    • members array<object>
      Licenses the launch is shared with: grant_id, username, display_name, avatar_url, granted_by, depth, operations, export_keys_count, allow_future_wallets, expires_at and created_at (Unix seconds).
    • pending_invites integer
      Number of pending invites.

List launches

Admin JWT internal
GET /admin/launches

Returns a filtered, sorted page of launches across all accounts.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

List filters take comma-separated values. Empty filters and chain_id=all are left out of the query string.

Query parameters

  • limit integer Optional Default 50
    Page size. The API defaults to 50 and caps at 200.
  • offset integer Optional Default 0
    Number of rows to skip.
  • chain_id string Optional
    Comma-separated chain ids, such as sol,base.
  • account_id string Optional
    Restricts the results to one owner account.
  • referrer_account_id string Optional
    Restricts the results to launches of the accounts this account referred.
  • search string Optional
    Free-text search.
  • launch_status string Optional
    Comma-separated launch statuses.
  • platform string Optional
    Comma-separated launchpads.
  • launch_method string Optional
    Comma-separated launch methods: mev, block0, stagger, manual.
  • is_imported boolean Optional
    Filters on imported tokens.
  • scheduled_mode boolean Optional
    Filters on scheduled launches.
  • archived boolean Optional
    Filters on archived launches.
  • shared boolean Optional
    Filters on launches with a live sharing grant.
  • launched_from integer Optional
    Earliest launch time, Unix seconds, inclusive.
  • launched_to integer Optional
    Latest launch time, Unix seconds, inclusive.
  • order_by enum Optional Default launched_at
    Sort column. The API refuses owner_username.
    Possible values launched_atcreated_atlaunch_idlicense_keyowner_usernamepnl_usdpnl_nativegross_volume_usdgross_volume_nativegross_revenue_usdgross_revenue_nativereferral_paid_usdreferral_paid_nativeholder_countnamesymbollaunch_platformlaunch_statuschain_id
  • order enum Optional Default desc
    Sort direction.
    Possible values ascdesc

Returns 200 OK · application/json

  • items array<object>
    Launches on this page. See Admin launch.
  • total integer
    Total number of matching launches.
  • limit integer
    Applied page size.
  • offset integer
    Applied offset.
  • native_mixed boolean
    true when the results span several chains, so native amounts are not in a single unit.
  • units object
    Unit labels for the amounts in the response.
    Child attributes 3
    • usd string
      Unit of the USD amounts.
    • native string
      Unit of the native amounts.
    • time string
      Unit of the timestamps.

Errors

StatusCodeWhen and what to do
400 bad_request order_by is not a sortable column; the API refuses owner_username. An order other than asc or desc answers invalid order: <order>. Sort on another order_by column, with order set to asc or desc.
400 bad_request A chain_id, launch_status, platform or launch_method value is unknown. The message lists the accepted values. Use only the values the message lists.
400 bad_request launched_from or launched_to is too large to be read as a date. Send the time in Unix seconds.
404 not_found No account has this account_id. Take the account_id from List users.

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

Web client proxima.admin.listLaunches(query) src/lib/proxima/endpoints/admin.ts

List a user's launches

Admin JWT internal
GET /admin/launches/{username}

Returns a page of one user's launches.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

Path parameters

  • username string Required
    Username of the owner.

Query parameters

  • limit integer Optional Default 50
    Page size. The API defaults to 50 and caps at 200.
  • offset integer Optional Default 0
    Number of rows to skip.
  • chain_id string Optional
    Comma-separated chain ids, such as sol,base.
  • search string Optional
    Free-text search.
  • launch_status string Optional
    Comma-separated launch statuses.
  • platform string Optional
    Comma-separated launchpads.
  • launch_method string Optional
    Comma-separated launch methods: mev, block0, stagger, manual.
  • is_imported boolean Optional
    Filters on imported tokens.
  • scheduled_mode boolean Optional
    Filters on scheduled launches.
  • archived boolean Optional
    Filters on archived launches.
  • shared boolean Optional
    Filters on launches with a live sharing grant.
  • launched_from integer Optional
    Earliest launch time, Unix seconds, inclusive.
  • launched_to integer Optional
    Latest launch time, Unix seconds, inclusive.
  • order_by enum Optional Default launched_at
    Sort column. The API refuses owner_username.
    Possible values launched_atcreated_atlaunch_idlicense_keyowner_usernamepnl_usdpnl_nativegross_volume_usdgross_volume_nativegross_revenue_usdgross_revenue_nativereferral_paid_usdreferral_paid_nativeholder_countnamesymbollaunch_platformlaunch_statuschain_id
  • order enum Optional Default desc
    Sort direction.
    Possible values ascdesc

Returns 200 OK · application/json

  • items array<object>
    Launches on this page. See Admin launch.
  • total integer
    Total number of matching launches.
  • limit integer
    Applied page size.
  • offset integer
    Applied offset.
  • native_mixed boolean
    true when the results span several chains, so native amounts are not in a single unit.
  • units object
    Unit labels for the amounts in the response.
    Child attributes 3
    • usd string
      Unit of the USD amounts.
    • native string
      Unit of the native amounts.
    • time string
      Unit of the timestamps.

Errors

StatusCodeWhen and what to do
400 bad_request order_by is not a sortable column; the API refuses owner_username. An order other than asc or desc answers invalid order: <order>. Sort on another order_by column, with order set to asc or desc.
400 bad_request A chain_id, launch_status, platform or launch_method value is unknown. The message lists the accepted values. Use only the values the message lists.
400 bad_request launched_from or launched_to is too large to be read as a date. Send the time in Unix seconds.
404 not_found No account has this username. Use a username returned by List users.

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

Web client proxima.admin.listLaunchesByUsername(username, query) src/lib/proxima/endpoints/admin.ts

Retrieve a launch

Admin JWT internal
GET /admin/get-launch-info/{launch_id}

Returns the full configuration and wallets of any account's launch.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Allowed.
Retry
Safe to retry

Same shape as the owner's GET /launch/get-launch-info/{launch_id}, readable for any launch. The admin launch setup modal shows it. Wallet secrets are not included.

Path parameters

  • launch_id string Required
    Launch id.

Returns 200 OK · application/json

Returns a launch info object. The main fields are listed below.

  • chain_id string
    Proxima chain id.
  • launch_method enum
    Launch method.
    Possible values MevStaggerManualAllowlist
  • funding_type enum
    How the wallets were funded.
    Possible values ClassicCex
  • is_graduated boolean
    Whether the token left its bonding curve.
  • creator_fees integer
    Uncollected creator fees, in base units of the native or quote token. See Collect creator fees.
  • buy_delay integer
    Delay between holder buys, in milliseconds.
  • dev object | null
    Dev wallet.
  • funder object
    Funder wallet.
  • holder array<object>
    Holder wallets.
  • front_mev array<object>
    Front MEV wallets.
  • back_mev array<object>
    Back MEV wallets.
  • temp_holder array<object>
    Temporary holder wallets.
  • pnl_native string
    P&L, in lamports or wei, as an integer string.
  • pnl_usd string
    P&L, in micro-USD, as an integer string.
  • gross_volume_native string
    Gross volume, in lamports or wei, as an integer string.
  • gross_volume_usd string
    Gross 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.

Errors

StatusCodeWhen and what to do
400 bad_request launch_id is not a valid launch id. Use a launch id returned by List launches.
404 not_found No launch has this id. Use a launch id returned by List launches.

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

Web client proxima.admin.getLaunchInfo(launchId) src/lib/proxima/endpoints/admin.ts