get_private_keys

The get_private_keys method provides unified offline private key export functionality, with optional HD support. There are two export modes: iguana and hd. The mode to be used should match the MM2.json enable_hd configuration. This method supports various coin protocols including UTXO-based coins (Bitcoin, Komodo, etc.), Ethereum-based tokens, Tendermint-based coins, and ZHTLC.

Arguments

Structure	Type	Description
coins	array of strings	array of coin tickers to export private keys for
mode	string (optional)	export mode: `"hd"` for HD wallet export, `"iguana"` for legacy Iguana format. Defaults based on MM2.json config
start_index	integer (optional)	`"mode": hd` only. starting address index for HD mode (default: 0).
end_index	integer (optional)	`"mode": hd` only. ending address index for HD mode (default: start_index + 10).
account_index	integer (optional)	`"mode": hd` only. account index for HD derivation path (default: 0).

Response

The response format depends on the mode value:

HD Mode Response

Structure	Type	Description
result	array of HdCoinKeys	array of coin key information with HD derivation data

Iguana Mode Response

Structure	Type	Description
result	array of IguanaKeysInfo	array of coin key information in Iguana format

For detailed information about the structure fields and examples for different coin types (UTXO, ETH, ZHTLC, Tendermint), refer to the HdKeysInfo and IguanaKeysInfo common structures.

📌 Examples

Command (HD Mode)

POST get_private_keys

{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "get_private_keys",
  "params": {
    "mode": "hd",
    "coins": [
      "KMD",
      "ETH",
      "ARRR",
      "ATOM",
      "LTC-segwit"
    ],
    "start_index": 0,
    "end_index": 1,
    "account_index": 0
  }
}

curl --url "http://127.0.0.1:7783" --data '{
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "get_private_keys",
  "params": {
    "mode": "hd",
    "coins": [
      "KMD",
      "ETH",
      "ARRR",
      "ATOM",
      "LTC-segwit"
    ],
    "start_index": 0,
    "end_index": 1,
    "account_index": 0
  }
}'

import requests
import json

url = "http://127.0.0.1:7783"
payload = {
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "get_private_keys",
  "params": {
    "mode": "hd",
    "coins": [
      "KMD",
      "ETH",
      "ARRR",
      "ATOM",
      "LTC-segwit"
    ],
    "start_index": 0,
    "end_index": 1,
    "account_index": 0
  }
}

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

const payload = {
  "userpass": "RPC_UserP@SSW0RD",
  "mmrpc": "2.0",
  "method": "get_private_keys",
  "params": {
    "mode": "hd",
    "coins": [
      "KMD",
      "ETH",
      "ARRR",
      "ATOM",
      "LTC-segwit"
    ],
    "start_index": 0,
    "end_index": 1,
    "account_index": 0
  }
};

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": "get_private_keys",
  "params": {
    "mode": "hd",
    "coins": [
      "KMD",
      "ETH",
      "ARRR",
      "ATOM",
      "LTC-segwit"
    ],
    "start_index": 0,
    "end_index": 1,
    "account_index": 0
  }
}
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":"get_private_keys","params":{"mode":"hd","coins":["KMD","ETH","ARRR","ATOM","LTC-segwit"],"start_index":0,"end_index":1,"account_index":0}}`)

	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": "get_private_keys",
  "params": {
    "mode": "hd",
    "coins": [
      "KMD",
      "ETH",
      "ARRR",
      "ATOM",
      "LTC-segwit"
    ],
    "start_index": 0,
    "end_index": 1,
    "account_index": 0
  }
}

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

Show Response

Response (HD Mode)

Each coin object contains an array of HdKeysInfo objects:

{
  "mmrpc": "2.0",
  "result": [
      {
          "coin": "KMD",
          "addresses": [
              {
                  "derivation_path": "m/44'/141'/0/0/0",
                  "pubkey": "02416813acfc3d051f2a3163241528331cb1407814ca7eda035e29dd81ce1a7360",
                  "address": "RLEiXpHJrBBFGLHfBVyKwB8pWyuZvTX46Q",
                  "priv_key": "Ur57s4Btk5zv7ts2Rb1vHUjDzcBUuPGXZtuLUKK2yUTSCyNiA82f"
              },
              {
                  "derivation_path": "m/44'/141'/0/0/1",
                  "pubkey": "02acd4bb36d93065879be4aae17c62791898ce366adb732b03dc0ce8092d04944b",
                  "address": "RJyVMQknrJnGBQVUrSBNffc2BD8j7kM6w1",
                  "priv_key": "UuMf4R7qEccYNDQWKYeooBANodhfev37QyoAnqZyb2VQz3CFGPH2"
              }
          ]
      },
      {
          "coin": "ETH",
          "addresses": [
              {
                  "derivation_path": "m/44'/60'/0/0/0",
                  "pubkey": "0x47d306e1d039d958539d7b292c62a1da1d61eff2f4d8d96d35f3074032ef4a28f2434dab1170092591b955043792e6d8278d16b37363d79d34b5029dbe2d9a51",
                  "address": "0x614b89716A94b5be94a67540dF9A5bF1bE1685F3",
                  "priv_key": "0x4718e83c33159c53c19fbb44b98a5006a902d682ad096b2e1dbb7c55619463ac"
              },
              {
                  "derivation_path": "m/44'/60'/0/0/1",
                  "pubkey": "0xde36fe6b0b1eaea7447e4bb3a56c8755fd5cf5d3fd9885a0582c99777229052e1b7019075669c5d65d4878b3db06e0b534159b0ba762714737677711b3375a3f",
                  "address": "0x49F4A1c47579d9603100Fc50e227079794335f20",
                  "priv_key": "0xe6a0f10b28192d2823433ec7121633c5d85239799b50e1e93280d000ad6a1341"
              }
          ]
      },
      {
          "coin": "ARRR",
          "addresses": [
              {
                  "derivation_path": "m/44'/141'/0/0/0",
                  "pubkey": "02416813acfc3d051f2a3163241528331cb1407814ca7eda035e29dd81ce1a7360",
                  "address": "zs1tc85uguljgmhrhreqnsphanu4xura9lcn6zmz7qr3unsq5yr34kvl6938rvz7d2uml5g53ae3ys",
                  "priv_key": "secret-extended-key-main1qd0cv2y2qqqqpqye077hevux884lgksjtcqrxnc2qtdrfs05qh3h2wc99s8zc2fpke4auwnrwhpzqfzdudqn2t34t08d8rfvx3df02cgff82x5spg7lq28tvsr9vvwx6sdsymjc7fgk2ued06z9rzkp6lfczlx5ykj3mrqcy4l4wavgqsgzem0nunwzllely77k0ra86nhl936auh2qkuc3j3k75nmdw3cwaaevty6pq5wv57nxfqhwc2q4a97wpg2duxezegpkqe4cg05smz",
                  "viewing_key": "zxviews1qd0cv2y2qqqqpqye077hevux884lgksjtcqrxnc2qtdrfs05qh3h2wc99s8zc2fpkepkc20seu8dr44353s5ydt2vmlzr9jmk6dnqx2su6g2tp7jetqalgd45qweck6r54dexp2397m3qj2kwd5d8rq4fdu3lddh7fjc4awv4l4wavgqsgzem0nunwzllely77k0ra86nhl936auh2qkuc3j3k75nmdw3cwaaevty6pq5wv57nxfqhwc2q4a97wpg2duxezegpkqe4czeh3g2"
              },
              {
                  "derivation_path": "m/44'/141'/0/0/1",
                  "pubkey": "02acd4bb36d93065879be4aae17c62791898ce366adb732b03dc0ce8092d04944b",
                  "address": "zs1gzddrvely0w04ugfgqaqnmsfdastjpgncedzk9duepvfwfwv3gnz7sqtwypp3g76szhxvky9fct",
                  "priv_key": "secret-extended-key-main1qhcqkcgnqyqqqq9mxw0qagvy89vdgmxn97jekuuatm3vcta2ejc9ehqdj7zafu370h2ph55942ysapxklzx4mv79mzceh0yxx5xfe3kau0lt7l5c5hfqfqg93fwm9rjq2avx8rpq77j38cwk8zgezn22qa097r5pezmg5qcfq86sup92ffwjachkeqfmla94ta5vp5jp3fzl32d669602w05xxavm0zr4nc476dy8gk2dytl79zcwrvpmnl5mg94r5mdecnsnwwexqsp3k56y",
                  "viewing_key": "zxviews1qhcqkcgnqyqqqq9mxw0qagvy89vdgmxn97jekuuatm3vcta2ejc9ehqdj7zafu370k24wlc7y7w6we2eck5cxa675cjmmhu8ya8ujlq37fvf8sdkl0tvqad6s8qscj7aynlw9wpta7meyap5z02ha8hq5eta0v7je7zv6esuq86sup92ffwjachkeqfmla94ta5vp5jp3fzl32d669602w05xxavm0zr4nc476dy8gk2dytl79zcwrvpmnl5mg94r5mdecnsnwwexqs8ypfm4"
              }
          ]
      },
      {
          "coin": "ATOM",
          "addresses": [
              {
                  "derivation_path": "m/44'/118'/0/0/0",
                  "pubkey": "03888f72d067742f86922ed59e2e9c5ed4ac169ab930a1ef09d1073e8315c9057f",
                  "address": "cosmos1cfzlpyygw0vnjsqvgp0gnx52pd8ca4xqjs5cfu",
                  "priv_key": "c53a59347d214359d8b180c7d9d0ed4571d3e28e073ed3d4e366ab7556eaaa44"
              },
              {
                  "derivation_path": "m/44'/118'/0/0/1",
                  "pubkey": "03d4da08e60e30d01dd9a17f4056302139461b168dbc3ef1fe6e4a97d467106774",
                  "address": "cosmos1zx32jeyv22quwke3rl75076l53rqusve9vcnuy",
                  "priv_key": "f297934a5b4bfbd814e3201dd9ebfa806eec220eed0382253ecbca9bd153286d"
              }
          ]
      },
      {
          "coin": "LTC-segwit",
          "addresses": [
              {
                  "derivation_path": "m/84'/2'/0/0/0",
                  "pubkey": "02e32887fa81f83a4ff7a19f0852fd81bd55777e9b18c5568c677ea15259072cab",
                  "address": "ltc1qmqpl475drzjhlun0fpap2ktq2ctflhzyqqzphl",
                  "priv_key": "T87JyKC4cVCEtjEHjUDEH5vZibLb6VjjvKiaS9pre9JM77NrDcMe"
              },
              {
                  "derivation_path": "m/84'/2'/0/0/1",
                  "pubkey": "03a99ef21c9df994f508f893490efad0677697dffd7f16b61082b89e5057bd9196",
                  "address": "ltc1qrm26v0v6m58r3wa0nrzs90f7gd7tqrl92fpup8",
                  "priv_key": "T5BeXdbLb6JhJbUaLAiHJVLk2GB6ZZizGQWWBefQWuJuJrzYRtUZ"
              }
          ]
      }
  ],
  "id": null
}

Command (Iguana Mode)

POST get_private_keys

{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "get_private_keys",
  "coins": [
    "KMD",
    "ETH",
    "ARRR",
    "ATOM",
    "LTC-segwit"
  ],
  "mode": "iguana"
}

curl --url "http://127.0.0.1:7783" --data '{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "get_private_keys",
  "coins": [
    "KMD",
    "ETH",
    "ARRR",
    "ATOM",
    "LTC-segwit"
  ],
  "mode": "iguana"
}'

import requests
import json

url = "http://127.0.0.1:7783"
payload = {
  "userpass": "RPC_UserP@SSW0RD",
  "method": "get_private_keys",
  "coins": [
    "KMD",
    "ETH",
    "ARRR",
    "ATOM",
    "LTC-segwit"
  ],
  "mode": "iguana"
}

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

const payload = {
  "userpass": "RPC_UserP@SSW0RD",
  "method": "get_private_keys",
  "coins": [
    "KMD",
    "ETH",
    "ARRR",
    "ATOM",
    "LTC-segwit"
  ],
  "mode": "iguana"
};

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",
  "method": "get_private_keys",
  "coins": [
    "KMD",
    "ETH",
    "ARRR",
    "ATOM",
    "LTC-segwit"
  ],
  "mode": "iguana"
}
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","method":"get_private_keys","coins":["KMD","ETH","ARRR","ATOM","LTC-segwit"],"mode":"iguana"}`)

	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",
  "method": "get_private_keys",
  "coins": [
    "KMD",
    "ETH",
    "ARRR",
    "ATOM",
    "LTC-segwit"
  ],
  "mode": "iguana"
}

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

Show Response

Response (Iguana Mode)

Each item is an IguanaKeysInfo object:

{
  "mmrpc": "2.0",
  "result": [
      {
          "coin": "KMD",
          "pubkey": "0399e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f",
          "address": "RQbyMz5jSBjidHkM4wRAhmbHUTSR7UehXG",
          "priv_key": "UpaMPnKdPZJWBGb8whpQWjP5A61WpT6e2SUYQz4KyfkE4JzVU9ZF"
      },
      {
          "coin": "ETH",
          "pubkey": "0x99e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f4e4a134020143df1d5cc243bb558db3eb94060247efd2c0a92878378ec424957",
          "address": "0x2E75c8e10541C1202bFA8E38440b51A78263a914",
          "priv_key": "0x10e0c6d3fcfdfe38f9200d83d5d17383f8bc756bfbcf01d7ec147110eccaf67a"
      },
      {
          "coin": "ARRR",
          "pubkey": "0399e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f",
          "address": "zs1dapmqsrrepxxw9qy4x97k5wpztjd2z6tzkgtgnyhyukzks92tttm9cnye02c2yd8qd6ug7uysvf",
          "priv_key": "secret-extended-key-main1qqqqqqqqqqqqqqqqn7vs773606gx6lu3yhnmefhmcq887pxauktferk7530gcjdag0ggkajtt2c0vprldflng26q20veqyeuywlfmzpvjypnup59mmcqzalxgdvh294lucfwa9dx9c4c5ufh8aqdnyuxcznuw87jdkcg6xg88f282k6f4vzkzprfqaxv0fe7spe7c7a0z35y4zrq9y8wllm0c680lp7rc6z555szreu2mh8kgztm2jp3u5e8erp320mftv30v7egzzg9tjxx5"
      },
      {
          "coin": "ATOM",
          "pubkey": "0399e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f",
          "address": "cosmos14qtjek3vhdavfxv5q4mtywe75uvuatvud6fvv4",
          "priv_key": "10e0c6d3fcfdfe38f9200d83d5d17383f8bc756bfbcf01d7ec147110eccaf67a"
      },
      {
          "coin": "LTC-segwit",
          "pubkey": "0399e7edd441d026ab62d915c6542464002c1634cacfa3afd69fb9c08b7b76355f",
          "address": "LaYjYgWGv2BCp65JmuRLtGKqvQM6crcRD4",
          "priv_key": "T3cnXqzqHiJrV4RvJo5gxeFEAsbgoRqv58zyhXuC5vhggLfJvQF7"
      }
  ],
  "id": null
}

Error Types

Error Type	Description
HdRangeTooLarge	`end_index` must not be > 100 higher than `start_index`
InvalidHdRange	`start_index`must be ≤ `end_index`
InvalidRequest	`start_index`, `end_index` or `account_index` value must not be negative
KeyDerivationFailed	Many causes, see examples below for more information
CoinConfigNotFound	Requested coin does not exist in coins configuration
InvalidParametersForMode	HD-specific parameters provided when using Iguana mode

Show Error Responses

Response (Error)

HdRangeTooLarge (negative index)

When the end_index value is less than the start_index value

{
  "mmrpc": "2.0",
  "error": "HD index range is too large: maximum range is 100 addresses",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:672]",
  "error_type": "HdRangeTooLarge",
  "id": null
}

InvalidHdRange (negative index)

When the end_index value is less than the start_index value

{
  "mmrpc": "2.0",
  "error": "HD index range is invalid: start_index 22 must be less than or equal to end_index 1",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:637]",
  "error_type": "InvalidHdRange",
  "error_data": {
      "start_index": 22,
      "end_index": 1
  },
  "id": null
}

InvalidRequest (negative index)

When the start_index, end_index or account_index value is negative

{
  "mmrpc": "2.0",
  "error": "Error parsing request: invalid value: integer `-560`, expected u32",
  "error_path": "dispatcher",
  "error_trace": "dispatcher:125]",
  "error_type": "InvalidRequest",
  "error_data": "invalid value: integer `-560`, expected u32",
  "id": null
}

KeyDerivationFailed (index overflow)

When the start_index, end_index or account_index value is too high

{
  "mmrpc": "2.0",
  "error": "Failed to derive keys for KMD: Invalid derivation path m/44'/141'/4294967295'/0/0: Bip32Error(ChildNumber)",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:314]",
  "error_type": "KeyDerivationFailed",
  "error_data": {
      "ticker": "KMD",
      "error": "Invalid derivation path m/44'/141'/4294967295'/0/0: Bip32Error(ChildNumber)"
  },
  "id": null
}

CoinConfigNotFound (Unsupported coin)

When sending a query to a coin which is not present in the coins configuration file.

{
  "mmrpc": "2.0",
  "error": "Coin configuration not found for COVID",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:275]",
  "error_type": "CoinConfigNotFound",
  "error_data": "COVID",
  "id": null
}

KeyDerivationFailed (Unsupported coin)

When sending a query to a coin which has no derivation_path defined in the coins configuration file.

{
  "mmrpc": "2.0",
  "error": "Failed to derive keys for BBK: Derivation path not defined for this coin. HD mode requires a valid derivation_path in the coin configuration.",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:281]",
  "error_type": "KeyDerivationFailed",
  "error_data": {
      "ticker": "BBK",
      "error": "Derivation path not defined for this coin. HD mode requires a valid derivation_path in the coin configuration."
  },
  "id": null
}

KeyDerivationFailed (wrong mode)

When sending a query with "mode": "hd", while KDF configuration is set to "enable_hd": false

{
  "mmrpc": "2.0",
  "error": "Failed to derive keys for ETH: HD key derivation requires GlobalHDAccount mode. Please initialize with HD wallet.",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:303]",
  "error_type": "KeyDerivationFailed",
  "error_data": {
      "ticker": "ETH",
      "error": "HD key derivation requires GlobalHDAccount mode. Please initialize with HD wallet."
  },
  "id": null
}

KeyDerivationFailed (wrong mode)

When sending a query with "mode": "iguana", while KDF configuration is set to "enable_hd": true

{
  "mmrpc": "2.0",
  "error": "Failed to derive keys for ARRR: Iguana key derivation requires Iguana mode",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:583]",
  "error_type": "KeyDerivationFailed",
  "error_data": {
      "ticker": "ARRR",
      "error": "Iguana key derivation requires Iguana mode"
  },
  "id": null
}

InvalidParametersForMode

When attempting to use the start_index, end_index or account_index when "mode": "iguana"

{
  "mmrpc": "2.0",
  "error": "Invalid parameters: start_index and end_index are only valid for HD mode",
  "error_path": "offline_keys",
  "error_trace": "offline_keys:650]",
  "error_type": "InvalidParametersForMode",
  "id": null
}

get_private_keys#

Arguments#

Response#

HD Mode Response#

Iguana Mode Response#

📌 Examples#

Command (HD Mode)#

Response (HD Mode)#

Command (Iguana Mode)#

Response (Iguana Mode)#

Error Types#

Response (Error)#

HdRangeTooLarge (negative index)#

InvalidHdRange (negative index)#

InvalidRequest (negative index)#

KeyDerivationFailed (index overflow)#

CoinConfigNotFound (Unsupported coin)#

KeyDerivationFailed (Unsupported coin)#

KeyDerivationFailed (wrong mode)#

KeyDerivationFailed (wrong mode)#

InvalidParametersForMode#

get_private_keys

Arguments

Response

HD Mode Response

Iguana Mode Response

📌 Examples

Command (HD Mode)

Response (HD Mode)

Command (Iguana Mode)

Response (Iguana Mode)

Error Types

Response (Error)

HdRangeTooLarge (negative index)

InvalidHdRange (negative index)

InvalidRequest (negative index)

KeyDerivationFailed (index overflow)

CoinConfigNotFound (Unsupported coin)

KeyDerivationFailed (Unsupported coin)

KeyDerivationFailed (wrong mode)

KeyDerivationFailed (wrong mode)

InvalidParametersForMode