Skip to content
API Reference

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

Wallet activity

Enroll wallets in activity farms that trade on their own across chains for a set duration.

Wallet activity enrolls wallets in farms. For the chosen duration, each wallet makes a random number of transactions per day on the chosen chains, buying and selling back in full, optionally toward a volume target and within a spend budget. Farms are run by the Hushxima marketplace service; Proxima validates the plan, checks that every wallet belongs to your account, and relays the call.

The flow is: read the presets for the supported chains and limits, estimate a plan for per-wallet feasibility and cost, then run it. List farms reports progress and Stop farms ends them early.

In the web app this is behind the walletActivityEnabled flag (on by default on the dev deployment only), where the Generate Activity button opens it instead of Generate activity.

A wallet enrolled in an activity farm, with its progress.

Attributes

  • pubkey string
    Wallet address.
  • network string
    Network of the wallet.
  • chains array<string>
    Chain IDs farmed.
  • state string
    running, stopped, finished, or another state reported by the farming service.
  • stop_reason string | null
    Why the farm stopped.
  • persona string | null
    Trading persona.
  • timezone string | null
    Timezone profile.
  • tier string | null
    Tier.
  • tx_per_day integer | null
    Transactions per day drawn for this wallet.
  • tx_count integer
    Transactions made so far.
  • balance string
    Current native balance, in base units.
  • start_balance string | null
    Native balance at enrollment, in base units.
  • started_at string
    ISO 8601 start time.
  • ends_at string
    ISO 8601 scheduled end time.
  • stopped_at string | null
    ISO 8601 stop time.
  • next_op_at string | null
    ISO 8601 time of the next planned operation.
  • duration_secs integer
    Planned duration in seconds.
  • continuous boolean
    Whether the farm runs continuously.
  • volume_reached_at string | null
    ISO 8601 time the volume target was reached.
  • budgets object
    Spend limit per chain ID, in native base units. A chain left out has no limit.
  • ops_completed integer
    Operations completed.
  • ops_failed integer
    Operations failed.
  • ops_pending integer
    Operations pending.
  • ops_skipped integer
    Operations skipped.
  • chain_stats array<object>
    Statistics per chain. Native amounts are base-unit decimal strings.
    Child attributes 19
    • chain string
      Chain ID.
    • volume string
      Volume traded.
    • volume_usd number
      Volume traded, in USD.
    • volume_target string | null
      Target volume.
    • volume_reached boolean
      Whether the target is reached.
    • buy_spent string
      Native spent on buys.
    • sell_received string
      Native received from sells.
    • fees string
      Fees paid.
    • fees_usd number
      Fees paid, in USD.
    • swap_loss string
      Value lost to swaps.
    • swap_loss_usd number
      Value lost to swaps, in USD.
    • native_usd number
      USD price of the native token.
    • recoverable object
      Value still held that can be recovered.
      Child attributes 3
      • tokens_value string
        Native value of tokens held.
      • tokens_unpriced array<string>
        Tokens held that could not be priced.
      • rent string
        Recoverable rent.
    • txs_confirmed integer
      Confirmed transactions.
    • txs_failed integer
      Failed transactions.
    • txs_pending_effect integer
      Transactions whose effect is not yet recorded.

One transaction made by a farm.

Attributes

  • id string
    Operation ID.
  • chain string
    Chain ID.
  • op_type string
    Operation type reported by the farming service.
  • status string
    confirmed, failed, or another status reported by the farming service.
  • tx_hash string | null
    Transaction hash or signature.
  • error string | null
    Failure reason.
  • token_mint string | null
    Token traded.
  • token_symbol string | null
    Symbol of the token traded.
  • native_spent string | null
    Native spent, in base units.
  • native_received string | null
    Native received, in base units.
  • fee_native string | null
    Fee paid, in native base units.
  • reverted boolean
    Whether the transaction reverted.
  • created_at string
    ISO 8601 creation time.
  • settled_at string | null
    ISO 8601 settlement time.

Retrieve activity presets

Bearer JWT beta
GET /activity/presets

Returns the chains a farm can run on and the request limits.

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

The web app loads it when the Generate Activity modal opens and shows an error state if it fails.

Parameters

No parameters.

Returns 200 OK · application/json

  • chains array<string>
    Chain IDs a farm can run on.
  • limits object
    Request limits.
    Child attributes 4
    • max_duration_days integer
      Longest duration in days.
    • max_duration_hours integer
      Longest duration in hours.
    • max_tx_per_day integer
      Highest tx_per_day_max.
    • max_wallets_per_request integer
      Most wallets per run.

Errors

StatusCodeWhen and what to do
422 upstream_failure The farming service could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Refusals the service states itself come back with its own status (400, 404, 409, 422 or 429) and message. Retry after a short wait; the failure is on the farming service's 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.walletActivity.getPresets() src/lib/proxima/endpoints/wallet-activity.ts

Estimate an activity plan

Bearer JWT beta
POST /activity/estimate

Returns per-wallet feasibility, planned volume and cost for a plan without enrolling anything.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Read-only: nothing is started.

Takes the same body as Run an activity plan. The web app calls it debounced while the plan is edited.

Body parameters application/json

  • wallets array<string> Required
    Wallets of the account to farm, SVM and EVM mixed. At most limits.max_wallets_per_request.
  • chains array<string> Required
    Chain IDs to farm on, from the presets.
  • tier string Optional
    Tier passed to the farming service. Not set by the web app.
  • tx_per_day_min integer Required
    Minimum transactions per day per wallet, at least 1.
  • tx_per_day_max integer Required
    Maximum transactions per day per wallet, at least tx_per_day_min and at most limits.max_tx_per_day.
  • duration_hours integer Optional
    Farm duration in hours. Send this or duration_days.
  • duration_days integer Optional
    Farm duration in days. Send this or duration_hours.
  • volume_target object Optional
    Target volume per chain ID, in native base units as positive decimal strings. Every key must be in chains.
  • budgets object Optional
    Spend limits per chain ID, in native base units. A wallet takes the budget of its home chain only: sol for a Solana wallet, the first EVM chain in chains for an EVM wallet. A budget on another EVM chain is accepted but not applied. Every key must be in chains.
    Child attributes 3
    • {chain_id} object Optional
      Spend limits on one chain, keyed by chain ID.
      Child attributes 2
      • min_native string Optional
        Minimum, in native base units.
      • max_native string Optional
        Maximum, in native base units. At least min_native.
  • budget_compound boolean Optional
    Passed to the farming service. Not set by the web app.
  • token_mints array<string> Optional
    Token addresses passed to the farming service. Not set by the web app.
  • token_inherit_default boolean Optional
    Passed to the farming service. Not set by the web app.

Returns 200 OK · application/json

  • feasible boolean
    Whether the whole plan can run.
  • continuous boolean
    Whether the farm runs continuously.
  • duration_secs integer
    Planned duration in seconds.
  • wallets array<object>
    Per-wallet estimate.
    Child attributes 18
    • address string
      Wallet address.
    • feasible boolean
      Whether this wallet can run the plan.
    • reasons array<object>
      Why the wallet is not feasible.
      Child attributes 2
      • code string
        Machine-readable reason.
      • message string
        Human-readable reason.
    • chains array<object>
      Estimate per chain. Native amounts are base-unit decimal strings.
      Child attributes 12
      • chain string
        Chain ID.
      • balance string
        Current native balance.
      • spendable string
        Balance the farm may use.
      • buy_size string
        Planned size of each buy.
      • planned_txs integer
        Planned transactions.
      • planned_buys integer
        Planned buys.
      • volume string
        Planned volume.
      • volume_usd number
        Planned volume, in USD.
      • fees string
        Expected fees.
      • swap_loss string
        Expected swap loss.
      • cost string
        Expected total cost.
      • cost_usd number
        Expected total cost, in USD.

Errors

StatusCodeWhen and what to do
400 bad_request The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again.
400 bad_request chains is empty. Send at least one chain.
400 bad_request A key of chains, budgets or volume_target is not a chain the API serves. Use chain IDs listed by Retrieve activity presets; monad is no longer accepted.
400 unsupported_chain A key of chains, budgets or volume_target is xlayer, which cannot be farmed. The body adds chain. Farm only chains listed by Retrieve activity presets.
400 bad_request tx_per_day_min is 0 or above tx_per_day_max. Keep tx_per_day_min between 1 and tx_per_day_max.
400 bad_request Neither duration_hours nor duration_days was sent. Send duration_hours or duration_days.
400 bad_request duration_hours or duration_days is 0. Send a duration of at least 1.
400 bad_request A budgets key is not in chains. Key budgets only by chains listed in chains.
400 bad_request A budget's min_native is above its max_native. Set min_native no higher than max_native.
400 bad_request A volume_target key is not in chains. Key volume_target only by chains listed in chains.
400 bad_request A volume_target value is neither a string nor a number. Send each target as a decimal string of base units.
400 bad_request A volume_target value is 0 or not a whole number of base units. Send each target as a positive whole number of base units.
400 bad_request wallets is empty or holds only blank strings. Send at least one wallet.
400 bad_request More than 200 distinct wallets were sent. Duplicates and blank entries are dropped before counting. Send at most 200 wallets per call.
404 not_found A wallet is not on the account. The whole request is refused. Use wallets from List wallets.
422 upstream_failure The farming service could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Refusals the service states itself come back with its own status (400, 404, 409, 422 or 429) and message. Retry after a short wait; the failure is on the farming service's 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.walletActivity.estimate(plan) src/lib/proxima/endpoints/wallet-activity.ts

Run an activity plan

Bearer JWT beta
POST /activity/run

Enrolls wallets in a farm according to a plan.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Check before retrying Before retrying, call List farms and check whether the wallets already have a running farm.

Wallets that cannot be enrolled are returned in skipped. The web app refreshes the farm list after the call.

Body parameters application/json

  • wallets array<string> Required
    Wallets of the account to farm, SVM and EVM mixed. At most limits.max_wallets_per_request.
  • chains array<string> Required
    Chain IDs to farm on, from the presets.
  • tier string Optional
    Tier passed to the farming service. Not set by the web app.
  • tx_per_day_min integer Required
    Minimum transactions per day per wallet, at least 1.
  • tx_per_day_max integer Required
    Maximum transactions per day per wallet, at least tx_per_day_min and at most limits.max_tx_per_day.
  • duration_hours integer Optional
    Farm duration in hours. Send this or duration_days.
  • duration_days integer Optional
    Farm duration in days. Send this or duration_hours.
  • volume_target object Optional
    Target volume per chain ID, in native base units as positive decimal strings. Every key must be in chains.
  • budgets object Optional
    Spend limits per chain ID, in native base units. A wallet takes the budget of its home chain only: sol for a Solana wallet, the first EVM chain in chains for an EVM wallet. A budget on another EVM chain is accepted but not applied. Every key must be in chains.
    Child attributes 3
    • {chain_id} object Optional
      Spend limits on one chain, keyed by chain ID.
      Child attributes 2
      • min_native string Optional
        Minimum, in native base units.
      • max_native string Optional
        Maximum, in native base units. At least min_native.
  • budget_compound boolean Optional
    Passed to the farming service. Not set by the web app.
  • token_mints array<string> Optional
    Token addresses passed to the farming service. Not set by the web app.
  • token_inherit_default boolean Optional
    Passed to the farming service. Not set by the web app.

Returns 200 OK · application/json

  • enrolled array<object>
    Wallets enrolled.
    Child attributes 7
    • pubkey string
      Wallet address.
    • chains array<string>
      Chain IDs farmed.
    • ends_at string
      ISO 8601 scheduled end time.
    • tx_per_day integer
      Transactions per day drawn for this wallet.
    • budgets object
      Spend limit per chain ID, in native base units. A chain left out has no limit.
    • purchased boolean
      Purchase flag reported by the farming service.
    • reenrolled boolean
      Whether the wallet was enrolled again rather than for the first time.
  • skipped array<object>
    Wallets not enrolled.
    Child attributes 2
    • reference string
      Wallet address or reference skipped.
    • reason string
      Why it was skipped.

Errors

StatusCodeWhen and what to do
400 bad_request The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again.
400 bad_request chains is empty. Send at least one chain.
400 bad_request A key of chains, budgets or volume_target is not a chain the API serves. Use chain IDs listed by Retrieve activity presets; monad is no longer accepted.
400 unsupported_chain A key of chains, budgets or volume_target is xlayer, which cannot be farmed. The body adds chain. Farm only chains listed by Retrieve activity presets.
400 bad_request tx_per_day_min is 0 or above tx_per_day_max. Keep tx_per_day_min between 1 and tx_per_day_max.
400 bad_request Neither duration_hours nor duration_days was sent. Send duration_hours or duration_days.
400 bad_request duration_hours or duration_days is 0. Send a duration of at least 1.
400 bad_request A budgets key is not in chains. Key budgets only by chains listed in chains.
400 bad_request A budget's min_native is above its max_native. Set min_native no higher than max_native.
400 bad_request A volume_target key is not in chains. Key volume_target only by chains listed in chains.
400 bad_request A volume_target value is neither a string nor a number. Send each target as a decimal string of base units.
400 bad_request A volume_target value is 0 or not a whole number of base units. Send each target as a positive whole number of base units.
400 bad_request wallets is empty or holds only blank strings. Send at least one wallet.
400 bad_request More than 200 distinct wallets were sent. Duplicates and blank entries are dropped before counting. Send at most 200 wallets per call.
404 not_found A wallet is not on the account. The whole request is refused. Use wallets from List wallets.
422 unprocessable A wallet is watch-only, so there is no key to hand to the farming service. The whole request is refused. Remove watch-only wallets from wallets.
422 upstream_failure The farming service could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Refusals the service states itself come back with its own status (400, 404, 409, 422 or 429) and message. Retry after a short wait; the failure is on the farming service's 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.walletActivity.run(plan) src/lib/proxima/endpoints/wallet-activity.ts

Stop farms

Bearer JWT beta
POST /activity/stop

Stops the farms of the given wallets.

Token
Upgraded session token, bound to a license.
Read-only tokens
Refused with 403 read_only_token.
Retry
Safe to retry Stopping a farm that is already stopped changes nothing.

Body parameters application/json

  • wallets array<string> Required
    Wallets of the account whose farm to stop. At most 200.
  • forget boolean Optional Default false
    Passed to the farming service with the stop. The web app always sends false.

Returns 200 OK · application/json

  • stopped array<string>
    Wallets stopped.
  • skipped array<object>
    Wallets not stopped.
    Child attributes 2
    • reference string
      Wallet address or reference skipped.
    • reason string
      Why it was skipped.

Errors

StatusCodeWhen and what to do
400 bad_request The body is not valid JSON, or a field is missing or has the wrong type. Fix the field named in message and send the request again.
400 bad_request wallets is empty or holds only blank strings. Send at least one wallet.
400 bad_request More than 200 distinct wallets were sent. Duplicates and blank entries are dropped before counting. Send at most 200 wallets per call.
404 not_found A wallet is not on the account. The whole request is refused. Use wallets from List wallets.
422 upstream_failure The farming service could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Refusals the service states itself come back with its own status (400, 404, 409, 422 or 429) and message. Retry after a short wait; the failure is on the farming service's 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.walletActivity.stop(wallets, forget?) src/lib/proxima/endpoints/wallet-activity.ts

List farms

Bearer JWT beta
GET /activity/farms

Returns the account's farms with their progress and per-chain stats.

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

The web app polls it every 15 seconds in pages of 50, re-reading every loaded page on each poll.

Query parameters

  • include_stopped boolean Optional Default false
    Also return stopped and finished farms.
  • limit integer Optional Default 200
    Page size, from 1 to 200; values outside are clamped. The web app sends 50.
  • offset integer Optional Default 0
    Number of farms to skip.

Returns 200 OK · application/json

Returns an array of Farm objects.

Errors

StatusCodeWhen and what to do
422 upstream_failure The farming service could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Refusals the service states itself come back with its own status (400, 404, 409, 422 or 429) and message. Retry after a short wait; the failure is on the farming service's 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.walletActivity.getFarms(includeStopped?, limit?, offset?) src/lib/proxima/endpoints/wallet-activity.ts

List farm operations

Bearer JWT beta
GET /activity/farms/{address}/ops

Returns the transactions made by one wallet's farm.

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

Path parameters

  • address string Required
    Wallet address. Must be a wallet of the account.
    ExampleC31EeqtSvpjYHFQxBoP9bBTpqtUWV2avNhjdaN1yem44

Query parameters

  • limit integer Optional Default 50
    Page size, from 1 to 200; values outside are clamped.
  • offset integer Optional Default 0
    Number of operations to skip.

Returns 200 OK · application/json

Returns an array of Farm operation objects.

Errors

StatusCodeWhen and what to do
404 not_found The wallet is not on the account. Use wallets from List wallets.
422 upstream_failure The farming service could not be reached, failed, or sent a body the API could not read. The body also carries service: "hushxima". Refusals the service states itself come back with its own status (400, 404, 409, 422 or 429) and message. Retry after a short wait; the failure is on the farming service's 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.walletActivity.getOps(address, limit?, offset?) src/lib/proxima/endpoints/wallet-activity.ts