kmd REST Paths

post /v1/wallet
Create a wallet (createWallet)
Create a new wallet (collection of keys) with the given parameters.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Create Wallet Request CreateWalletRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "wallet" : {
    "driver_name" : "driver_name",
    "supported_txs" : [ { }, { } ],
    "name" : "name",
    "driver_version" : 0,
    "id" : "id",
    "mnemonic_ux" : true
  },
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerCreateWalletResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTWalletResponse

delete /v1/key
Delete a key (deleteKey)
Deletes the key with the passed public key from the wallet.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Delete Key Request DeleteKeyRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerDeleteKeyResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1DELETEKeyResponse

delete /v1/multisig
Delete a multisig (deleteMultisig)
Deletes multisig preimage information for the passed address from the wallet.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Delete Multisig Request DeleteMultisigRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerDeleteMultisigResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1DELETEMultisigResponse

post /v1/key/export
Export a key (exportKey)
Export the secret key associated with the passed public key.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Export Key Request ExportKeyRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "private_key" : "",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerExportKeyResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTKeyExportResponse

post /v1/master-key/export
Export the master derivation key from a wallet (exportMasterKey)
Export the master derivation key from the wallet. This key is a master "backup" key for the underlying wallet. With it, you can regenerate all of the wallets that have been generated with this wallet's POST /v1/key endpoint. This key will not allow you to recover keys imported from other wallets, however.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Export Master Key Request ExportMasterKeyRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "master_derivation_key" : "",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerExportMasterKeyResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTMasterKeyExportResponse

post /v1/multisig/export
Export multisig address metadata (exportMultisig)
Given a multisig address whose preimage this wallet stores, returns the information used to generate the address, including public keys, threshold, and multisig version.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Export Multisig Request ExportMultisigRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "multisig_version" : 0,
  "pks" : [ "", "" ],
  "threshold" : 6,
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerExportMultisigResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTMultisigExportResponse

post /v1/key
Generate a key (generateKey)
Generates the next key in the deterministic key sequence (as determined by the master derivation key) and adds it to the wallet, returning the public key.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Generate Key Request GenerateKeyRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "address" : "address",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerGenerateKeyResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTKeyResponse

get /versions
(getVersion)
Retrieves the current version

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "versions" : [ "versions", "versions" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerVersionsResponse is an autogenerated wrapper from genSwaggerWrappers.py VersionsResponse

post /v1/wallet/info
Get wallet info (getWalletInfo)
Returns information about the wallet associated with the passed wallet handle token. Additionally returns expiration information about the token itself.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Get Wallet Info Request WalletInfoRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "wallet_handle" : {
    "wallet" : {
      "driver_name" : "driver_name",
      "supported_txs" : [ { }, { } ],
      "name" : "name",
      "driver_version" : 0,
      "id" : "id",
      "mnemonic_ux" : true
    },
    "expires_seconds" : 0
  },
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerWalletInfoResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTWalletInfoResponse

post /v1/key/import
Import a key (importKey)
Import an externally generated key into the wallet. Note that if you wish to back up the imported key, you must do so by backing up the entire wallet database, because imported keys were not derived from the wallet's master derivation key.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Import Key Request ImportKeyRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "address" : "address",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerImportKeyResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTKeyImportResponse

post /v1/multisig/import
Import a multisig account (importMultisig)
Generates a multisig account from the passed public keys array and multisig metadata, and stores all of this in the wallet.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Import Multisig Request ImportMultisigRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "address" : "address",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerImportMultisigResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTMultisigImportResponse

post /v1/wallet/init
Initialize a wallet handle token (initWalletHandleToken)
Unlock the wallet and return a wallet handle token that can be used for subsequent operations. These tokens expire periodically and must be renewed. You can POST the token to /v1/wallet/info to see how much time remains until expiration, and renew it with /v1/wallet/renew. When you're done, you can invalidate the token with /v1/wallet/release.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Initialize Wallet Handle Token Request InitWalletHandleTokenRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "wallet_handle_token" : "wallet_handle_token",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerInitWalletHandleTokenResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTWalletInitResponse

post /v1/key/list
List keys in wallet (listKeysInWallet)
Lists all of the public keys in this wallet. All of them have a stored private key.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

List Keys Request ListKeysRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "addresses" : [ "addresses", "addresses" ],
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerListKeysResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTKeyListResponse

post /v1/multisig/list
List multisig accounts (listMultisg)
Lists all of the multisig accounts whose preimages this wallet stores

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

List Multisig Request ListMultisigRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "addresses" : [ "addresses", "addresses" ],
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerListMultisigResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTMultisigListResponse

get /v1/wallets
List wallets (listWallets)
Lists all of the wallets that kmd is aware of.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

Example data

Content-Type: application/json
{
  "wallets" : [ {
    "driver_name" : "driver_name",
    "supported_txs" : [ { }, { } ],
    "name" : "name",
    "driver_version" : 0,
    "id" : "id",
    "mnemonic_ux" : true
  }, {
    "driver_name" : "driver_name",
    "supported_txs" : [ { }, { } ],
    "name" : "name",
    "driver_version" : 0,
    "id" : "id",
    "mnemonic_ux" : true
  } ],
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerListWalletsResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1GETWalletsResponse

post /v1/wallet/release
Release a wallet handle token (releaseWalletHandleToken)
Invalidate the passed wallet handle token, making it invalid for use in subsequent requests.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Release Wallet Handle Token Request ReleaseWalletHandleTokenRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerReleaseWalletHandleTokenResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTWalletReleaseResponse

post /v1/wallet/rename
Rename a wallet (renameWallet)
Rename the underlying wallet to something else

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Rename Wallet Request RenameWalletRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "wallet" : {
    "driver_name" : "driver_name",
    "supported_txs" : [ { }, { } ],
    "name" : "name",
    "driver_version" : 0,
    "id" : "id",
    "mnemonic_ux" : true
  },
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerRenameWalletResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTWalletRenameResponse

post /v1/wallet/renew
Renew a wallet handle token (renewWalletHandleToken)
Renew a wallet handle token, increasing its expiration duration to its initial value

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Renew Wallet Handle Token Request RenewWalletHandleTokenRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "wallet_handle" : {
    "wallet" : {
      "driver_name" : "driver_name",
      "supported_txs" : [ { }, { } ],
      "name" : "name",
      "driver_version" : 0,
      "id" : "id",
      "mnemonic_ux" : true
    },
    "expires_seconds" : 0
  },
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerRenewWalletHandleTokenResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTWalletRenewResponse

post /v1/multisig/sign
Sign a multisig transaction (signMultisigTransaction)
Start a multisig signature, or add a signature to a partially completed multisig signature object.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Sign Multisig Transaction Request SignMultisigRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "multisig" : "",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerSignMultisigResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTMultisigTransactionSignResponse

post /v1/transaction/sign
Sign a transaction (signTransaction)
Signs the passed transaction with a key from the wallet, determined by the sender encoded in the transaction.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Request body

Sign Transaction Request SignTransactionRequest (required)
Body Parameter

Return type

Example data

Content-Type: application/json
{
  "signed_transaction" : "",
  "error" : true,
  "message" : "message"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

SwaggerSignTransactionResponse is an autogenerated wrapper from genSwaggerWrappers.py APIV1POSTTransactionSignResponse

get /swagger.json
Gets the current swagger spec. (swaggerHandler)
Returns the entire swagger spec in json.

Consumes

This API call consumes the following media types via the Content-Type request header:
  • application/json

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json

Responses

200

The current swagger spec String

default

Unknown Error