Skip to main content
GET
/
api
/
private
/
v2
/
wallet
/
address-book
/
{id}
/
Get Address Book Entry
curl --request GET \
  --url https://app.digitalsurge.com.au/api/private/v2/wallet/address-book/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "asset": "<string>",
  "asset_name": "<string>",
  "network": "<string>",
  "address": "<string>",
  "memo": "<string>",
  "label": "<string>",
  "status": "<string>",
  "enabled": true,
  "confirmed": true,
  "confirmed_at": "2023-11-07T05:31:56Z",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "last_used": "2023-11-07T05:31:56Z",
  "times_used": 123,
  "travel_rule": {}
}

Authorizations

​
Authorization
string
header
required

Personal API key, created in the Digital Surge app under Account Settings → API Keys. Send it with every request as Authorization: Bearer <your-api-key>.

Path Parameters

​
id
integer
required

A unique integer value identifying this Withdrawal Address Book Entry.

Response

200 - application/json

Read-only serializer for listing address book entries. Includes asset code instead of full asset object. Includes a computed 'status' field with values: verified, unverified, unavailable. Includes nested travel_rule data when available.

​
id
integer
required
read-only
​
asset
string
required
read-only
​
asset_name
string
required
read-only
​
network
string
required
read-only
​
address
string
required
read-only
​
memo
string
required
read-only

Tag/Memo for assets that require it (XRP, XLM, etc)

​
label
string
required
read-only

User-friendly label (e.g., 'My Ledger', 'Cold Storage')

​
status
string
required
read-only

Compute status based on unavailable and confirmed fields.

  • unavailable: unavailable=True (admin-disabled)
  • verified: confirmed=True, unavailable=False
  • unverified: confirmed=False, unavailable=False

Note: enabled=False addresses are filtered out in the view and won't appear here.

​
enabled
boolean
required
read-only

False = soft deleted

​
confirmed
boolean
required
read-only

Email confirmation status

​
confirmed_at
string<date-time> | null
required
read-only
​
created
string<date-time>
required
read-only
​
updated
string<date-time>
required
read-only
​
last_used
string<date-time> | null
required
read-only

Last time used for a withdrawal

​
times_used
integer
required
read-only
​
travel_rule
object | null
required
read-only

Return current travel rule data for this address book entry, or null.

Uses prefetched _prefetched_attestations (set via Prefetch in the viewset queryset). Falls back to a query if the prefetch is missing (e.g. single-object retrieval).