'/%3e%3cdefs%3e%3cpattern%20id='pattern0_2104_4598'%20patternContentUnits='objectBoundingBox'%20width='1'%20height='1'%3e%3cuse%20xlink:href='%23image0_2104_4598'%20transform='matrix(0.00376176%200%200%200.0172414%20-0.00219436%200)'/%3e%3c/pattern%3e%3cimage%20id='image0_2104_4598'%20width='267'%20height='58'%20preserveAspectRatio='none'%20xlink:href='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQsAAAA6CAMAAACQ2ozcAAAAM1BMVEVMaXH////////////////////////////////////////////////////////////////x7/yuAAAAEHRSTlMAoDDgEPBgwIBAINCwkHBQDIOTDwAAAAlwSFlzAAFxGAABcRgB7MGwCAAABm1JREFUaIHlW+uWsyoMLSIIeH3/pz0CKrmgQuusdn0nf2YaMW42kISgr1cQK+SySj+61/9cmm45RLTfRvNV0WoBIptv4/mi6AWLuiVDd0lKmLPGGPsA0nelGG8TZoXU69poTPi/v1smBjB338dZxvk218B/VIrxBl8hth9t73+Zp2x7SdNuLMX+tJTitZCKjQx1MzFquLBVc+hvpBSv8NMX/Hb+Bv2MbS8DaNsVYn9aSvFK2nWB5slHtr0sUL4Ur0vx+usowdL3A1jBhUVcfGmR1HCBFPbvuWhskvuefC4/wkWbWyMgzV2ub39GarhA+cf0KBevHrTdffSvcuGxonzCA73JBGq4gFnt7qN/lYtxwflEWOA3KWJVriWOpkd0+lUuQj6Rsu6QkcuL9jW2o4xbyzTZfpWLOG79FlatgnP5Y9tRnFn3RAYE7p/loo1bJ6GtnSLIYbuwRrz8rq6SCyY/y8W2UU0SFkw7xQCghszN/y4Xr0ZCKjpPxQz46Vjdj9pupiHUBsxclmRXcOG0CKZHfVV9dHqM1QmRrZNU4IVN15kwQ98fNHSlYNsaUsmmEUw899gNuQCck2ur17KwZXcypM6gsVSCtSN4YcozzLmWqtvbNCPRUDKgbU07RiC/z8XgmOnMtHNiYUJZu8Tbg8YW3B6HOK6PwRPQRo1sT21nBGVq73OxKNaElx8n3iiAR4CL8YbOHlH0YHnXtAL2osg2Gr8PuMgIIaPNTIooqIJdijfkyFO6b6u9gBTDo1M1PKOK6bNcYCBtf9Gwqcc7LHgr1qqFaHil69Y2KAY9zMWe/Ny3BWSU4vVdZ3UtvCHxGuQD7m2nmfY0FyBBGK8bJidXitf/gxbA7DVQwStdBbbVng48zsUxMexdy7EWr/8H9dw/QjJNLRfHKnmci2Pk5G1LW4nX/2U9x5p5eYOLvYj6PBfb+qXHfacWy/H6P6yuhavBfl1Cl0VtK7MaaGcS30wZF6ny2WS4kD71ttjyZgXHEDk5j4Ew2dTh9SbREYCEqA/NBBXY9pHX4E2eLOPiRQT1RsDAv0sc7QZhOHowIwxjHd4wDcDEmCJ1jmjQREG2werBxt3HXKRIwE+cEAYwmMijygze/hxvrq6FNJp0mNp2Zxf0x1ykWD8zLmA7lIChqe+u8U4Eb2goLbjYSaCJdnDqC20jR4JOAMzHXADYjAs4pCj5QYvH3uCFVjy66IR6Y8zoSfDlPr1rhEKdyHCB64GwJ8PHXAA144L3eBcYaw3DixwfW3skqw+GcUpHj1fP60TwSveXXKDRP7fAubjBi2bKwnrAT5p/gAsEEFuA41jNBQ60YZEip8Lq4r/NBexOLRfbvX0XfGZY5i5uVjcNOzs6tz0S23/GhYNctKcWKrmI4Sq+2BlebpRm9FSY8IRYcVTndS3si6DrEX/JBfKdeKjgitcMLw4DxNf7oVcHW/viSLt/kfqV46KHF9BofR5Tr7iA0QKhg6lIJqZe4Q3hExAroJEgIe6c17XgpEOeZy7ighatS7mA0RDlTyiJr8Obr2sJqjmva4H1g7eObREXNEiVcoGeBWqKuXy7FG9kBEhwfyjPZG9wkQOVfJlgS/Bu9+wbyy5z7YoLNL2XfgNMisFTBd6+qH5xW9fqjbV6JLUVfc4FzuS6yVoz3Lyzw7jAi2SlfrWiBTkhaOvwZrnomaa6lrNPxRwX2ft1JRe3Jb40mUvxkmc+Vtcy0NyFjgIv5oJOjEz39nVXitf/Rb6c+4txufQXWTkqpjkuXrnDLlnLhcsfmSU5Up9SvP7ZvK7F4shFXSsrB5lZLrLHXbzGd80FziS4pN15Kd6QXIGJYUhftolyXtfKSgrBWS5c7p6plguyayJyFmcv8IZRT1nmHnKJ5jzvzAoormS5yFoYqrm4AgI//LjFu3cvkKvioLQp2qlIlQseSuEXQYDt7JqFiVmei+wqqeeCfBIFewcT5XK80R+rwZgNx/F60qEhm3Zgu+HHuxK54hMucmTYei5e7B2NCD37hknAy9tDvPS0WjDNef1iTUQMploZvKc942L/3Aj0sXmDi9UOGw0KoQovzAPD2miRhr35mr7fCo3BO0K9pq/ONOBbL03NpIfIcXNQI2gP2gIteym5gSmkGvgbmRd4J/aqj93zFiUc1VCSc+K0WWWytd+HtHZ678YTQ2Yu+4jSzVePbcNVe6n51+U/wZKesx3N5aEAAAAASUVORK5CYII='/%3e%3c/defs%3e%3c/svg%3e)
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.
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., 'bitcoin', 'ethereum', 'bsc'). 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.
A client-provided reference string for tracking purposes. May be empty if not provided during address creation.
Cursor token for fetching the next page of results. Empty string when there are no more pages.
Indicates whether there are more results available beyond the current page.
Query Parameters
Filter and paginate the address list with any combination of these parameters on GET /api/addresses. Pagination is cursor-based — pass data.next_cursor from the previous response to fetch the next page.
Filter by blockchain network (e.g. 'bitcoin', 'ethereum', 'bsc', 'polygon', 'solana', 'tron', 'stellar', 'avalanche').
Filter by address status — 'active' for usable addresses, 'inactive' for disabled ones.
Filter by one or more blockchain address strings. Useful for looking up a specific address without its UUID.
Opaque base64 pagination cursor. Pass data.next_cursor from the previous response to fetch the next page. Omit on the first request.
Maximum number of records to return per page. 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
Unique identifier assigned to the address.
The blockchain address string used to receive funds.
Identifier of the company this address belongs to.
Human-readable label for the address (e.g. 'bsc Test', 'test-address').
Blockchain network the address belongs to (e.g. 'bitcoin', 'ethereum', 'avalanche').
Current status of the address: 'active' or 'inactive'.
RFC 3339 / ISO 8601 timestamp of when the address was created (UTC).
Generate Addresses
Use Case
Generate or assign a new address for a supported blockchain, optionally tied to a customer.
Generate Addresses Sample Request
Blockchain network to generate the deposit address on. Determines the address format. Supported values: 'bitcoin', 'ethereum', 'bsc', 'polygon', 'solana', 'tron', 'stellar'.
Email of the customer this address belongs to. Must match a customer already registered via the Customers API. Links incoming deposits to that customer for attribution.
Human-readable label to help you identify this address (e.g. 'test-address', 'hot-wallet-1').
Client-generated unique identifier for this address request. Returned on the response and useful for idempotency and internal tracking.
Generate Addresses Sample Response
Unique identifier assigned to the generated address.
The blockchain network the address belongs to (e.g., 'bitcoin', 'ethereum').
UUID of the company that owns the address.
The generated blockchain address.
Current status of the address (e.g., 'active').
A user-friendly name to identify the address (e.g., 'Primary Deposit Address').
Client-provided reference string for tracking purposes.
Stellar Address Generation
On Stellar, Bitnob does not mint a fresh blockchain address each time you call POST /api/addresses with chain: "stellar". Every request for your company returns the same single shared Stellar wallet address, because all Stellar deposits land on one account and are attributed downstream via memos.
If you need to distinguish deposits per user, generating the address is not enough — you must also assign and surface a unique memo to each end-user. Bitnob does not generate or manage memos on your behalf.
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.
Live supports more chains than sandbox. Production currently returns 13 chains; sandbox returns a subset of those — every chain in the sandbox list is fully usable for testing. Call this endpoint from the environment you plan to use to get its authoritative list before integrating a new chain.
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.