Get one wallet's balances

curl --request GET \
  --url https://api.sand.etherfuse.com/ramp/balances \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sand.etherfuse.com/ramp/balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "blockchain": "stellar",
  "publicKey": "<string>",
  "observedAt": "2023-11-07T05:31:56Z",
  "balances": [
    {
      "symbol": "<string>",
      "identifier": "<string>",
      "balance": "<string>",
      "currency": "<string>",
      "amountInFiat": "<string>",
      "amountInUsd": "<string>"
    }
  ]
}

Assets

Get one wallet's balances

Reads one wallet, the one you name on the call. It never picks a wallet for you, so an organization with many registered wallets calls this once per wallet.

Name the wallet with cryptoWalletId, or with blockchain and publicKey together. Send exactly one of those two forms. The response echoes the wallet back as walletId, blockchain, and publicKey, so both forms return the same object for the same wallet. The wallet must be registered to your organization or to one of its child organizations.

For that wallet you get the current balance of every supported Etherfuse asset it holds, with the value of each in the asset’s own fiat currency and in USD.

Assets are resolved from the Etherfuse catalog for the wallet’s chain, so no asset list is accepted or required. Assets with a zero balance are omitted, so an empty balances array is a successful read of a wallet holding nothing.

currency is per balance, because one wallet can hold CETES denominated in MXN and TESOURO denominated in BRL at the same time. balance carries the asset’s own decimal precision; the two value fields carry six decimal places. Interest-bearing assets accrue continuously, so two calls seconds apart can return different values for an unchanged balance.

GET

ramp

balances

Get one wallet's balances

curl --request GET \
  --url https://api.sand.etherfuse.com/ramp/balances \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sand.etherfuse.com/ramp/balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "blockchain": "stellar",
  "publicKey": "<string>",
  "observedAt": "2023-11-07T05:31:56Z",
  "balances": [
    {
      "symbol": "<string>",
      "identifier": "<string>",
      "balance": "<string>",
      "currency": "<string>",
      "amountInFiat": "<string>",
      "amountInUsd": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

API key sent in the Authorization header.

Query Parameters

cryptoWalletId

string<uuid>

Names the wallet by its identifier. Send either this or the blockchain and publicKey pair, never both and never neither.

blockchain

enum<string>

Names the wallet by chain and address, together with publicKey. Send this pair instead of cryptoWalletId, not alongside it. Canonical blockchain enum for API serialization. Use this type for JSON APIs and WebSocket messages. For database storage, convert to BlockchainType.

Available options:

stellar,

solana,

base,

polygon,

monad

publicKey

string

The wallet's public address, sent together with blockchain. Match the address exactly as you registered it, including its casing.

Response

The wallet's held balances

walletId

string<uuid>

required

The wallet you named, echoed back. Present whichever form you sent, so a request that used blockchain and publicKey still returns the wallet's cryptoWalletId here.

blockchain

enum<string>

required

Canonical blockchain enum for API serialization. Use this type for JSON APIs and WebSocket messages. For database storage, convert to BlockchainType.

Available options:

stellar,

solana,

base,

polygon,

monad

publicKey

string

required

The named wallet's public address

observedAt

string<date-time>

required

When the balances were read

balances

object[]

required

One entry per held asset. Empty when the wallet holds none.

Show child attributes

User Authentication

Ramp API

Lookup API

Get one wallet's balances

Authorizations

Query Parameters

Response