wallet_listOutputs

Lists spendable outputs in a basket, optionally filtered by tags.

Result

The BRC-100 listOutputs result, encoded as JSON text. Wallet failures return an error result.

Permissions

Forwarded to the connected wallet under the configured app origin. Its protocol, certificate or basket permission checks apply to the requested operation.

In role-routed configurations, walletRole selects an assigned wallet. Identity methods default to the identity role; encryption and HMAC use the encryption role. Transaction and basket operations follow their assigned role. An unavailable role fails rather than borrowing another key.

Definition 1

Full catalog · Legacy local wallet; Legacy local identity; External BRC-100 wallet

Field	Type / required	Description
basket	string Required	Basket name (e.g. "default")
tagsJSON	string Optional	JSON array of tag strings
tagQueryMode	"all" \| "any" Optional	See schema for details.
include	"locking scripts" \| "entire transactions" Optional	See schema for details.
includeCustomInstructions	boolean Optional	See schema for details. default: false
includeTags	boolean Optional	See schema for details. default: false
includeLabels	boolean Optional	See schema for details. default: false
limit	number Optional	See schema for details. default: 25
offset	number Optional	See schema for details. default: 0
seekPermission	boolean Optional	See schema for details.

Nested fields are required only when their parent object or array item is supplied.

Full input schema

{
  "type": "object",
  "properties": {
    "basket": {
      "type": "string",
      "description": "Basket name (e.g. \"default\")"
    },
    "tagsJSON": {
      "description": "JSON array of tag strings",
      "type": "string"
    },
    "tagQueryMode": {
      "type": "string",
      "enum": [
        "all",
        "any"
      ]
    },
    "include": {
      "type": "string",
      "enum": [
        "locking scripts",
        "entire transactions"
      ]
    },
    "includeCustomInstructions": {
      "default": false,
      "type": "boolean"
    },
    "includeTags": {
      "default": false,
      "type": "boolean"
    },
    "includeLabels": {
      "default": false,
      "type": "boolean"
    },
    "limit": {
      "default": 25,
      "type": "number"
    },
    "offset": {
      "default": 0,
      "type": "number"
    },
    "seekPermission": {
      "type": "boolean"
    }
  },
  "required": [
    "basket"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Definition 2

Full catalog · Local Vault · broadcasting disabled; Local Vault · all roles; Local Vault · payment role only; Local Vault + sponsor

Field	Type / required	Description
basket	string Required	Basket name (e.g. "default")
tagsJSON	string Optional	JSON array of tag strings
tagQueryMode	"all" \| "any" Optional	See schema for details.
include	"locking scripts" \| "entire transactions" Optional	See schema for details.
includeCustomInstructions	boolean Optional	See schema for details. default: false
includeTags	boolean Optional	See schema for details. default: false
includeLabels	boolean Optional	See schema for details. default: false
limit	number Optional	See schema for details. default: 25
offset	number Optional	See schema for details. default: 0
seekPermission	boolean Optional	See schema for details.
walletRole	"payments" \| "identity" \| "ordinals" \| "encryption" Optional	Select the configured root key for this BRC-100 call. Defaults to the role for the method; action continuations retain their original role.

Nested fields are required only when their parent object or array item is supplied.

Full input schema

{
  "type": "object",
  "properties": {
    "basket": {
      "type": "string",
      "description": "Basket name (e.g. \"default\")"
    },
    "tagsJSON": {
      "description": "JSON array of tag strings",
      "type": "string"
    },
    "tagQueryMode": {
      "type": "string",
      "enum": [
        "all",
        "any"
      ]
    },
    "include": {
      "type": "string",
      "enum": [
        "locking scripts",
        "entire transactions"
      ]
    },
    "includeCustomInstructions": {
      "default": false,
      "type": "boolean"
    },
    "includeTags": {
      "default": false,
      "type": "boolean"
    },
    "includeLabels": {
      "default": false,
      "type": "boolean"
    },
    "limit": {
      "default": 25,
      "type": "number"
    },
    "offset": {
      "default": 0,
      "type": "number"
    },
    "seekPermission": {
      "type": "boolean"
    },
    "walletRole": {
      "description": "Select the configured root key for this BRC-100 call. Defaults to the role for the method; action continuations retain their original role.",
      "type": "string",
      "enum": [
        "payments",
        "identity",
        "ordinals",
        "encryption"
      ]
    }
  },
  "required": [
    "basket"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}