Get Wallet By Locator - Crossmint Docs

Get Wallet By Locator

curl --request GET \
  --url https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator} \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}"

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

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}', 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://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}",
  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: <x-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://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}")

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

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

response = http.request(request)
puts response.read_body

{
  "address": "0x1234567890123456789012345678901234567890",
  "chainType": "aptos",
  "type": "smart",
  "alias": "my-usdc-wallet",
  "config": "<unknown>",
  "createdAt": 123,
  "owner": "email:test@example.com"
}

{
  "error": true,
  "message": "<error message>",
  "code": "DEVICE_SIGNER_NOT_SUPPORTED"
}

GET

/

2025-06-09

/

wallets

/

{walletLocator}

Get Wallet By Locator

curl --request GET \
  --url https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator} \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}"

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

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

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}', 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://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}",
  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: <x-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://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}"

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

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}")

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

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

response = http.request(request)
puts response.read_body

{
  "address": "0x1234567890123456789012345678901234567890",
  "chainType": "aptos",
  "type": "smart",
  "alias": "my-usdc-wallet",
  "config": "<unknown>",
  "createdAt": 123,
  "owner": "email:test@example.com"
}

{
  "error": true,
  "message": "<error message>",
  "code": "DEVICE_SIGNER_NOT_SUPPORTED"
}

Headers

X-API-KEY

string

required

API key required for authentication

Path Parameters

walletLocator

string

required

A wallet locator can be of the format:

<walletAddress>
email:<email>:<chainType>[:<walletType>][:alias:<alias>] (walletType defaults to 'smart')
userId:<userId>:<chainType>[:<walletType>][:alias:<alias>] (white label user example)
phoneNumber:<phoneNumber>:<chainType>[:<walletType>][:alias:<alias>]
twitter:<handle>:<chainType>[:<walletType>][:alias:<alias>]
x:<handle>:<chainType>[:<walletType>][:alias:<alias>]
me:<chainType>[:<walletType>][:alias:<alias>] (Use when calling from the client side with a client API key)
chainType[:<walletType>]:alias:<alias>

Response

The record has been successfully retreived.

Aptos wallet output
EVM wallet output
Solana wallet output
Stellar wallet output
Sui wallet output

Complete wallet configuration including type-specific settings

address

string

required

The onchain address of the wallet

Example:

"0x1234567890123456789012345678901234567890"

chainType

enum<string>

required

The blockchain type of the wallet

Available options:

aptos

type

enum<string>

required

The wallet type (smart or mpc)

Available options:

mpc,

smart

Example:

"smart"

alias

string

The wallet alias

Example:

"my-usdc-wallet"

config

any

Aptos wallet type specific configuration settings

createdAt

ISO timestamp of when the wallet was created

owner

string

The user that owns this wallet in format :

Example:

"email:test@example.com"