Skip to main content
GET
/
v1
/
w3s
/
buidl
/
wallets
/
{blockchain}
/
{address}
/
balances
Get wallet balances by blockchain and address
curl --request GET \
  --url https://api.circle.com/v1/w3s/buidl/wallets/{blockchain}/{address}/balances \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "tokenBalances": [
      {
        "amount": "6.62607015",
        "token": {
          "name": "<string>",
          "standard": "ERC20",
          "blockchain": "MATIC-AMOY",
          "decimals": 123,
          "isNative": true,
          "symbol": "<string>",
          "tokenAddress": "0x4b6c0b0078b63f881503e7fd3a9a1061065db242"
        },
        "updateDate": "2023-01-01T12:04:05Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Path Parameters

​
blockchain
enum<string>
required

Filter by given blockchain.

Available options:
ETH,
ETH-SEPOLIA,
MATIC,
MATIC-AMOY,
ARB,
ARB-SEPOLIA,
UNI,
UNI-SEPOLIA,
BASE,
BASE-SEPOLIA,
OP,
OP-SEPOLIA
Example:

"MATIC-AMOY"

​
address
string
required

Filter by given address.

Example:

"0x4b6c0b0078b63f881503e7fd3a9a1061065db242"

Query Parameters

​
standard
enum<string>

Filter by token standard.

Available options:
,
ERC20
Example:

"ERC20"

​
name
string

Filter by token name.

​
tokenAddress
string

Filter by token address.

Example:

"0x4b6c0b0078b63f881503e7fd3a9a1061065db242"

​
pageBefore
string<uuid>

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageAfter.

​
pageAfter
string<uuid>

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjunction with pageBefore.

​
pageSize
integer
default:10

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Required range: 1 <= x <= 50

Response

Balance list retrieved.

​
data
object
required