==1. Overview== dcrd provides a [https://json-rpc.org/wiki/specification JSON-RPC] API that is fully compatible with the original bitcoind/bitcoin-qt. There are a few key differences between dcrd and bitcoind as far as how RPCs are serviced: * Unlike bitcoind that has the wallet and chain intermingled in the same process which leads to several issues, dcrd intentionally splits the wallet and chain services into independent processes. See the blog post [https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon/ here] for further details on why they were separated. This means that if you are talking directly to dcrd, only chain-related RPCs are available. However both chain-related and wallet-related RPCs are available via [https://github.com/decred/dcrwallet dcrwallet]. * dcrd is secure by default which means that the RPC connection is TLS-enabled by default * dcrd provides access to the API through both [https://en.wikipedia.org/wiki/POST_%28HTTP%29 HTTP POST] requests and [https://en.wikipedia.org/wiki/WebSocket Websockets] Websockets are the preferred transport for dcrd RPC and are used by applications such as [https://github.com/decred/dcrwallet dcrwallet] for inter-process communication with dcrd. The websocket connection endpoint for dcrd is wss://your_ip_or_domain:9109/ws. In addition to the [[#5-standard-methods|standard API]], an [[#6-websocket-methods-websocket-specific|extension API]] has been developed that is exclusive to clients using Websockets. In its current state, this API attempts to cover features found missing in the standard API during the development of dcrwallet. While the [[#5-standard-methods|standard API]] is stable, the [[#6-websocket-methods-websocket-specific|Websocket extension API]] should be considered a work in progress, incomplete, and susceptible to changes (both additions and removals). ==2. HTTP POST Versus Websockets== The dcrd RPC server supports both [https://en.wikipedia.org/wiki/POST_%28HTTP%29 HTTP POST] requests and the preferred [https://en.wikipedia.org/wiki/WebSocket Websockets]. All of the standard and extension methods described in this documentation can be accessed through both. As the name indicates, the [[#6-websocket-methods-websocket-specific|Websocket-specific extension]] methods can only be accessed when connected via Websockets. As mentioned in the [[#1-overview|overview]], the websocket connection endpoint for dcrd is wss://your_ip_or_domain:9109/ws. The most important differences between the two transports as it pertains to the JSON-RPC API are: {| !  !HTTP POST Requests !Websockets |- |Allows multiple requests across a single connection |Yes |Yes |- |Supports asynchronous notifications |No |Yes |- |Scales well with large numbers of requests |No |Yes |} ==3. Authentication== ===3.1 Authentication Overview=== The following authentication details are needed before establishing a connection to a dcrd RPC server: * '''rpcuser''' is the full-access username configured for the dcrd RPC server * '''rpcpass''' is the full-access password configured for the dcrd RPC server * '''rpclimituser''' is the limited username configured for the dcrd RPC server * '''rpclimitpass''' is the limited password configured for the dcrd RPC server * '''rpccert''' is the PEM-encoded X.509 certificate (public key) that the dcrd server is configured with. It is automatically generated by dcrd and placed in the dcrd home directory (which is typically %LOCALAPPDATA%\Dcrd on Windows and ~/.dcrd on POSIX-like OSes) '''NOTE:''' As mentioned above, dcrd is secure by default which means the RPC server is not running unless configured with a '''rpcuser''' and '''rpcpass''' and/or a '''rpclimituser''' and '''rpclimitpass''', and uses TLS authentication for all connections. Depending on which connection type you are using, you can choose one of two, mutually exclusive, methods. * [[#32-http-basic-access-authentication|Use HTTP Authorization Header]] - HTTP POST requests and Websockets * [[#33-json-rpc-authenticate-command-websocket-specific|Use the JSON-RPC "authenticate" command]] - Websockets only ===3.2 HTTP Basic Access Authentication=== The dcrd RPC server uses HTTP [https://en.wikipedia.org/wiki/Basic_access_authentication basic access authentication] with the '''rpcuser''' and '''rpcpass''' detailed above. If the supplied credentials are invalid, you will be disconnected immediately upon making the connection. ===3.3 JSON-RPC Authenticate Command (Websocket-specific)=== While the HTTP basic access authentication method is the preferred method, the ability to set HTTP headers from websockets is not always available. In that case, you will need to use the [[#authenticate|authenticate]] JSON-RPC method. The [[#authenticate|authenticate]] command must be the first command sent after connecting to the websocket. Sending any other commands before authenticating, supplying invalid credentials, or attempting to authenticate again when already authenticated will cause the websocket to be closed immediately. ==4. Command-line Utility== dcrd comes with a separate utility named dcrctl which can be used to issue these RPC commands via HTTP POST requests to dcrd after configuring it with the information in the [[#3-authentication|Authentication]] section above. It can also be used to communicate with any server/daemon/service which provides a JSON-RPC API compatible with the original dcrd client. ==5. Standard Methods== ===5.1 Method Overview=== The following is an overview of the RPC methods and their current status. Click the method name for further details such as parameter and return information. {| !Method !Safe for limited user? !Description |- |[[#addnode|addnode]] |N |Attempts to add or remove a persistent peer. |- |[[#createrawsstx|createrawsstx]] |Y |Returns a new unsigned ticket spending the provided inputs. |- |[[#createrawssrtx|createrawssrtx]] |Y |Returns a new unsigned revocation spending the provided inputs. |- |[[#createrawtransaction|createrawtransaction]] |Y |Returns a new transaction spending the provided inputs and sending to the provided addresses. |- |[[#debuglevel|debuglevel]] |N |Dynamically changes the debug logging level. |- |[[#decoderawtransaction|decoderawtransaction]] |Y |Returns a JSON object representing the provided serialized, hex-encoded transaction. |- |[[#decodescript|decodescript]] |Y |Returns a JSON object with information about the provided hex-encoded script. |- |[[#estimatefee|estimatefee]] |Y |Returns the estimated fee in dcr/kb. |- |[[#estimatesmartfee|estimatesmartfee]] |Y |Returns the estimated fee using the historical fee data in dcr/kb. |- |[[#estimatestakediff|estimatestakediff]] |Y |Returns the estimated next minimum, maximum, expected, and user-specified stake difficulty. |- |[[#existsaddress|existsaddress]] |Y |Returns the existence of the provided address. |- |[[#existsaddresses|existsaddresses]] |Y |Returns the existence of the provided addresses. |- |[[#existsexpiredtickets|existsexpiredtickets]] |Y |Returns the existence of the provided tickets in the expired ticket map. |- |[[#existsliveticket|existsliveticket]] |Y |Returns the existence of the provided ticket. |- |[[#existslivetickets|existslivetickets]] |Y |Returns the existence of the provided tickets in the live ticket map. |- |[[#existsmempooltxs|existsmempooltxs]] |Y |Returns the existence of the provided txs in the mempool. |- |[[#existsmissedtickets|existsmissedtickets]] |Y |Returns the existence of the provided tickets in the missed ticket map. |- |[[#generate|generate]] |N |When in simnet or regtest mode, generate a set number of blocks. |- |[[#getaddednodeinfo|getaddednodeinfo]] |N |Returns information about manually added (persistent) peers. |- |[[#getbestblock|getbestblock]] |Y |Get block height and hash of best block in the main chain. |- |[[#getbestblockhash|getbestblockhash]] |Y |Returns the hash of the of the best (most recent) block in the longest block chain. |- |[[#getblock|getblock]] |Y |Returns information about a block given its hash. |- |[[#getblockchaininfo|getblockchaininfo]] |Y |Returns information about the current state of the block chain. |- |[[#getblockcount|getblockcount]] |Y |Returns the number of blocks in the longest block chain. |- |[[#getblockhash|getblockhash]] |Y |Returns hash of the block in best block chain at the given height. |- |[[#getblockheader|getblockheader]] |N |Returns the block header of the block. |- |[[#getblocksubsidy|getblocksubsidy]] |Y |Returns information regarding subsidy amounts. |- |[[#getcfilter|getcfilter]] |Y |Returns the committed filter for a block. |- |[[#getchaintips|getchaintips]] |Y |Returns information about all known chain tips the in the block tree. |- |[[#getcoinsupply|getcoinsupply]] |Y |Returns current total coin supply in atoms. |- |[[#getconnectioncount|getconnectioncount]] |N |Returns the number of active connections to other peers. |- |[[#getcurrentnet|getcurrentnet]] |Y |Get Decred network dcrd is running on. |- |[[#getdifficulty|getdifficulty]] |Y |Returns the proof-of-work difficulty as a multiple of the minimum difficulty. |- |[[#getgenerate|getgenerate]] |N |Return if the server is set to generate coins (mine) or not. |- |[[#gethashespersec|gethashespersec]] |N |Returns a recent hashes per second performance measurement while generating coins (mining). |- |[[#getheaders|getheaders]] |Y |Returns block headers starting with the first known block hash from the request. |- |[[#getinfo|getinfo]] |Y |Returns a JSON object containing various state info. |- |[[#getmempoolinfo|getmempoolinfo]] |N |Returns a JSON object containing mempool-related information. |- |[[#getmininginfo|getmininginfo]] |N |Returns a JSON object containing mining-related information. |- |[[#getnettotals|getnettotals]] |Y |Returns a JSON object containing network traffic statistics. |- |[[#getnetworkhashps|getnetworkhashps]] |Y |Returns the estimated network hashes per second for the block heights provided by the parameters. |- |[[#getnetworkinfo|getnetworkinfo]] |Y |Returns a JSON object containing network-related information. |- |[[#getpeerinfo|getpeerinfo]] |N |Returns information about each connected network peer as an array of json objects. |- |[[#getrawmempool|getrawmempool]] |Y |Returns an array of hashes for all of the transactions currently in the memory pool. |- |[[#getrawtransaction|getrawtransaction]] |Y |Returns information about a transaction given its hash. |- |[[#getstakedifficulty|getstakedifficulty]] |Y |Returns the proof-of-stake difficulty. |- |[[#getstakeversioninfo|getstakeversioninfo]] |Y |Returns stake version statistics for one or more stake version intervals. |- |[[#getstakeversions|getstakeversions]] |Y |Get stake versions per block. |- |[[#getticketpoolvalue|getticketpoolvalue]] |N |Returns the current value of all locked funds in the ticket pool. |- |[[#gettxout|gettxout]] |Y |Returns information about an unspent transaction output. |- |[[#getvoteinfo|getvoteinfo]] |Y |Returns the vote info statistics. |- |[[#getwork|getwork]] |N |Returns formatted hash data to work on or checks and submits solved data. NOTE: Since dcrd does not have the wallet integrated to provide payment addresses, dcrd must be configured via the --miningaddr option to provide which payment addresses to pay created blocks to for this RPC to function. |- |[[#help|help]] |Y |Returns a list of all commands or help for a specified command. |- |[[#livetickets|livetickets]] |Y |Returns live ticket hashes from the ticket database. |- |[[#missedtickets|missedtickets]] |Y |Returns missed ticket hashes from the ticket database. |- |[[#node|node]] |N |Attempts to add or remove a peer. |- |[[#ping|ping]] |N |Queues a ping to be sent to each connected peer. |- |[[#rebroadcastmissed|rebroadcastmissed]] |Y |Asks the daemon to rebroadcast missed votes. |- |[[#rebroadcastwinners|rebroadcastwinners]] |Y |Asks the daemon to rebroadcast the winners of the voting lottery. |- |[[#searchrawtransactions|searchrawtransactions]] |Y |Query for transactions related to a particular address. |- |[[#sendrawtransaction|sendrawtransaction]] |Y |Submits the serialized, hex-encoded transaction to the local peer and relays it to the network. |- |[[#setgenerate|setgenerate]] |N |Set the server to generate coins (mine) or not. NOTE: Since dcrd does not have the wallet integrated to provide payment addresses, dcrd must be configured via the --miningaddr option to provide which payment addresses to pay created blocks to for this RPC to function. |- |[[#stop|stop]] |N |Shutdown dcrd. |- |[[#submitblock|submitblock]] |Y |Attempts to submit a new serialized, hex-encoded block to the network. |- |[[#ticketfeeinfo|ticketfeeinfo]] |Y |Get various information about ticket fees from the mempool, blocks, and difficulty windows (units: DCR/kB). |- |[[#ticketsforaddress|ticketsforaddress]] |Y |Request all the tickets for an address. |- |[[#ticketvwap|ticketvwap]] |Y |Calculate the volume weighted average price of tickets for a range of blocks (default: full PoS difficulty adjustment depth). |- |[[#txfeeinfo|txfeeinfo]] |Y |Get various information about regular transaction fees from the mempool, blocks, and difficulty windows. |- |[[#validateaddress|validateaddress]] |Y |Verifies the given address is valid. NOTE: Since dcrd does not have a wallet integrated, dcrd will only return whether the address is valid or not. |- |[[#verifychain|verifychain]] |N |Verifies the block chain database. |- |[[#verifymessage|verifymessage]] |Y |Verifies a signed message. |- |[[#version|version]] |Y |Returns the JSON-RPC API version (semver). |} ===5.2 Method Details=== ====addnode==== {| !Method |addnode |- !Parameters | # peer: (string, required) ip address and port of the peer to operate on. # command: (string, required) - add to add a persistent peer, remove to remove a persistent peer, or onetry to try a single connection to a peer. |- !Description |Attempts to add or remove a persistent peer. |- !Returns |Nothing |} ---- ====createrawsstx==== {| !Method |createrawsstx |- !Parameters | # inputs: (json array, required) The inputs to the transaction of type. #: txid: (string) Unspent tx output hash. #: vout: Index of the output being redeemed. #: amt: Amount of utxo. #: tree: Which tree utxo is located. # amount: (json object, required) json object with the destination addresses as keys and amounts as values. #: {"desaddr":"amount", ...} # couts: (json array, required) Array of sstx commit outs to use. #: addr: (string) Address to send sstx commit. #: commitamt: (string) Amount to commit. #: changeamt: (string) Amount for change. #: changeaddr: (string) Address for change. |- !Description |Returns a new unsigned ticket spending the provided inputs. |- !Returns |(string) Hex-encoded bytes of the serialized transaction. |} ---- ====createrawssrtx==== {| !Method |createrawssrtx |- !Parameters | # inputs: (json array, required) The inputs to the transaction. #: amount: (numeric) Amount of the uxto. #: txid: (string) Unspent ticket output hash. #: vout: (numeric) Index of the ticket output being redeemed. #: tree: (numeric) Which tree utxo is located. # fee: (numeric) The fee to apply to the revocation in atoms. |- !Description |Returns a new unsigned revocation spending the provided inputs. |- !Returns |(string) Hex-encoded bytes of the serialized transaction |} ---- ====createrawtransaction==== {| !Method |createrawtransaction |- !Parameters | # transaction inputs: (JSON array, required) json array of json objects. #: amount: (numeric) the previous output amount. #: hash: (string, required) the hash of the input. #: vout: (numeric, required) the specific output of the input transaction to redeem transaction. #: [{"amount": n.nnn, "txid": "hash", "vout": n}, ...] # addresses and amounts: (JSON object, required) - json object with addresses as keys and output amounts as values. #: address: (string, required) the address to send the specified output amount to. #: {"address": n.nnn, ...} |- !Description | : Returns a new transaction spending the provided inputs and sending to the provided addresses.The transaction inputs are not signed in the created transaction. : The signrawtransaction RPC command provided by wallet must be used to sign the resulting transaction. |- !Returns |transaction: (string) - hex-encoded bytes of the serialized transaction |- !Example Parameters | # transaction inputs [{"amount":0.49213337, "txid":"e6da89de7a6b8508ce8f371a3d0535b04b5e108cb1a6e9284602d3bfd357c018", "vout":1}] # addresses and amounts {"13cgrTP7wgbZYWrY9BZ22BV6p82QXQT3nY": 0.49213337} |- !Example Return | : Newlines added for display purposes. The actual return does not contain newlines. : 010000000118c057d3bfd3024628e9a6b18c105e4bb035053d1a378fce08856b7ade89dae6010000 : 0000ffffffff0199efee02000000001976a9141cb013db35ecccc156fdfd81d03a11c51998f99388 : ac00000000 |} ---- ====debuglevel==== {| !Method |debuglevel |- !Parameters | # levelspec: (string, required) the debug level specification. |- !Description | : Dynamically changes the debug logging level. : The levelspec can either be a debug level or of the form =,=,... : The valid debug levels are trace, debug, info, warn, error, and critical. : The valid subsystems are AMGR, ADXR, BCDB, BMGR, DCRD, CHAN, DISC, PEER, RPCS, SCRP, SRVR, and TXMP. : Additionally, the special keyword show can be used to get a list of the available subsystems. |- !Returns |string |- !Example Return |Done. |- !Example show Return |Supported subsystems [AMGR ADXR BCDB BMGR DCRD CHAN DISC PEER RPCS SCRP SRVR TXMP] |} ---- ====decoderawtransaction==== {| !Method |decoderawtransaction |- !Parameters |# data: (string, required) serialized, hex-encoded transaction. |- !Description |Returns a JSON object representing the provided serialized, hex-encoded transaction. |- !Returns | (json object) : txid: (string) the transaction id. : hash: (string) the hash of the transaction. : locktime: (numeric) the transaction lock time. : version: (numeric) the block version. : expiry: (numeric) the transaction expiry. : vin: (array of json objects) the transaction inputs as json objects. : vout: (array of json objects) the transaction outputs as json objects. {"txid": "hash", "locktime": n, "version":n, "expiry": n, "vin": [...], "vout": [...]} ; vin (for coinbase transactions) : (json object) :: coinbase: (string) the hex-encoded bytes of the signature script. :: sequence: (numeric) the script sequence number. : {"coinbase": "data", "sequence": n, ...} ; vin (for stakebase transactions) : (json object) :: stakebase: (string) the hash of the stake transaction. :: sequence: (numeric) the script sequence number. : {"stakebase": "hash", "sequence": n, ...} ; vin (for non-coinbase / non-stakebase transactions) : (json object) :: txid: (string) the hash of the origin transaction. :: vout: (numeric) the index of the output being redeemed from the origin transaction. :: scriptSig: (json object) the signature script used to redeem the origin transaction. :: asm:(string) disassembly of the script. :: data: (string) hex-encoded bytes of the script. :: sequence: (numeric) the script sequence number. : {"txid": "hash", "vout": n,"scriptSig": {"asm": "asm", "hex": "data"}, "sequence": n, ...} ; vout : (json object) :: value: (numeric) the value in DCR. :: n: (numeric) the index of this transaction output. :: scriptPubKey:(json object) the public key script used to pay coins. :: asm: (string) disassembly of the script. :: hex: (string) hex-encoded bytes of the script. :: reqSigs: (numeric) the number of required signatures. :: type: (string) the type of the script (e.g. 'pubkeyhash'). :: addresses: (json array of string) the Decred addresses associated with this output. : { "value": n, "n": n, "scriptPubKey": {"asm": "asm", "hex": "data","reqSigs": n, "type": "scripttype","addresses": [...]}} |- !Example Return | ; For coinbase transactions : {"txid": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b", "version": 1, "locktime": 0, "vin": [{"coinbase": "04ffff001d0104455468652054696d65732030332f4a616e2f32303039204368616e63656c6c6...","sequence": 4294967295}, ...],"vout": [{"value": 50, "n": 0, "scriptPubKey": {"asm": "04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4ce...","hex": "4104678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4...", "reqSigs": 1,"type": "pubkey","addresses": ["1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", ...]}}]} ; For stakebase transactions : {"txid": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b", "version": 1, "locktime": 0, "vin": [{"stakebase": "60ac4b057247b3d0b9a8173de56b5e1be8c1d1da970511c626ef53706c66be04","sequence": 4294967295}, ...],"vout": [{"value": 50, "n": 0, "scriptPubKey": {"asm": "04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4ce...","hex": "4104678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4...", "reqSigs": 1,"type": "pubkey","addresses": ["1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", ...]}}]} ; For non-coinbase / non-stakebase transactions : {"txid": "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b", "version": 1, "locktime": 0, "vin": [{"txid": "60ac4b057247b3d0b9a8173de56b5e1be8c1d1da970511c626ef53706c66be04", "vout": 0, "scriptSig": {"asm": "3046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8f0...", "hex": "493046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8...",},"sequence": 4294967295}, ...],"vout": [{"value": 50, "n": 0, "scriptPubKey": {"asm": "04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4ce...","hex": "4104678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4...", "reqSigs": 1,"type": "pubkey","addresses": ["1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa", ...]}}]} |} ---- ====decodescript==== {| !Method |decodescript |- !Parameters |# script: (string, required) hex-encoded script. |- !Description |Returns a JSON object with information about the provided hex-encoded script. |- !Returns | (json object) : asm: (string) disassembly of the script (absent for nonstandard scripts). : reqSigs: (numeric) the number of required signatures. : type: (string) the type of the script (e.g. 'pubkeyhash'). : addresses: (json array of string) the Decred addresses associated with this script. : p2sh: (string) the script hash for use in pay-to-script-hash transactions. { "asm": "asm", "reqSigs": n, "type": "scripttype", "addresses": [...], "p2sh": "scripthash"} |- !Example Return |{"asm": "OP_DUP OP_HASH160 b0a4d8a91981106e4ed85165a66748b19f7b7ad4 OP_EQUALVERIFY OP_CHECKSIG", "reqSigs": 1, "type": "pubkeyhash", "addresses": ["1H71QVBpzuLTNUh5pewaH3UTLTo2vWgcRJ"], "p2sh": "359b84ff799f48231990ff0298206f54117b08b6"} |} ---- ====estimatefee==== {| !Method |estimatefee |- !Parameters | # numblocks: (numeric, required) unused. |- !Description |Returns the estimated fee in dcr/kb. |- !Returns |numeric |- !Example Return |0.0001 |} ---- ====estimatesmartfee==== {| !Method |estimatesmartfee |- !Parameters | # confirmations: (numeric, required) Estimate the fee rate a transaction requires so that it is mined in up to this number of blocks. # mode: (string) The only supported mode for the moment is 'conservative'. |- !Description |Returns the estimated fee using the historical fee data in dcr/kb. |- !Returns |numeric |- !Example Return | : 0.0001 |} ---- ====estimatestakediff==== {| !Method |estimatestakediff |- !Parameters | # tickets: (numeric) Use this number of new tickets in blocks to estimate the next difficulty. |- !Description |Returns the estimated next minimum, maximum, expected, and user-specified stake difficulty. |- !Returns | (json object) : min: (numeric) Minimum estimate for stake difficulty. : max: (numeric) Maximum estimate for stake difficulty. : expected: (numeric) Expected estimate for stake difficulty. : user: (numeric) Estimate for stake difficulty with the passed user amount of tickets. |- !Example Return |{"min": 128.13311397, "max": 137.30522474, "expected": 130.85145872, "user": 128.16965817} |} ---- ====existsaddress==== {| !Method |existsaddress |- !Parameters | # address: (string, required) The address to check. |- !Description |Returns the existence of the provided address. |- !Returns |boolean |- !Example Return |true |} ---- ====existsaddresses==== {| !Method |existsaddresses |- !Parameters | # addresses: (json array, required) The addresses to check. |- !Description |Returns the existence of the provided address. |- !Returns |bitset Bitset of bools showing if addresses exist or not. |- !Example Return |07 |} ---- ====existsexpiredtickets==== {| !Method |existsexpiredtickets |- !Parameters | # txhashes: (json array, required) The array of tx hashes to check. |- !Description |Returns the existence of the provided tickets in the expired ticket map. |- !Returns |bitset Bitset of bools showing if tx hashes exist or not as expired tickets. |- !Example Return |00 |} ---- ====existsliveticket==== {| !Method |existsliveticket |- !Parameters | # txhash: (string, required) The ticket hash to check. |- !Description |Returns the existence of the provided ticket. |- !Returns |boolean |- !Example Return |true |} ---- ====existslivetickets==== {| !Method |existslivetickets |- !Parameters | # txhashes: (json array, required) The array of tx hashes to check. |- !Description |Returns the existence of the provided tickets in the live ticket map. |- !Returns |bitset Bitset of bools showing if tx hashes exist or not as live tickets. |- !Example Return |00 |} ---- ====existsmempooltxs==== {| !Method |existsmempooltxs |- !Parameters | # txhashes: (json array, required) The array of tx hashes to check. |- !Description |Returns the existence of the provided txs in the mempool. |- !Returns |bitset Bitset of bools showing if tx hashes exist or not in the mempool. |- !Example Return |00 |} ---- ====existsmissedtickets==== {| !Method |existsmissedtickets |- !Parameters | # txhashes: (json array, required) The array of tx hashes to check. |- !Description |Returns the existence of the provided tickets in the missed ticket map. |- !Returns |bitset Bitset of bools showing if tx hashes exist or not as missed tickets. |- !Example Return |00 |} ---- ====generate==== {| !Method |generate |- !Parameters | # numblocks: (int, required) The number of blocks to generate. |- !Description |When in simnet or regtest mode, generates numblocks blocks. If blocks arrive from elsewhere, they are built upon but don't count toward the number of blocks to generate. Only generated blocks are returned. This RPC call will exit with an error if the server is already CPU mining, and will prevent the server from CPU mining for another command while it runs. |- !Returns |(json array of strings) : blockhash: hash of the generated block. ["blockhash", ...] |- |} ---- ====getaddednodeinfo==== {| !Method |getaddednodeinfo |- !Parameters | # dns: (boolean, required) specifies whether the returned data is a JSON object including DNS and connection information, or just a list of added peers. # node: (string, optional) only return information about this specific peer instead of all added peers. |- !Description |Returns information about manually added (persistent) peers. |- !Returns (dns=false) |["ip:port", ...] |- !Returns (dns=true) |(json array of objects) : addednode: (string) the ip address or domain of the added peer. : connected: (boolean) whether or not the peer is currently connected. : addresses: (json array or objects) DNS lookup and connection information about the peer. : address: (string) the ip address for this DNS entry. : connected: (string) the connection 'direction' (if connected). [{"addednode": "ip_or_domain","connected": true or false,"addresses": [{address: "ip"}, ...], "connected": "inbound/outbound/false"}, ...] |- !Example Return (dns=false) |["192.168.0.10:9108", "mydomain.org:9108"] |- !Example Return (dns=true) |[{"addednode": "mydomain.org:9108", "connected": true, "addresses": [{"address": "1.2.3.4", "connected": "outbound"}, {"address": "5.6.7.8", "connected": "false"}]}] |} ---- ====getbestblock==== {| !Method |getbestblock |- !Parameters |None |- !Description |Get block height and hash of best block in the main chain. |- !Returns | (json object) : hash: (string) the hex-encoded bytes of the best block hash. : height: (numeric) the block height of the best block. {"hash": "data", "height": n} |} ---- ====getbestblockhash==== {| !Method |getbestblockhash |- !Parameters |None |- !Description |Returns the hash of the of the best (most recent) block in the longest block chain. |- !Returns |string |- !Example Return |0000000000000001f356adc6b29ab42b59f913a396e170f80190dba615bd1e60 |} ---- ====getblock==== {| !Method |getblock |- !Parameters | # block hash: (string, required) the hash of the block. # verbose: (boolean, optional, default=true) specifies the block is returned as a JSON object instead of hex-encoded string. # verbosetx: (boolean, optional, default=false) specifies that each transaction is returned as a JSON object and only applies if the verbose flag is true. |- !Description |Returns information about a block given its hash. |- !Returns (verbose=false) |"data" (string) hex-encoded bytes of the serialized block |- !Returns (verbose=true, verbosetx=false) | (json object) : hash: (string) the hash of the block (same as provided). : confirmations: (numeric) the number of confirmations. : size: (numeric) the size of the block. : height: (numeric) the height of the block in the block chain. : version: (numeric) the block version. : merkleroot: (string) root hash of the merkle tree. : stakeroot: (string) root hash of the stake tree. : tx: (json array of string) the transaction hashes. : stx: (json array of string) the stake transaction hashes. : time: (numeric) the block time in seconds since 1 Jan 1970 GMT. : nonce: (numeric) the block nonce. : votebits: (numeric) the block voting results. : finalstate: (string) the final lottery state. : voters: (numeric) the number of votes. : freshstake: (numeric) the number of ticket purchases. : revocations: (numeric) the number of ticket revocations. : poolsize: (numeric) the total number of valid spendble tickets as of the block. : bits: (numeric) the bits which represent the block difficulty. : sbits: (numeric) the bits which represent the stake difficulty. : difficulty: (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty. : chainwork: (string) the total number of hashes expected to produce the chain up to the block in hex. : extradata: (string) extra data for the block including the extra nonce used by proof-of-work miners. : stakeversion: (string) block stake version. : previousblockhash: (string) the hash of the previous block. : nextblockhash: (string) the hash of the next block (only if there is one). {"hash": "blockhash", "confirmations": n, "size": n, "height": n, "version": n, "merkleroot": "hash", "stakeroot": "hash", "tx": ["transactionhash", ...], "stx": ["transactionhash", ...], "time": n, "nonce": n, "votebits": n, "finalstate": "state", "voters": n, "freshstake": n, "revocations": n, "poolsize": n, "bits": n, "sbits": n.nn, "difficulty": n.nn, "chainwork": "workhex", "extradata": "data", "stakeversion": n, previousblockhash": "hash", "nextblockhash": "hash"} |- !Example Return (verbose=false) | : Newlines added for display purposes. The actual return does not contain newlines. : "01000000b926d1870d6f88760a8b10db0d4439e5cd74f3827fd4b6827443000000000000 : 35cade3c4cd99e7547d1dffe8474855dd363dff69b395428810466c985d067c800000000 : 000000000000000000000000000000000000000000000000000000000100000000000000 : 0000000000000000ffff011b00c2eb0b00000000020000007e01000080d8b856bac0f231 : c84e3a6b6ad536d301000000000000000000000000000000000000000000000000000000 : 010100000001000000000000000000000000000000000000000000000000000000000000 : 0000ffffffff00ffffffff03fa1a981200000000000017a914f5916158e3e2c4551c1796 : 708db8367207ed13bb8700000000000000000000266a2402000000000000000000000000 : 000000000000000000000000000000ffa310d9a6a9588edea1906f0000000000001976a9 : 148ffe7a49ecf0f4858e7a52155302177398d2296988ac000000000000000001d8bc2882 : 0000000000000000ffffffff0800002f646372642f00" |- !Example Return (verbose=true, verbosetx=false) |"hash": "000000000000c41019872ff7db8fd2e9bfa05f42d3f8fee8e895e8c1e5b8dcba", "confirmations": 283285,"size": 382, "height": 2, "version": 1, "merkleroot": "c867d085c96604812854399bf6df63d35d857484fedfd147759ed94c3cdeca35", "stakeroot": "000000000000000000000000000000000000000000000000000000000000000", tx": ["ba8d2fcb5c705a1e5cbeda0db9dd30a521e360efd3aef75e862b2b69e0a673af", ...], "time": 1454954624, "nonce": 837992634, "votebits": 1, "finalstate": "000000000000", "voters": 0, "freshstake": 0, "revocations": 0, "poolsize": 0, "bits": "1d00ffff", "sbits": 2, "difficulty": 32767.74999809, "chainwork": "00000000000000000000000000000000000000000000000000018000c0006000", "extradata": "c84e3a6b6ad536d3010000000000000000000000000000000000000000000000", "stakeversion": 0, "previousblockhash": "000000000000437482b6d47f82f374cde539440ddb108b0a76886f0d87d126b9", "nextblockhash": "00000000000108ac3e3f51a0f4424dd757a3b0485da0ec96592f637f27bd1cf5"} |} ---- ====getblockchaininfo==== {| !Method |getblockchaininfo |- !Parameters |None |- !Description |Returns information about the current state of the block chain. |- !Returns |(json object) : chain: (string) The current network name. : blocks: (numeric) The number of blocks in the current best chain. : headers: (numeric) The number of validated block headers that comprise the target best chain. : syncheight: (numeric) The latest known block height being synced to. : bestblockhash: (string) The block hash of the current best chain tip. : difficulty: (numeric) (DEPRECATED) The current network difficulty. : difficultyratio: (numeric) The current proof-of-work difficulty as a multiple of the minimum difficulty. : verificationprogress: (numeric) The chain verification progress estimate. : chainwork: (string) Hex encoded total work done for the chain. : initialblockdownload: (boolean) Best guess of whether this node is in the initial block download mode used to catch up the chain when it is far behind. : maxblocksize: (numeric) The maximum allowed block size. : deployments: (json array of objects) Network consensus deployments. : status: (string) The deployment agenda's current status. : since: (numeric) The blockheight of the first block to which the status applies. : starttime: (numeric) The start time of the voting period for the agenda. : expiretime: (numeric) The expiry time of the voting period for the agenda. { "chain": "name", "blocks": n, "headers": n, "syncheight": n, "bestblockhash": "hash", "difficulty": n, "difficultyratio": n, "verificationprogress": n, "chainwork": "n", "initialblockdownload": bool, "maxblocksize": n, "deployments": {"agenda": { "status": "status", "since": n, "starttime": n, "expiretime": n}, ...}} |- !Example Return |{"chain": "simnet", "blocks": 463, "headers": 463, "syncheight": 0, "bestblockhash": "000043c89f6e227c9d90a5460aff98b662e503b9a394818942bdd60709cbb8aa", "difficulty": 520127421, "difficultyratio": 1180923195.260000, "verificationprogress": 0, "chainwork": "0x23c0e40", "initialblockdownload": false, "maxblocksize": 1000000, "deployments": {"lnfeatures": {"status": "started", "since": 463, "starttime": 0, "expiretime": 9223372036854775807}, "maxblocksize": {"status": "started", "since": 463, "starttime": 0, "expiretime": 9223372036854775807}, "sdiffalgorithm": {"status": "started", "since": 463, "starttime": 0, "expiretime": 9223372036854775807}}} |} ---- ====getblockcount==== {| !Method |getblockcount |- !Parameters |None |- !Description |Returns the number of blocks in the longest block chain. |- !Returns |numeric |- !Example Return |276820 |} ---- ====getblockhash==== {| !Method |getblockhash |- !Parameters | # block height (numeric, required) |- !Description |Returns hash of the block in best block chain at the given height. |- !Returns |string |- !Example Return |000000000000000096579458d1c0f1531fcfc58d57b4fce51eb177d8d10e784d |} ---- ====getblockheader==== {| !Method |getblockheader |- !Parameters | # block hash: (string, required) the hash of the block. # verbose: (boolean, optional, default=true) specifies the block header is returned as a JSON object instead of a hex-encoded string. |- !Description |Returns hex-encoded bytes of the serialized block header. |- !Returns (verbose=false) |"data" (string) hex-encoded bytes of the serialized block |- !Returns (verbose=true) |(json object) : hash: (string) the hash of the block (same as provided). : confirmations: (numeric) the number of confirmations. : version: (numeric) the block version. : merkleroot: (string) root hash of the merkle tree. : stakeroot: (string) root hash of the stake tree. : votebits: (numeric) the block voting results. : finalstate: (string) the final lottery state. : voters: (numeric) the number of votes. : freshstake: (numeric) the number of ticket purchases. : revocations: (numeric) the number of ticket revocations. : poolsize: (numeric) the total number of valid spendble tickets as of the block. : bits: (numeric) the bits which represent the block difficulty. : sbits: (numeric) the bits which represent the stake difficulty. : height: (numeric) the height of the block in the block chain. : size: (numeric) the size of the block. : time: (numeric) the block time in seconds since 1 Jan 1970 GMT. : nonce: (numeric) the block nonce. : extradata: (string) extra data for the block including the extra nonce used by proof-of-work miners. : stakeversion: (string) block stake version. : difficulty: (numeric) the proof-of-work difficulty as a multiple of the minimum difficulty. : chainwork: (string) the total number of hashes expected to produce the chain up to the block in hex. : previousblockhash: (string) the hash of the previous block. : nextblockhash: (string) the hash of the next block (only if there is one). {"hash": "blockhash", "confirmations": n, "version": n, "merkleroot": "hash", "stakeroot": "hash", "votebits": n, "finalstate": "state", "voters": n, "freshstake": n, "revocations": n, "poolsize": n, "bits": n, "sbits": n.nn, "height": n, "size": n, "time": n, "nonce": n, "extradata": "data", "stakeversion": n, "difficulty": n.nn, "chainwork": "workhex", "previousblockhash": "hash", "nextblockhash": "hash"} |- !Example Return (verbose=false) | : Newlines added for display purposes. The actual return does not contain newlines. : "0100000094f455952f88b4ff019c6673f3f01541b76e700e0c8a2ab9da00000000000000 : 266b9d4672f099e2b36c7adcede6564ee7326ac02b757b065e4a7c69efa44925825ccc8e : 9602af73d03e54ea1ac717f712c869440a1762375f64b9fe3ae2409f01008b736885bab7 : 0500000047a60000b494111a6688f80402000000a0860100600c000000a081585ab58b03 : 360000000024680140d1ec18000000000000000000000000000000000000000000000000" |- !Example Return (verbose=true) |{"hash": "00000000000004289d9a7b0f7a332fb60a1c221faae89a107ce3ab93eead2f93", "confirmations": 183291, "version": 1, "merkleroot": "2549a4ef697c4a5e067b752bc06a32e74e56e6eddc7a6cb3e299f072469d6b26", "stakeroot":"9f40e23afeb9645f3762170a4469c812f717c71aea543ed073af02968ecc5c82", "votebits": 1, "finalstate": "8b736885bab7", "voters": 5, "freshstake": 0, "revocations": 0, "poolsize": 42567, "bits": "1a1194b4", "sbits": 86.73331302, "height": 100000, "size": 3168, "time": 1484890112, "nonce": 59487578, "stakeversion": 0, "difficulty": 954273.50809769, "chainwork": "00000000000000000000000000000000000000000000001060ad4432c4d6eff1", "previousblockhash": "00000000000000dab92a8a0c0e706eb74115f0f373669c01ffb4882f9555f494", "nextblockhash": "0000000000000578b08f22fd2bdf5f7fe5b0af1bb4928de5053a3f906b3c8f6b"} |} ---- ====getblocksubsidy==== {| !Method |getblocksubsidy |- !Parameters | # height: (numeric, required) The block height. # voters: (numeric, required) The number of voters. |- !Description |Returns information regarding subsidy amounts. |- !Returns |(json object) : developer: (nuneric) The developer subsidy. : pos: (numeric) The Proof-of-Stake subsidy. : pow: (numeric) The Proof-of-Work subsidy. : total: (numeric) The total subsidy. |- !Example Return |{"developer": 171717305, "pos": 515151915, "pow": 1030303833, "total": 1717173053} |} ---- ====getcfilter==== {| !Method |getcfilter |- !Parameters | # hash: (string, required) The block hash of the filter being queried. # filtertype: (string, required) The type of committed filter to return. |- !Description |Returns the committed filter for a block. |- !Returns |string The hex encoded committed filter. |- !Example Return | : Newlines added for display purposes. The actual return does not contain newlines. :0000002305d72c4c0f6e3d19783a59f26cef1fab1ec21585f8016a22a43762cd2edbda7a1fba :596d06e092c6ec2f651d5242074fd063918741f4492dd0dd889f6909fd3028e04fa1e84259c4 :1088aea6fa0cd0cb162daaa4afb05de43718914a7e04 |} ---- ====getchaintips==== {| !Method |getchaintips |- !Parameters |None |- !Description | : Returns about all known chain tips the in the block tree. : The statuses in the result have the following meanings: * active: The current best chain tip. * invalid: The block or one of its ancestors is invalid. * headers-only: The block or one of its ancestors does not have the full block data available which also means the block can't be validated or connected. * valid-fork: The block is fully validated which implies it was probably part of the main chain at one point and was reorganized. * valid-headers: The full block data is available and the header is valid, but the block was never validated which implies it was probably never part of the main chain. |- !Returns | (json array of objects) : height: (numeric) The height of the chain tip. : hash: (string) The block hash of the chain tip. : branchlen: (numeric) The length of the branch that connects the tip to the main chain (0 for the main chain tip). : status: (string) status of the chain (active, invalid, headers-only, valid-fork, valid-headers). [{"height": n, "hash": "hash", "branchlen": n, "status": "status"}, ...] |- !Example Return |[{"height": 217033, "hash": "00000000000000161bd5b120ef945faad60fc6e4c32b5caf1d4cabeae9a75346", "branchlen": 0, "status": "active"}, {"height": 213522, "hash": "0000000000000015e27658ce02ba8fa05d8d7ad9c587a5a472e3307773a9b36e", "branchlen": 1, "status": "valid-fork"}]" |} ---- ====getcoinsupply==== {| !Method |getcoinsupply |- !Parameters |None |- !Description |Returns current total coin supply in atoms. |- !Returns |numeric Current coin supply in atoms. |- !Example Return |1029794286558577 |} ---- ====getconnectioncount==== {| !Method |getconnectioncount |- !Parameters |None |- !Description |Returns the number of active connections to other peers. |- !Returns |numeric |- !Example Return |8 |} ---- ====getcurrentnet==== {| !Method |getcurrentnet |- !Parameters |None |- !Description |Get Decred network dcrd is running on. |- !Returns |numeric |- !Example Return | : (mainnet) 3652501241 : (testnet3) 2979310197 : |} ---- ====getdifficulty==== {| !Method |getdifficulty |- !Parameters |None |- !Description |Returns the proof-of-work difficulty as a multiple of the minimum difficulty. |- !Returns |numeric |- !Example Return |1180923195.260000 |} ---- ====getgenerate==== {| !Method |getgenerate |- !Parameters |None |- !Description |Return if the server is set to generate coins (mine) or not. |- !Returns |false (boolean) |} ---- ====gethashespersec==== {| !Method |gethashespersec |- !Parameters |None |- !Description |Returns a recent hashes per second performance measurement while generating coins (mining). |- !Returns |0 (numeric) |} ---- ====getheaders==== {| !Method |getheaders |- !Parameters | # blocklocators: (json array, required) Array of block locator hashes. # hashstop: (string, required) Block hash to stop including block headers for, set to zero to get as many blocks as possible. |- !Description |Returns block headers starting with the first known block hash from the request. |- !Returns |(json object) : headers: (json array) Serialized block headers of all located blocks, limited to some arbitrary maximum number of hashes (currently 2000, which matches the wire protocol headers message, but this is not guaranteed). |- !Example Return |{"headers": ["060000001abfc354ad9f714fad8f8ec8ae0aecac8a660d...",...]} |} ---- ====getinfo==== {| !Method |getinfo |- !Parameters |None |- !Description |Returns a JSON object containing various state info. |- !Notes |NOTE: Since dcrd does NOT contain wallet functionality, wallet-related fields are not returned. See getinfo in dcrwallet for a version which includes that information. |- !Returns | (json object) : version: (numeric) the version of the server. : protocolversion: (numeric) the latest supported protocol version. : blocks: (numeric) the number of blocks processed. : timeoffset: (numeric) the time offset. : connections: (numeric) the number of connected peers. : proxy: (string) the proxy used by the server : difficulty: (numeric) the current target difficulty. : testnet: (boolean) whether or not server is using testnet. : relayfee: (numeric) the minimum relay fee for non-free transactions in DCR/KB. {"version": n,"protocolversion": n, "blocks": n, "timeoffset": n, "connections": n, "proxy": "host:port", "difficulty": n.nn, "testnet": true or false, "relayfee": n.nn} |- !Example Return |{"version": 70000, "protocolversion": 70001, "blocks": 298963, "timeoffset": 0, "connections": 17, "proxy": "", "difficulty": 8000872135.97, "testnet": false,"relayfee": 0.00001} |} ---- ====getmempoolinfo==== {| !Method |getmempoolinfo |- !Parameters |None |- !Description |Returns a JSON object containing mempool-related information. |- !Returns |(json object) : bytes: (numeric) size in bytes of the mempool : size: (numeric) number of transactions in the mempool {"bytes": n, "size": n} |- !Example Return |{"bytes": 310768, "size": 157} |} ---- ====getmininginfo==== {| !Method |getmininginfo |- !Parameters |None |- !Description |Returns a JSON object containing mining-related information. |- !Returns |(json object) : blocks: (numeric) latest best block. : currentblocksize: (numeric) size of the latest best block. : currentblocktx: (numeric) number of transactions in the latest best block. : difficulty: (numeric) current target difficulty. : stakedifficulty: (numeric) Stake difficulty required for the next block. : errors: (string) any current errors. : generate: (boolean) whether or not server is set to generate coins. : genproclimit: (numeric) number of processors to use for coin generation (-1 when disabled). : hashespersec: (numeric) recent hashes per second performance measurement while generating coins. : networkhashps: (numeric) estimated network hashes per second for the most recent blocks. : pooledtx: (numeric) number of transactions in the memory pool. : testnet: (boolean) whether or not server is using testnet. {"blocks": n, "currentblocksize": n, "currentblocktx": n, "difficulty": n.nn, "stakedifficulty": n, "errors": "errors", "generate": true or false, "genproclimit": n, "hashespersec": n, "networkhashps": n, "pooledtx": n, "testnet": true or false } |- !Example Return |{"blocks": 236526, "currentblocksize": 185, "currentblocktx": 1, "difficulty": 256, "errors": "", "generate": false, "genproclimit": -1, "hashespersec": 0, "networkhashps": 33081554756, "pooledtx": 8, "testnet": true } |} ---- ====getnettotals==== {| !Method |getnettotals |- !Parameters |None |- !Description |Returns a JSON object containing network traffic statistics. |- !Returns |(json object) : totalbytesrecv: (numeric) total bytes received. : totalbytessent: (numeric) total bytes sent. : timemillis: (numeric) number of milliseconds since 1 Jan 1970 GMT. {"totalbytesrecv": n, "totalbytessent": n, "timemillis": n } |- !Example Return |{"totalbytesrecv": 1150990, "totalbytessent": 206739, "timemillis": 1391626433845 } |} ---- ====getnetworkhashps==== {| !Method |getnetworkhashps |- !Parameters | # blocks: (numeric, optional, default=120) The number of blocks, or -1 for blocks since last difficulty change. # height: (numeric, optional, default=-1) Perform estimate ending with this height or -1 for current best chain block height. |- !Description |Returns the estimated network hashes per second for the block heights provided by the parameters. |- !Returns |numeric |- !Example Return |6573971939 |} ---- ====getnetworkinfo==== {| !Method |getnetworkinfo |- !Parameters |None |- !Description |Returns a JSON object containing network-related information. |- !Returns |(json object) : address: (string) The local address being listened on. : port: (numeric) The port being listened on for the associated local address. : score: (numeric) Reserved. : name: (string) The name of the network interface. : limited: (boolean) True if only connections to the network are allowed. : proxy: (string) The proxy set for the network. : proxyrandomizecredentials: (boolean) True if randomized credentials are set for the proxy. : reachable: (boolean) True if connections can be made to or from the network. : version: (numeric) The version of the node as a numeric. : subversion: (string) The subversion of the node, as advertised to peers. : protocolversion: (numeric) The protocol version of the node. : timeoffset: (numeric) The node clock offset in seconds. : connections: (numeric) The total number of open connections for the node. : networks: (json array) An array of objects describing IPV4, IPV6 and Onion network interface states. : relayfee: (numeric) The minimum required transaction fee for the node. : localaddresses: (json array) An array of objects describing local addresses being listened on by the node. : localservices: (string) The services supported by the node, as advertised in its version message. {"version": n, "subversion": "major.minor.patch", "protocolversion": n, "timeoffset": n, "connections": n, "networks": [{"name": "network", "limited": true or false, "reachable": true or false, "proxy": "host:port","proxyrandomizecredentials": true or false }, ...], "relayfee": n.nn., "localaddresses": [{ "address": "ip", "port": n, "score": n }, ...], "localservices": "services"} |- !Example Return |{"version": 1050000, "subversion": "1.5.0", "protocolversion": 6, "timeoffset": 0, "connections": 4, "networks": [{"name": "IPV4", "limited": true, "reachable": true, "proxy": "127.0.0.1:9050", "proxyrandomizecredentials": false}, {"name": "IPV6", "limited": false, "reachable": false, "proxy": "", "proxyrandomizecredentials": false}, {"name": "Onion", "limited": false, "reachable": false, "proxy": "", "proxyrandomizecredentials": false}], "relayfee": 0.0001, "localaddresses": [{"address": "fd87:d87e:eb43:d208:593b:4305:c8e5:2e77", "port": 9108, "score": 0}], "localservices": "0000000000000005"} |} ---- ====getpeerinfo==== {| !Method |getpeerinfo |- !Parameters |None |- !Description |Returns data about each connected network peer as an array of json objects. |- !Returns |(json array) : addr: (string) the ip address and port of the peer. : services: (string) the services supported by the peer. : lastrecv: (numeric) time the last message was received in seconds since 1 Jan 1970 GMT. : lastsend: (numeric) time the last message was sent in seconds since 1 Jan 1970 GMT. : bytessent: (numeric) total bytes sent. : bytesrecv: (numeric) total bytes received. : conntime: (numeric) time the connection was made in seconds since 1 Jan 1970 GMT. : pingtime: (numeric) number of microseconds the last ping took. : pingwait: (numeric) number of microseconds a queued ping has been waiting for a response. : version: (numeric) the protocol version of the peer. : subver: (string) the user agent of the peer. : inbound: (boolean) whether or not the peer is an inbound connection. : startingheight: (numeric) the latest block height the peer knew about when the connection was established. : currentheight: (numeric) the latest block height the peer is known to have relayed since connected. : syncnode: (boolean) whether or not the peer is the sync peer. [{"addr": "host:port", "services": "00000001", "lastrecv": n, "lastsend": n, "bytessent": n, "bytesrecv": n, "conntime": n, "pingtime": n, "pingwait": n, "version": n, "subver": "useragent", "inbound": true_or_false, "startingheight": n, "currentheight": n, "syncnode": true_or_false }, ...] |- !Example Return |[{"addr": "178.172.xxx.xxx:9108", "services": "00000001", "lastrecv": 1388183523, "lastsend": 1388185470, "bytessent": 287592965, "bytesrecv": 780340, "conntime": 1388182973, "pingtime": 405551, "pingwait": 183023, "version": 70001, "subver": "/dcrd:0.4.0/", "inbound": false, "startingheight": 276921, "currentheight": 276955, "syncnode": true }, ...] |} ---- ====getrawmempool==== {| !Method |getrawmempool |- !Parameters | # verbose (boolean, optional, default=false) |- !Description | :Returns an array of hashes for all of the transactions currently in the memory pool. :The verbose flag specifies that each transaction is returned as a JSON object. |- !Notes |Since dcrd does not perform any mining, the priority related fields startingpriority and currentpriority that are available when the verbose flag is set are always 0. |- !Returns (verbose=false) | (json array of string) : transactionhash: (string) hash of the transaction. ["transactionhash", ...] |- !Returns (verbose=true) | (json object) : size: (numeric) transaction size in bytes. : fee : (numeric) transaction fee in DCR. : time: (numeric) local time transaction entered pool in seconds since 1 Jan 1970 GMT. : height: (numeric) block height when transaction entered the pool. : startingpriority: (numeric) priority when transaction entered the pool. : currentpriority: (numeric) current priority. : depends: (json array) unconfirmed transactions used as inputs for this transaction. : transactionhash: (string) hash of the parent transaction. {"transactionhash": {"size": n,"fee" : n, "time": n,"height": n, "startingpriority": n, "currentpriority": n, "depends": ["transactionhash", ...]}, ...} |- !Example Return (verbose=false) |["3480058a397b6ffcc60f7e3345a61370fded1ca6bef4b58156ed17987f20d4e7","cbfe7c056a358c3a1dbced5a22b06d74b8650055d5195c1c2469e6b63a41514a"] |- !Example Return (verbose=true) |{"1697a19cede08694278f19584e8dcc87945f40c6b59a942dd8906f133ad3f9cc": {"size": 226, "fee" : 0.0001, "time": 1387992789, "height": 276836, "startingpriority": 0, "currentpriority": 0, "depends": ["aa96f672fcc5a1ec6a08a94aa46d6b789799c87bd6542967da25a96b2dee0afb", ...]} |} ---- ====getrawtransaction==== {| !Method |getrawtransaction |- !Parameters | # transaction hash: (string, required) the hash of the transaction. # verbose: (int, optional, default=0) specifies the transaction is returned as a JSON object instead of hex-encoded string. |- !Description |Returns information about a transaction given its hash. |- !Returns (verbose=0) |"data" (string) hex-encoded bytes of the serialized transaction |- !Returns (verbose=1) |(json object) : hex: (string) hex-encoded transaction / hex-encoded bytes of the script. : txid: (string) the hash of the transaction. : version: (numeric) the transaction version. : locktime: (numeric) the transaction lock time. : expiry: (numeric) the transaction expiry. : vin: (array of json objects) the transaction inputs as json objects. :: coinbase: (string) the hex-encoded bytes of the signature script. :: stakebase: (string) the hash of the stake transaction. :: sequence: (numeric) the script sequence number. :: txid: (string) the hash of the origin transaction. :: vout: (numeric) the index of the output being redeemed from the origin transaction. :: scriptSig: (json object) the signature script used to redeem the origin transaction. ::: asm: (string) disassembly of the script. ::: sequence: (numeric) the script sequence number. : vout: (array of json objects) the transaction outputs as json objects. :: value: (numeric) the value in DCR. :: n: (numeric) the index of this transaction output. :: scriptPubKey: (json object) the public key script used to pay coins. ::: reqSigs: (numeric) the number of required signatures. ::: type: (string) the type of the script (e.g. 'pubkeyhash'). ::: addresses: (json array of string) the Decred addresses associated with this output. :::: decredaddress: (string) the Decred address : blockhash: (string) the hash of the block that contains the transaction. : blockheight: (numeric) the height of the block that contains the transaction. : blockindex: (numeric) the index within the array of transactions contained by the block. : confirmations: (numeric) number of confirmations. : time: (numeric) transaction time in seconds since the epoch. : blocktime: (numeric) block time in seconds since the epoch. ; For coinbase transactions : {"hex": "data", "txid": "hash", "version": n, "locktime": n, "expiry": n, vin": [{ "coinbase": "data", "sequence": n}, ...], "vout": [{"value": n, "n": n,"scriptPubKey": { "asm": "asm","hex": "data", "reqSigs": n,"type": "scripttype", "addresses": [ "decredaddress", ...]}}, ...], "blockhash": "hash", "blockheight": n, "confirmations": n, "blocktime": n} ; For stakebase transactions : {"hex": "data", "txid": "hash", "version": n, "locktime": n, "expiry": n, "vin": [{ "stakebase": "hash", "sequence": n}, ...], "vout": [{"value": n, "n": n,"scriptPubKey": { "asm": "asm","hex": "data", "reqSigs": n,"type": "scripttype", "addresses": [ "decredaddress", ...]}}, ...], "blockhash": "hash", "blockheight": n, "blockindex": n, "confirmations": n, "time": n, blocktime": n} ; For non-coinbase / non-stakebase transactions : {"hex": "data", "txid": "hash", "version": n, "locktime": n, "expiry": n, "vin": [{"txid": "hash","vout": n, "scriptSig": {"asm": "asm", "hex": "data"}, "sequence": n}, ...], "vout": [{"value": n, "n": n,"scriptPubKey": { "asm": "asm","hex": "data", "reqSigs": n,"type": "scripttype", "addresses": [ "decredaddress", ...]}}, ...], "blockhash": "hash", "blockheight": n, "blockindex": n, "confirmations": n, "time": n, "blocktime": n} |- !Example Return (verbose=0) | : Newlines added for display purposes. The actual return does not contain newlines. : "010000000104be666c7053ef26c6110597dad1c1e81b5e6be53d17a8b9d0b34772054bac60000000 : 008c493046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8f : 022100fbce8d84fcf2839127605818ac6c3e7a1531ebc69277c504599289fb1e9058df0141045a33 : 76eeb85e494330b03c1791619d53327441002832f4bd618fd9efa9e644d242d5e1145cb9c2f71965 : 656e276633d4ff1a6db5e7153a0a9042745178ebe0f5ffffffff0280841e00000000001976a91406 : f1b6703d3f56427bfcfd372f952d50d04b64bd88ac4dd52700000000001976a9146b63f291c295ee : abd9aee6be193ab2d019e7ea7088ac00000000 |- !Example Return (verbose=1) | ; For coinbase transactions : {"hex": "01000000010000000000000000000000000000000000000000000000000000000000000000f...","txid": "90743aad855880e517270550d2a881627d84db5265142fd1e7fb7add38b08be9","version": 1,"locktime": 0,"vin": [{"coinbase": "03708203062f503253482f04066d605108f800080100000ea2122f6f7a636f696e4065757374726174756d2f","sequence": 0},...], "vout": [{"value": 25.1394,"n": 0, "scriptPubKey": {"asm": "OP_DUP OP_HASH160 ea132286328cfc819457b9dec386c4b5c84faa5c OP_EQUALVERIFY OP_CHECKSIG", "hex": "76a914ea132286328cfc819457b9dec386c4b5c84faa5c88ac", "reqSigs": 1, "type": "pubkeyhash", "addresses": ["1NLg3QJMsMQGM5KEUaEu5ADDmKQSLHwmyh", ...]}}, ...]} ; For stakebase transactions : {"hex": "01000000010000000000000000000000000000000000000000000000000000000000000000f...","txid": "90743aad855880e517270550d2a881627d84db5265142fd1e7fb7add38b08be9","version": 1,"locktime": 0,"vin": [{"stakebase": "90743aad855880e517270550d2a881627d84db5265142fd1e7fb7add38b08be9","sequence": 0},...], "vout": [{"value": 25.1394,"n": 0, "scriptPubKey": {"asm": "OP_DUP OP_HASH160 ea132286328cfc819457b9dec386c4b5c84faa5c OP_EQUALVERIFY OP_CHECKSIG", "hex": "76a914ea132286328cfc819457b9dec386c4b5c84faa5c88ac", "reqSigs": 1, "type": "pubkeyhash", "addresses": ["1NLg3QJMsMQGM5KEUaEu5ADDmKQSLHwmyh", ...]}}, ...]} ; For non-coinbase / non-stakebase transactions : {"hex": "01000000010000000000000000000000000000000000000000000000000000000000000000f...","txid": "90743aad855880e517270550d2a881627d84db5265142fd1e7fb7add38b08be9","version": 1,"locktime": 0,"vin": [{"txid": "60ac4b057247b3d0b9a8173de56b5e1be8c1d1da970511c626ef53706c66be04","scriptSig": {"asm": "3046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8f0...","hex": "493046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8..."}, "sequence": 4294967295}, ...], "vout": [{"value": 25.1394,"n": 0, "scriptPubKey": {"asm": "OP_DUP OP_HASH160 ea132286328cfc819457b9dec386c4b5c84faa5c OP_EQUALVERIFY OP_CHECKSIG", "hex": "76a914ea132286328cfc819457b9dec386c4b5c84faa5c88ac", "reqSigs": 1, "type": "pubkeyhash", "addresses": ["1NLg3QJMsMQGM5KEUaEu5ADDmKQSLHwmyh", ...]}}, ...]} |} ---- ====getstakedifficulty==== {| !Method |getstakedifficulty |- !Parameters |None |- !Description |Returns the proof-of-stake difficulty. |-version !Returns |(json object) : current: (numeric) The current top block's stake difficulty. : next: (numeric) The calculated stake difficulty of the next block. |- !Example Return |{"current": 131.13416327,"next": 131.13416327} |} ---- ====getstakeversioninfo==== {| !Method |getstakeversioninfo |- !Parameters | # count: (numeric) Number of intervals to return. |- !Description |Returns stake version statistics for one or more stake version intervals. |- !Returns |(json object) : currentheight: (numeric) Top of the chain height. : hash: (string) Top of the chain hash. : intervals: (json array) Array of total stake and vote counts. :: startingheight: (numeric) Start of the interval. :: endheight: (numeric) End of the interval. :: posversions: (numeric) Tally of all stake versions. :: voteversions: (numeric) Tally of all vote versions. :: count: (numeric) Number of votes. :: version: (numeric) Version of the vote. |- !Example Return |{"currentheight": 374702,"hash": "000000000000000002dc20112532524e9224949c2e5ac94b418532552e3e9a26","intervals": [{"startheight": 373024,"endheight": 374702,"posversions": [{"version": 6,"count": 1679}],"voteversions": [{"version": 5,"count": 390},{"version": 6,"count": 7912}]}]} |} ---- ====getstakeversions==== {| !Method |getstakeversions |- !Parameters | # hash: (string, required) The start block hash. # count: (numeric, required) The number of blocks that will be returned. |- !Description | Returns the stake versions statistics. |- !Returns | stakeversions: (array of object) Array of stake versions per block. : hash: (string) hash of the block. : height: (numeric) Height of the block. : blockversion: (numeric) the block version. : stakeversion: (numeric) the stake version of the block. : votes: (array of object) the version and bits of each vote in the block. : version: (numeric) the version of the vote. : bits: (numeric) the bits assigned by the vote. {"stakeversions": [{ "hash": "value", "height": n, "blockversion": n, "stakeversion": n,"votes": [{ "version": n, "bits": n },...]},...]} |} ---- ====getticketpoolvalue==== {| !Method |getticketpoolvalue |- !Parameters |None |- !Description | Returns the current value of all locked funds in the ticket pool. |- !Returns |numeric |- !Example Return |5214124.18608402 |} ---- ====gettxout==== {| !Method |gettxout |- !Parameters | # txid: (string, required) The hash of the transaction. # vout: (numeric, required) The index of the output. # includemempool: (string,default=true) Include the mempool when true. |- !Description | Returns information about an unspent transaction output. |- !Returns |(json object) : bestblock: (string) The block hash that contains the transaction output. : confirmations: (numeric) The number of confirmations. : value: (numeric) The transaction amount in DCR. : scriptpubkey: (json object) The public key script used to pay coins as a JSON object. : version: (numeric) The transaction version. : coinbase: (numeric) Whether or not the transaction is a coinbase. |- !Example Return |{"bestblock": "00000000000000001914563fe4f93addae64cd2808a81835ae03b0947034843b","confirmations": 19,"value": 4.63835862,"scriptPubKey": {"asm": "OP_DUP OP_HASH160 f127302adf84741d28fa705a995dc827030077e5 OP_EQUALVERIFY OP_CHECKSIG","hex": "76a914f127302adf84741d28fa705a995dc827030077e588ac","reqSigs": 1,"type": "pubkeyhash","addresses": ["Dsnx1HW62otMif9zFyLzDnQdKuaV9cRNoyr"]},"version": 1,"coinbase": false} |} ---- ====getvoteinfo==== {| !Method |getvoteinfo |- !Parameters | # version: (numeric) The stake version. |- !Description | Returns the vote info statistics. |- !Returns |(json array) : currentheight: (numeric) Top of the chain height. : startheight: (numeric) The start height of the voting window. : endheight: (numeric) The end height of the voting window. : hash: (string) The hash of the current height block. : voteversion: (numeric) The selected vote version. : quorum: (numeric) The minimum amount of votes required. : totalvotes: (numeric) Total votes. : agendas: (json array) All agendas for this stake version. :: id: (string) Unique identifier of the agenda. :: description: (string) Description of this agenda. :: mask: (numeric) Agenda mask. :: starttime: (numeric) Time agenda becomes valid. :: expiretime: (numeric) Time agenda becomes invalid. :: status: (string) Agenda status. :: quorumprogress: (numeric) Progress of quorum reached. :: choices: (json array) All choices in the agenda. ::: id: (string) Unique identifier of the choice. ::: description: (string) Unique identifier of the choice. ::: bits: (numeric) Bits that identify the choice. ::: isabstain: (boolean) This choice is to abstain from change. ::: isno: (boolean) Hard no choice (1 and only 1 per agenda). ::: count: (numeric) How many votes received. ::: progress: (numeric) Progress of the overall count. |- !Example Return |{"currentheight": 374709,"startheight": 366976,"endheight": 375039,"hash": "00000000000000001ff9abe7300929d1a0ce8cca0d3a57e201336af82be3330e","voteversion": 5,"quorum": 4032,"totalvotes": 1835,"agendas": [{"id": "lnfeatures","description": "Enable features defined in DCP0002 and DCP0003 necessary to support Lightning Network (LN)","mask": 6,"starttime": 1505260800,"expiretime": 1536796800,"status": "active","quorumprogress": 0,"choices": [{"id": "abstain","description": "abstain voting for change","bits": 0,"isabstain": true,"isno": false,"count": 0,"progress": 0},{"id": "no","description": "keep the existing consensus rules","bits": 2,"isabstain": false,"isno": true,"count": 0,"progress": 0},{"id": "yes","description": "change to the new consensus rules","bits": 4,"isabstain": false,"isno": false,"count": 0,"progress": 0}]}]} |} ---- ====getwork==== {| !Method |getwork |- !Parameters | # data: (string, optional) The hex |- !Description |Returns information about a transaction given its hash. |- !Notes |Since dcrd does not have the wallet integrated to provide payment addresses, dcrd must be configured via the --miningaddr option to provide which payment addresses to pay created blocks to for this RPC to function. |- !Returns (data not specified) | (json object) : data: (string) hex-encoded block data : hash1: (string) (DEPRECATED) hex-encoded formatted hash buffer : midstate: (string) (DEPRECATED) hex-encoded precomputed hash state after hashing first half of the data : target: (string) the hex-encoded little-endian hash target {"data": "hex", "hash1": "hex", "midstate": "hex", "target": "hex"} |- !Returns (data specified) |true or false (boolean) |- !Example Return (data not specified) |{"data": "00000002c39b5d2b7a1e8f7356a1efce26b24bd15d7d906e85341ef9cec99b6a000000006474f...", "hash1": "00000000000000000000000000000000000000000000000000000000000000000000008000000...", "midstate": "ae4a80fc51476e452de855b4e20d5f33418c50fc7cae3b1ecd5badb819b8a584", "target": "0000000000000000000000000000000000000000000000008c96010000000000"} |- !Example Return (data specified) |true |} ---- ====help==== {| !Method |help |- !Parameters | # command: (string, optional) the command to get help for |- !Description | : Returns a list of all commands or help for a specified command. : When no command parameter is specified, a list of available commands is returned : When command is a valid method, the help text for that method is returned. |- !Returns |string |- !Example Return | : getblockcount : Returns a numeric for the number of blocks in the longest block chain. |} ---- ====livetickets==== {| !Method |livetickets |- !Parameters |None |- !Description | Returns live ticket hashes from the ticket database. |- !Returns |(json object) : tickets: (json array) List of live tickets. |- !Example Return |{"tickets": ["12ce6a03ce0d449cd88f2c0b6796d746be2f2902aedcc2829b9279ce27020ef4","325742e8037cfa2f76e32ed337978cc845001c9a0aeccb387186a6119ea510f4",...]} |} ---- ====missedtickets==== {| !Method |missedtickets |- !Parameters |None |- !Description | Returns missed ticket hashes from the ticket database. |- !Returns |(json object) : tickets: (json array) List of missed tickets. |- !Example Return |{"tickets": ["f56cd8250ac399773bd0a5461587fd1512193476278c4e4b05efc3eca35ca3fe","071c140969f6d74b90e98df5713e07f83f246a92b4f13f365952b83e3922c6fe",...]} |} ---- ====node==== {| !Method |node |- !Parameters | # command: (string, required) connect to add a peer (defaults to temporary), remove to remove a persistent peer, or disconnect to remove all matching non-persistent peers. # peer: (string, required) ip address and port, or ID of the peer to operate on. # connection type: (string) perm indicates the peer should be added as a permanent peer, temp indicates a connection should only be attempted once. |- !Description |Attempts to add or remove a peer. |- !Returns |Nothing |} ---- ====ping==== {| !Method |ping |- !Parameters |None |- !Description | : Queues a ping to be sent to each connected peer. : Ping times are provided by [[#getpeerinfo|getpeerinfo]] via the pingtime and pingwait fields. |- !Returns |Nothing |- |} ---- ====rebroadcastmissed==== {| !Method |rebroadcastmissed |- !Parameters |None |- !Description |Asks the daemon to rebroadcast missed votes. |- !Returns |Nothing |- |} ---- ====rebroadcastwinners==== {| !Method |rebroadcastwinners |- !Parameters |None |- !Description |Asks the daemon to rebroadcast the winners of the voting lottery. |- !Returns |Nothing |- |} ---- ====searchrawtransactions==== {| !Method |searchrawtransactions |- !Parameters | # address: (string, required) Decred address. # verbose: (int, optional, default=true) specifies the transaction is returned as a JSON object instead of hex-encoded string. # skip: (int, optional, default=0) the number of leading transactions to leave out of the final response. # count: (int, optional, default=100) the maximum number of transactions to return. # vinextra: (int, optional, default=0) specify that extra data from previous output will be returned in vin. |- !Description |Returns raw data for transactions involving the passed address. Returned transactions are pulled from both the database, and transactions currently in the mempool. Transactions pulled from the mempool will have the "confirmations" field set to 0. Usage of this RPC requires the optional --addrindex flag to be activated, otherwise all responses will simply return with an error stating the address index has not yet been built up. Similarly, until the address index has caught up with the current best height, all requests will return an error response in order to avoid serving stale data. |- !Returns (verbose=0) | (json array of strings) : serializedtx: (string) hex-encoded bytes of the serialized transaction. ["serializedtx", ... ] |- !Returns (verbose=1) | (array of json objects) : hex: (string) hex-encoded transaction. : txid: (string) the hash of the transaction. : version: (numeric) the transaction version. : locktime: (numeric) the transaction lock time. : expiry: (numeric) the transaction expiry. : vin: (json array) the transaction inputs as json objects. :: coinbase: (string) the hex-encoded bytes of the signature script. :: stakebase: (string) the hash of the stake transaction. :: sequence: (numeric) the script sequence number. :: txid: (string) the hash of the origin transaction. :: vout: (numeric) the index of the output being redeemed from the origin transaction. :: scriptSig: (json object) the signature script used to redeem the origin transaction. ::: asm: (string) disassembly of the script. ::: hex: (string) hex-encoded bytes of the script. :: prevOut: Data from the origin transaction output with index vout. ::: addresses: (array of string) previous output addresses. ::: value: (numeric) previous output value. :: sequence: (numeric) the script sequence number. : vout: (array of json objects) the transaction outputs as json objects. :: value: (numeric) the value in DCR. :: n: (numeric) the index of this transaction output. :: scriptPubKey: (json object) the public key script used to pay coins. ::: asm: (string) disassembly of the script. ::: hex: (string) hex-encoded bytes of the script. ::: reqSigs: (numeric) the number of required signatures. ::: type: (string) the type of the script (e.g. 'pubkeyhash'). ::: addresses: (json array of string) the Decred addresses associated with this output. ::: address: (string) the Decred address. : blockhash: (string) the hash of the block that contains the transaction. : blockheight: (numeric) the height of the block that contains the transaction. : blockindex: (numeric) the index within the array of transactions contained by the block. : confirmations: (numeric) number of confirmations. : time: (numeric) transaction time in seconds since the epoch. : blocktime: (numeric) block time in seconds since the epoch. ; For coinbase transactions : [{"hex": "data", "txid": "hash", "version": n, "locktime": n,"vin": [{"coinbase": "data", "sequence": n},{"txid": "hash", "vout": n, "scriptSig": {"asm": "asm", "hex": "data"}, "prevOut": {"addresses": ["value", ...], "value": n.nnn}, "sequence": n}, ...],"vout": [{ "value": n, "n": n, "scriptPubKey": {"asm": "asm", "hex": "data", "reqSigs": n, "type": "scripttype", "addresses": ["address", ...]}}, ...], "blockhash": "hash", "blockheight": n, confirmations": n, "time": n, "blocktime": n},...] ; For stakebase transactions : [{"hex": "data", "txid": "hash", "version": n, "locktime": n,"vin": [{"stakebase": "hash", "sequence": n},{"txid": "hash", "vout": n, "scriptSig": {"asm": "asm", "hex": "data"}, "prevOut": {"addresses": ["value", ...], "value": n.nnn}, "sequence": n}, ...],"vout": [{ "value": n,"n": n, "scriptPubKey": {"asm": "asm", "hex": "data", "reqSigs": n, "type": "scripttype", "addresses": ["address", ...]}}, ...], "blockhash": "hash", "blockheight": n, "blockindex": n, confirmations": n, "time": n, "blocktime": n},...] ; For non-coinbase / non-stakebase transactions : [{"hex": "data", "txid": "hash", "version": n, "locktime": n,"vin": [{"txid": "hash", "vout": n, "scriptSig": {"asm": "asm", "hex": "data"}, "prevOut": {"addresses": ["value",...], "value": n.nnn}, "sequence": n}, ...],"vout": [{ "value": n,"n": n, "scriptPubKey": {"asm": "asm", "hex": "data", "reqSigs": n, "type": "scripttype", "addresses": ["address", ...]}}, ...], "blockhash":"hash", "blockheight": n, "blockindex": n, confirmations": n, "time": n, "blocktime": n},...] |} ---- ====sendrawtransaction==== {| !Method |sendrawtransaction |- !Parameters | # signedhex: (string, required) serialized, hex-encoded signed transaction. # allowhighfees: (boolean, optional, default=false) whether or not to allow insanely high fees. |- !Description |Submits the serialized, hex-encoded transaction to the local peer and relays it to the network. |- !Returns |"hash" (string) the hash of the transaction |- !Example Return |"1697a19cede08694278f19584e8dcc87945f40c6b59a942dd8906f133ad3f9cc" |} ---- ====setgenerate==== {| !Method |setgenerate |- !Parameters | # generate: (boolean, required) set to true to enable generation, false to disable it. # genproclimit: (numeric, optional) the number of processors (cores) to limit generation to or -1 for default. |- !Description |Set the server to generate coins (mine) or not. |- !Notes |NOTE: Since dcrd does not have the wallet integrated to provide payment addresses, dcrd must be configured via the --miningaddr option to provide which payment addresses to pay created blocks to for this RPC to function. |- !Returns |Nothing |- |} ---- ====stop==== {| !Method |stop |- !Parameters |None |- !Description |Shutdown dcrd. |- !Returns |"dcrd stopping." (string) |- |} ---- ====submitblock==== {| !Method |submitblock |- !Parameters | # data: (string, required) serialized, hex-encoded block. # params: (json object, optional, default=nil) this parameter is currently ignored. |- !Description |Attempts to submit a new serialized, hex-encoded block to the network. |- !Returns | : Success: Nothing. : Failure: (string) "rejected: reason" |- |} ---- ====ticketfeeinfo==== {| !Method |ticketfeeinfo |- !Parameters | # blocks: (numeric) The number of blocks, starting from the chain tip and descending, to return fee information about. # windows: (numeric) The number of difficulty windows to return ticket fee information about. |- !Description | Returns various information about ticket fees from the mempool, blocks, and difficulty windows (units: DCR/kB). |- !Returns |(json object) : feeinfomempool: (json object) Ticket fee information for all tickets in the mempool (units: DCR/kB). :: number: (numeric) Number of transactions in the mempool. :: min: (numeric) Minimum transaction fee in the mempool. :: max: (numeric) Minimum transaction fee in the mempool. :: mean: (numeric) Mean of transaction fees in the mempool. :: median: (numeric) Median of transaction fees in the mempool. :: stddev: (numeric) Standard deviation of transaction fees in the mempool. : feeinfoblocks: (json array) Ticket fee information for a given list of blocks descending from the chain tip (units: DCR/kB). :: height: (numeric) Height of the block. :: number: (numeric) Number of transactions in the block. :: min: (numeric) Minimum transaction fee in the block. :: max: (numeric) Minimum transaction fee in the block. :: mean: (numeric) Mean of transaction fees in the block. :: median: (numeric) Median of transaction fees in the block. :: stddev: (numeric) Standard deviation of transaction fees in the block. : feeinfowindows: (json array) Ticket fee information for a window period where the stake difficulty was the same (units: DCR/kB). :: startheight: (numeric) First block in the window (inclusive). :: endheight: (numeric) Last block in the window (exclusive). :: number: (numeric) Number of transactions in the window. :: min: (numeric) Minimum transaction fee in the window. :: max: (numeric) Minimum transaction fee in the window. :: mean: (numeric) Mean of transaction fees in the window. :: median: (numeric) Median of transaction fees in the window. :: stddev: (numeric) Standard deviation of transaction fees in the window. |- !Example Return |{"feeinfomempool": {"number": 8,"min": 0.00010033,"max": 0.00100675,"mean": 0.00021377,"median": 0.00010052,"stddev": 0.00032041},"feeinfoblocks": [{"height": 374776,"number": 4,"min": 0.00010033,"max": 0.00100336,"mean": 0.00032619,"median": 0.00010055,"stddev": 0.00045144}],"feeinfowindows": [{"startheight": 374688,"endheight": 374777,"number": 474,"min": 0.00010033,"max": 0.00103381,"mean": 0.00011589,"median": 0.00010055,"stddev": 0.0001172}]} |} ---- ====ticketsforaddress==== {| !Method |ticketsforaddress |- !Parameters | # address: (string, required) Address to look for. |- !Description |Request all the tickets for an address. |- !Returns |(json object) : tickets: (json array) Tickets owned by the specified address. |- !Example Return |{"tickets":["f93c7fc34f72d546eabac791ea6b11d0fcaf7ec42e14045d8a837e4445a5b7ff","312a741b3c4a6bf8ead9071ddd16e539bcb0b2b13d6443dae617af35eec5cdff",...]} |} ---- ====ticketvwap==== {| !Method |ticketvwap |- !Parameters | # start: (numeric) The start height to begin calculating the VWAP from. # end: (numeric) The end height to begin calculating the VWAP from. |- !Description |Calculate the volume weighted average price of tickets for a range of blocks (default: full PoS difficulty adjustment depth). |- !Returns |numeric The volume weighted average price. |- !Example Return |129.59443029 |} ---- ====txfeeinfo==== {| !Method |txfeeinfo |- !Parameters | # blocks: (numeric) The number of blocks to calculate transaction fees for, starting from the end of the tip moving backwards. # rangestart: (numeric) The start height of the block range to calculate transaction fees for. # rangeend: (numeric) The end height of the block range to calculate transaction fees for. |- !Description |Get various information about regular transaction fees from the mempool, blocks, and difficulty windows. |- !Returns |(json object) : feeinfomempool: (json object) Transaction fee information for all regular transactions in the mempool. : feeinfoblocks: (json array) Transaction fee information for a given list of blocks descending from the chain tip. : feeinforange: (json object) Transaction fee information for a window period where the stake difficulty was the same. |- !Example Return |{"feeinfomempool": {"number": 7,"min": 0.00010047,"max": 0.00010387,"mean": 0.00010166,"median": 0.00010096,"stddev": 0.00000146},"feeinfoblocks": [{"height": 374851,"number": 0,"min": 0,"max": 0,"mean": 0,"median": 0,"stddev": 0},{"height": 374850,"number": 7,"min": 0.00010038,"max": 0.00364651,"mean": 0.00060713,"median": 0.00010072,"stddev": 0.00134024}],"feeinforange": {"number": 670,"min": 0.00010018,"max": 0.03968253,"mean": 0.00033239,"median": 0.00010072,"stddev": 0.00235464}} |} ---- ====validateaddress==== {| !Method |validateaddress |- !Parameters | # address: (string, required) Decred address. |- !Description |Verify an address is valid. |- !Returns |(json object) : isvalid: (bool) whether or not the address is valid. : address: (string) the Decred address validated. {"isvalid": true or false,"address": "decredaddress"} |} ---- ====verifychain==== {| !Method |verifychain |- !Parameters | # checklevel: (numeric, optional, default=3) how in-depth the verification is (0=least amount of checks, higher levels are clamped to the highest supported level). # numblocks: (numeric, optional, default=288) the number of blocks starting from the end of the chain to verify. |- !Description | :Verifies the block chain database. The actual checks performed by the checklevel parameter is implementation specific. :For dcrd this is: :: checklevel=0 - Look up each block and ensure it can be loaded from the database. :: checklevel=1 - Perform basic context-free sanity checks on each block. |- !Notes |dcrd currently only supports checklevel 0 and 1, but the default is still 3 for compatibility. Per the information in the Parameters section above, higher levels are automatically clamped to the highest supported level, so this means the default is effectively 1 for dcrd. |- !Returns |(boolean) true or false |- !Example Return |true |} ---- ====verifymessage==== {| !Method |verifymessage |- !Parameters | # address: (string, required) The Decred address to use for the signature. # signature: (string, required) The base-64 encoded signature provided by the signer. # message: (string, required) The signed message. |- !Description |Verify an address is valid. |- !Returns |(boolean) Whether or not the signature verified. |- !Example Return |true |} ---- ====version==== {| !Method |version |- !Parameters |None |- !Description |Returns the JSON-RPC API version (semver) |- !Returns |(json object) Object containing the semantic versions of programs and API versions. |- !Example Return |{"dcrd": {"versionstring": "1.5.0-pre+dev","major": 1,"minor": 5,"patch": 0,"prerelease": "pre","buildmetadata": "dev.go1-12-9"},"dcrdjsonrpcapi": {"versionstring": "6.1.0","major": 6,"minor": 1,"patch": 0,"prerelease": "","buildmetadata": ""}} |} ---- ==6. Websocket Methods (Websocket-specific)== ===6.1 Method Overview=== The following is an overview of the RPC method requests available exclusively to Websocket clients. All of these RPC methods are available to the limited user. Click the method name for further details such as parameter and return information. {| !Method !Description !Notifications |- |[[#authenticate|authenticate]] |Authenticate the connection against the username and passphrase configured for the RPC server. NOTE: This is only required if an HTTP Authorization header is not being used. |None |- |[[#notifyblocks|notifyblocks]] |Send notifications when a block is connected or disconnected from the best chain. |[[#blockconnected|blockconnected]] and [[#blockdisconnected|blockdisconnected]] |- |[[#stopnotifyblocks|stopnotifyblocks]] |Cancel registered notifications for whenever a block is connected or disconnected from the main (best) chain. |None |- |[[#notifyreceived|notifyreceived]] |Send notifications when a txout spends to an address. |[[#recvtx|recvtx]] and [[#redeemingtx|redeemingtx]] |- |[[#stopnotifyreceived|stopnotifyreceived]] |Cancel registered notifications for when a txout spends to any of the passed addresses. |None |- |[[#notifyspent|notifyspent]] |Send notification when a txout is spent. |[[#redeemingtx|redeemingtx]] |- |[[#stopnotifyspent|stopnotifyspent]] |Cancel registered spending notifications for each passed outpoint. |None |- |[[#loadtxfilter|loadtxfilter]] |Load, add to, or reload a websocket client's transaction filter for mempool transactions, new blocks and rescanblocks. |[[#relevanttxaccepted|relevanttxaccepted]] |- |[[#rescan|rescan]] |Rescan block chain for transactions to addresses and spent transaction outpoints. |[[#recvtx|recvtx]], [[#redeemingtx|redeemingtx]], [[#rescanprogress|rescanprogress]], and [[#rescanfinished|rescanfinished]] |- |[[#notifynewtransactions|notifynewtransactions]] |Send notifications for all new transactions as they are accepted into the mempool. |[[#txaccepted|txaccepted]] or [[#txacceptedverbose|txacceptedverbose]] |- |[[#stopnotifynewtransactions|stopnotifynewtransactions]] |Stop sending either a txaccepted or a txacceptedverbose notification when a new transaction is accepted into the mempool. |None |- |[[#session|session]] |Return details regarding a websocket client's current connection. |None |} ===6.2 Method Details=== ====authenticate==== {| !Method |authenticate |- !Parameters | # username: (string, required) # passphrase: (string, required) |- !Description |Authenticate the connection against the username and password configured for the RPC server. Invoking any other method before authenticating with this command will close the connection. NOTE: This is only required if an HTTP Authorization header is not being used. |- !Returns | Success: Nothing Failure: Nothing (websocket disconnected) |} ---- ====notifyblocks==== {| !Method |notifyblocks |- !Notifications |[[#blockconnected|blockconnected]] and [[#blockdisconnected|blockdisconnected]] |- !Parameters |None |- !Description |Request notifications for whenever a block is connected or disconnected from the main (best) chain. NOTE: If a client subscribes to both block and transaction (recvtx and redeemingtx) notifications, the blockconnected notification will be sent after all transaction notifications have been sent. This allows clients to know when all relevant transactions for a block have been received. |- !Returns |Nothing |} ---- ====stopnotifyblocks==== {| !Method |stopnotifyblocks |- !Notifications |None |- !Parameters |None |- !Description |Cancel sending notifications for whenever a block is connected or disconnected from the main (best) chain. |- !Returns |Nothing |} ---- ====notifyreceived==== {| !Method |notifyreceived |- !Notifications |[[#recvtx|recvtx]] and [[#redeemingtx|redeemingtx]] |- !Parameters | # Addresses: (JSON array, required) : decredaddress: (string) the Decred address. ["decredaddress", ...] |- !Description |Send a recvtx notification when a transaction added to mempool or appears in a newly-attached block contains a txout pkScript sending to any of the passed addresses. Matching outpoints are automatically registered for redeemingtx notifications. |- !Returns |Nothing |} ---- ====stopnotifyreceived==== {| !Method |stopnotifyreceived |- !Notifications |None |- !Parameters | # Addresses: (JSON array, required) : decredaddress: (string) the Decred address. ["decredaddress", ...] |- !Description |Cancel registered receive notifications for each passed address. |- !Returns |Nothing |} ---- ====notifyspent==== {| !Method |notifyspent |- !Notifications |[[#redeemingtx|redeemingtx]] |- !Parameters | # Outpoints: (json array, required) : hash: (string) the hex-encoded bytes of the outpoint hash. : index: (numeric) the txout index of the outpoint. [{"hash":"data", "index":n }, ...] |- !Description |Send a redeemingtx notification when a transaction spending an outpoint appears in mempool (if relayed to this dcrd instance) and when such a transaction first appears in a newly-attached block. |- !Returns |Nothing |} ---- ====stopnotifyspent==== {| !Method |stopnotifyspent |- !Notifications |None |- !Parameters | # Outpoints: (json array, required) : hash: (string) the hex-encoded bytes of the outpoint hash. : index: (numeric) the txout index of the outpoint. [{"hash":"data", "index":n }, ...] |- !Description |Cancel registered spending notifications for each passed outpoint. |- !Returns |Nothing ---- |} ====loadtxfilter==== {| !Method |loadtxfilter |- !Notifications |[[#relevanttxaccepted|relevanttxaccepted]] |- !Parameters | # Reload: (boolean, required) load a new filter instead of adding data to an existing one. # Addresses: (json array, required) array of addresses to add to the transaction filter # Outpoints: (JSON array, required) array of outpoints to add to the transaction filter. |- !Description |Load, add to, or reload a websocket client's transaction filter for mempool transactions, new blocks and [[#rescanblocks|rescanblocks]]. |- !Returns |Nothing |} ---- ====rescan==== {| !Method |rescan |- !Notifications |None |- !Parameters | # Blockhashes: (JSON array, required) list of hashes to rescan. Each next block must be a child of the previous. |- !Description |Rescan blocks for transactions matching the loaded transaction filter. |- !Returns | (json array) : hash: (string) hash of the matching block. : transactions: (json array) list of matching transactions, serialized and hex-encoded. : serializedtx: (string) serialized and hex-encoded transaction. [{"hash": "data", "transactions": [serializedtx,...]}, ...] |- !Example Return |[{"hash": "0000002099417930b2ae09feda10e38b58c0f6bb44b4d60fa33f0e000000000000000000d53...", "transactions": ["493046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8...", ...]}, ...] |} ---- ====notifynewtransactions==== {| !Method |notifynewtransactions |- !Notifications |[[#txaccepted|txaccepted]] or [[#txacceptedverbose|txacceptedverbose]] |- !Parameters | # verbose: (boolean, optional, default=false) specifies which type of notification to receive. If verbose is true, then the caller receives [[#txacceptedverbose|txacceptedverbose]], otherwise the caller receives [[#txaccepted|txaccepted]] |- !Description |Send either a [[#txaccepted|txaccepted]] or a [[#txacceptedverbose|txacceptedverbose]] notification when a new transaction is accepted into the mempool. |- !Returns |Nothing |} ---- ====stopnotifynewtransactions==== {| !Method |stopnotifynewtransactions |- !Notifications |None |- !Parameters |None |- !Description |Stop sending either a [[#txaccepted|txaccepted]] or a [[#txacceptedverbose|txacceptedverbose]] notification when a new transaction is accepted into the mempool. |- !Returns |Nothing |} ---- ====session==== {| !Method |session |- !Notifications |None |- !Parameters |None |- !Description |Return a JSON object with details regarding a websocket client's current connection to the RPC server. This currently only includes the session ID, a random unsigned 64-bit integer that is created for each newly connected client. Session IDs may be used to verify that the current connection was not lost and subsequently reestablished. |- !Returns | (json object) : sessionid: (numeric) the session ID. {"sessionid": n} |- !Example Return |{"sessionid": 67089679842} |} ==7. Notifications (Websocket-specific)== dcrd uses standard JSON-RPC notifications to notify clients of changes, rather than requiring clients to poll dcrd for updates. JSON-RPC notifications are a subset of requests, but do not contain an ID. The notification type is categorized by the method field and additional details are sent as a JSON array in the params field. ===7.1 Notification Overview=== The following is an overview of the JSON-RPC notifications used for Websocket connections. Click the method name for further details of the context(s) in which they are sent and their parameters. {| !Method !Description !Request |- |[[#blockconnected|blockconnected]] |Block connected to the main chain. |[[#notifyblocks|notifyblocks]] |- |[[#blockdisconnected|blockdisconnected]] |Block disconnected from the main chain. |[[#notifyblocks|notifyblocks]] |- |[[#recvtx|recvtx]] |Processed a transaction output spending to a wallet address. |[[#notifyreceived|notifyreceived]] and [[#rescan|rescan]] |- |[[#redeemingtx|redeemingtx]] |Processed a transaction that spends a registered outpoint. |[[#notifyspent|notifyspent]] and [[#rescan|rescan]] |- |[[#txaccepted|txaccepted]] |Received a new transaction after requesting simple notifications of all new transactions accepted into the mempool. |[[#notifynewtransactions|notifynewtransactions]] |- |[[#txacceptedverbose|txacceptedverbose]] |Received a new transaction after requesting verbose notifications of all new transactions accepted into the mempool. |[[#notifynewtransactions|notifynewtransactions]] |- |[[#rescanprogress|rescanprogress]] |A rescan operation that is underway has made progress. |[[#rescan|rescan]] |- |[[#rescanfinished|rescanfinished]] |A rescan operation has completed. |[[#rescan|rescan]] |} ===7.2 Notification Details=== ====blockconnected==== {| !Method |blockconnected |- !Request |[[#notifyblocks|notifyblocks]] |- !Parameters | # BlockHash: (string) hex-encoded bytes of the attached block hash. # BlockHeight: (numeric) height of the attached block. # BlockTime: (numeric) unix time of the attached block. |- !Description |Notifies when a block has been added to the main chain. Notification is sent to all connected clients. |- !Example |Example blockconnected notification for mainnet block 280330: : {"jsonrpc": "1.0", "method": "blockconnected", "params": ["000000000000000004cbdfe387f4df44b914e464ca79838a8ab777b3214dbffd", 280330, 1389636265],"id": null} |} ---- ====blockdisconnected==== {| !Method |blockdisconnected |- !Request |[[#notifyblocks|notifyblocks]] |- !Parameters | # BlockHash: (string) hex-encoded bytes of the disconnected block hash. # BlockHeight: (numeric) height of the disconnected block. # BlockTime: (numeric) unix time of the disconnected block. |- !Description |Notifies when a block has been removed from the main chain. Notification is sent to all connected clients. |- !Example |Example blockdisconnected notification for mainnet block 280330: : {"jsonrpc": "1.0","method": "blockdisconnected", "params":["000000000000000004cbdfe387f4df44b914e464ca79838a8ab777b3214dbffd", 280330,1389636265],"id": null} |} ---- ====recvtx==== {| !Method |recvtx |- !Request |[[#rescan|rescan]] or [[#notifyreceived|notifyreceived]] |- !Parameters | # Transaction: (string) full transaction encoded as a hex string. # Block details: (object, optional) details about a block and the index of the transaction within a block, if the transaction is mined. |- !Description |Notifies a client when a transaction is processed that contains at least a single output with a pkScript sending to a requested address. If multiple outputs send to requested addresses, a single notification is sent. If a mempool (unmined) transaction is processed, the block details object (second parameter) is excluded. |- !Example |Example recvtx notification for mainnet transaction 61d3696de4c888730cbe06b0ad8ecb6d72d6108e893895aa9bc067bd7eba3fad when processed by mempool: : {"jsonrpc": "1.0", "method": "recvtx", "params": ["010000000114d9ff358894c486b4ae11c2a8cf7851b1df64c53d2e511278eff17c22fb737300000000...], "id": null } The recvtx notification for the same txout, after the transaction was mined into block 276425: : {"jsonrpc": "1.0","method": "recvtx", "params": ["010000000114d9ff358894c486b4ae11c2a8cf7851b1df64c53d2e511278eff17c22fb737300000000...", {"height": 276425, "hash": "000000000000000325474bb799b9e591f965ca4461b72cb7012b808db92bb2fc", "index": 684, "time": 1387737310 }], "id": null } |} ---- ====redeemingtx==== {| !Method |redeemingtx |- !Requests |[[#notifyspent|notifyspent]] and [[#rescan|rescan]] |- !Parameters | # Transaction: (string) full transaction encoded as a hex string. # Block details: (object, optional) details about a block and the index of the transaction within a block, if the transaction is mined. |- !Description |Notifies a client when a registered outpoint is spent by a transaction accepted to mempool and/or mined into a block. |- !Example |Example redeemingtx notification for mainnet outpoint 61d3696de4c888730cbe06b0ad8ecb6d72d6108e893895aa9bc067bd7eba3fad:0 after being spent by transaction 4ad0c16ac973ff675dec1f3e5f1273f1c45be2a63554343f21b70240a1e43ece: : {"jsonrpc": "1.0", "method": "redeemingtx", "params": ["0100000003ad3fba7ebd67c09baa9538898e10d6726dcb8eadb006be0c7388c8e46d69d3610000000..."],"id": null} The redeemingtx notification for the same txout, after the spending transaction was mined into block 279143: : {"jsonrpc": "1.0", "method": "recvtx", "params": ["0100000003ad3fba7ebd67c09baa9538898e10d6726dcb8eadb006be0c7388c8e46d69d3610000000...", {"height": 279143, "hash": "00000000000000017188b968a371bab95aa43522665353b646e41865abae02a4", "index": 6, "time": 1389115004 }], "id": null } |} ---- ====txaccepted==== {| !Method |txaccepted |- !Request |[[#notifynewtransactions|notifynewtransactions]] |- !Parameters | # TxId: (string) hex-encoded bytes of the transaction hash. # Amount: (numeric) sum of the value of all the transaction outpoints. |- !Description |Notifies when a new transaction has been accepted and the client has requested standard transaction details. |- !Example |Example txaccepted notification for mainnet transaction id 16c54c9d02fe570b9d41b518c0daefae81cc05c69bbe842058e84c6ed5826261: : {"jsonrpc": "1.0", "method": "txaccepted", "params": ["16c54c9d02fe570b9d41b518c0daefae81cc05c69bbe842058e84c6ed5826261", 55838384], "id": null} |} ---- ====txacceptedverbose==== {| !Method |txacceptedverbose |- !Request |[[#notifynewtransactions|notifynewtransactions]] |- !Parameters | # RawTx: (json object) the transaction as a json object (see getrawtransaction json object details). |- !Description |Notifies when a new transaction has been accepted and the client has requested verbose transaction details. |- !Example | ; For coinbase transactions : {"jsonrpc": "1.0", "method": "txacceptedverbose", "params": [{"hex": "01000000010000000000000000000000000000000000000000000000000000000000000000f...", "txid": "90743aad855880e517270550d2a881627d84db5265142fd1e7fb7add38b08be9", "version": 1, "locktime": 0, "vin": [{"coinbase": "03708203062f503253482f04066d605108f800080100000ea2122f6f7a636f696e4065757374726174756d2f", "sequence": 0}, ...], "vout": [{"value": 25.1394, "n": 0,"scriptPubKey": {"asm": "OP_DUP OP_HASH160 ea132286328cfc819457b9dec386c4b5c84faa5c OP_EQUALVERIFY OP_CHECKSIG", "hex": "76a914ea132286328cfc819457b9dec386c4b5c84faa5c88ac", "reqSigs": 1,"type": "pubkeyhash", "addresses": ["1NLg3QJMsMQGM5KEUaEu5ADDmKQSLHwmyh", ...]}]}], "id": null} ; For non-coinbase transactions : {"jsonrpc": "1.0", "method": "txacceptedverbose", "params": [{"hex": "01000000010000000000000000000000000000000000000000000000000000000000000000f...", "txid": "90743aad855880e517270550d2a881627d84db5265142fd1e7fb7add38b08be9", "version": 1, "locktime": 0, "vin": [{"txid": "60ac4b057247b3d0b9a8173de56b5e1be8c1d1da970511c626ef53706c66be04","vout": 0, "scriptSig": {"asm": "3046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8f0...", "hex": "493046022100cb42f8df44eca83dd0a727988dcde9384953e830b1f8004d57485e2ede1b9c8..."}, "sequence": 4294967295}, ...], "vout": [{"value": 25.1394, "n": 0,"scriptPubKey": {"asm": "OP_DUP OP_HASH160 ea132286328cfc819457b9dec386c4b5c84faa5c OP_EQUALVERIFY OP_CHECKSIG", "hex": "76a914ea132286328cfc819457b9dec386c4b5c84faa5c88ac", "reqSigs": 1,"type": "pubkeyhash", "addresses": ["1NLg3QJMsMQGM5KEUaEu5ADDmKQSLHwmyh", ...]}]}], "id": null} |} ---- ====rescanprogress==== {| !Method |rescanprogress |- !Request |[[#rescan|rescan]] |- !Parameters | # Hash: (string) hash of the last processed block. # Height: (numeric) height of the last processed block. # Time: (numeric) UNIX time of the last processed block. |- !Description |Notifies a client with the current progress at periodic intervals when a long-running [[#rescan|rescan]] is underway. |- !Example |{"jsonrpc": "1.0", "method": "rescanprogress", "params": ["0000000000000ea86b49e11843b2ad937ac89ae74a963c7edd36e0147079b89d", 127213, 1306533807], "id": null } |} ---- ====rescanfinished==== {| !Method |rescanfinished |- !Request |[[#rescan|rescan]] |- !Parameters | # Hash: (string) hash of the last rescanned block. # Height: (numeric) height of the last rescanned block. # Time: (numeric) UNIX time of the last rescanned block. |- !Description |Notifies a client that the [[#rescan|rescan]] has completed and no further notifications will be sent. |- !Example |{"jsonrpc": "1.0", "method": "rescanfinished", "params": ["0000000000000ea86b49e11843b2ad937ac89ae74a963c7edd36e0147079b89d", 127213, 1306533807], "id": null } |} ==8. Example Code== This section provides example code for interacting with the JSON-RPC API in various languages. * [[#81-example-go-code|Example Go Code]] * [[#82-example-nodejs-code|Example node.js Code]] ===8.1 Example Go Code=== This section provides examples of using the RPC interface using Go and the [https://github.com/decred/dcrd/tree/master/rpcclient rpcclient] package. * [[#811-using-getblockcount-to-retrieve-the-current-block-height|Using getblockcount to Retrieve the Current Block Height]] * [[#812-using-getblock-to-retrieve-the-genesis-block|Using getblock to Retrieve the Genesis Block]] * [[#813-using-notifyblocks-to-receive-blockconnected-and-blockdisconnected-notifications-websocket-specific|Using notifyblocks to Receive blockconnected and blockdisconnected Notifications (Websocket-specific)]] ====8.1.1 Using getblockcount to Retrieve the Current Block Height==== The following is an example Go application which uses the [https://github.com/decred/dcrd/tree/master/rpcclient rpcclient] package to connect with a dcrd instance via Websockets, issues [[#getblockcount|getblockcount]] to retrieve the current block height, and displays it. 
package main

import (
	"io/ioutil"
	"log"
	"path/filepath"

	"github.com/decred/dcrd/dcrutil/v2"
	"github.com/decred/dcrd/rpcclient/v4"
)

func main() {
	// Load the certificate for the TLS connection which is automatically
	// generated by dcrd when it starts the RPC server and doesn't already
	// have one.
	dcrdHomeDir := dcrutil.AppDataDir("dcrd", false)
	certs, err := ioutil.ReadFile(filepath.Join(dcrdHomeDir, "rpc.cert"))
	if err != nil {
		log.Fatal(err)
	}

	// Create a new RPC client using websockets.  Since this example is
	// not long-lived, the connection will be closed as soon as the program
	// exits.
	connCfg := &rpcclient.ConnConfig{
		Host:         "localhost:9109",
		Endpoint:     "ws",
		User:         "yourrpcuser",
		Pass:         "yourrpcpass",
		Certificates: certs,
	}
	client, err := rpcclient.New(connCfg, nil)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Shutdown()

	// Query the RPC server for the current block count and display it.
	blockCount, err := client.GetBlockCount()
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Block count: %d", blockCount)
}
Which results in: 
Block count: 203528
====8.1.2 Using getblock to Retrieve the Genesis Block==== The following is an example Go application which uses the [https://github.com/decred/dcrd/tree/master/rpcclient rpcclient] package to connect with a dcrd instance via Websockets, issues [[#getblock|getblock]] to retrieve information about the Genesis block, and display a few details about it. 
package main

import (
	"io/ioutil"
	"log"
	"path/filepath"
	"time"

	"github.com/decred/dcrd/chaincfg/chainhash"
	"github.com/decred/dcrd/dcrutil/v2"
	"github.com/decred/dcrd/rpcclient/v4"
)

func main() {
	// Load the certificate for the TLS connection which is automatically
	// generated by dcrd when it starts the RPC server and doesn't already
	// have one.
	dcrdHomeDir := dcrutil.AppDataDir("dcrd", false)
	certs, err := ioutil.ReadFile(filepath.Join(dcrdHomeDir, "rpc.cert"))
	if err != nil {
		log.Fatal(err)
	}

	// Create a new RPC client using websockets.  Since this example is
	// not long-lived, the connection will be closed as soon as the program
	// exits.
	connCfg := &rpcclient.ConnConfig{
		Host:         "localhost:9109",
		Endpoint:     "ws",
		User:         "yourrpcuser",
		Pass:         "yourrpcpass",
		Certificates: certs,
	}
	client, err := rpcclient.New(connCfg, nil)
	if err != nil {
		log.Fatal(err)
	}
	defer client.Shutdown()

	// Query the RPC server for the genesis block using the "getblock"
	// command with the verbose flag set to true and the verboseTx flag
	// set to false.
	genesisHashStr := "298e5cc3d985bfe7f81dc135f360abe089edd4396b86d2de66b0cef42b21d980"
	blockHash, err := chainhash.NewHashFromStr(genesisHashStr)
	if err != nil {
		log.Fatal(err)
	}
	block, err := client.GetBlockVerbose(blockHash, false)
	if err != nil {
		log.Fatal(err)
	}

	// Display some details about the returned block.
	log.Printf("Hash: %v\n", block.Hash)
	log.Printf("Previous Block: %v\n", block.PreviousHash)
	log.Printf("Next Block: %v\n", block.NextHash)
	log.Printf("Merkle root: %v\n", block.MerkleRoot)
	log.Printf("Timestamp: %v\n", time.Unix(block.Time, 0).UTC())
	log.Printf("Confirmations: %v\n", block.Confirmations)
	log.Printf("Difficulty: %f\n", block.Difficulty)
	log.Printf("Size (in bytes): %v\n", block.Size)
	log.Printf("Num transactions: %v\n", len(block.Tx))
}
Which results in: 
Hash: 298e5cc3d985bfe7f81dc135f360abe089edd4396b86d2de66b0cef42b21d980
Previous Block: 0000000000000000000000000000000000000000000000000000000000000000
Next Block: 000000000000437482b6d47f82f374cde539440ddb108b0a76886f0d87d126b9
Merkle root: 66aa7491b9adce110585ccab7e3fb5fe280de174530cca10eba2c6c3df01c10d
Timestamp: 2016-02-08 18:00:00 +0000 UTC
Confirmations: 203529
Difficulty: 32767.749998
Size (in bytes): 0
Num transactions: 1
====8.1.3 Using notifyblocks to Receive blockconnected and blockdisconnected Notifications (Websocket-specific)==== The following is an example Go application which uses the [https://github.com/decred/dcrd/tree/master/rpcclient rpcclient] package to connect with a dcrd instance via Websockets and registers for [[#blockconnected|blockconnected]] and [[#blockdisconnected|blockdisconnected]] notifications with [[#notifyblocks|notifyblocks]]. It also sets up handlers for the notifications. 
package main

import (
	"io/ioutil"
	"log"
	"path/filepath"
	"time"

	"github.com/decred/dcrd/dcrutil/v2"
	"github.com/decred/dcrd/rpcclient/v4"
)

func main() {
	// Setup handlers for blockconnected and blockdisconnected
	// notifications.
	ntfnHandlers := rpcclient.NotificationHandlers{
		OnBlockConnected: func(blockHeader []byte, transactions [][]byte) {
			log.Printf("Block connected: %x (%d txs)", blockHeader, len(transactions))

		},
		OnBlockDisconnected: func(blockHeader []byte) {
			log.Printf("Block disconnected: %x", blockHeader)
		},
	}

	// Load the certificate for the TLS connection which is automatically
	// generated by dcrd when it starts the RPC server and doesn't already
	// have one.
	dcrdHomeDir := dcrutil.AppDataDir("dcrd", false)
	certs, err := ioutil.ReadFile(filepath.Join(dcrdHomeDir, "rpc.cert"))
	if err != nil {
		log.Fatal(err)
	}

	// Create a new RPC client using websockets.
	connCfg := &rpcclient.ConnConfig{
		Host:         "localhost:9109",
		Endpoint:     "ws",
		User:         "yourrpcuser",
		Pass:         "yourrpcpass",
		Certificates: certs,
	}
	client, err := rpcclient.New(connCfg, &ntfnHandlers)
	if err != nil {
		log.Fatal(err)
	}

	// Register for blockconnected and blockdisconneted notifications.
	if err := client.NotifyBlocks(); err != nil {
		client.Shutdown()
		log.Fatal(err)
	}

	// For this example, gracefully shutdown the client after 10 seconds.
	// Ordinarily when to shutdown the client is highly application
	// specific.
	log.Println("Client shutdown in 10 seconds...")
	time.AfterFunc(time.Second*10, func() {
		log.Println("Client shutting down...")
		client.Shutdown()
		log.Println("Client shutdown complete.")
	})

	// Wait until the client either shuts down gracefully (or the user
	// terminates the process with Ctrl+C).
	client.WaitForShutdown()
}
Example output: 
Client shutdown in 10 seconds...
Block connected: 050000008478546af6812f4b3cb2148b5967b2dab78c3438d31821760f000000000000002c5f513f6ed478b90a7fc3525bbd64d16ab9b577c6b01861a1e9438f42e22ad95369522fdb6d393edf7eff3f0b33e93b60361fef1ec678843faae2caec0b782701003406e68c8961050013004aa00000e21668193dcd2d0302000000a21d03002bed00003b125d5a005fd38e00000000f1ea07e25fff20eb000000000000000000000000000000000000000005000000 (0 txs)
Client shutting down...
Client shutdown complete.
===8.2. Example node.js Code=== ====8.2.1 Using notifyblocks to be Notified of Block Connects and Disconnects==== The following is example node.js code which uses [https://github.com/einaros/ws ws] (can be installed with npm install ws) to connect with a dcrd instance, issues [[#notifyblocks|notifyblocks]] to register for [[#blockconnected|blockconnected]] and [[#blockdisconnected|blockdisconnected]] notifications, and displays all incoming messages. This code has only been confirmed to work as of node.js 8.11.1 LTS. It might not work with earlier versions. 
var fs = require('fs');
var WebSocket = require('ws');

// Load the certificate for the TLS connection which is automatically
// generated by dcrd when it starts the RPC server and doesn't already
// have one.
var cert = fs.readFileSync('/path/to/dcrd/appdata/rpc.cert');
var user = "yourusername";
var password = "yourpassword";


// Initiate the websocket connection.  The dcrd generated certificate acts as
// its own certificate authority, so it needs to be specified in the 'ca' array
// for the certificate to properly validate.
var ws = new WebSocket('wss://127.0.0.1:9109/ws', {
  headers: {
    'Authorization': 'Basic '+Buffer.from(user+':'+password).toString('base64')
  },
  cert: cert,
  ecdhCurve: 'secp521r1', // Required for node.js v8.11.1 LTS, not for v10.1.0.
  ca: [cert]
});
ws.on('open', function() {
    console.log('CONNECTED');
    // Send a JSON-RPC command to be notified when blocks are connected and
    // disconnected from the chain.
    ws.send('{"jsonrpc":"1.0","id":"0","method":"notifyblocks","params":[]}');
});
ws.on('message', function(data, flags) {
    console.log(data);
});
ws.on('error', function(derp) {
  console.log('ERROR:' + derp);
})
ws.on('close', function(data) {
  console.log('DISCONNECTED');
})