Skip to navigation
Wallets and AddressesAddresses

List light addresses

This endpoint returns a list of addresses with light information filtered by a unique currency and a list of addresses. The light address information mainly contains the identifiers. There is no balance, risk score or attributes.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

currencyIDstringOptional
One of the currencyID or uniqueCurrencyFilter fields must be provided
uniqueCurrencyFilter.blockchainstringRequired

Required: The Blockchain to filter by (e.g. ETH, BTC). Can be found using the blockchain endpoint /api/rest/v1/blockchains

uniqueCurrencyFilter.networkstringRequired

Required: Network or environment the currency is used on (e.g. 'mainnet', 'testnet').

uniqueCurrencyFilter.tokenContractAddressstringOptional
If this parameter is set, the currency returned will be a token with the specified contract address. If not set, the currency returned will be the native currency of the blockchain.
uniqueCurrencyFilter.tokenIDstringOptional

For some blockchains (ex. ALGO, XTZ) a tokenContractAddress might contain multiple assets. The tokenID is used to differentiate between those assets. If not set, the currency returned won't have any tokenID defined.

addresseslist of stringsOptional

Response

A successful response.
resultlist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error