Skip to main content
POST
Get-or-create a permanent deposit address

Authorizations

x-api-key
string
header
required

Body

application/json
user_id
string
required
Required string length: 1 - 128
family
enum<string> | null
Available options:
evm,
bitcoin,
litecoin,
bitcoincash,
tron,
solana,
xrp,
ton
asset
string | null

Asset ticker (e.g. usdt_trc20). Used to infer family when family is omitted.

notify_url
string | null
Maximum string length: 500
metadata
Metadata · object | null

Response

Created

ok
boolean
required
result
PermanentAddress · object
required

Public shape of a permanent deposit address.

Deliberately omits the internal bookkeeping fields carried by addresses the Telegram userbot creates (label, label_key, stats_excluded, created_via, created_by_tg_id). _serialize whitelists by the fields declared here, so leaving them out keeps them out of both the JSON response and the published OpenAPI spec.

Example: