On this page

latest contributor to this doc

Last Edit:

@gcharang

task_create_new_account

If you have activated a coin with the task::enable_utxo::init or task::enable_qtum::init and are using HD Mode, your funds may be spread across a range of addresses under a specified account index. The methods below will return the combined balance of your account, detailing the balance for each active account address.

API-v2init

Use the task::create_new_account::init method to initialise a HD account.

ParameterTypeDescription
coinstringTicker of coin you would like to initialise a HD account for.
account_idstringOptional. If not defined, will increment to the next unused account id in the wallet.
scanstringOptional. If true, will scan the account for funded addresses. Defaults to true.
gap_limitstringOptional. The maximum number of empty addresses in a row. Defaults to the value provided on activation, or 20 if no value was provided.

ParameterTypeDescription
task_idintegerAn identifying number which is used to query task status.

init

POST
task::create_new_account::init
{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::create_new_account::init",
  "params": {
    "coin": "KMD",
    "account_id": 77,
    "scan": true,
    "gap_limit": 20
  }
}
API-v2status

Use the task::create_new_account::status method to query the status of a HD account creation task.

ParameterTypeDescription
task_idintegerThe identifying number returned when initiating the withdrawal process.
forget_if_finishedbooleanIf false, will return final response for completed tasks. Optional, defaults to true.

ParameterTypeDescription
statusstringStatus of the task. Ok, InProgress or Error.
detailsstring or objectIf in progress, either Preparing or RequestingAccountBalance. Once complete, a standard WalletAccountInfo object.

POST
status
{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "task::create_new_account::status",
  "params": {
    "task_id": 1
  }
}