Generate Receiving Address

Through this endpoint customers can generate a new Receiving/Deposit Addresses into their Wallet.

POST /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses

Path Parameters

  • Required
    blockchain string

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

    Example : bitcoin
    Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum
  • Required
    network string

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten", "rinkeby" are test networks.

    Example : testnet
    Possible Values : mainnet testnet
  • Required
    walletId string

    Represents the unique ID of the specific Wallet.

    Example : 60c9d9921c38030006675ff6

Query parameters

  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Request body schema application/json

  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

  • Required
    data object
    • Required
      item object
      • Required
        label string

        Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".

        Example : yourLabelStringHere

Response schema

201 400 401 402 403 404 409 415 422 429 500
HTTP Status Code: 201
Content-Type: application/json

The resource has been successfully created.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0
  • Required
    requestId string

    Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

    Example : 601c1710034ed6d407996b30
  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : You can add any text here
  • Required
    data object
    • Required
      item object
      • Required
        address string

        Specifies the specific address's unique string value.

        Example : 0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036
      • Required
        createdTimestamp integer

        Defines the specific UNIX time when the deposit address was created.

        Example : 1624028267
      • Required
        label string

        Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".

        Example : yourLabelStringHere
Try it out

Request Example

POST
https://rest.cryptoapis.io/v2/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Request Body
{
    "context": "",
    "data": {
        "item": {
            "label": "yourLabelStringHere"
        }
    }
}

Response Example

{
    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "item": {
            "address": "0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036",
            "createdTimestamp": 1624028267,
            "label": "yourLabelStringHere"
        }
    }
}