Task: Get New Address

task::get_new_address::initAPI-v2task::get_new_address::init

A hierarchical-deterministic (HD) wallet generates a new key pair from a master key pair, allowing for multiple addresses to be generated from the same seed so that change from transactions go to a previously unused address, enhancing privacy and security. The hierarchical structure resembles that of a tree, with the master key “determining” the key pairs that follow it in the hierarchy. If you are running KDF in HD mode, and don’t already have too many unused addresses, you can use the get_new_address method to generate a new address. The generated address will be shown in the task::account_balance RPCs and at the next coin activation.

Arguments

Parameter	Type	Description
coin	string	The ticker of the coin you want to get a new address for
account_id	integer	Generally this will be `0` unless you have multiple accounts registered on your Trezor
chain	string	`Internal`, or `External`. Defaults to `External`. External is used for addresses that are intended to be visible outside of the wallet (e.g. for receiving payments). Internal is used for addresses which are not meant to be visible outside of the wallet and is used to return the leftover change from a transaction.
gap_limit	integer	Optional. The maximum number of empty addresses in a row. Defaults to the value provided on activation or 20 if no value was provided

Response

Parameter	Type	Description
new_address	object	A standard NewAddressInfo object.

Some reasons you might not be able to get a new address are:

EmptyAddressesLimitReached - Last gap_limit addresses are still unused.
AddressLimitReached - Addresses limit reached. Currently, the limit is 2^31

📌 Examples

Command

POST task::get_new_address::init

{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::get_new_address::init",
  "params": {
    "coin": "DOC",
    "account_id": 0,
    "chain": "External",
    "gap_limit": 20
  }
}

curl --url "http://127.0.0.1:7783" --data '{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::get_new_address::init",
  "params": {
    "coin": "DOC",
    "account_id": 0,
    "chain": "External",
    "gap_limit": 20
  }
}'

import requests
import json

url = "http://127.0.0.1:7783"
payload = {
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::get_new_address::init",
  "params": {
    "coin": "DOC",
    "account_id": 0,
    "chain": "External",
    "gap_limit": 20
  }
}

response = requests.post(url, json=payload)
print(json.dumps(response.json(), indent=2))

const payload = {
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::get_new_address::init",
  "params": {
    "coin": "DOC",
    "account_id": 0,
    "chain": "External",
    "gap_limit": 20
  }
};

const response = await fetch("http://127.0.0.1:7783", {
  method: "POST",
  body: JSON.stringify(payload),
});

console.log(await response.json());

<?php

$payload = <<<'JSON'
{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::get_new_address::init",
  "params": {
    "coin": "DOC",
    "account_id": 0,
    "chain": "External",
    "gap_limit": 20
  }
}
JSON;

$ch = curl_init("http://127.0.0.1:7783");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

package main

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

func main() {
	payload := []byte(`{"userpass":"RPC_UserP@SSW0RD","mmrpc":"2.0","method":"task::get_new_address::init","params":{"coin":"DOC","account_id":0,"chain":"External","gap_limit":20}}`)

	resp, err := http.Post("http://127.0.0.1:7783", "application/json", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require 'net/http'
require 'json'
require 'uri'

uri = URI("http://127.0.0.1:7783")
payload = {
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::get_new_address::init",
  "params": {
    "coin": "DOC",
    "account_id": 0,
    "chain": "External",
    "gap_limit": 20
  }
}

response = Net::HTTP.post(uri, payload.to_json, 'Content-Type' => 'application/json')
puts JSON.pretty_generate(JSON.parse(response.body))

Show Response

Response (success)

{
  "mmrpc": "2.0",
  "result": {
    "task_id": 3
  },
  "id": null
}