Create Sub-Address

Endpoint Description: /user-addrs

This endpoint facilitates the creation of multiple new blockchain subaddresses for a specified chain based on the provided requirements. It allows the creation of addresses, enhancing efficiency for operations that need to manage multiple wallet addresses for a single chain.

Request Body Requirements

Object: The request body must specify the blockchain chain, the count of addresses to generate, and optionally, the type of address, which is relevant for certain chains.

Properties

chain: Specifies the blockchain type for which the address(es) will be generated. Supported values are 'BITCOIN', 'ETHEREUM', 'LITECOIN', 'TRON', 'ARBITRUM_ONE', and 'OPTIMISM'.

count: Indicates the number of addresses to generate. The value must be an integer between 1 and 6.

type (optional): Specifies the type of address to generate. For BITCOIN, the valid types are DEFAULT and P2WPKH. For all other chains, the only valid type is DEFAULT. This field defaults to DEFAULT if not provided.

Validation Rules

Chain Specific:

For BITCOIN, both DEFAULT (which generates a P2TR type address) and P2WPKH are valid values for the type field.

For chains other than BITCOIN, the type must be DEFAULT.

Type Constraints:

The type field is validated based on the chain specified:

If BITCOIN is selected, type can be either DEFAULT or P2WPKH.

For ETHEREUM, LITECOIN, TRON, ARBITRUM_ONE, and OPTIMISM, only DEFAULT is acceptable.

Count Validation:

The count must be a positive integer and should not exceed 5 to prevent excessive load and potential misuse of the service.

Error Handling

Custom error messages are provided to ensure that any input validation errors are clearly communicated to the developer, aiding in quick resolution:

Chain Validation Error: "Invalid chain specified. Allowed chains are 'BITCOIN', 'ETHEREUM', 'LITECOIN', 'TRON', 'ARBITRUM_ONE', and 'OPTIMISM'."

Count Validation Error: "Invalid count specified. The count must be a positive integer between 1 and 5."

Type Validation Error: "Invalid type specified for the selected chain."

Rate Limit

Specified rate limit for this endpoint is 3 requests per IP address per minute.

Request

Authorization

Add parameter in header

apikey

Example:

apikey: ********************

Body Params application/json

chain

enum<string>

required

Blockchain

Allowed values:

ETHEREUMOPTIMISMBITCOINLITECOINTRONARBITRUM_ONEARBITRUM_NOVA

Example:

ETHEREUM

count

integer

optional

>= 1<= 6

Default:

Examples:

type

enum<string>

optional

Address Type For BTC/LTC

Allowed values:

P2WPKHP2TRDEFAULT

Example

{
    "chain": "TRON",
    "count": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

success

boolean

required

API Normal response flag

Default:

true

msg

string

required

Response result message

Default:

data

array [object {2}]

required

chain

enum<string>

required

Blockchain

Allowed values:

ETHEREUMOPTIMISMBITCOINLITECOINTRONARBITRUM_ONEARBITRUM_NOVA

Example:

ETHEREUM

addr

string

required

Example

{
    "success": true,
    "data": [
        {
            "addr": "0xc3b1Cfb301D33A08fA9D9Af13A8D651Cc19f9C06",
            "chain": "ETHEREUM"
        }
    ],
    "msg": "ok"
}

🟠403Authentication error

🟠422Parameter error

🟠429Rate Limit Error

Create Sub-Address

Endpoint Description: /user-addrs#

Request Body Requirements#

Properties#

Validation Rules#

Error Handling#

Rate Limit#

Request

Request samples

Responses

Endpoint Description: /user-addrs

Request Body Requirements

Properties

Validation Rules

Error Handling

Rate Limit