Counterparties
List counterparties
List counterparties visible to the agent.
GET
/v1/agent-api/counterpartiesQuery parameters
addressstringOptionalOnly counterparties with a wallet rail at this address; bank rails never match
network"base" | "arc"OptionalOnly counterparties owning a wallet address in this network class; a matching rail can omit network when its configured destination is unavailable to the agent; such a rail cannot receive an agent send until that configuration or the organization's capability changes; bank rails never match
Responses
200Visible counterparties
400Malformed address, unknown network, or network not enabled
Response fields
counterpartiesarray of objectRequiredcounterparties[].idstringRequiredcounterparties[].namestringRequiredcounterparties[].status"ready" | "awaiting_details"Requiredcounterparties[].railsarray of objectRequired