Skip to main content
Generate blockchain addresses for your profiles. Addresses belong to wallets and are used to send and receive funds.

Methods

createAddress()

Generate a new address for a profile (V1 API). Requires wallet to exist first. Signature:
Parameters:
ParameterTypeRequiredDescription
request.referencestringYesProfile reference
request.networkIdstringYesNetwork ID (from getNetworks())
request.clientSharestringYesClient share for key derivation
Example:

createAddressV2()

Generate a new address (V2 API). Automatically creates wallet if it doesn’t exist. This is the recommended method. Signature:
Parameters: Same as createAddress(). Example:
Use V2: The createAddressV2() method is recommended as it automatically creates a wallet if one doesn’t exist, simplifying your workflow.

getAddressById()

Retrieve a single address by its UUID. Signature:
Parameters:
ParameterTypeRequiredDescription
request.idstringYesAddress UUID
Example:

getAddressForProfile()

Get addresses for a profile by reference. Signature:
Parameters:
ParameterTypeRequiredDescription
referencestringYesProfile reference
request.skipnumberNoNumber of records to skip
request.takenumberNoNumber of records to retrieve
Example:

getAddressForOrganization()

Get all addresses for an organization. Signature:
Parameters:
ParameterTypeRequiredDescription
request.skipnumberNoNumber of records to skip
request.takenumberNoNumber of records to retrieve
Example:

Complete Example