Skip to navigation
Taurus-PROTECT APIsAddress whitelisting

Export whitelisted addresses

This endpoint exports a list of whitelisted addresses

Authentication

AuthorizationBearer

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

Query parameters

formatstringOptional

defaults to json; can be csv or json

addressTypestringOptional

Can be one of the following: individual, exchange, baker, stakepool, contract, validator, node

querystringOptional

Will find a match in any part of the value. Filter applies to the following fields: customerid, address, blockchain, label, memo, addresstype

exchangeAccountIdslist of stringsOptional
Array containing the list of IDs for exchange accounts
tagslist of stringsOptional
List of tags applied returned whitelisted addresses
blockchainstringOptional
Filter on the blockchain of the WLA.
addresseslist of stringsOptional
Filter on the specific addresses to return. This field is using the blockchain's native address syntax
networkstringOptional

Name of the blockchain network, eg. mainnet, testnet, or sepolia

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.
exchangeAccountIdstringOptionalformat: "uint64"

Deprecated: Use exchangeAccountIds instead

currencystringOptional

Deprecated: Use blockchain instead

scoreProviderstringOptional

Deprecated: Use scoreFilter instead. Can be either of the following: scorechain, coinfirm, chainalysis, elliptic, trmlabs

scoreInBelowstringOptional

numeric; Deprecated: Use scoreFilter instead

scoreOutBelowstringOptional

numeric; Deprecated: Use scoreFilter instead

scoreExclusivebooleanOptional

Deprecated: Use scoreFilter instead

coinfirmScoreGreaterstringOptionalformat: "int64"

Deprecated: Use scoreFilter instead

chainalysisScoreGreaterstringOptionalformat: "int64"

Deprecated: Use scoreFilter instead

Response

A successful response.
resultstringOptional
totalItemsstringOptionalformat: "uint64"

Errors

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