List whitelisted contracts

get

https://your-protect-instance.example.com/api/rest/v1/whitelists/contracts

This endpoint returns a list of whitelisted contracts

Query Params

limit

string

uint64; Return maximum limit items for a query; Max 100.

offset

string

uint64; Start retrieving items starting at offset id

query

string

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

blockchain

string

Symbol of the blockchain on which to whitelist an address

includeForApproval

boolean

If true, include also addresses waiting for approval in the results.

network

string

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

isNFT

boolean

Deprecated: use the kindTypes parameter with 'nft' instead

whitelistedContractAddressIds

array of strings

uint64; The whitelisted contract IDs to retrieve

whitelistedContractAddressIds

kindTypes

array of strings

Filter on contract kind type, can be nft or token. An empty list means no filtering.

kindTypes

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.