List Wallets

The Get Wallets endpoint allows you to retrieve all Bridge wallets associated with your application. Bridge wallets are blockchain wallets that can hold and transact with various stablecoins across different supported networks.

Endpoint DetailsCopied!

Method: GET
URL: /api/v0/wallets
Content-Type: application/json

AuthenticationCopied!

This endpoint requires API key authentication using both:

x-client-key: Your application's client key
x-client-secret: Your application's client secret

Include both headers in your request as shown in the examples below.

RequestCopied!

This endpoint doesn't require any request body or query parameters. The wallets returned are automatically filtered to only show wallets associated with your authenticated application.

ResponseCopied!

Success Response (200 OK)

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "bridge_id": "wa_bridge123abc",
      "address": "0x742d35Cc6Ff82a8C2D8D1Da9da17c7eDfD5bE0a3",
      "chain": "base",
      "balances": [
        {
          "balance": "1000.50",
          "currency": "usdc",
          "chain": "base",
          "contract_address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
        },
        {
          "balance": "250.75",
          "currency": "eurc",
          "chain": "base",
          "contract_address": "0x60a3E35Cc302bfa44Cb288Bc5a4F316Fdb1adb42"
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z",
      "business": {
        "id": "bus_550e8400e29b41d4a716446655440000",
        "name": "Your Business Name"
      },
      "app": {
        "id": "app_123e4567e89b12d3a456426614174000",
        "name": "Your App Name"
      }
    }
  ]
}

Response Fields

Wallet Object

Field	Type	Description
`id`	string	Unique identifier for the wallet in our system
`address`	string	Blockchain address of the wallet
`chain`	string	Blockchain network (`base`, `solana`)
`balances`	array	Array of token balances in the wallet
`created_at`	string	ISO 8601 timestamp when wallet was created
`updated_at`	string	ISO 8601 timestamp when wallet was last updated
`business`	object	Business information associated with the wallet

Balance Object

Field	Type	Description
`balance`	string	Token balance amount (as string to preserve precision)
`currency`	string	Token currency (`usdc`, `eurc`, `usdt`, etc.)
`chain`	string	Blockchain network where this balance exists
`contract_address`	string	Smart contract address of the token

Supported NetworksCopied!

Currently, the following blockchain networks are supported for wallets:

Base (base) - Coinbase's Layer 2 network
Solana (solana) - Solana blockchain

Example RequestsCopied!

cURL

curl -X GET "https://api.yourplatform.com/api/v0/wallets" \
  -H "Content-Type: application/json" \
  -H "x-client-key: your_client_key_here" \
  -H "x-client-secret: your_client_secret_here"

JavaScript (Node.js)

const response = await fetch('https://api.yourplatform.com/api/v0/wallets', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'x-client-key': 'your_client_key_here',
    'x-client-secret': 'your_client_secret_here'
  }
});

if (!response.ok) {
  throw new Error(`HTTP error! status: ${response.status}`);
}

const wallets = await response.json();
console.log('Your wallets:', wallets);

Python

import requests

url = "https://api.yourplatform.com/api/v0/wallets"
headers = {
    'Content-Type': 'application/json',
    'x-client-key': 'your_client_key_here',
    'x-client-secret': 'your_client_secret_here'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    wallets = response.json()
    print("Your wallets:", wallets)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.yourplatform.com/api/v0/wallets',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'x-client-key: your_client_key_here',
    'x-client-secret: your_client_secret_here'
  ),
));

$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($httpCode === 200) {
    $wallets = json_decode($response, true);
    print_r($wallets);
} else {
    echo "Error: " . $httpCode . "\n";
    echo $response;
}
?>

Error ResponsesCopied!

401 Unauthorized

{
  "statusCode": 401,
  "message": "Invalid API credentials",
  "error": "Unauthorized"
}

403 Forbidden

{
  "statusCode": 403,
  "message": "Insufficient permissions to access wallets",
  "error": "Forbidden"
}

500 Internal Server Error

{
  "statusCode": 500,
  "message": "Failed to retrieve wallets",
  "error": "Internal Server Error"
}

Important NotesCopied!

Real-time Balances: The wallet balances are fetched in real-time from the Bridge API, ensuring you always get the most current balance information.
Application Scoping: This endpoint automatically filters wallets to only show those associated with your authenticated application.
Multiple Networks: A single wallet response may contain balances across multiple blockchain networks.
Precision: All balance amounts are returned as strings to preserve decimal precision and avoid floating-point arithmetic issues.
Rate Limiting: This endpoint is subject to our standard rate limiting policies. See our rate limiting documentation for details.

Use CasesCopied!

Portfolio Overview: Display all wallet balances to users
Asset Management: Track stablecoin holdings across different networks
Transaction Planning: Check available balances before initiating transfers
Reporting: Generate financial reports and statements
Monitoring: Monitor wallet activity and balance changes

Next StepsCopied!

After retrieving your wallets, you can:

Use the wallet addresses for receiving funds
Check individual token balances for transaction planning
Monitor balance changes over time
Integrate wallet data into your application's dashboard