Skip to main content

List Assets

The catalogue a client builds its currency and network pickers from: the assets available to the caller and, for each one, the networks it can be deposited to or paid out on.

GET/api/assetsAuth: Required

The fee fields are this merchant's own — they are resolved for the owner's fee group — so a deposit or payout fee can be read straight from this response. For the exact total of a specific payout, use Withdrawal Fees instead, which accounts for the amount and the destination.

Query Parameters

pagenumber

Page number. Default 1.

per_pagenumber

Items per page. Default 20, maximum 1000.

Response

A paginated envelope. The assets are in items.

total_countnumberRequired

Total number of assets across all pages.

per_pagenumberRequired

Rows per page, as applied.

total_pagesnumberRequired

Number of pages available.

pagenumberRequired

The page returned.

prev_pagenumber | nullRequired

Previous page number, or null on the first page.

next_pagenumber | nullRequired

Next page number, or null on the last page.

itemsarrayRequired

The assets.

The two active flags answer separate questions

active_deposit and active_withdrawal move independently. A network routinely keeps accepting deposits while payouts on it are paused — that is the normal state during a chain incident — so check the one your flow actually needs rather than treating the network as up or down.