CLI Command Reference#
This page is generated from the Agent API endpoint catalog and the @hightop/cli command-shaping rules. It documents 85 generated command rows plus the standalone raw, simulate, and operation-wait commands. Current package versions: @hightop/cli@0.1.4 and @hightop/sdk@0.1.4.
Configuration#
| Input | Purpose |
|---|---|
HIGHTOP_BASE_URL / --base-url | Agent API base URL. Defaults are not loaded from .env; export variables in the shell. |
HIGHTOP_AGENT_ID + HIGHTOP_API_KEY | Header-key auth. Use both together and do not combine with bearer auth. |
HIGHTOP_BEARER_TOKEN | OAuth bearer token auth. Use instead of header-key auth. |
HIGHTOP_TIMEOUT_MS / --timeout-ms | Request timeout in milliseconds. |
--pretty | Pretty-print JSON output. |
--help | Show global, group, or command-specific help. |
Boolean request fields currently parsed as boolean flags:
--allow-conversion, --allow-partial, --enabled, --move-all, --remove-all, --repay-all, --to-best-available, --use-available-cash-first, --use-best-available, --withdraw-all
Generated Endpoint Commands#
| Command | Endpoint | Request flags | Submit options | Description |
|---|---|---|---|---|
hightop account | GET /v1/agent/account | none | none | Return a scoped account summary for the authenticated agent wallet. |
hightop activity | GET /v1/agent/activity | --cursor, --limit, --type, --since | none | List scoped Activity rows for the authenticated agent wallet without marking them read. |
hightop activity list | GET /v1/agent/activity | --cursor, --limit, --type, --since | none | List scoped Activity rows for the authenticated agent wallet without marking them read. |
hightop assets | GET /v1/agent/assets | --cursor, --limit | none | List assets visible to the authenticated agent. |
hightop assets list | GET /v1/agent/assets | --cursor, --limit | none | List assets visible to the authenticated agent. |
hightop balances | GET /v1/agent/balances | --cursor, --limit | none | List balances for the authenticated agent wallet. |
hightop balances cash | GET /v1/agent/balances/cash | --cursor, --limit | none | List cash balances for the authenticated agent wallet. |
hightop balances cash list | GET /v1/agent/balances/cash | --cursor, --limit | none | List cash balances for the authenticated agent wallet. |
hightop balances list | GET /v1/agent/balances | --cursor, --limit | none | List balances for the authenticated agent wallet. |
hightop borrow | GET /v1/agent/borrow | none | none | Return borrow summary for the authenticated agent wallet. |
hightop borrow collateral | GET /v1/agent/borrow/collateral | --cursor, --limit | none | List collateral for the authenticated agent wallet. |
hightop borrow collateral add | POST /v1/agent/borrow/collateral/add | --asset, --source-asset, --allow-conversion, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a collateral add operation. |
hightop borrow collateral list | GET /v1/agent/borrow/collateral | --cursor, --limit | none | List collateral for the authenticated agent wallet. |
hightop borrow collateral remove | POST /v1/agent/borrow/collateral/remove | --asset, --remove-all, --max-ltv-after, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a collateral remove operation. |
hightop borrow create | POST /v1/agent/borrow | --asset, --max-ltv-after, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a borrow operation for USDC or GREEN. |
hightop borrow deleverage | POST /v1/agent/borrow/deleverage | --target-ltv, --max-repay-amount-usd, --source-asset, --use-available-cash-first, --allow-conversion, --allow-partial | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a target-LTV deleverage operation. |
hightop borrow repay | POST /v1/agent/borrow/repay | --asset, --repay-all, --source-asset, --allow-conversion, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a debt repayment operation. |
hightop capabilities | GET /v1/agent/capabilities | none | none | Return Agent API capabilities for the authenticated agent. |
hightop capabilities json | GET /v1/agent/capabilities.json | none | none | Return Agent API capabilities as JSON. |
hightop conversions | GET /v1/agent/conversions | --cursor, --limit | none | List conversion operations for the authenticated agent. |
hightop conversions execute | POST /v1/agent/conversions | --quote-id | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Execute a conversion from a quote. |
hightop conversions get <id> | GET /v1/agent/conversions/{id} | --include | none | Get one conversion operation for the authenticated agent. |
hightop conversions list | GET /v1/agent/conversions | --cursor, --limit | none | List conversion operations for the authenticated agent. |
hightop conversions quote | POST /v1/agent/conversions/quote | --from-asset, --to-asset, --from-vault-address, --to-vault-address, --slippage-percent, --amount, --amount-usd | --idempotency-key, --simulate | Create a stateful conversion quote. |
hightop deposit-address | GET /v1/agent/deposit-address | --asset, --chain | none | Return a Base deposit address for an asset. |
hightop deposit-methods | GET /v1/agent/deposit-methods | --cursor, --limit | none | List deposit methods for the authenticated agent wallet. |
hightop deposit-methods list | GET /v1/agent/deposit-methods | --cursor, --limit | none | List deposit methods for the authenticated agent wallet. |
hightop earn | GET /v1/agent/earn | --cursor, --limit | none | List earn positions for the authenticated agent wallet. |
hightop earn deposit | POST /v1/agent/earn/deposit | --asset, --vault-id, --use-best-available, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create an earn deposit operation. |
hightop earn get <id> | GET /v1/agent/earn/{id} | none | none | Get one earn position for the authenticated agent wallet. |
hightop earn list | GET /v1/agent/earn | --cursor, --limit | none | List earn positions for the authenticated agent wallet. |
hightop earn move | POST /v1/agent/earn/move | --from-position-id, --move-all, --to-vault-id, --to-best-available, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create an earn move operation. |
hightop earn opportunities | GET /v1/agent/earn/opportunities | --cursor, --limit | none | List earn opportunities available to the authenticated agent. |
hightop earn opportunities list | GET /v1/agent/earn/opportunities | --cursor, --limit | none | List earn opportunities available to the authenticated agent. |
hightop earn rewards claim | POST /v1/agent/earn/rewards/claim | --protocols | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a rewards claim operation. |
hightop earn withdraw | POST /v1/agent/earn/withdraw | --position-id, --withdraw-all, --destination-asset, --allow-conversion, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create an earn withdrawal operation. |
hightop one-off-payments | GET /v1/agent/one-off-payments | --cursor, --limit | none | List one-off payment operations for the authenticated agent. |
hightop one-off-payments create | POST /v1/agent/one-off-payments | --to, --asset, --note, --unlock-delay-seconds, --expires-in-seconds, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a one-off payment operation. |
hightop one-off-payments get <id> | GET /v1/agent/one-off-payments/{id} | --include | none | Get a one-off payment operation for the authenticated agent. |
hightop one-off-payments list | GET /v1/agent/one-off-payments | --cursor, --limit | none | List one-off payment operations for the authenticated agent. |
hightop openapi | GET /v1/agent/openapi.json | none | none | Return the public Agent API OpenAPI document. |
hightop operations | GET /v1/agent/operations | --cursor, --limit, --status, --type, --since | none | List AgentOperation rows for the authenticated agent. |
hightop operations get <id> | GET /v1/agent/operations/{id} | --include | none | Get one AgentOperation for the authenticated agent. |
hightop operations list | GET /v1/agent/operations | --cursor, --limit, --status, --type, --since | none | List AgentOperation rows for the authenticated agent. |
hightop payments | GET /v1/agent/payments | --cursor, --limit | none | List payment operations for the authenticated agent. |
hightop payments create | POST /v1/agent/payments | --to, --asset, --deliver-as, --note, --slippage-percent, --prefer, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a payment operation. |
hightop payments get <id> | GET /v1/agent/payments/{id} | --include | none | Get one payment operation for the authenticated agent. |
hightop payments list | GET /v1/agent/payments | --cursor, --limit | none | List payment operations for the authenticated agent. |
hightop protocols | GET /v1/agent/protocols | --cursor, --limit | none | List protocols visible to the authenticated agent. |
hightop protocols list | GET /v1/agent/protocols | --cursor, --limit | none | List protocols visible to the authenticated agent. |
hightop recipients | GET /v1/agent/recipients | --cursor, --limit | none | List payment recipients visible to the authenticated agent wallet. |
hightop recipients get <id> | GET /v1/agent/recipients/{id} | none | none | Get one recipient visible to the authenticated agent wallet. |
hightop recipients list | GET /v1/agent/recipients | --cursor, --limit | none | List payment recipients visible to the authenticated agent wallet. |
hightop recipients resolve | POST /v1/agent/recipients/resolve | --to, --asset, --action | none | Resolve an agent-facing recipient identifier. |
hightop recurring-payments | GET /v1/agent/recurring-payments | --cursor, --limit | none | List recurring payment recipients visible to the authenticated agent wallet. |
hightop recurring-payments get <id> | GET /v1/agent/recurring-payments/{id} | none | none | Get one recurring payment recipient visible to the authenticated agent wallet. |
hightop recurring-payments list | GET /v1/agent/recurring-payments | --cursor, --limit | none | List recurring payment recipients visible to the authenticated agent wallet. |
hightop self | GET /v1/agent/self | none | none | Return the authenticated agent and scoped wallet context. |
hightop self usage | GET /v1/agent/self/usage | none | none | Return current Agent API rate-limit and usage state. |
hightop trusted-destinations | GET /v1/agent/trusted-destinations | --cursor, --limit | none | List trusted destinations visible to the authenticated agent wallet. |
hightop trusted-destinations cancel <id> | POST /v1/agent/trusted-destinations/{id}/cancel | none | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Cancel a pending trusted destination for the authenticated agent wallet. |
hightop trusted-destinations confirm <id> | POST /v1/agent/trusted-destinations/{id}/confirm | none | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Confirm a pending trusted destination for the authenticated agent wallet. |
hightop trusted-destinations delete <id> | DELETE /v1/agent/trusted-destinations/{id} | none | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Remove a trusted destination from the authenticated agent wallet. |
hightop trusted-destinations get <id> | GET /v1/agent/trusted-destinations/{id} | none | none | Get one trusted destination visible to the authenticated agent wallet. |
hightop trusted-destinations list | GET /v1/agent/trusted-destinations | --cursor, --limit | none | List trusted destinations visible to the authenticated agent wallet. |
hightop usage | GET /v1/agent/self/usage | none | none | Return current Agent API rate-limit and usage state. |
hightop webhooks | GET /v1/agent/webhooks | --cursor, --limit | none | List outbound webhook endpoints for the authenticated agent. |
hightop webhooks create | POST /v1/agent/webhooks | --url, --description, --event-types | --idempotency-key | Create an outbound webhook endpoint. |
hightop webhooks delete <id> | DELETE /v1/agent/webhooks/{id} | none | --idempotency-key | Delete or disable an outbound webhook endpoint. |
hightop webhooks deliveries <id> | GET /v1/agent/webhooks/{id}/deliveries | --cursor, --limit, --status, --event-id | none | List webhook delivery attempts for one outbound webhook endpoint. |
hightop webhooks get <id> | GET /v1/agent/webhooks/{id} | --include | none | Get one outbound webhook endpoint for the authenticated agent. |
hightop webhooks list | GET /v1/agent/webhooks | --cursor, --limit | none | List outbound webhook endpoints for the authenticated agent. |
hightop webhooks rotate-secret <id> | POST /v1/agent/webhooks/{id}/rotate-secret | none | --idempotency-key | Rotate an outbound webhook signing secret. |
hightop webhooks test <id> | POST /v1/agent/webhooks/{id}/test | none | --idempotency-key | Send a webhook.test delivery to an outbound webhook endpoint. |
hightop webhooks update <id> | PATCH /v1/agent/webhooks/{id} | --url, --description, --event-types, --enabled | --idempotency-key | Update an outbound webhook endpoint. |
hightop withdrawal-methods | GET /v1/agent/withdrawal-methods | --cursor, --limit | none | List withdrawal methods visible to the authenticated agent wallet. |
hightop withdrawal-methods list | GET /v1/agent/withdrawal-methods | --cursor, --limit | none | List withdrawal methods visible to the authenticated agent wallet. |
hightop withdrawals | GET /v1/agent/withdrawals | --cursor, --limit | none | List withdrawal operations for the authenticated agent. |
hightop withdrawals get <id> | GET /v1/agent/withdrawals/{id} | --include | none | Get one withdrawal operation for the authenticated agent. |
hightop withdrawals list | GET /v1/agent/withdrawals | --cursor, --limit | none | List withdrawal operations for the authenticated agent. |
hightop withdrawals to-bank | POST /v1/agent/withdrawals/to-bank | --method-id, --asset, --note, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a bank withdrawal operation. |
hightop withdrawals to-crypto | POST /v1/agent/withdrawals/to-crypto | --destination-id, --asset, --note, --amount, --amount-usd | --idempotency-key, --simulate, --wait, --wait-timeout-ms | Create a crypto withdrawal operation. |
hightop x402 purchase | POST /v1/agent/x402/purchase | --url, --method, --body, --max-amount | --idempotency-key, --wait, --wait-timeout-ms | Fetch a URL, satisfy an x402 challenge when required, and return the upstream response. |
hightop x402 quote | POST /v1/agent/x402/quote | --url, --method, --body, --timeout-ms | none | Fetch a URL and return its supported x402 price without paying. |
hightop x402 sign | POST /v1/agent/x402/sign | --payment-requirements, --pay-to, --amount, --target-url, --max-timeout-seconds | --idempotency-key, --wait, --wait-timeout-ms | Sign a Base USDC x402 payment authorization from an x402 payment requirement. |
Standalone Commands#
| Command | Purpose | Important flags |
|---|---|---|
hightop raw <method> <path> | Call a known /v1/agent/* route directly. The SDK still validates known-route and idempotency requirements. | --query key=value, --body '{"field":"value"}', --idempotency-key <key> |
hightop simulate <method> <path> | Call POST /v1/agent/simulate for a supported write route without broadcasting. | --body '{"field":"value"}' |
hightop operations wait <id> | Poll an operation until it reaches a terminal status or times out. | --timeout-ms <ms>, --poll-interval-ms <ms> |