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 a UUID assigned when the address is created.
The actual blockchain address generated by the system, used to receive or send cryptocurrency.
The unique identifier of the company that owns or manages this address.
The unique identifier of the customer associated with this address. Links the address to a specific user account.
A user-defined name or label for easy identification of the address. Often used to differentiate between purposes (e.g., 'Primary Deposit Address').
The blockchain network the address is associated with (e.g., 'arbitrum', 'ethereum', 'tron'). Determines how transactions are routed.
The current status of the address. Typically 'active' for addresses that can receive deposits, or 'inactive' for disabled addresses.
Timestamp indicating when the address was created. Contains 'seconds' (Unix timestamp) and 'nanos' (nanoseconds) for precise timing.
The current page number in the paginated response.
The number of items returned per page.
The total number of addresses available across all pages.
The total number of pages available based on the per_page limit.
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.
The customer associated with this address, containing details such as id, name, email, phone, and blacklist status. Null if no customer is linked.
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 deposit address is being generated. Determines the address format and compatibility (e.g., 'ethereum').
A unique identifier for the customer in your system. This is typically a UUID representing the user account.
Optional unique ID to track this deposit address request (e.g., order ID or user reference).
The email address of the customer associated with the deposit address. Used for mapping and communication purposes.
A descriptive label for the address, such as 'Primary Deposit Address' or 'ETH Wallet'. Helps organize and identify generated addresses.
Generate Addresses Sample Response
The blockchain network the address belongs to (e.g., 'bitcoin', 'ethereum').
The unique identifier of the company that owns the address.
The unique identifier of the customer associated with the generated address.
The generated blockchain address associated with the customer or company.
Represents whether the address is currently active or inactive.
A user-friendly name used to identify the purpose of the address (e.g., 'Primary Deposit Address').
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
Indicates whether the API request was processed successfully.
A human-readable message describing the result of the validation operation.
Returns true if the provided blockchain address is valid for the specified chain, otherwise false.
The blockchain address that was validated.
The blockchain network the address was validated against (e.g., 'solana', 'ethereum').
A unique identifier for this specific API request, useful for debugging and support.
The UTC timestamp when the validation was completed.
Stablecoins Supported Chains
Use Case
Displays all supported blockchain networks along with their native tokens and stablecoins.
Helps developers identify which tokens can be used for transactions and ensures correct decimals are applied when sending or receiving assets.
Stablecoins Supported Chains Response
A list of supported blockchain networks, each containing its native token and available stablecoins.
The name of the blockchain network (e.g., 'arbitrum', 'bsc', 'ethereum', 'tron').
Details of the chain's native token, including symbol and decimals.
A list of stablecoins supported on the chain, each with symbol and decimals.
The symbol of the chain's native token (e.g., 'ETH', 'BNB', 'TRX').
The number of decimals used by the native token.