Task: Scan for New Addresses
API-v2task::scan_for_new_addresses::init
| Parameter | Type | Description |
|---|---|---|
| coin | string | The ticker of the coin you want to scan addresses for |
| account_id | integer | Optional, HD wallets only. Generally this will be 0 unless you have multiple accounts registered on your HD wallet |
| 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 |
| Parameter | Type | Description |
|---|---|---|
| task_id | integer | An identifying number which is used to query task status. |
task::scan_for_new_addresses::init
POST
task::scan_for_new_addresses::init{
"userpass": "RPC_UserP@SSW0RD",
"mmrpc": "2.0",
"method": "task::scan_for_new_addresses::init",
"params": {
"coin": "DGB",
"account_index": 0,
"gap_limit": 20
}
}
{
"mmrpc": "2.0",
"result": {
"task_id": 3
},
"id": null
}
API-v2task::scan_for_new_addresses::status
Use the task::scan_for_new_addresses::status method to query the status of a HD address scanning task.
| Parameter | Type | Description |
|---|---|---|
| task_id | integer | The identifying number returned when initiating the task. |
| forget_if_finished | boolean | If false, will return final response for completed tasks. Optional, defaults to true. |
| Parameter | Type | Description |
|---|---|---|
| status | string | Status of the task. Ok, InProgress or Error. |
| details | string or object | Once complete, a standard ScanAddressesInfo object. |
task::scan_for_new_addresses::status
POST
task::scan_for_new_addresses::status{
"userpass": "RPC_UserP@SSW0RD",
"mmrpc": "2.0",
"method": "task::scan_for_new_addresses::status",
"params": {
"task_id": 3
}
}
{
"mmrpc": "2.0",
"result": {
"status": "Ok",
"details": {
"account_index": 0,
"derivation_path": "m/44'/141'/0'",
"new_addresses": []
}
},
"id": null
}
{
"mmrpc": "2.0",
"result": {
"status": "Ok",
"details": {
"account_index": 0,
"derivation_path": "m/44'/141'/0'",
"new_addresses": [
{
"address": "RXaMK6RtvwPiy67oramBfFXCgMobBofMWv",
"derivation_path": "m/44'/141'/0'/0/3",
"chain": "External",
"balance": {
"DOC": {
"spendable": "0",
"unspendable": "0"
}
}
},
{
"address": "RJkjq4DeQ5vTNJxa1gHoS4y31ZU9F3aisu",
"derivation_path": "m/44'/141'/0'/0/4",
"chain": "External",
"balance": {
"DOC": {
"spendable": "0.444",
"unspendable": "0"
}
}
}
]
}
},
"id": null
}