Retrieve a list of addresses

post https://api-sdk.lmnl.dev/api/wallet/generate-many-address

This API is a request to retrieve a sequential index of pre-generated addresses within your deposit hot wallet. You can assign each address sequentially to a specific customer for depositing their assets.

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.

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

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 from the last index each time when one or more addresses within the last 30,000 addresses have 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.

Note that if you want to create more than 39,997 addresses, say 100,000, ensure that your addresses between 9,997 to 39, 997 have balance. Once the next 10,000 addresses are indexed by Liminal, ensure that your customer addresses between 19,998 to 49,998 have balance, and continue this process until you reach 100,000.

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.

Prerequisites

Ensure that you have created your hot deposit wallet.