For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get persistent address data

get

Returns a paginated, filterable, sortable list of the persistent deposit addresses created with this API key. Use /api/persistent-deposit-address-data/:apiKey to fetch a single address by its value.

Path parameters
apiKeystringRequired

API key generated at https://studio.aurora.dev

Query parameters
recipientstring · min: 1Optional

Filter by exact recipient (destination chain address).

senderstring · min: 1Optional

Filter by exact sender (the integrator-supplied user id).

depositChainstring · enumOptional

Filter by deposit chain. A non-EVM shortcut (e.g. "near", "sol", "btc") matches that chain exactly; the special value "evm" matches addresses created on any EVM chain.

Possible values:
recipientChainstring · enumOptional

Filter by the chain the funds are received on (any shortcut, EVM chains separately). Resolved against the tokens list: matches addresses whose destination asset lives on this chain.

Possible values:
destinationAssetstring · min: 1Optional

Filter by destination token SYMBOL (e.g. "USDC"). When a symbol maps to multiple asset ids, addresses for ALL of them are returned.

sortstring · enumOptional

Sort order (newest first). "created" sorts by created_at then last_time_used; "used" sorts by last_time_used then created_at.

Default: createdPossible values:
pageinteger · max: 9007199254740991Optional

1-based page number. Default: 1.

Default: 1
perPageinteger · max: 1000Optional

Items per page. Default: 50. Max: 1000.

Default: 50
Responses
200

A paginated page of deposit address records

application/json

A paginated page of deposit address records

pagenumberRequired

Current page number.

Example: 1
perPagenumberRequired

Items per page.

Example: 50
totalnumberRequired

Total records matching the query.

Example: 230
totalPagesnumberRequired

Total number of pages.

Example: 5
nextPagenumber · nullableRequired

Next page number, or null if none.

Example: 2
prevPagenumber · nullableRequired

Previous page number, or null if none.

get/api/persistent-deposit-addresses/{apiKey}
get

Returns the details of a single persistent deposit address by its value, scoped to this API key (404 if the address was not created with this key).

Path parameters
apiKeystringRequired

API key generated at https://studio.aurora.dev

Query parameters
addressstring · min: 1Required

The exact deposit address to look up. Must belong to this API key (otherwise 404).

Responses
200

The deposit address record

application/json

The deposit address record

depositAddressstringRequired

Chain-specific deposit address.

Example: 0x76b4c56085ED136a8744D52bE956396624a730E8
recipientstringRequired

Target address on the destination chain.

Example: 0x2527D02599Ba641c19FEa793cD0F167589a0f10D
senderstringRequired

Integrator-supplied user id the address was generated for.

Example: some-user-id
depositChainstring · nullableRequired

Deposit chain in shortcut format. EVM chains share one address, so any EVM deposit chain is reported as the single value "evm".

Example: evm
destinationSymbolstring · nullableRequired

Symbol of the destination asset the address is bound to. Null for legacy rows whose asset could not be resolved.

Example: USDC
recipientChainstring · nullableRequired

Chain the funds are received on (the chain the destination asset lives on), in shortcut format. Null for legacy rows whose asset could not be resolved.

Example: base
memostringOptional

Deposit memo required by some chains (currently only Stellar). Deposits to this address on such chains MUST include it. Omitted for chains that do not use a memo.

Example: 66357
createdAtstringRequired

When the address was first created (ISO 8601).

Example: 2026-01-01T00:00:00.000Z
lastTimeUsedstringRequired

When the address was last requested (ISO 8601).

Example: 2026-01-02T00:00:00.000Z
get/api/persistent-deposit-address-data/{apiKey}

Last updated