Skip to navigation
Wallets and AddressesAddresses

List addresses

This endpoint returns a list of addresses

Authentication

AuthorizationBearer

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

Query parameters

currencystringOptional
Filter on IDs or symbols of the currency
querystringOptional
limitlongOptional
offsetlongOptional
scoreProviderstringOptional
Deprecated. Use scoreFilter instead.
scoreInBelowstringOptional
Deprecated. Use scoreFilter instead.
scoreOutBelowstringOptional
Deprecated. Use scoreFilter instead.
scoreExclusivebooleanOptional
Deprecated. Use scoreFilter instead.
onlyPositiveBalancebooleanOptional
Set this parameter to true to get only addresses with a positive unconfirmed balance
sortBystringOptional

Set this parameter to select the type on which you want to sort.The types accepted yet are: BALANCE and ADDRESSID

sortOrderstringOptional
Set this parameter to ASC to get the addresses sorted in ascending order or DESC to get them in descending order.
balanceBelowstringOptional
Filter addresses and keep only addresses with a balance below the threshold.
balanceAbovestringOptional
Filter addresses and keep only addresses with a balance above the threshold.
walletIdstringOptionalformat: "uint64"
customerIdstringOptional
coinfirmScoreGreaterstringOptional
Deprecated. Use scoreFilter instead.
chainalysisScoreGreaterstringOptional
Deprecated. Use scoreFilter instead.
tagIDslist of stringsOptional
Filter addresses with a 'OR' combination of tag IDs
blockchainstringOptional
networkstringOptional
addressIdslist of stringsOptional
Filter addresses with a list of address IDs.
nftsstringOptional

One of [exclude, include, only] depending on whether you want to include addresses of type NFTs (or you want only those). Filtering will be performed after pagination: totalItems won't represent the number of addresses with this filter but can be used in combination with offset.

addresseslist of stringsOptional

Filter addresses with a list of blockchain addresses (hashes).The blockchain needs to be specified when using this filter.

scoreFilter.scoreProviderstringOptional

Specify the score provider to filter on, or empty.Each provider has associated filter parameters that can be set.Supported values: scorechain, coinfirm, chainalysis, elliptic, trmlabs

scoreFilter.scorechainFilters.scoreInBelowstringOptional
Filter addresses under a Scorechain incoming score threshold.
scoreFilter.scorechainFilters.scoreOutBelowstringOptional
Filter addresses under a Scorechain outgoing score threshold.
scoreFilter.scorechainFilters.scoreExclusivebooleanOptional

By default when both Scorechain scores scoreInBelow and scoreOutBelow are provided, it returns the addresses matching (scoreInBelow AND scoreOutBelow). When scoreExclusive is set to true, it will return the addresses matching (scoreInBelow OR scoreOutBelow).

scoreFilter.coinfirmFilters.scoreGreaterstringOptional

Filter addresses with a Coinfirm C-score above threshold.

scoreFilter.chainalysisFilters.scoreGreaterstringOptional
Filter addresses with a Chainalysis risk score above threshold.
scoreFilter.ellipticFilters.scoreGreaterstringOptional
Filter addresses with an Elliptic risk score above threshold.
scoreFilter.trmlabsFilters.scoreGreaterstringOptional
Filter addresses with an TRM Labs risk score above threshold.
attributeFiltersJsonstringOptional

A JSON representation of a list of AttributeFilter objects. The filters are combined with an attributeFiltersOperator ('OR' by default). Each AttributeFilter can use different comparison operators: = (default if not specified), <> (not equal), > (greater than), >= (greater than or equal), < (less than), <= (less than or equal)

attributeFiltersOperatorstringOptional

Specifies how attribute filters are combined. Accepted values: 'OR' (default), 'AND'.

includeDisabledAddressesstringOptional

One of [exclude, include, only] depending on whether you want to include disabled addresses (or you want only those). Filtering will be performed after pagination: totalItems won't represent the number of addresses with this filter but can be used in combination with offset.

includeUntaggedstringOptional

One of [exclude, include, only] depending on whether you want to include untagged addresses (or you want only those). Optional field with default value as "include"

Response

A successful response.
resultlist of objectsOptional
totalItemsstringOptionalformat: "uint64"
offsetstringOptionalformat: "uint64"

The offset to get the next page. Note: the value is not always the same as the number of elements returned.

Errors

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