- Arguments are the route’s parameters, flat: path and query parameters and the fields of the JSON body. Their names and types are in the tool’s
inputSchemaand in the API reference of the route. idempotency_keyis the route’sIdempotency-Keyheader, offered on every tool whose route takes one.- A result comes as
structuredContent(the route’s JSON answer; a list is wrapped as{"result": [...]}) and as the same JSON in a text block. - An error comes with
isError: trueand{"error": {"code", "message", "status"}}— the API’s own error code. - Hints: every tool carries
title,readOnlyHint,destructiveHintandopenWorldHint. Everything that spends the balance or turns on recurring spending is markeddestructiveHint: true, so clients ask before calling it.
spends — charges the balance at the call; recurring — turns on spending that runs by itself and needs recurring for a connected app; to balance — returns money to the balance.
Prices and estimates
| Tool | Permissions | Money | What it does |
|---|---|---|---|
get_energy_prices | none | — | Get energy prices (GET /api/v1/energy/prices) |
get_bandwidth_prices | none | — | Get bandwidth prices (GET /api/v1/bandwidth/prices) |
estimate_energy | none | — | Estimate energy for a transfer (POST /api/v1/energy/estimate) |
analyze_savings | none | — | Analyze an address’s savings (GET /api/v1/savings/analyze) |
Quotes
| Tool | Permissions | Money | What it does |
|---|---|---|---|
quote_energy | view | — | Quote energy at the account’s price (GET /api/v1/energy/quote/me) |
quote_bandwidth | view | — | Quote bandwidth at the account’s price (GET /api/v1/bandwidth/quote/me) |
Balance and history
| Tool | Permissions | Money | What it does |
|---|---|---|---|
get_balance | view | — | Get the account balance (GET /api/v1/account/balance) |
get_history | view | — | Get the balance history (GET /api/v1/account/history) |
get_report | view | — | Get an account report (GET /api/v1/account/reports/{report}) |
Address
| Tool | Permissions | Money | What it does |
|---|---|---|---|
check_address | view | — | Check a TRON address (GET /api/v1/tools/address-info) |
check_activation | view | — | Check address activation (GET /api/v1/tools/check-activation) |
Deposits
| Tool | Permissions | Money | What it does |
|---|---|---|---|
get_deposit_address | deposit_view | — | Get the deposit address (GET /api/v1/account/deposit) |
list_deposits | deposit_view | — | List deposits (GET /api/v1/account/deposits) |
new_deposit_address | deposit_view | — | New deposit address (POST /api/v1/account/deposit/new-address) |
create_crypto_deposit | deposit_view | — | Deposit in another coin (POST /api/v1/nowpayments/deposit) |
get_crypto_deposit | deposit_view | — | Get a coin deposit’s status (GET /api/v1/nowpayments/deposit/{deposit_id}/status) |
Energy
| Tool | Permissions | Money | What it does |
|---|---|---|---|
buy_energy | buy_energy | spends | Buy energy (POST /api/v1/energy/buy) |
activate_address | buy_energy | spends | Activate a TRON address (POST /api/v1/energy/activate) |
Bandwidth
| Tool | Permissions | Money | What it does |
|---|---|---|---|
buy_bandwidth | buy_bandwidth | spends | Buy bandwidth (POST /api/v1/bandwidth/buy) |
reclaim_order | buy_bandwidth | — | Reclaim a bandwidth order (POST /api/v1/orders/{order_id}/reclaim) |
Auto bandwidth
| Tool | Permissions | Money | What it does |
|---|---|---|---|
quote_auto_bw | buy_bandwidth | — | Quote auto bandwidth (GET /api/v1/bandwidth/auto/quote) |
list_auto_bw | buy_bandwidth | — | List auto bandwidth (GET /api/v1/bandwidth/auto) |
create_auto_bw | buy_bandwidth + recurring | recurring | Start auto bandwidth (POST /api/v1/bandwidth/auto) |
update_auto_bw | buy_bandwidth + recurring | recurring | Change auto bandwidth (PATCH /api/v1/bandwidth/auto/{sub_id}) |
delete_auto_bw | buy_bandwidth | — | Stop auto bandwidth (DELETE /api/v1/bandwidth/auto/{sub_id}) |
list_auto_bw_contracts | buy_bandwidth | — | List auto bandwidth contracts (GET /api/v1/bandwidth/auto/contracts) |
add_auto_bw_contract | buy_bandwidth + recurring | recurring | Add an auto bandwidth contract (POST /api/v1/bandwidth/auto/contracts) |
remove_auto_bw_contract | buy_bandwidth | — | Remove an auto bandwidth contract (DELETE /api/v1/bandwidth/auto/contracts/{address}) |
Auto-refill
| Tool | Permissions | Money | What it does |
|---|---|---|---|
quote_energy_autorefill | buy_energy | — | Quote energy auto-refill (GET /api/v1/energy/auto-refill/quote) |
list_energy_autorefill | buy_energy | — | List energy auto-refill (GET /api/v1/energy/auto-refill) |
create_energy_autorefill | buy_energy + recurring | recurring | Start energy auto-refill (POST /api/v1/energy/auto-refill) |
update_energy_autorefill | buy_energy + recurring | recurring | Change energy auto-refill (PATCH /api/v1/energy/auto-refill/{rule_id}) |
delete_energy_autorefill | buy_energy | — | Stop energy auto-refill (DELETE /api/v1/energy/auto-refill/{rule_id}) |
quote_bandwidth_autorefill | buy_bandwidth | — | Quote bandwidth auto-refill (GET /api/v1/bandwidth/auto-refill/quote) |
list_bandwidth_autorefill | buy_bandwidth | — | List bandwidth auto-refill (GET /api/v1/bandwidth/auto-refill) |
create_bandwidth_autorefill | buy_bandwidth + recurring | recurring | Start bandwidth auto-refill (POST /api/v1/bandwidth/auto-refill) |
update_bandwidth_autorefill | buy_bandwidth + recurring | recurring | Change bandwidth auto-refill (PATCH /api/v1/bandwidth/auto-refill/{rule_id}) |
delete_bandwidth_autorefill | buy_bandwidth | — | Stop bandwidth auto-refill (DELETE /api/v1/bandwidth/auto-refill/{rule_id}) |
Orders
| Tool | Permissions | Money | What it does |
|---|---|---|---|
list_orders | view | — | List orders (GET /api/v1/orders) |
get_order | view | — | Get an order (GET /api/v1/orders/{order_id}) |
Smart Mode
| Tool | Permissions | Money | What it does |
|---|---|---|---|
get_smart_mode_fees | smart_mode | — | Get Smart Mode fees (GET /api/v1/smart-mode/fees) |
list_smart_mode | smart_mode | — | List Smart Mode addresses (GET /api/v1/smart-mode/subscriptions) |
get_smart_mode | smart_mode | — | Get a Smart Mode address (GET /api/v1/smart-mode/{sub_id}) |
list_smart_mode_events | smart_mode | — | List Smart Mode events (GET /api/v1/smart-mode/events) |
activate_smart_mode | smart_mode + recurring | recurring | Start Smart Mode (POST /api/v1/smart-mode/activate) |
update_smart_mode | smart_mode + recurring | recurring | Change Smart Mode (PATCH /api/v1/smart-mode/{sub_id}) |
pause_smart_mode | smart_mode + recurring | recurring | Pause or resume Smart Mode (POST /api/v1/smart-mode/{sub_id}/toggle) |
deactivate_smart_mode | smart_mode | — | Stop Smart Mode (POST /api/v1/smart-mode/{sub_id}/deactivate) |
reactivate_smart_mode | smart_mode + recurring | recurring | Restart Smart Mode (POST /api/v1/smart-mode/{sub_id}/reactivate) |
delete_smart_mode | smart_mode | — | Delete a Smart Mode address (POST /api/v1/smart-mode/{sub_id}/delete) |
Transfer packages
| Tool | Permissions | Money | What it does |
|---|---|---|---|
list_package_tiers | transfer_packages | — | List package tiers (GET /api/v1/transfer-packages/tiers) |
check_package | transfer_packages | — | Check an address’s package (GET /api/v1/transfer-packages/check/{address}) |
list_my_packages | transfer_packages | — | List my packages (GET /api/v1/transfer-packages/my) |
buy_package | transfer_packages | spends | Buy a transfer package (POST /api/v1/transfer-packages/buy) |
cancel_package | transfer_packages | — | Cancel an unpaid package (POST /api/v1/transfer-packages/{package_id}/cancel) |
create_package_invoice | transfer_packages | — | Invoice for a package (POST /api/v1/transfer-packages/buy-invoice) |
Invoices
| Tool | Permissions | Money | What it does |
|---|---|---|---|
create_invoice | buy_energy | — | Create an invoice (POST /api/v1/invoices) |
list_my_invoices | buy_energy | — | List my invoices (GET /api/v1/invoices/my) |
get_invoice | buy_energy | — | Get an invoice (GET /api/v1/invoices/{invoice_id}) |
send_invoice_email | buy_energy | — | Email an invoice (POST /api/v1/invoices/{invoice_id}/send-email) |
Broadcaster
| Tool | Permissions | Money | What it does |
|---|---|---|---|
get_broadcaster_quota | view | — | Get the broadcaster quota (GET /api/v1/broadcast/slugs/quota) |
list_broadcast_events | view | — | List broadcaster events (GET /api/v1/broadcast/events) |
list_broadcast_slugs | broadcaster | — | List broadcaster nodes (GET /api/v1/broadcast/slugs) |
create_broadcast_slug | broadcaster + recurring | recurring | Create a broadcaster node (POST /api/v1/broadcast/slugs) |
update_broadcast_slug | broadcaster + recurring | recurring | Change a broadcaster node (PATCH /api/v1/broadcast/slugs/{slug_id}) |
delete_broadcast_slug | broadcaster | — | Delete a broadcaster node (DELETE /api/v1/broadcast/slugs/{slug_id}) |
Energy Resale
| Tool | Permissions | Money | What it does |
|---|---|---|---|
list_resale_addresses | energy_resale | — | List resale addresses (GET /api/v1/sublease/addresses) |
get_resale | energy_resale | — | Get a resale address (GET /api/v1/sublease/{sub_id}) |
get_resale_balance | energy_resale | — | Get a resale balance (GET /api/v1/sublease/{sub_id}/balance) |
get_resale_logs | energy_resale | — | Get resale logs (GET /api/v1/sublease/{sub_id}/logs) |
activate_resale | energy_resale + recurring | recurring | Start Energy Resale (POST /api/v1/sublease/activate) |
generate_resale_address | energy_resale + recurring | recurring | Generate a resale address (POST /api/v1/sublease/generate) |
update_resale | energy_resale + recurring | recurring | Change Energy Resale (PATCH /api/v1/sublease/{sub_id}) |
deactivate_resale | energy_resale | — | Stop Energy Resale (POST /api/v1/sublease/{sub_id}/deactivate) |
reset_resale_stats | energy_resale | — | Reset resale stats (POST /api/v1/sublease/{sub_id}/reset-stats) |
collect_resale_profit | energy_resale | to balance | Collect resale profit (POST /api/v1/sublease/{sub_id}/collect) |
Withdrawal
| Tool | Permissions | Money | What it does |
|---|---|---|---|
get_withdrawal_fee | view + API key only | — | Get the withdrawal fee (GET /api/v1/account/withdrawal-fee) |
list_withdrawals | view + API key only | — | List withdrawals (GET /api/v1/account/withdrawals) |
get_withdrawal | view + API key only | — | Get a withdrawal (GET /api/v1/account/withdrawals/{withdrawal_id}) |
lock_withdrawal_rate | withdraw + API key only | — | Lock a USDT withdrawal rate (POST /api/v1/account/withdrawal/rate-lock) |
withdraw | withdraw + API key only | withdrawal | Withdraw funds (POST /api/v1/account/withdrawal) |
Staking
| Tool | Permissions | Money | What it does |
|---|---|---|---|
list_stakes | view | — | List stakes (GET /api/v1/account/stakes) |
get_staking_rewards | view | — | Get staking rewards (GET /api/v1/account/staking-rewards) |
get_staking_params | view | — | Get staking parameters (GET /api/v1/staking/network-params) |
stake | staking | spends | Stake TRX (POST /api/v1/account/stake) |
unstake | staking | to balance | Unstake a position (POST /api/v1/account/stake/{position_id}/unstake) |
cancel_unstake | staking | — | Cancel an unstake (POST /api/v1/account/stake/{position_id}/cancel-unstake) |
claim_stake | staking | to balance | Claim a position (POST /api/v1/account/stake/{position_id}/claim) |
claim_staking_rewards | staking | to balance | Claim staking rewards (POST /api/v1/account/staking-rewards/claim) |
set_staking_auto_claim | staking | — | Set reward auto-claim (PATCH /api/v1/account/staking-rewards/auto-claim) |
Node API
| Tool | Permissions | Money | What it does |
|---|---|---|---|
list_node_plans | view | — | List Node API plans (GET /api/v1/node-api/plans) |
get_node_subscription | view | — | Get the Node API plan (GET /api/v1/node-api/subscription) |
get_node_usage | view | — | Get Node API usage (GET /api/v1/node-api/usage) |
list_node_charges | view | — | List Node API charges (GET /api/v1/node-api/charges) |
buy_node_plan | node_api_plan + recurring | recurring | Buy a Node API plan (POST /api/v1/node-api/subscription) |
start_node_trial | node_api_plan | — | Start a Node API trial (POST /api/v1/node-api/trial) |
set_node_renewal | node_api_plan + recurring | recurring | Set Node API auto-renewal (PATCH /api/v1/node-api/subscription) |