Generate Deposit Address

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

Single Result - This endpoint returns only one single result. 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 ethereum-classic xrp zcash binance-smart-chain tron
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", "goerli" are test networks.

Example : testnet

Possible Values : mainnet testnet mordor nile goerli
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.

Example : yourExampleString

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.

Example : yourExampleString
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 : 2023-04-25
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 : yourExampleString
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

Credits Cost : 500 Credits For 1 Result(s)

Try it out

Request Example

Http Java C# PHP Python Ruby Node.js Go

POST

https://rest.cryptoapis.io/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses?context=yourExampleString

Headers

Content-Type: application/json

X-API-Key: my-api-key

Request Body

{
    "context": "yourExampleString",
    "data": {
        "item": {
            "label": "yourLabelStringHere"
        }
    }
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"label\": \"yourLabelStringHere\"
        }
    }
}");
Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses?context=yourExampleString")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.cryptoapis.io/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses?context=yourExampleString");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader(""X-API-Key", "my-api-key");
request.AddParameter("application/json", "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"label\": \"yourLabelStringHere\"
        }
    }
}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses?context=yourExampleString');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

$request->setBody('{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"label\": \"yourLabelStringHere\"
        }
    }
}');

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.cryptoapis.io")

payload = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"label\": \"yourLabelStringHere\"
        }
    }
}"
    querystring = {"context":"yourExampleString"}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("POST", "wallet-as-a-service,wallets,60c9d9921c38030006675ff6,bitcoin,testnet,addresses",payload, headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.cryptoapis.io/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses?context=yourExampleString")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'
request.body = "{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"label\": \"yourLabelStringHere\"
        }
    }
}"

response = http.request(request)
puts response.read_body

var https = require("https");

var options = {
  "method": "POST",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses",
  "qs": {"context":"yourExampleString"},
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key"
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
    "context": "yourExampleString",
    "data": {
        "item": {
            "label": "yourLabelStringHere"
        }
    }
}));

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.cryptoapis.io/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses?context=yourExampleString"

  payload := strings.NewReader("{
    \"context\": \"yourExampleString\",
    \"data\": {
        \"item\": {
            \"label\": \"yourLabelStringHere\"
        }
    }
}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

201 400 401 402 403 404 409 415 422 429 500

Response Example

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "address": "0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036",
            "createdTimestamp": 1624028267,
            "label": "yourLabelStringHere"
        }
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "wallet_as_a_service_deposit_addresses_limit_reached",
        "message": "You have reached the maximum Deposit Addresses count which is currently {depositAddressesCount}. Please, upgrade your plan in order to have a higher Deposit Address count.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "wallet_as_a_service_provided_network_is_not_suitable_for_this_wallet_type",
        "message": "This wallet is not for the provided network.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "resource_not_found",
        "message": "Resource not found",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2023-04-25",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

Key	Value

Generate Deposit Address

Path Parameters

Query parameters

Request body schema application/json

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Credits Cost : 500 Credits For 1 Result(s)

Request Example

Response Example

Try It Out API Endpoint