Tools
A query reads; nothing leaves the process. An action drafts a transaction group that a human approves and a wallet signs; in compose mode it returns the unsigned group. Every tool is callable the same way from MCP, the agent, vibekit tool <name>, and POST /tools/<name>.
Queries (29)
Section titled “Queries (29)”get_network
Section titled “get_network”Get this deployment’s network configuration: which networks are served, the default network, endpoints, and signing mode. Use to orient before network-specific calls.
No parameters.
get_network_status
Section titled “get_network_status”Get network health dashboard: current round, TPS, block time, supply, participation. Use when users ask about network status, health, metrics, or stats.
No parameters.
lookup_block
Section titled “lookup_block”Look up a block by its round number. Omit round for the latest. Returns header facts and type totals only — not the transactions. To list or filter that round, call search_transactions with minRound and maxRound set to the round; add txType (pay, axfer, appl) to filter.
| parameter | type | required | description |
|---|---|---|---|
round | number | The round number of the block (omit for latest) |
search_block_headers
Section titled “search_block_headers”Search blocks by time or round range. Useful for finding recent blocks or blocks in a time window.
| parameter | type | required | description |
|---|---|---|---|
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
minRound | number | Include blocks at or after this round | |
maxRound | number | Include blocks at or before this round | |
beforeTime | string | Include blocks before this RFC 3339 time | |
afterTime | string | Include blocks after this RFC 3339 time |
lookup_account
Section titled “lookup_account”Get detailed information about an Algorand account by address, including balance, assets, and participation status
| parameter | type | required | description |
|---|---|---|---|
address | string | yes | The Algorand address to look up |
batch_lookup_accounts
Section titled “batch_lookup_accounts”Look up multiple Algorand accounts at once. Prefer this over repeated single lookup_account calls when looking up 2 or more addresses.
| parameter | type | required | description |
|---|---|---|---|
addresses | array | yes | The Algorand addresses to look up |
search_accounts
Section titled “search_accounts”Search for accounts by criteria like asset held, minimum balance, or application opted in
| parameter | type | required | description |
|---|---|---|---|
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
assetId | number | Filter by accounts holding this asset | |
applicationId | number | Filter by accounts opted into this app | |
currencyGreaterThan | number | Min balance in microAlgos | |
currencyLessThan | number | Max balance in microAlgos |
search_account_transactions
Section titled “search_account_transactions”Search one account’s transactions, NEWEST first (the opposite of search_transactions); nextToken walks back in time. Narrow with txType, assetId, addressRole (sender or receiver), rounds, or times before paging. For the account’s EARLIEST activity do not page from the top: take createdAtRound from lookup_account and search with minRound=createdAtRound and maxRound=createdAtRound+100000 — the last rows of that window are its first transactions.
| parameter | type | required | description |
|---|---|---|---|
address | string | yes | The Algorand address |
addressRole | sender | receiver | Only transactions where the address was the sender or the receiver; unset means either. ‘receiver’ finds what an account was given. | |
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token from a previous response | |
assetId | number | Filter by asset ID | |
txType | pay | keyreg | acfg | axfer | afrz | appl | stpf | hb | Filter by transaction type | |
minRound | number | Include results at or after this round | |
maxRound | number | Include results at or before this round | |
beforeTime | string | Include results before this RFC 3339 time | |
afterTime | string | Include results after this RFC 3339 time | |
minAmount | number | Filter by minimum amount (microAlgos) | |
maxAmount | number | Filter by maximum amount (microAlgos, inclusive) | |
notePrefix | string | Only transactions whose note starts with this UTF-8 text (e.g. a protocol tag) |
get_account_assets
Section titled “get_account_assets”Get all assets held by an account
| parameter | type | required | description |
|---|---|---|---|
address | string | yes | The Algorand address |
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token |
get_account_app_local_states
Section titled “get_account_app_local_states”Get application local state for an account (the key-value data stored by apps the account has opted into)
| parameter | type | required | description |
|---|---|---|---|
address | string | yes | The Algorand address |
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
applicationId | number | Filter by specific application ID |
get_account_portfolio
Section titled “get_account_portfolio”Get an account portfolio with all asset holdings and ALGO balance.
| parameter | type | required | description |
|---|---|---|---|
address | string | yes | Algorand address |
lookup_asset
Section titled “lookup_asset”Look up an Algorand Standard Asset (ASA) by its ID via the indexer: params plus creation round; a destroyed asset still resolves. Common ASA IDs: USDC=31566704, USDT=312769, goETH=386192725, goBTC=386195940. get_asset_info is the algod view of the same asset.
| parameter | type | required | description |
|---|---|---|---|
assetId | number | yes | The asset ID to look up |
top_asset_holders
Section titled “top_asset_holders”The largest holders of an asset, sorted by balance — scans every holder via the indexer, so it is authoritative. Use for “top holders”, “biggest bags”, “whale watch”, or concentration questions. Not paginated; ask for a bigger limit instead. minBalance/maxBalance (raw base units) narrow the set — “who holds more than N”.
| parameter | type | required | description |
|---|---|---|---|
assetId | number | yes | The asset ID |
limit | number | How many top holders to return (default 10, max 100) | |
minBalance | number | Only holders with more than this (raw base units) | |
maxBalance | number | Only holders with less than this (raw base units) |
search_asset_transactions
Section titled “search_asset_transactions”Search transactions for a specific asset
| parameter | type | required | description |
|---|---|---|---|
assetId | number | yes | The asset ID |
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
beforeTime | string | Include results before this RFC 3339 time | |
afterTime | string | Include results after this RFC 3339 time | |
minAmount | number | Filter by minimum amount (microAlgos) | |
maxAmount | number | Filter by maximum amount (microAlgos, inclusive) | |
notePrefix | string | Only transactions whose note starts with this UTF-8 text (e.g. a protocol tag) |
search_assets
Section titled “search_assets”Search for assets by name, unit name, or creator address
| parameter | type | required | description |
|---|---|---|---|
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
name | string | Filter by asset name (exact match) | |
unit | string | Filter by asset unit name (exact match) | |
creator | string | Filter by creator address |
get_asset_info
Section titled “get_asset_info”An asset’s current parameters straight from algod (name, supply, roles, frozen state); fails once the asset is destroyed. Same shape as lookup_asset, which is the indexer view.
| parameter | type | required | description |
|---|---|---|---|
assetId | number | yes | The asset ID |
lookup_transaction
Section titled “lookup_transaction”Look up a single transaction by its ID
| parameter | type | required | description |
|---|---|---|---|
txid | string | yes | The transaction ID to look up |
search_transactions
Section titled “search_transactions”Search transactions and render a transaction list card. Results come OLDEST first within the bounds you set, and nextToken walks forward. Always bound a search: set minRound or a round/time window — an unbounded txType-only search times out at the indexer. For the LATEST activity, keep the window tiny: minRound = the current round from get_network_status minus 30, read the last row, and only widen (×4) if the page came back empty — a wide window fills pages with old rows before it reaches the tip. To list a block, set minRound and maxRound to that round. To filter by kind, set txType (pay, axfer, appl, …). For one account use search_account_transactions. Do not recap results as markdown — the list card is the answer.
| parameter | type | required | description |
|---|---|---|---|
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
txType | pay | keyreg | acfg | axfer | afrz | appl | stpf | hb | Filter by transaction type | |
assetId | number | Filter by asset ID | |
minRound | number | Include results at or after this round | |
maxRound | number | Include results at or before this round | |
beforeTime | string | Include results before this RFC 3339 time | |
afterTime | string | Include results after this RFC 3339 time | |
minAmount | number | Filter by minimum amount (microAlgos) | |
maxAmount | number | Filter by maximum amount (microAlgos, inclusive) | |
applicationId | number | Filter by application ID | |
notePrefix | string | Only transactions whose note starts with this UTF-8 text (e.g. a protocol tag) |
lookup_transaction_group
Section titled “lookup_transaction_group”Look up all transactions in an atomic transaction group by group ID. The group ID is the base64 of the 32-byte group hash (44 characters, trailing =), as shown on a transaction card.
| parameter | type | required | description |
|---|---|---|---|
groupId | string | yes | The base64-encoded 32-byte group ID |
lookup_application
Section titled “lookup_application”Look up an application by its ID via the indexer: creator, global state, schemas. get_application_info is the algod view; call one, not both.
| parameter | type | required | description |
|---|---|---|---|
applicationId | number | yes | The application ID to look up |
search_applications
Section titled “search_applications”Search for applications by creator address
| parameter | type | required | description |
|---|---|---|---|
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
creator | string | Filter by creator address |
lookup_application_logs
Section titled “lookup_application_logs”Get log messages for a specific application
| parameter | type | required | description |
|---|---|---|---|
applicationId | number | yes | The application ID |
limit | number | Max results to return (default 20, max 100) | |
nextToken | string | Pagination token | |
txid | string | Filter by transaction ID | |
minRound | number | Include logs at or after this round | |
maxRound | number | Include logs at or before this round |
read_global_state
Section titled “read_global_state”Read global state from a deployed application. Returns decoded key-value pairs.
| parameter | type | required | description |
|---|---|---|---|
appId | number | yes | The application ID |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). |
read_local_state
Section titled “read_local_state”Read local state for a specific account from a deployed application.
| parameter | type | required | description |
|---|---|---|---|
appId | number | yes | The application ID |
address | string | yes | The account address to read local state for |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). |
read_box_state
Section titled “read_box_state”Read a box value from a deployed application. Supports simple box names and BoxMap compound keys.
Modes:
- Simple box: Provide boxName for UTF-8 encoded box names
- BoxMap: Provide keyPrefix + key + keyType for compound BoxMap keys
Examples:
- Simple box: { “appId”: 123, “boxName”: “myBox” }
- BoxMap with uint64 key: { “appId”: 123, “keyPrefix”: “boxMap”, “key”: 1, “keyType”: “uint64” }
- BoxMap with address key: { “appId”: 123, “keyPrefix”: “users”, “key”: “ABC123…”, “keyType”: “address” }
| parameter | type | required | description |
|---|---|---|---|
appId | number | yes | The application ID |
boxName | string | The box name (UTF-8 encoded). Use for simple boxes. | |
keyPrefix | string | BoxMap key prefix. Use with key and keyType. | |
key | object | BoxMap key value | |
keyType | uint64 | address | string | BoxMap key type. Defaults to uint64. | |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). |
list_application_boxes
Section titled “list_application_boxes”List the boxes a deployed application holds — names only. Follow up with read_box_state to fetch a value.
| parameter | type | required | description |
|---|---|---|---|
appId | number | yes | The application ID |
limit | number | Max boxes to return (default 100, max 1000) |
get_application_info
Section titled “get_application_info”An application’s current parameters straight from algod: creator, schema, program sizes, extra pages. lookup_application is the indexer view; call one, not both.
| parameter | type | required | description |
|---|---|---|---|
appId | number | yes | The application ID |
get_application_program
Section titled “get_application_program”Fetch and disassemble an application’s on-chain program into TEAL, with static facts: version, entrypoints (ARC-4 selectors or string-routed names), state keys, which transaction fields it reads, inner transactions, OnCompletion handling. Use to explain what a smart contract does. Not a security audit: the facts describe behavior, never safety. Large result — call it once; page with fromLine/toLine only when the facts and first page are not enough.
| parameter | type | required | description |
|---|---|---|---|
applicationId | number | yes | The application ID |
program | approval | clear | Which program (default approval) | |
fromLine | integer | First TEAL line to return (default 1; 600 lines a page) | |
toLine | integer | Last TEAL line to return |
list_app_spec_methods
Section titled “list_app_spec_methods”List the ABI methods of an app spec: signatures, args, returns, descriptions.
| parameter | type | required | description |
|---|---|---|---|
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). |
Actions (16)
Section titled “Actions (16)”send_payment
Section titled “send_payment”Send a payment of microALGO from sender to receiver. In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
receiver | string | yes | Receiver address |
amountMicroAlgos | integer | yes | Amount in microALGO |
confirmCloseAccount | boolean | Must be true when closeRemainderTo is set — closing empties the account | |
closeRemainderTo | string | Address receiving remaining balance — closes the sender account | |
note | string | Optional UTF-8 note |
send_group_transactions
Section titled “send_group_transactions”Send 1-16 transactions as an atomic group — all succeed or all fail.
Types and required fields (sender always required):
- payment: receiver, amountMicroAlgos
- asset_transfer: assetId, receiver, amount in base units (optional: clawbackTarget, closeAssetTo)
- asset_opt_in: assetId · asset_opt_out: assetId, closeAssetTo
- asset_create: total (optional: decimals, assetName, unitName, url, metadataHash, defaultFrozen, manager, reserve, freeze, clawback)
- asset_config: assetId · asset_freeze: assetId, freezeTarget, frozen · asset_destroy: assetId
- app_call/app_opt_in/app_close_out/app_delete: appId + (methodSignature OR appSpec + method) (optional: args, extraFee, maxFee)
ABI transaction args (pay/axfer/acfg/afrz) are passed as objects in args, e.g. optInToAsset(pay,uint64)void: args: [{“type”:“pay”,“receiver”:“APPADDR”,“amount”:200000}, 1659]
Inner transaction fees: use extraFee (1000 microALGO per inner txn with fee 0). In compose mode this returns unsigned transactions for external signing instead of executing.
| parameter | type | required | description |
|---|---|---|---|
transactions | array | yes |
simulate_transactions
Section titled “simulate_transactions”Simulate 1-16 transactions as a group WITHOUT sending: dry-run outcomes, ABI returns, logs, opcode budgets. No signatures needed. Same transaction shapes as send_group_transactions.
| parameter | type | required | description |
|---|---|---|---|
transactions | array | yes | |
allowMoreLogging | boolean | Lift log limits during simulation | |
allowUnnamedResources | boolean | Allow unnamed resource access | |
extraOpcodeBudget | number | Extra opcode budget to grant |
asset_create
Section titled “asset_create”Create a new Algorand Standard Asset (ASA). In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
total | number | yes | Total supply in base units |
decimals | number | Decimals (default 0) | |
assetName | string | Asset name | |
unitName | string | Unit name | |
url | string | Asset URL | |
metadataHash | string | 32-byte metadata hash (64 hex or 44 base64 chars) | |
defaultFrozen | boolean | Holdings frozen by default | |
manager | string | Manager address (can reconfigure) | |
reserve | string | Reserve address | |
freeze | string | Freeze address | |
clawback | string | Clawback address | |
note | string | Optional note (max 1000 bytes) |
asset_transfer
Section titled “asset_transfer”Transfer an ASA between accounts (or claw back with clawbackTarget). In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
assetId | number | yes | The asset ID |
receiver | string | yes | Receiver address |
amount | number | yes | Amount in base units of the asset |
clawbackTarget | string | Clawback: account to claw back from | |
closeAssetTo | string | Account receiving remaining asset balance — CLOSES the position; requires confirmCloseAccount: true | |
confirmCloseAccount | boolean | Must be true when closeAssetTo is set | |
note | string | Optional note (max 1000 bytes) |
asset_opt_in
Section titled “asset_opt_in”Opt the sender account into an ASA so it can receive it. In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
assetId | number | yes | The asset ID |
note | string | Optional note (max 1000 bytes) |
asset_opt_out
Section titled “asset_opt_out”Opt the sender out of an ASA, closing remaining balance to closeAssetTo (usually the creator). Fails on non-zero balance unless ensureZeroBalance is false. In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
assetId | number | yes | The asset ID |
closeAssetTo | string | yes | Account receiving remaining balance (usually the creator) |
ensureZeroBalance | boolean | Fail if balance non-zero (default true) | |
note | string | Optional note (max 1000 bytes) |
asset_freeze
Section titled “asset_freeze”Freeze or unfreeze an account’s holding of an ASA (sender must be the freeze address). In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
assetId | number | yes | The asset ID |
freezeTarget | string | yes | Account to freeze/unfreeze |
frozen | boolean | yes | true = freeze, false = unfreeze |
note | string | Optional note (max 1000 bytes) |
asset_config
Section titled “asset_config”Reconfigure an ASA’s role addresses (sender must be the manager). Omitted addresses are cleared PERMANENTLY and require confirmClearRoles: true. In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
assetId | number | yes | The asset ID |
confirmClearRoles | boolean | Must be true to clear any omitted role address (clearing is permanent) | |
manager | string | New manager address | |
reserve | string | New reserve address | |
freeze | string | New freeze address | |
clawback | string | New clawback address | |
note | string | Optional note (max 1000 bytes) |
asset_destroy
Section titled “asset_destroy”Destroy an ASA (sender must be the manager; all units must be back in the creator account). In compose mode returns the unsigned transaction for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
assetId | number | yes | The asset ID |
note | string | Optional note (max 1000 bytes) |
app_deploy
Section titled “app_deploy”Deploy a new smart contract instance from an ARC-56/ARC-32 app spec.
Bare create (omit method) for contracts without constructor args — most contracts.
ABI create (method + args) for contracts with a constructor (e.g. “createApplication”).
Plain create only: no idempotent update semantics (deploy again = new app).
Unless a note is given, the create txn carries the AlgoKit deployer note (ALGOKIT_DEPLOYER:j{“name”:…}) so the Explorer and AlgoKit tooling recognise the deployment by contract name.
Pass appSpecPath — the built artifact (artifacts/
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Creator/sender address |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). | |
method | string | ABI create method name (omit for bare create) | |
args | array | Arguments for the ABI create method | |
deployTimeParams | object | TMPL_* template substitutions applied to TEAL source before compiling | |
note | string | Optional note (default: the AlgoKit deployer note for the contract name) |
app_update
Section titled “app_update”Replace an existing application’s approval and clear programs from a rebuilt ARC-56/ARC-32 app spec. The app ID, address, state, and boxes stay; only the code changes.
The contract must allow UpdateApplication: a bare update (omit method) when it declares a bare update handler, or an ABI update method (method + args).
Global/local state schema cannot change on update — a schema change needs app_deploy (a new app).
Pass appSpecPath — the rebuilt artifact (artifacts/
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address (must be authorized to update by the contract) |
appId | number | yes | The application ID to update |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). | |
method | string | ABI update method name (omit for a bare update) | |
args | array | Arguments for the ABI update method | |
deployTimeParams | object | TMPL_* template substitutions applied to TEAL source before compiling | |
note | string | Optional note |
app_call
Section titled “app_call”Call a smart contract method (or bare NoOp). Provide methodSignature OR appSpec+method for ABI calls; omit both for a bare call. In compose mode returns unsigned transactions for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
appId | number | yes | The application ID |
methodSignature | string | ARC-4 method signature, e.g. “hello(string)string”. Alternative to appSpec+method. | |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). | |
method | string | Method name to look up in the app spec | |
args | array | Method args. Transaction-typed args as objects: {“type”:“pay”,“receiver”:”…”,“amount”:1000} | |
extraFee | number | Extra fee in microALGO for inner transactions | |
maxFee | number | Max fee in microALGO | |
note | string | Optional note |
app_opt_in
Section titled “app_opt_in”Opt the sender into an application (allocates local state). Provide methodSignature OR appSpec+method for ABI calls; omit both for a bare call. In compose mode returns unsigned transactions for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
appId | number | yes | The application ID |
methodSignature | string | ARC-4 method signature, e.g. “hello(string)string”. Alternative to appSpec+method. | |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). | |
method | string | Method name to look up in the app spec | |
args | array | Method args. Transaction-typed args as objects: {“type”:“pay”,“receiver”:”…”,“amount”:1000} | |
extraFee | number | Extra fee in microALGO for inner transactions | |
maxFee | number | Max fee in microALGO | |
note | string | Optional note |
app_close_out
Section titled “app_close_out”Close the sender out of an application (graceful local-state exit). Provide methodSignature OR appSpec+method for ABI calls; omit both for a bare call. In compose mode returns unsigned transactions for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
appId | number | yes | The application ID |
methodSignature | string | ARC-4 method signature, e.g. “hello(string)string”. Alternative to appSpec+method. | |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). | |
method | string | Method name to look up in the app spec | |
args | array | Method args. Transaction-typed args as objects: {“type”:“pay”,“receiver”:”…”,“amount”:1000} | |
extraFee | number | Extra fee in microALGO for inner transactions | |
maxFee | number | Max fee in microALGO | |
note | string | Optional note |
app_delete
Section titled “app_delete”Delete an application (sender must be authorized by the contract). Provide methodSignature OR appSpec+method for ABI calls; omit both for a bare call. In compose mode returns unsigned transactions for external signing.
| parameter | type | required | description |
|---|---|---|---|
sender | string | yes | Sender address |
appId | number | yes | The application ID |
methodSignature | string | ARC-4 method signature, e.g. “hello(string)string”. Alternative to appSpec+method. | |
appSpecPath | string | Path to the ARC-56/ARC-32 app spec file, e.g. artifacts/HelloWorld.arc56.json. Preferred whenever the spec exists as a file — it is read here, nothing to paste. | |
appSpec | string | The app spec JSON as a string. Use only when the spec is not available as a file (then appSpecPath cannot apply). | |
method | string | Method name to look up in the app spec | |
args | array | Method args. Transaction-typed args as objects: {“type”:“pay”,“receiver”:”…”,“amount”:1000} | |
extraFee | number | Extra fee in microALGO for inner transactions | |
maxFee | number | Max fee in microALGO | |
note | string | Optional note |
Plugin: nfd (4) — NFD name resolution — name.algo ↔ address, profiles (mainnet/testnet)
Section titled “Plugin: nfd (4) — NFD name resolution — name.algo ↔ address, profiles (mainnet/testnet)”resolve_nfd
Section titled “resolve_nfd”Resolve an NFD name (e.g. “vibekit.algo”) to its Algorand deposit address. Use when a user refers to an account by name instead of address.
| parameter | type | required | description |
|---|---|---|---|
name | string | yes | The NFD name to resolve (e.g. “vibekit.algo”) |
reverse_resolve_nfd
Section titled “reverse_resolve_nfd”Look up the NFD name associated with an Algorand address, to display a human-readable name.
| parameter | type | required | description |
|---|---|---|---|
address | string | yes | The Algorand address to look up |
batch_reverse_resolve_nfd
Section titled “batch_reverse_resolve_nfd”Look up NFD names for multiple addresses at once. Prefer over repeated reverse_resolve_nfd for 2+ addresses.
| parameter | type | required | description |
|---|---|---|---|
addresses | array | yes | The Algorand addresses to look up |
search_nfds
Section titled “search_nfds”Search NFD names by fragment (mainnet/testnet): owner, state, and asking price when for sale. For “names like X” or “is X.algo taken”.
| parameter | type | required | description |
|---|---|---|---|
query | string | yes | Name fragment; matches anywhere in the name |
limit | number | Max results (default 10, max 50) | |
forSale | boolean | Only names listed for sale |
Plugin: alpha-arcade (8) — Alpha Arcade prediction markets — prices, orderbooks, positions (mainnet)
Section titled “Plugin: alpha-arcade (8) — Alpha Arcade prediction markets — prices, orderbooks, positions (mainnet)”get_live_markets
Section titled “get_live_markets”Live prediction markets on Alpha Arcade (mainnet): title, YES/NO price = implied probability, volume, close time. Filter by category, cap with limit.
| parameter | type | required | description |
|---|---|---|---|
category | string | Only markets in this category (case-insensitive) | |
limit | number | Max markets (default 20, max 100) | |
nextToken | string | Pagination token from the previous page |
get_market
Section titled “get_market”One Alpha Arcade market by app id or UUID: prices, volume, close time, options.
| parameter | type | required | description |
|---|---|---|---|
marketId | string | yes | Market ID — app ID as string or UUID |
get_orderbook
Section titled “get_orderbook”The on-chain orderbook of an Alpha Arcade market: YES and NO bids and asks in USD and shares.
| parameter | type | required | description |
|---|---|---|---|
marketAppId | number | yes | The market app ID |
get_positions
Section titled “get_positions”An account’s Alpha Arcade positions — YES/NO share balances per market. Default to the active account.
| parameter | type | required | description |
|---|---|---|---|
walletAddress | string | yes | Algorand wallet address |
get_open_orders
Section titled “get_open_orders”An account’s open orders on one Alpha Arcade market. Default to the active account.
| parameter | type | required | description |
|---|---|---|---|
marketAppId | number | yes | The market app ID |
walletAddress | string | yes | Algorand wallet address |
place_order
Section titled “place_order”Compose an Alpha Arcade order for the wallet to sign (mainnet): buy or sell YES/NO shares; a limit order at a price, a market order without one. Never call it unasked.
| parameter | type | required | description |
|---|---|---|---|
marketId | string | yes | Market app ID as a string, or its UUID |
side | yes | no | yes | |
action | buy | sell | yes | |
quantity | number | yes | Shares (each pays $1 if right) |
priceUsd | number | Limit price per share in USD; omit for a market order | |
slippagePercent | number | Market orders only; default 2 | |
sender | string | yes | The account that trades |
cancel_order
Section titled “cancel_order”Compose the cancellation of one open Alpha Arcade order (by escrow app id) for the wallet to sign.
| parameter | type | required | description |
|---|---|---|---|
marketAppId | number | yes | |
escrowAppId | number | yes | From get_open_orders |
sender | string | yes | The order’s owner |
claim_winnings
Section titled “claim_winnings”Compose the claim of a resolved Alpha Arcade market’s winning shares for the wallet to sign.
| parameter | type | required | description |
|---|---|---|---|
marketId | string | yes | Market app ID as a string, or its UUID |
side | yes | no | yes | Which shares the account holds |
sender | string | yes | The account that claims |
Plugin: vestige (4) — Vestige market data — USD prices, history charts, ranked asset search, DeFi TVL (mainnet)
Section titled “Plugin: vestige (4) — Vestige market data — USD prices, history charts, ranked asset search, DeFi TVL (mainnet)”get_asset_prices
Section titled “get_asset_prices”Current USD prices for one or more Algorand assets (mainnet), from Vestige DEX data. Use for “what is X worth”, market cap, or converting holdings to dollars. ALGO itself is asset 0.
| parameter | type | required | description |
|---|---|---|---|
assetIds | array | yes | Asset IDs (0 = ALGO) |
search_assets_ranked
Section titled “search_assets_ranked”Search Algorand assets by name/ticker, ranked by market activity (mainnet, via Vestige). Returns USD price, market cap, TVL, and 24h volume per hit — far better than indexer name search for “the real X” or trending/market questions.
| parameter | type | required | description |
|---|---|---|---|
query | string | yes | Name or ticker fragment |
limit | number | Max results (default 10, max 50) |
get_asset_price_history
Section titled “get_asset_price_history”USD price candles for one asset over a range (mainnet, Vestige). The chart card is the answer; ALGO is asset 0.
| parameter | type | required | description |
|---|---|---|---|
assetId | number | yes | Asset ID (0 = ALGO) |
range | 1d | 7d | 30d | 90d | 1y | Default 7d |
get_defi_overview
Section titled “get_defi_overview”Algorand DeFi by protocol — TVL in USD per DEX and lending market (mainnet, Vestige). For “how big is DeFi” or “biggest protocol”.
No parameters.
Plugin: pera (1) — Pera asset registry — verification tier, project identity (mainnet/testnet)
Section titled “Plugin: pera (1) — Pera asset registry — verification tier, project identity (mainnet/testnet)”get_asset_profile
Section titled “get_asset_profile”Pera Wallet’s curated profile of an asset: verification tier (trusted/verified/unverified/suspicious), project identity (website, socials, description), logo, and USD price. Check it before presenting an unfamiliar asset; tell the user plainly when the tier is suspicious or unverified.
| parameter | type | required | description |
|---|---|---|---|
assetId | number | yes | The asset ID |
Plugin: web (2) — Web search and page reading via Exa (keyless; every network)
Section titled “Plugin: web (2) — Web search and page reading via Exa (keyless; every network)”web_search
Section titled “web_search”Search the web for what the chain cannot answer — news, docs, who is behind a project. Describe the ideal page; cite the card, answer in one sentence.
| parameter | type | required | description |
|---|---|---|---|
query | string | yes | A description of the ideal page, not keywords |
limit | number | Results (default 5, max 10) |
read_page
Section titled “read_page”Read one web page as markdown when the search highlights are not enough. Quote briefly; the card holds the page.
| parameter | type | required | description |
|---|---|---|---|
url | string | yes |