Skip to content
API Reference

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

Wallet folders

Group trading wallets into named, colored folders.

Folders group wallets so they can be selected and acted on together. The API calls them tags: the routes live under /wallets/tags/ and a folder is referenced by tag_id.

A folder belongs to one network type and only holds wallets of that network. Folders are returned with List wallets under tags.svm and tags.evm, and each wallet lists its folders in tag_ids. Archiving a folder hides it from the main list but keeps its wallets.

A named group of wallets on one network type.

Attributes

  • id integer
    Folder ID (tag_id in requests). Unique per network type only.
  • name string
    Folder name, at most 25 characters.
  • color string
    Display color as a hex string, for example #A6B1FF.
  • archived boolean
    Whether the folder is archived. Archived folders keep their wallets.

Create a folder

Bearer JWT
POST /wallets/tags/create-tag

Creates an empty folder on a network type.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying Each call creates a new folder, even with a name already in use. Before retrying, call List wallets and look for the folder in tags.

Body parameters application/json

  • name string Required
    Folder name, at most 25 characters.
  • color string Required
    Display color as a hex string.
  • network_type enum Required
    Network type of the wallets the folder will hold.
    Possible values svmevm

Returns 200 OK · application/json

  • ok boolean
    Always true on success.
  • message string
    Human-readable confirmation.
  • tag_id integer
    ID of the new folder.

Errors

StatusCodeWhen and what to do
400 bad_request name is longer than 25 characters. Shorten name to 25 characters or fewer.
400 bad_request network_type is missing. Set network_type to svm or evm.

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.wallets.tags.createTag(network_type, name, color) src/lib/proxima/endpoints/wallets/tags.ts

Update a folder

Bearer JWT
POST /wallets/tags/update-tag

Renames, recolors, archives or unarchives a folder.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Sending the same values again leaves the folder in the same state.

Omitted fields are left unchanged.

Body parameters application/json

  • tag_id integer Required
    ID of the folder.
  • new_name string Optional
    New name, at most 25 characters.
  • new_color string Optional
    New hex color.
  • archive boolean Optional
    true to archive the folder, false to unarchive 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 new_name is longer than 25 characters. Shorten new_name to 25 characters or fewer.
500 internal_error The folder is not on the account. Returned as a 500, not a 404. Use a folder ID from the tags of List wallets.

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.wallets.tags.updateTag(tag_id, updates) src/lib/proxima/endpoints/wallets/tags.ts

Delete a folder

Bearer JWT
POST /wallets/tags/delete-tag

Deletes a folder.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A repeat after a successful delete returns 500 tag not found.

Body parameters application/json

  • tag_id integer Required
    ID of the folder.

Returns 200 OK · application/json

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

Errors

StatusCodeWhen and what to do
500 internal_error The folder is not on the account. Returned as a 500, not a 404. Use a folder ID from the tags of List wallets.

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.wallets.tags.deleteTag(tag_id) src/lib/proxima/endpoints/wallets/tags.ts

POST /wallets/tags/tag-wallets

Adds wallets to a folder.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A wallet already in the folder is left as is.

The network is read from the address format, and the folder must belong to that network. Addresses that are not wallets of the account are skipped. The web app calls this after creating wallets, from the folder pickers, and after a marketplace order is delivered.

Body parameters application/json

  • tag_id integer Required
    ID of the folder.
  • pubkeys array<string> Required
    Addresses to add, all on the folder's network.

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 address was sent. Send at least one address in pubkeys.
400 bad_request SVM and EVM addresses were mixed. Send SVM and EVM addresses in separate requests.
400 bad_request The folder is not on the account for the addresses' network. Use a folder of the same network from the tags of List wallets.
400 bad_request For an SVM folder, an address is not a valid Solana address. Check that every address is a valid base58 public key.
400 bad_request For an EVM folder, an address is not a valid EVM address. Check that every address is a valid 0x address.
400 bad_request None of the addresses is a wallet of the account. Use addresses from List wallets.

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.wallets.tags.tagWallets(tag_id, pubkeys) src/lib/proxima/endpoints/wallets/tags.ts

POST /wallets/tags/untag-wallets

Removes wallets from a folder without deleting them.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A wallet that is not in the folder is left as is.

Body parameters application/json

  • tag_id integer Required
    ID of the folder.
  • pubkeys array<string> Required
    Addresses to remove, all on the folder's network.

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 address was sent. Send at least one address in pubkeys.
400 bad_request SVM and EVM addresses were mixed. Send SVM and EVM addresses in separate requests.
400 bad_request The folder is not on the account for the addresses' network. Use a folder of the same network from the tags of List wallets.
400 bad_request For an SVM folder, an address is not a valid Solana address. Check that every address is a valid base58 public key.
400 bad_request For an EVM folder, an address is not a valid EVM address. Check that every address is a valid 0x address.
400 bad_request None of the addresses is a wallet of the account. Use addresses from List wallets.

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.wallets.tags.untagWallets(tag_id, pubkeys) src/lib/proxima/endpoints/wallets/tags.ts