Addresses
Blockchain addresses are unique identifiers used to send and receive digital assets. This section allows you to manage, generate, and validate addresses associated with customers.
GET addresses
Use Case
This endpoint returns a paginated list of wallet addresses associated with users or companies. Commonly used for auditing address activity or linking addresses to accounts.
Address Sample Response
Unique identifier of the address. This is typically a UUID assigned when the address is created.
The actual blockchain address generated by the system, used to receive or send cryptocurrency.
A user-defined name or label for easy identification of the address. Often used to differentiate between purposes (e.g., salary wallet, savings).
Describes the purpose or category of the address, such as 'deposit' for receiving funds or 'withdrawal' for outgoing transactions.
The blockchain network the address is associated with, e.g., 'bitcoin', 'ethereum'. Determines how transactions are routed.
Cumulative amount of funds received at the address, typically shown in the blockchain’s native currency.
The number of distinct incoming transactions this address has received.
Indicates whether the address has expired or is no longer valid for transactions. Helps prevent sending to deprecated addresses.
The timestamp representing when the address was generated. Useful for audit trails and sorting.
The most recent timestamp when the address data was updated, such as after a label change or status update.
Specifies the current page number in the pagination response. Starts from 1.
Defines how many address records are included in each response page. Helps control payload size.
Total number of address records available in the system matching the current query.
Calculated total number of pages available based on itemCoun and take values.
Returns true if there are address records before the current page. Enables backward navigation in pagination.
Returns true if there are more address records after the current page. Used for forward pagination.
Query Parameters
The page number of the paginated results to retrieve. This is used for navigating through multiple pages of data. Default is 1, meaning the first page.
The maximum number of items to return per page. Useful for controlling the size of each response. Default is 20.
Get Address by ID or Address
Use Case
Retrieve a single address using its unique UUID or address string. Useful for looking up detailed address activity or metadata.
The unique identifier for the address, usually auto-generated by the system. It can be used to fetch specific address details or manage address lifecycle events.
The actual blockchain address to query. This is the alphanumeric string used for sending or receiving crypto assets on a specific chain, such as Bitcoin or Ethereum.
Get Address by ID or Address Sample Response
A system-generated unique identifier assigned to the blockchain address. This is used internally for referencing and managing the address.
The actual blockchain address string (e.g., 'bc1q...') used to receive or send digital assets. This is the key value for wallet transactions.
A user-friendly name or tag given to the address to easily distinguish it from others (e.g., 'Main Wallet', 'USDT Wallet').
Specifies how the address is used. Common types include 'deposit' for receiving funds and 'withdrawal' for sending funds.
The blockchain network to which the address belongs (e.g., 'bitcoin', 'ethereum'). Ensures compatibility with specific cryptocurrency protocols.
Cumulative value of funds received by this address, typically denominated in the chain's native asset.
Total number of individual transactions that have credited this address.
Indicates if the address has expired or is no longer active. Expired addresses should not be used for new deposits.
Timestamp indicating when the address was first created in the system. Format follows ISO 8601 standards.
Timestamp representing the last time the address record was modified. Useful for tracking changes or updates.
Validate Address
Use Case
Validates whether an address is well-formed and supported on a given chain. Does not assign or persist the address — only validates its format.
Validate Address Sample Request
The blockchain address you want to validate. It should be in the correct format for the selected chain (e.g., a Bitcoin address like 'bc1q...').
The blockchain network the address belongs to (e.g., 'bitcoin', 'ethereum'). This helps ensure the address is valid for the correct network.
Validate Address Response
Returns true if the provided blockchain address is valid for the specified chain, otherwise false. This helps confirm whether the address format and checksum are correct for the selected blockchain network.
Generate Addresses
Use Case
Generate or assign a new address for a supported blockchain, optionally tied to a customer.
Generate Addresses Sample Request
The blockchain network for which the address is being generated. This defines the format and compatibility of the address. For example, use 'bitcoin' to generate a BTC address. Only supported chains can be used.
A unique identifier for a previously registered user in your system. It could be an email address or user id.
A custom label to describe the purpose of the address, such as 'Main BTC Wallet' or 'User Deposit Address'. It is helpful for internal reference but not mandatory.
Generate Addresses Sample Response
A unique identifier for the address, typically used to track it in your system. This is automatically generated.
The actual blockchain address that can be used for receiving or sending funds. This is generated based on the selected chain.
A human-friendly name given to the address to help identify its purpose (e.g., 'Main Wallet'). This is optional.
Specifies the purpose of the address such as 'deposit' for receiving funds or 'withdraw' for sending.
Indicates the blockchain the address belongs to, such as 'bitcoin', 'ethereum', etc.
The total amount of cryptocurrency received at this address, typically shown as a string for precision.
The total number of incoming transactions to this address.
A flag that shows whether this address has expired (true) or is still valid (false).
The date and time when the address was created, formatted in ISO 8601 (e.g., '2025-05-14T12:00:00Z').
The most recent timestamp when the address details were updated.