Skip to content
API Reference

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

Users and licenses

List accounts with their metrics, create licenses, and change fees, referrers, keys and status.

Admin endpoints manage Proxima accounts and their license keys. They need a JWT whose user has the admin role; other callers get 403. The web app calls them from the /admin pages.

An account is identified by its stable account_id, which survives a key rotation and a rename. Rates are in basis points (1% = 100). *_usd amounts are micro-USD and *_native amounts are lamports or wei, all as integer strings.

An account as listed in the admin users table, with its fees, trading metrics and referral position.

Attributes

  • account_id string
    Stable account id. It survives a key rotation and a rename; admin write endpoints identify accounts by it.
  • username string
    Account username.
  • display_name string | null
    Display name shown instead of @username.
  • avatar_url string | null
    Avatar image URL.
  • license_key string
    Current license key.
  • created_at integer
    Creation time, Unix seconds.
  • tier string
    License tier.
  • fee_rate integer
    Sell fee, in basis points.
  • sell_fee_rate integer
    Same value as fee_rate.
  • buy_fee_rate integer
    Buy fee, in basis points.
  • cashback_rate integer
    Share of what Proxima keeps on this account's launches, after referrals, paid back to it, in basis points.
  • is_active boolean
    Whether the license key is active.
  • is_internal boolean
    Internal account. Analytics populations leave internal accounts out.
  • launch_count integer
    Number of launches.
  • pnl_usd string
    Launch P&L, in micro-USD, as an integer string.
  • pnl_native string | null
    Launch P&L, in lamports or wei, as an integer string. null when no chain_id filter is set and the account is active on several chains.
  • volume_sold_usd string
    Volume sold, in micro-USD, as an integer string.
  • volume_sold_native string | null
    Volume sold, in lamports or wei, as an integer string.
  • volume_bought_usd string
    Volume bought, in micro-USD, as an integer string.
  • volume_bought_native string | null
    Volume bought, in lamports or wei, as an integer string.
  • fees_paid_usd string
    Fees paid to Proxima, in micro-USD, as an integer string.
  • fees_paid_native string | null
    Fees paid to Proxima, in lamports or wei, as an integer string.
  • referral_paid_usd string
    Referral paid out of this account's fees to its referrer chain, in micro-USD, as an integer string.
  • referral_paid_native string | null
    Same as referral_paid_usd, in lamports or wei, as an integer string.
  • referral_profit_usd string
    Referral earned by this account, in micro-USD, as an integer string.
  • referral_profit_native string | null
    Same as referral_profit_usd, in lamports or wei, as an integer string.
  • referral_fee_rate_current integer
    Rate this account earns on its referrals, in basis points — the value Update a license writes. Do not recompute paid or net amounts with it.
  • referrer_license_key string | null
    License key of the referrer.
  • referrer_username string | null
    Username of the referrer.
  • referrer_account_id string | null
    Account id of the referrer.
  • referred_license_keys array<string>
    License keys this account referred.
  • referred_count integer
    Number of accounts referred.
  • referred_revenue_usd string
    Fees paid by the accounts this one referred, in micro-USD, as an integer string.
  • referred_revenue_native string | null
    Same as referred_revenue_usd, in lamports or wei, as an integer string.
  • referred_net_revenue_usd string
    Referees' fees minus the referral paid back to this account, in micro-USD, as an integer string.

List users

Admin JWT internal
GET /admin/users

Returns a page of accounts with their fees, metrics and referral data.

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

Backs the admin users table. The account modal reads a single account with account_id and limit=1, the referred-accounts view lists up to 500 accounts by referrer_account_id, and the referrer picker searches by search.

Query parameters

  • limit integer Optional Default 100
    Page size. The API defaults to 100 and caps at 500.
  • offset integer Optional Default 0
    Number of rows to skip.
  • search string Optional
    Matches part of the username or license key.
  • account_id string Optional
    Restricts the results to one account.
  • referrer_account_id string Optional
    Restricts the results to the accounts this account referred.
  • chain_id enum Optional
    Restricts metrics to one chain. all is not sent.
    Possible values solethbscbaserobinhoodmonadarcxlayer
  • order_by enum Optional Default created_at
    Sort column. The API refuses sell_fee_rate, buy_fee_rate and cashback_rate.
    Possible values created_atusernamelicense_keylaunch_countpnl_usdpnl_nativevolume_sold_usdvolume_sold_nativevolume_bought_usdvolume_bought_nativefees_paid_usdfees_paid_nativereferral_paid_usdreferral_paid_nativereferral_profit_usdreferral_profit_nativereferral_ratereferred_countreferred_revenue_usdreferred_revenue_nativereferred_net_revenue_usddisplay_namereferrer_license_keytierfee_ratesell_fee_ratebuy_fee_ratecashback_rate
  • order enum Optional Default desc
    Sort direction.
    Possible values ascdesc

Returns 200 OK · application/json

  • users array<object>
    Accounts on this page. See Admin user.
  • total integer
    Total number of matching accounts.
  • 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 sell_fee_rate, buy_fee_rate and cashback_rate. An order other than asc or desc answers invalid order: <order>. Sort on another order_by column, with order set to asc or desc.

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.listUsers(query) src/lib/proxima/endpoints/admin.ts

List licenses with launches

Admin JWT internal
GET /admin/get-mints

Returns every license with its launches and revenue figures.

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

Loaded on the legacy /admin/v1 pages only, where the users and launches tables are built from it client-side.

Parameters

No parameters.

Returns 200 OK · application/json

Returns an array with one entry per license.

  • license object
    The license, in the shape its owner reads from GET /license/get-license-info, with its key under license_key and admin-only fields added.
    Child attributes 12
    • license_key string
      License key.
    • username string | null
      Username.
    • account_id string
      Stable account id.
    • tier string
      License tier.
    • fee_rate integer
      Sell fee, in basis points.
    • buy_fee_rate integer
      Buy fee, in basis points.
    • cashback_rate integer
      Cashback rate, in basis points.
    • is_active boolean
      Whether the key is active.
    • created_at string
      Creation time.
    • total_pnl_usd string
      Lifetime P&L, in micro-USD, as an integer string.
    • gross_volume_usd string
      Lifetime gross volume, in micro-USD, as an integer string.
    • referral object
      Referral position: referral_fee_rate, referred_keys, referrer_key, referrer_username, referrer_account_id, profits and codes.
  • mints array<object>
    The license's launches, in the shape of GET /license/get-mints-info, plus admin revenue fields.
    Child attributes 13
    • launch_id integer
      Launch id.
    • chain_id string
      Proxima chain id.
    • mint_pubkey string | null
      Token address.
    • launch_platform string
      Launchpad.
    • launch_method enum
      Launch method.
      Possible values MevStaggerManualAllowlist
    • launch_status string
      Launch status.
    • holder_count integer | null
      Token holder count.
    • gross_revenue_usd string
      Fees Proxima earned on the launch, in micro-USD, as an integer string.
    • gross_revenue_native string
      Same, 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_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_usd string
      Revenue after referral, in micro-USD, as an integer string.
  • launch_count integer
    Number of launches.
  • referred_revenue_usd string
    Fees paid by the licenses this one referred, in micro-USD, as an integer string.
  • referred_net_revenue_usd string
    Referees' fees minus the referral paid back to this license, in micro-USD, as an integer string.

Errors

Only 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.getMints() src/lib/proxima/endpoints/admin.ts

Create a license

Admin JWT internal
POST /admin/add-license

Creates an account with a new license key.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying A lost call may have created the account, and a repeat then fails with username already exists. Search for the username with List users to read its key.

The admin form strips the username to letters and digits and enters rates as percentages, sent in basis points. No referral code is consumed. The key is the upper-cased username, a hyphen and 17 random alphanumeric characters.

Body parameters application/json

  • username string Required
    Username of the new account: 3–50 letters, digits or hyphens, starting and ending with a letter or digit.
  • referrer string Optional
    Username of the referrer.
  • referral_fee_rate integer Optional
    Rate the new account earns on its own referrals, in basis points.
  • fee_rate integer Optional
    Sell fee, in basis points.

Returns 200 OK · application/json

  • license_key string
    The new license key.

Errors

StatusCodeWhen and what to do
400 bad_request The username is not 3–50 characters. Other format messages: username must start and end with a letter or number, username must be letters, numbers, or hyphens. Send a username of 3 to 50 letters, digits or inner hyphens.
400 bad_request Another account already has this username. Choose another username, or find the existing account with List users.

Also 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.admin.createAccount(username, referrer, referralFeeRate, feeRate) src/lib/proxima/endpoints/admin.ts

Update a license

Admin JWT internal
POST /admin/update-license

Changes an account's referrer, referral rate, fees or cashback rate.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Only the fields present are written, so a repeat sets the same values.

Only the fields present change. The client sends new_referrer_account_id when the referrer was picked from the user list and new_referrer (a username) otherwise, never both; an empty new_referrer clears the referrer. Rates are basis points from 0 to 10000 and also accept decimal strings. Changing the referrer does not waive referral already accrued.

Body parameters application/json

  • account_id string Required
    Target account id (see Admin user).
  • new_referrer string Optional
    Referrer's username. Empty string clears the referrer.
  • new_referrer_account_id string Optional
    Referrer's account id. Takes precedence over new_referrer in the client.
  • new_referral_fee_rate integer Optional
    Rate this account earns on its referrals, in basis points.
  • new_fee_rate integer Optional
    Sell fee, in basis points.
  • new_buy_fee_rate integer Optional
    Buy fee, in basis points.
  • new_cashback_rate integer Optional
    Share of what Proxima keeps on this account's launches, after referrals, paid back to it, in basis points.

Returns 200 OK · application/json

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

Errors

StatusCodeWhen and what to do
400 bad_request No target account is given. Send the target's account_id.
404 not_found No account has this account_id. Take the account_id from List users.
404 not_found new_referrer_account_id matches no account. An unknown new_referrer username answers Referrer username not found. Pick the referrer from List users.
400 bad_request new_fee_rate is above 10000. The other rates answer Invalid new referral fee rate and Invalid new buy fee rate. Send rates in basis points, from 0 to 10000.
400 bad_request The new referrer is the account itself or one of its own referrals. Choose a referrer outside the account's own referral tree.

Also 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.admin.updateAccount(request) src/lib/proxima/endpoints/admin.ts

Rotate a license key

Admin JWT internal
POST /admin/rotate-key

Replaces an account's license key with a new one.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying Each call issues another key. Compare the account's license_key in List users (filtered by account_id) with the key you had before retrying.

The license keeps its data under the new key. Started from the account modal after a confirmation.

Body parameters application/json

  • account_id string Required
    Target account id (see Admin user).

Returns 200 OK · application/json

  • new_key string
    The new license key.

Errors

StatusCodeWhen and what to do
400 bad_request account_id is missing. Send the target's account_id.
400 bad_request The key belongs to the calling admin's own user. Have another admin rotate this key.
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, 403 read_only_token and 429 when rate limited.

Web client proxima.admin.rotateKey(accountId) src/lib/proxima/endpoints/admin.ts

POST /admin/set-key-active

Turns an account's license key on or off.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry The call sets a state, so a repeat changes nothing.

Body parameters application/json

  • account_id string Required
    Target account id (see Admin user).
  • is_active boolean Required
    false deactivates the key, true reactivates it.

Returns 200 OK · application/json

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

Errors

StatusCodeWhen and what to do
400 bad_request account_id is missing. Send the target's account_id.
400 bad_request Deactivating a key that belongs to the calling admin's own user. Have another admin deactivate this key.
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, 403 read_only_token and 429 when rate limited.

Web client proxima.admin.setKeyActive(accountId, isActive) src/lib/proxima/endpoints/admin.ts

List an account's licenses

Admin JWT internal
GET /admin/users/licenses

Returns every license owned by the user behind an account.

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

Shown in the Licenses tab of the update-account modal.

Query parameters

  • account_id string Required
    Account id of any license the user owns.

Returns 200 OK · application/json

  • user_id string
    Id of the owning user.
  • licenses array<object>
    Licenses the user owns.
    Child attributes 9
    • key string
      License key.
    • account_id string
      Account id.
    • username string
      Username.
    • display_name string | null
      Display name.
    • tier string
      License tier.
    • is_active boolean
      Whether the key is active.
    • avatar_url string | null
      Avatar URL.
    • banner_url string | null
      Banner URL.
    • banner_theme string | null
      Banner preset id.

Errors

StatusCodeWhen and what to do
400 bad_request account_id is missing. Send account_id.
404 not_found No account has this account_id. Take the account_id from List users.
409 conflict The account is not attached to a user, so there is no license list to read. Read the account on its own with 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.getUserLicenses(accountId) src/lib/proxima/endpoints/admin.ts

Create a read token

Admin JWT internal
POST /admin/tokens/read

Issues a read-only JWT for tools, bound to its own session.

Token
Upgraded session token of an account with admin rights.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying Each call opens another session, and a lost token cannot be shown again. Find the session with user agent read-token: <label> in List sessions and end it with Revoke a session.

The token carries the caller's user and current license but is refused on every method except GET. It gets a session of its own, listed under its label in Settings → Sessions, so revoking it there leaves the admin signed in. The admin Tokens page creates it.

Body parameters application/json

  • ttl_seconds integer Optional Default 7776000
    Lifetime, in seconds, from 60 to 15552000 (180 days). Also accepts a numeric string.
  • label string Optional
    Name shown in the session list, up to 60 characters. Trimmed.

Returns 200 OK · application/json

  • ok boolean
    Always true.
  • token string
    The read-only JWT. Send it as Authorization: Bearer <token>.
  • session_id string
    Session the token belongs to.
  • expires_in integer
    Lifetime applied, in seconds.
  • expires_at integer
    Expiry, Unix seconds.
  • label string | null
    Label applied.

Errors

StatusCodeWhen and what to do
400 bad_request The caller's session has not been upgraded onto a license yet. Upgrade the session with Upgrade a session token first.

Also 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.admin.createReadToken(request) src/lib/proxima/endpoints/admin.ts