Retrieve a list of addresses

📘

Note

• The index path of addresses use the m/0/0 format, where m/0/0 is reserved for your deposit wallet address. Your customer addresses start from the m/0/1 path, where the final digit increases sequentially to represent the next address in the database.
• Retrieve the addresses sequentially, meaning each subsequent API request should begin from endIndex + 1 of the previous request. For example, if the first API call uses startIndex = 1 and endIndex = 50, the next request should start with startIndex = 51.
• For Stellar, Ripple, and Cosmos chain wallets (which only have a single wallet address), you can assign a unique memo or tag to each customer to track individual deposits.
• The API request runs locally on your infrastructure, therefore, Liminal has no way of knowing which addresses are retrieved or assigned.

Limitations

• When a new deposit wallet is created, Liminal pre-indexes up to 39,997 addresses on its own infrastructure. This means you can track these addresses for transactions, balances, etc. in Liminal Vaults or via Liminal APIs.
• It’s crucial to assign the first 39,997 addresses to your customers in a sequential order, to generate more addresses. Liminal indexes 10,000 new addresses sequentially within 30 minutes whenever one or more of the last 30,000 addresses have a balance. For example, if an address between 9,997 to 39,997 has a balance, Liminal will index addresses from 39,998 to 49,998. The process is continued further. To generate a large number of addresses at once, see Generate a large number of addresses.
• If you directly generate an address beyond 39,997 on your infrastructure, you will not be able to track transactions, balances, etc. of these addresses in Liminal Vaults or via Liminal APIs.
• You can index a maximum of 1000 addresses in each API call.

To retrieve a specific address by providing the corresponding index path in the request, use the Retrieve a single address API.

Generate a large number of addresses

To generate a large number of addresses (above 39,997) for one or more deposit wallets, submit a support ticket. Ensure to provide the following details:

• The total number of addresses to be generated.
• The IDs of the deposit wallets.

Prerequisites

• Ensure that you have created your hot deposit wallet.