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.
The Admin user object
An account as listed in the admin users table, with its fees, trading metrics and referral position.
Attributes
-
account_idstringStable account id. It survives a key rotation and a rename; admin write endpoints identify accounts by it. -
usernamestringAccount username. -
display_namestring | nullDisplay name shown instead of@username. -
avatar_urlstring | nullAvatar image URL. -
license_keystringCurrent license key. -
created_atintegerCreation time, Unix seconds. -
tierstringLicense tier. -
fee_rateintegerSell fee, in basis points. -
sell_fee_rateintegerSame value asfee_rate. -
buy_fee_rateintegerBuy fee, in basis points. -
cashback_rateintegerShare of what Proxima keeps on this account's launches, after referrals, paid back to it, in basis points. -
is_activebooleanWhether the license key is active. -
is_internalbooleanInternal account. Analytics populations leave internal accounts out. -
launch_countintegerNumber of launches. -
pnl_usdstringLaunch P&L, in micro-USD, as an integer string. -
pnl_nativestring | nullLaunch P&L, in lamports or wei, as an integer string.nullwhen nochain_idfilter is set and the account is active on several chains. -
volume_sold_usdstringVolume sold, in micro-USD, as an integer string. -
volume_sold_nativestring | nullVolume sold, in lamports or wei, as an integer string. -
volume_bought_usdstringVolume bought, in micro-USD, as an integer string. -
volume_bought_nativestring | nullVolume bought, in lamports or wei, as an integer string. -
fees_paid_usdstringFees paid to Proxima, in micro-USD, as an integer string. -
fees_paid_nativestring | nullFees paid to Proxima, in lamports or wei, as an integer string. -
referral_paid_usdstringReferral paid out of this account's fees to its referrer chain, in micro-USD, as an integer string. -
referral_paid_nativestring | nullSame asreferral_paid_usd, in lamports or wei, as an integer string. -
referral_profit_usdstringReferral earned by this account, in micro-USD, as an integer string. -
referral_profit_nativestring | nullSame asreferral_profit_usd, in lamports or wei, as an integer string. -
referral_fee_rate_currentintegerRate 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_keystring | nullLicense key of the referrer. -
referrer_usernamestring | nullUsername of the referrer. -
referrer_account_idstring | nullAccount id of the referrer. -
referred_license_keysarray<string>License keys this account referred. -
referred_countintegerNumber of accounts referred. -
referred_revenue_usdstringFees paid by the accounts this one referred, in micro-USD, as an integer string. -
referred_revenue_nativestring | nullSame asreferred_revenue_usd, in lamports or wei, as an integer string. -
referred_net_revenue_usdstringReferees' fees minus the referral paid back to this account, in micro-USD, as an integer string.
List users
/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
-
limitinteger OptionalPage size. The API defaults to 100 and caps at 500. -
offsetinteger OptionalNumber of rows to skip. -
searchstring OptionalMatches part of the username or license key. -
account_idstring OptionalRestricts the results to one account. -
referrer_account_idstring OptionalRestricts the results to the accounts this account referred. -
chain_idenum OptionalRestricts metrics to one chain.allis not sent.Possible valuessolethbscbaserobinhoodmonadarcxlayer -
order_byenum OptionalSort column. The API refusessell_fee_rate,buy_fee_rateandcashback_rate.Possible valuescreated_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 -
orderenum OptionalSort direction.Possible valuesascdesc
Returns 200 OK · application/json
-
usersarray<object>Accounts on this page. See Admin user. -
totalintegerTotal number of matching accounts. -
limitintegerApplied page size. -
offsetintegerApplied offset. -
native_mixedbooleantruewhen the results span several chains, so native amounts are not in a single unit. -
unitsobjectUnit labels for the amounts in the response.Child attributes 3
-
usdstringUnit of the USD amounts. -
nativestringUnit of the native amounts. -
timestringUnit of the timestamps.
-
Errors
| Status | Code | When 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/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.
-
licenseobjectThe license, in the shape its owner reads fromGET /license/get-license-info, with its key underlicense_keyand admin-only fields added.Child attributes 12
-
license_keystringLicense key. -
usernamestring | nullUsername. -
account_idstringStable account id. -
tierstringLicense tier. -
fee_rateintegerSell fee, in basis points. -
buy_fee_rateintegerBuy fee, in basis points. -
cashback_rateintegerCashback rate, in basis points. -
is_activebooleanWhether the key is active. -
created_atstringCreation time. -
total_pnl_usdstringLifetime P&L, in micro-USD, as an integer string. -
gross_volume_usdstringLifetime gross volume, in micro-USD, as an integer string. -
referralobjectReferral position:referral_fee_rate,referred_keys,referrer_key,referrer_username,referrer_account_id, profits and codes.
-
-
mintsarray<object>The license's launches, in the shape ofGET /license/get-mints-info, plus admin revenue fields.Child attributes 13
-
launch_idintegerLaunch id. -
chain_idstringProxima chain id. -
mint_pubkeystring | nullToken address. -
launch_platformstringLaunchpad. -
launch_methodenumLaunch method.Possible valuesMevStaggerManualAllowlist -
launch_statusstringLaunch status. -
holder_countinteger | nullToken holder count. -
gross_revenue_usdstringFees Proxima earned on the launch, in micro-USD, as an integer string. -
gross_revenue_nativestringSame, in lamports or wei, as an integer string. -
referral_paid_usdstringReferral paid on the launch, in micro-USD, as an integer string. -
referral_unpaid_usdstringReferral still owed on the launch, in micro-USD, as an integer string. -
referral_unpaid_statusenumsettlingwhile a queued sweep will still pay the unpaid referral.Possible valuessettledsettlingrequires_reconciliation -
revenue_net_usdstringRevenue after referral, in micro-USD, as an integer string.
-
-
launch_countintegerNumber of launches. -
referred_revenue_usdstringFees paid by the licenses this one referred, in micro-USD, as an integer string. -
referred_net_revenue_usdstringReferees' 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/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
-
usernamestring RequiredUsername of the new account: 3–50 letters, digits or hyphens, starting and ending with a letter or digit. -
referrerstring OptionalUsername of the referrer. -
referral_fee_rateinteger OptionalRate the new account earns on its own referrals, in basis points. -
fee_rateinteger OptionalSell fee, in basis points.
Returns 200 OK · application/json
-
license_keystringThe new license key.
Errors
| Status | Code | When 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/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_idstring RequiredTarget account id (see Admin user). -
new_referrerstring OptionalReferrer's username. Empty string clears the referrer. -
new_referrer_account_idstring OptionalReferrer's account id. Takes precedence overnew_referrerin the client. -
new_referral_fee_rateinteger OptionalRate this account earns on its referrals, in basis points. -
new_fee_rateinteger OptionalSell fee, in basis points. -
new_buy_fee_rateinteger OptionalBuy fee, in basis points. -
new_cashback_rateinteger OptionalShare of what Proxima keeps on this account's launches, after referrals, paid back to it, in basis points.
Returns 200 OK · application/json
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When 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/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_keyin List users (filtered byaccount_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_idstring RequiredTarget account id (see Admin user).
Returns 200 OK · application/json
-
new_keystringThe new license key.
Errors
| Status | Code | When 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
Activate or deactivate a license key
/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_idstring RequiredTarget account id (see Admin user). -
is_activeboolean Requiredfalsedeactivates the key,truereactivates it.
Returns 200 OK · application/json
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When 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/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_idstring RequiredAccount id of any license the user owns.
Returns 200 OK · application/json
-
user_idstringId of the owning user. -
licensesarray<object>Licenses the user owns.Child attributes 9
-
keystringLicense key. -
account_idstringAccount id. -
usernamestringUsername. -
display_namestring | nullDisplay name. -
tierstringLicense tier. -
is_activebooleanWhether the key is active. -
avatar_urlstring | nullAvatar URL. -
banner_urlstring | nullBanner URL. -
banner_themestring | nullBanner preset id.
-
Errors
| Status | Code | When 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/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_secondsinteger OptionalLifetime, in seconds, from 60 to 15552000 (180 days). Also accepts a numeric string. -
labelstring OptionalName shown in the session list, up to 60 characters. Trimmed.
Returns 200 OK · application/json
-
okbooleanAlwaystrue. -
tokenstringThe read-only JWT. Send it asAuthorization: Bearer <token>. -
session_idstringSession the token belongs to. -
expires_inintegerLifetime applied, in seconds. -
expires_atintegerExpiry, Unix seconds. -
labelstring | nullLabel applied.
Errors
| Status | Code | When 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