getAddresses

Requests the user's Bitcoin and Stacks addresses from the connected wallet. This is a multi-chain address discovery method that typically returns both BTC and STX addresses.

---

Usage

import { request } from '@stacks/connect';

const result = await request('getAddresses', {
  network: 'mainnet',
});

for (const entry of result.addresses) {
  console.log(`Address: ${entry.address}`);
  console.log(`Public Key: ${entry.publicKey}`);
  console.log(`Symbol: ${entry.symbol}`);
}

Notes

• This method returns addresses for all supported chains (BTC and STX). For Stacks-only addresses, use stx_getAddresses.

• Results are automatically cached in local storage when enableLocalStorage is true (the default).

• For Xverse-like wallets, this method is automatically overridden to use wallet_connect when provider overrides are enabled.

• The connect function is a convenience wrapper that calls this method with forceWalletSelect: true.

Reference Link

---

Signature

function request(
  'getAddresses',
  params?: GetAddressesParams
): Promise<GetAddressesResult>

---

Returns

GetAddressesResult

interface GetAddressesResult {
  addresses: AddressEntry[];
}

interface AddressEntry {
  symbol?: string;
  address: string;
  publicKey: string;
}

Property	Type	Description
addresses	AddressEntry[]	An array of address entries from the wallet.

Each AddressEntry contains:

Property	Type	Description
symbol	string (optional)	The symbol for the address (e.g. 'STX', 'BTC').
address	string	The address string.
publicKey	string	The hex-encoded public key for this address.

---

Parameters

network (optional)

• Type: NetworkString

The network to request addresses for (e.g. 'mainnet', 'testnet').