Skip to main content
GET
/
addresses
/
crypto
/
{customer_id}
Get all registered wallet addresses
curl --request GET \
  --url https://api.sandbox.iron.xyz/api/addresses/crypto/{customer_id} \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.sandbox.iron.xyz/api/addresses/crypto/{customer_id}"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.sandbox.iron.xyz/api/addresses/crypto/{customer_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.iron.xyz/api/addresses/crypto/{customer_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.iron.xyz/api/addresses/crypto/{customer_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sandbox.iron.xyz/api/addresses/crypto/{customer_id}")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/addresses/crypto/{customer_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "address_type": "SelfHosted",
    "blockchain": "Solana",
    "created_at": "2024-01-15T10:30:00.000Z",
    "disabled": false,
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "is_self": true,
    "name": "Primary Solana wallet",
    "proof_message": "I hereby verify that I own this wallet address",
    "proof_signature": "5J9qvKhKqYbpjhCkqDnKXSp7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp...",
    "vasp_did": null,
    "wallet_address": "7QqLDBU5iT4VWshsqRdWKHjKdqZqKqYbpjhCkqDnKXSp"
  }
]
"<string>"
"<string>"
"<string>"

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the wallet addresses will be filtered for the sub-partner

Path Parameters

customer_id
string<uuid>
required

the ID of the customer

Query Parameters

filter
enum<string>
default:All

Filter for which type of addresses to return Filter for address types when retrieving signatures

Specifies which type of addresses to return

Available options:
Hosted,
SelfHosted,
All

Response

GET Wallets Succeeded

address_type
enum<string>
required
Available options:
Hosted,
SelfHosted
blockchain
enum<string>
required

Blockchain

A type of blockchain

Available options:
Solana,
Ethereum,
Polygon,
Arbitrum,
Base,
Stellar,
Citrea,
Plasma,
Avalanche,
Moca,
Tempo,
Tron,
Bsc
created_at
string<date-time>
required

When the address was verified

disabled
boolean
required

Whether the address is disabled

id
string<uuid>
required

The ID of the verified address

is_self
boolean
required

Whether the wallet belongs to the customer themselves (true) or a third party

wallet_address
string
required

The wallet address

name
string

Optional display name for this wallet address

proof_message
string

The proof message

proof_signature
string

The proof signature

vasp_did
string

The VASP DID (decentralized Identifier) for hosted wallets