| Field | Value |
|---|---|
| Name | query |
| Title | Convex Query |
| Description | Execute a Convex Lisp query. Queries are read-only, free, and instant. Common patterns: - (balance #13) — coin balance in copper (1 CVM = 1,000,000,000 copper) - *balance* — caller's own balance - (account #13) — full account record - (@convex.fungible/balance #TOKEN #USER) — fungible token balance - (call #ACTOR (fn-name args)) — call actor function read-only - (lookup #ADDR 'symbol) — look up a definition - *state* — full network state (large!) |
Input Schema
{
"type": "object",
"required": ["source"],
"properties": {
"source": {
"type": "string",
"description": "CVM source code to execute, e.g. '(balance #13)'"
},
"address": {
"type": "string",
"description": "Optional account address to use for the query, e.g. '#13'"
}
}
}Output Schema
{
"type": "object",
"properties": {
"errorCode": {
"description": "CVM error code if the query failed"
},
"value": {
"description": "Resulting CVM value"
},
"message": {
"type": "string",
"description": "Optional human-readable message"
},
"info": {
"description": "Additional execution metadata"
}
}
}