API Reference

Wallets

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

List all deposit addresses

gethttps://api-sandbox.circle.com/v1/businessAccount/wallets/addresses/deposit

Reference
Playground

Returns a list of deposit addresses for a given wallet.

Query parameters

walletId

string

The wallet ID for which the deposit addresses were generated. If not provided, the default is the main wallet of the account.

You can get wallet IDs associated with your account using the Core API for Institutions.

Response

200GetBusinessDepositAddressResponse

Response Body

object

data

array of objects

Show 4 properties

address

string

An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address.
Important: For Ripple (XRP) addresses, only the classic address format is supported (for example, rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY).
The x-address format is NOT supported currently (for example, XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV).

addressTag

string

The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.

currency

string

A currency associated with a balance or address.

Allowed valuesUSDEURBTCETH

chain

string

A blockchain that a given currency is available on.

Allowed valuesALGOAPTOSARBAVAXBASEBTCCELOCODEXETHHBARHYPEREVMINKLINEANEARNOBLEOPPLUMEPAHPOLYSEISOLSONICSUIUNIWORLDCHAINXDCXLMXRPZKSZKSYNC

401NotAuthorized

RequestChoose a language

ResponseChoose an example

1{
2  "data": [
3    {
4      "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
5      "addressTag": "123456789",
6      "currency": "USD",
7      "chain": "ALGO"
8    }
9  ]
10}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy