List Gas Sponsor Wallets

Lists, per network, the platform wallet that sponsors users' gas. When a user's wallet holds too little of a network's native currency to pay for a transaction it has to sign, the platform sends native currency to it from that network's sponsor wallet and then runs the transaction. The sponsor wallet is the only source: on a network with no sponsor configured, gas cannot be sent and the transaction waiting for it fails. No other wallet is picked instead.

The list has one row per network of every chain on which the platform node holds a wallet, sorted by chain name and then network name. Networks on chains where the platform holds no wallet are left out: no wallet could sponsor them. A row with an empty wallet_id and address is a network with no sponsor configured.

Gas sponsorship is a platform-wide setting: only an API client of the platform node (the root of the node hierarchy) may call this. Any other client is refused with 10005. Set or clear a sponsor with Set Gas Sponsor Wallet.

Required permission: node:summary:view

Request

GET /v2/gas-sponsor-wallets

Parameters

Name	Type	In	Description
page	integer	query	Required. Page number, starting at 1
per_page	integer	query	Required. Items per page, 1–100
search	string	query	Case-insensitive partial match on the network name or the chain name. Applied before paging, so total counts the matches

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/gas-sponsor-wallets?page=1&per_page=20' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "data": [
    {
      "network_id": "6740e0a20000000000000101",
      "network_name": "Ethereum",
      "chain_id": "6740e0a10000000000000101",
      "chain_name": "EVM",
      "address": "",
      "wallet_id": ""
    },
    {
      "network_id": "6740e0a20000000000000102",
      "network_name": "Polygon",
      "chain_id": "6740e0a10000000000000101",
      "chain_name": "EVM",
      "address": "0x4A096E485281DE1B8bF11A511D39d5B128EF7C4b",
      "wallet_id": "6a89b68e0c46ca4c941271aa"
    }
  ],
  "total": 2,
  "page": 1,
  "per_page": 20
}

Response Fields

Field	Type	Description
data	array	The networks on this page
data[].network_id	string	Network id from Get Networks (24-character hex)
data[].network_name	string	Network display name
data[].chain_id	string	id of the network's chain
data[].chain_name	string	Chain display name
data[].address	string	Address of the sponsor wallet. Empty when no sponsor is configured
data[].wallet_id	string	Id of the platform wallet that sponsors gas on this network. Empty when no sponsor is configured
total	integer	Number of networks matching search
page	integer	Page number echoed back
per_page	integer	Page size echoed back

Errors

Status	Code	Description
400	10015	page or per_page is missing or out of range — see details
403	10005	The caller is not a client of the platform node (domain 2)
400	10001	The platform node was not found (domain 2)
500	10000	Unexpected server-side failure

See Errors for the error format and common codes.