Skip to content
API Reference

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

Marketplace orders

Reserve wallets with a quote, pay for it, take delivery and review past purchases.

Buying from the Marketplace follows a quote lifecycle. Create a quote reserves catalog wallets for a short hold and returns a deposit address (pay_address) and the amount due. Pay it from one of your funders with Pay a quote, wait for the quote to settle, then call Deliver a quote to import the wallets into your account.

Every quote is scoped to the account that created it: another account's quote id answers 404. Settled orders are listed by List purchases. Once delivered, a bought wallet's remaining tokens can be inspected and sold in place.

Amounts are integer strings in the chain's smallest unit (lamports on Solana, wei on EVM chains) and timestamps are RFC 3339 strings. Chains use marketplace slugs (solana, ethereum, bsc, base, robinhood, arc).

A reservation of a lot of catalog wallets, with its price and payment state. The client type also declares seller-side fields (org_id, our_price_total, margin_total, items[].our_price); the API removes them from buyer responses.

Attributes

  • id string
    Quote id (UUID).
  • chain string
    Marketplace chain slug the quote is priced and paid in.
  • status string
    Quote state. Only a reserved quote can be paid. The API reports reserved, then paid, settling and settled as payment completes; expired, cancelled and failed are terminal.
  • items array<object>
    Reserved wallets.
    Child attributes 10
    • wallet_id string
      Marketplace wallet id.
    • user_price string
      Price of this wallet in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
    • balance string
      Native balance of the wallet in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
    • token_holdings array<object> | null
      Tokens the wallet holds.
      Child attributes 6
      • mint string
        Token mint or contract address.
      • symbol string | null
        Token symbol, when known.
      • decimals integer | null
        Token decimals.
      • balance string
        Raw token balance as an integer string. Divide by 10^decimals (and apply ui_multiplier) for display.
      • ui_multiplier string | null
        Display multiplier scaled by 1e18, for tokens whose UI amount differs from the raw amount.
      • usd_value number | null
        USD value of the holding.
  • user_price_total string
    Total price of the lot in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • buyer_ref string | null
    Buyer reference. The API sets it to the caller's license when the quote is created; a value sent in the request is ignored.
  • pay_address string | null
    Deposit address to pay. null until the marketplace provisions it.
  • pay_checkout_url string | null
    Checkout URL for an alternative payment rail, when the marketplace provides one.
  • pay_intent_id string | null
    Marketplace payment intent id.
  • payment_tx_hash string | null
    Transaction that funded the deposit, once seen.
  • reserved_until string
    When the hold lapses and the wallets are released (RFC 3339). The quote can still read reserved right up to this time.
  • hard_expiry string
    Hard deadline of the reservation (RFC 3339).
  • created_at string
    Creation time (RFC 3339).
  • completed_at string | null
    Completion time (RFC 3339).
  • received_amount string | null
    Amount received on the deposit address so far, in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • expected_amount string | null
    Amount the deposit must reach for the quote to settle, in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string. The web app falls back to user_price_total when it is absent.
  • payment_status string | null
    Payment state reported by the marketplace.
  • sell_tokens_after_purchase boolean
    Whether the purchase asked for the wallets' tokens to be sold after purchase.

A settled Marketplace order.

Attributes

  • id string
    Purchase id.
  • quote_id string
    Quote the purchase settled.
  • chain string
    Marketplace chain slug.
  • user_price_total string
    Amount paid in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • wallet_count integer
    Number of wallets bought.
  • settled_at string
    Settlement time (RFC 3339).
  • payment_tx_hash string | null
    Payment transaction, when known.

Create a quote

Bearer JWT beta
POST /marketplace/quote

Reserves a lot of catalog wallets and returns its price and deposit address.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Do not retry blindly Each call reserves another lot, and a lost response leaves no quote id to look up. No funds move: an unpaid hold lapses at reserved_until.

The web app sends the exact lot previewed in the catalog as wallet_ids, with count set to its length, and remembers the quote id locally so an open checkout can resume after a reload. The other filter fields belong to the request type but the SDK method does not set them.

Body parameters application/json

  • chain enum Required
    Marketplace chain slug.
    Possible values solanaethereumbscbaserobinhoodarc
  • count integer Optional
    Number of wallets to reserve. The web app sends the length of wallet_ids.
  • wallet_ids array<string> | null Optional
    Exact catalog wallet ids to reserve.
  • sell_tokens_after_purchase boolean Required
    Asks for the wallets' tokens to be sold after purchase. The client type only allows true.
  • min_balance string | null Optional
    Minimum native balance in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • max_balance string | null Optional
    Maximum native balance in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • min_age_days integer | null Optional
    Minimum wallet age, in days.
  • max_age_days integer | null Optional
    Maximum wallet age, in days.
  • min_gap_seconds integer | null Optional
    Minimum spacing between funding timestamps, in seconds.
  • source string | null Optional
    Funding source to draw from.

Returns 200 OK · application/json

Returns a Quote object.

Errors

StatusCodeWhen and what to do
400 bad_request The body is not a JSON object. Send the body as a JSON object.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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.hushxima.createQuote(chain, walletIds) src/lib/proxima/endpoints/hushxima.ts

Retrieve a quote

Bearer JWT beta
GET /marketplace/quote/{quote_id}

Returns a quote with its items and payment state.

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

On load, the Marketplace page re-reads the quote it last held and resumes the checkout if it is still reserved and reserved_until is in the future. During checkout it is the fallback read when Settle a quote fails.

Path parameters

Returns 200 OK · application/json

Returns a Quote object.

Errors

StatusCodeWhen and what to do
404 not_found The quote does not exist or was created by another account. Use a quote id that Create a quote returned to this account.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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

Web client proxima.hushxima.getQuote(id) src/lib/proxima/endpoints/hushxima.ts

List quotes

Bearer JWT beta Web client only
GET /marketplace/quotes

Returns the caller's quotes.

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

The Marketplace page shows each returned quote as a chip with its wallet count, total and status.

The API does not serve this route yet: it answers 404 with an empty body. Keep the IDs returned by Create a quote until it does.

Parameters

No parameters.

Returns 200 OK · application/json

Returns an array of Quote objects.

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.hushxima.getQuotes() src/lib/proxima/endpoints/hushxima.ts

List quote wallets

Bearer JWT beta
GET /marketplace/quote/{quote_id}/wallets

Returns the wallets a quote reserved, with their addresses.

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

A durable snapshot of the reserved lot: it stays readable after the hold expires or is cancelled.

Path parameters

Returns 200 OK · application/json

  • wallet_id string
    Marketplace wallet id.
  • pubkey string
    Wallet address.
  • user_price string
    Price of the wallet in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • balance string
    Native balance in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • age_days_at_reserve string | null
    Wallet age in days when reserved, as a decimal string.

Errors

StatusCodeWhen and what to do
404 not_found The quote does not exist or was created by another account. Use a quote id that Create a quote returned to this account.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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

Web client proxima.hushxima.getQuoteWallets(id) src/lib/proxima/endpoints/hushxima.ts

Refresh a quote

Bearer JWT beta
POST /marketplace/quote/{quote_id}/refresh

Extends a quote's reservation hold.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry A repeat only pushes the hold back again, within the quote's cap.

Each refresh pushes reserved_until back by 30 seconds, within the quote's cap. The checkout calls it once when it opens on an unsettled quote.

Path parameters

Returns 200 OK · application/json

Returns the updated Quote object.

Errors

StatusCodeWhen and what to do
404 not_found The quote does not exist or was created by another account. Use a quote id that Create a quote returned to this account.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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.hushxima.refreshQuote(id) src/lib/proxima/endpoints/hushxima.ts

Settle a quote

Bearer JWT beta
POST /marketplace/quote/{quote_id}/settle

Confirms the purchase and forces a payment check.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Settling only checks the payment and confirms the buyer; it never charges or books the sale twice.

Optional: a quote settles on its own once the deposit reaches expected_amount. The call is safe to repeat. The checkout calls it right after paying, then every 4 seconds until the quote settles.

Path parameters

Returns 200 OK · application/json

Returns the updated Quote object.

Errors

StatusCodeWhen and what to do
404 not_found The quote does not exist or was created by another account. Use a quote id that Create a quote returned to this account.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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.hushxima.settleQuote(id) src/lib/proxima/endpoints/hushxima.ts

Cancel a quote

Bearer JWT beta
POST /marketplace/quote/{quote_id}/cancel

Releases a quote's reserved wallets.

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 cancel answers 409.

The checkout cancels the held quote when it is closed before any payment was sent, and ignores failures because the hold may already be settled or expired.

Path parameters

Returns 200 OK · application/json

  • ok boolean
    true when the reservation was released.

Errors

StatusCodeWhen and what to do
404 not_found The quote does not exist or was created by another account. Use a quote id that Create a quote returned to this account.
409 conflict The quote can no longer be cancelled, and the message is the marketplace's. If it settled in the meantime, the API delivers its wallets to the caller's account. Read the quote's status with Retrieve a quote; a settled quote has already been delivered.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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.hushxima.cancelQuote(id) src/lib/proxima/endpoints/hushxima.ts

Pay a quote

Bearer JWT 2FA beta
POST /marketplace/quote/{quote_id}/pay

Pays a reserved quote from one of the caller's funder wallets.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Two-factor
Step-up for wallet.withdraw when the user protects it. How it works
Retry
Check before retrying A lost call may have sent funds. Read the quote with Retrieve a quote: a higher received_amount or a status past reserved means it was paid, and the API refuses a second payment while one is unconfirmed.

The amount and destination are not parameters: the API sends expected_amount − received_amount to the quote's pay_address, so a partial deposit is topped up rather than paid twice. The network fee is paid on top of the amount. After a successful call the checkout settles the quote and polls until it does.

Path parameters

Body parameters application/json

  • funder_pubkey string Required
    Funder wallet that pays: a base58 pubkey on Solana, a 0x address on EVM chains. It must belong to the caller's license.

Returns 200 OK · application/json

  • ok boolean
    true when the transfer was sent.
  • quote_id string
    Quote that was paid.
  • chain string
    Chain the payment was sent on.
  • recipient string
    Deposit address that received the payment.
  • amount_sent string
    Amount sent in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • tx string
    Payment transaction signature or hash.

Errors

StatusCodeWhen and what to do
400 bad_request funder_pubkey is missing or blank. A body that does not parse answers invalid body: <detail>. Send funder_pubkey with the address of the wallet that pays.
400 bad_request funder_pubkey is not a wallet of the caller's account whose key the API holds. On EVM chains the message is no signable wallet for license: <address>, and an address that does not parse answers invalid funder address: <address>. Pay from one of the account's own wallets, such as one returned by List funders.
404 not_found The quote does not exist or was created by another account. Use a quote id that Create a quote returned to this account.
409 conflict Fewer than 15 seconds remain on the hold, too little for a transfer to land and be seen. Extend the hold with Refresh a quote, then pay again.
409 conflict The quote is not reserved, so it cannot be paid. A hold that has already run out answers the reservation has expired — reserve the lot again. Reserve the lot again with Create a quote.
409 conflict The marketplace has not provisioned the deposit address yet. Wait until Retrieve a quote returns a pay_address, then pay again.
409 conflict A payment for this quote is already in flight or waiting to be credited, so the API refuses to send another. Related messages: the deposit is already funded — waiting for settlement, payment already landed; waiting for settlement, payment confirmation is pending; retry to check its status. Poll Settle a quote until the quote settles instead of paying again.
409 conflict The funder cannot cover the amount plus the network fee. On EVM chains the amounts are in wei. Top up the funder, or pay from another wallet returned by List funders.
422 upstream_failure The transfer was sent but has not confirmed yet. The quote stays locked to that payment, so a retry checks it instead of sending again. Other messages with this code: hushxima api issue: payment transfer did not land; you can retry payment (the transfer expired without landing and the lock is released), hushxima api issue: payment transfer failed: <error>, and any marketplace failure. Retry the call to check the transfer, or read received_amount with Retrieve a quote.

Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token, 401 2fa_required and 429 when rate limited.

Web client proxima.hushxima.payQuote(id, funderPubkey) src/lib/proxima/endpoints/hushxima.ts

Deliver a quote

Bearer JWT beta
POST /marketplace/quote/{quote_id}/deliver

Imports a settled quote's wallets into the caller's account.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Delivery is idempotent: a repeat imports no wallet twice, and imported counts only new ones.

Settlement is asynchronous, so poll this call: while the quote has not settled it answers pending: true with imported: 0 and the current status. Once settled, the wallets are added to the account with their original funding time and venue, and the web app adds them to the chosen folders. Replaying a delivery is safe and never books the sale twice.

Path parameters

Returns 200 OK · application/json

  • imported integer
    Number of wallets imported by this call.
  • pending boolean
    true while the quote has not settled yet.
  • status string | null
    Quote status, e.g. paid, settling or settled.
  • wallets array<object>
    Delivered wallets.
    Child attributes 2
    • wallet_id string
      Marketplace wallet id.
    • pubkey string
      Wallet address, now in the caller's account.

Errors

StatusCodeWhen and what to do
404 not_found The quote does not exist or was created by another account. Use a quote id that Create a quote returned to this account.
409 conflict The quote reached expired, cancelled or failed and can never be delivered. Start a new purchase with Create a quote.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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.hushxima.deliverQuote(id) src/lib/proxima/endpoints/hushxima.ts

List purchases

Bearer JWT beta
GET /marketplace/purchases

Returns the caller's settled purchases, newest first.

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

Feeds the purchase history in the Marketplace and the wallet import pickers of the launch and funding flows.

Query parameters

  • limit integer Optional Default 50
    Maximum number of purchases. The web app always sends 100; the API defaults to 50 and caps at 500.

Returns 200 OK · application/json

Returns an array of Purchase objects.

Errors

StatusCodeWhen and what to do
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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

Web client proxima.hushxima.getPurchases() src/lib/proxima/endpoints/hushxima.ts

List purchase wallets

Bearer JWT beta
GET /marketplace/purchases/{purchase_id}/wallets

Returns the wallets bought in one of the caller's purchases.

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

The web app reads it to import a past order's wallets into a launch or a funding run.

Path parameters

Returns 200 OK · application/json

  • wallet_id string
    Marketplace wallet id.
  • pubkey string
    Wallet address.
  • user_price string
    Price paid for the wallet in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • age_days_at_sale string | null
    Wallet age in days at the time of sale, as a decimal string.

Errors

StatusCodeWhen and what to do
404 not_found The purchase does not exist or belongs to another license. Use a purchase id returned by List purchases.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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

Web client proxima.hushxima.getPurchaseWallets(id) src/lib/proxima/endpoints/hushxima.ts

GET /marketplace/wallets/by-pubkey/{pubkey}/tokens

Returns the tokens a delivered Marketplace wallet still holds, with any queued operations.

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

Used by the Sell all tokens panel, which is switched off in the current web app.

Path parameters

  • pubkey string Required
    Address of a wallet bought on the Marketplace and delivered to the caller's account (base58 on Solana, 0x address on EVM).

Returns 200 OK · application/json

  • wallet_id string
    Marketplace wallet id.
  • pubkey string
    Wallet address.
  • chain string
    Chain slug of the wallet.
  • count integer
    Number of tokens listed.
  • has_tokens boolean
    Whether the wallet holds any token.
  • has_sellable_tokens boolean
    Whether any token can be sold.
  • has_queued_sell boolean
    Whether a sell is already queued.
  • has_queued_withdraw boolean
    Whether a withdrawal is already queued.
  • native_balance string
    Native balance in the chain's smallest unit (lamports on Solana, wei on EVM chains), as an integer string.
  • total_usd_value number
    USD value of all tokens.
  • sellable_usd_value number
    USD value of the sellable part.
  • tokens array<object>
    Token positions.
    Child attributes 9
    • mint string
      Token mint or contract address.
    • symbol string | null
      Token symbol.
    • decimals integer
      Token decimals.
    • balance string
      Raw balance as an integer string.
    • ui_multiplier string | null
      Display multiplier scaled by 1e18.
    • usd_value number
      USD value of the balance.
    • sellable_balance string
      Raw sellable balance as an integer string.
    • sellable_usd_value number
      USD value of the sellable balance.
    • post_sale boolean
      true for a token received after the sale. The web app leaves these out of Sell all.
  • queued_operations array<object>
    Sells and withdrawals in progress on the wallet.
    Child attributes 7
    • id string
      Operation id.
    • kind string
      Operation kind.
    • mint string
      Token concerned.
    • status string
      Operation status.
    • to_address string
      Destination address.
    • tx_hash string
      Transaction, once sent.
    • created_at string
      Queue time.

Errors

StatusCodeWhen and what to do
404 not_found wallet not found: the address is not one of the caller's delivered Marketplace wallets. The web app skips these wallets silently. Use the address of a wallet imported by Deliver a quote.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Retry after a short wait; the failure is on the marketplace side.

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

Web client proxima.hushxima.getTokensByPubkey(pubkey) src/lib/proxima/endpoints/hushxima.ts

POST /marketplace/wallets/by-pubkey/{pubkey}/sell-all

Queues a sale of every token a delivered Marketplace wallet holds.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying A repeat queues a sale of whatever the wallet holds by then. Check has_queued_sell with Retrieve a bought wallet's tokens before retrying.

Takes no body. Returns the queued operation ids; follow them with Retrieve a bought wallet's tokens. A wallet that was paid for but not yet delivered is not addressable. The web app's caller sits in the Sell all tokens panel, which is switched off.

Path parameters

  • pubkey string Required
    Address of a wallet bought on the Marketplace and delivered to the caller's account (base58 on Solana, 0x address on EVM).

Returns 200 OK · application/json

  • wallet_id string
    Marketplace wallet id.
  • chain string
    Chain slug of the wallet.
  • tokens integer
    Number of tokens queued for sale.
  • operation_ids array<string>
    Ids of the queued sell operations.

Errors

StatusCodeWhen and what to do
404 not_found wallet not found: the address is not one of the caller's delivered Marketplace wallets. The web app skips these wallets silently. Use the address of a wallet imported by Deliver a quote.
422 upstream_failure The marketplace could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Check has_queued_sell with Retrieve a bought wallet's tokens before retrying.

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.hushxima.sellAllByPubkey(pubkey) src/lib/proxima/endpoints/hushxima.ts