Elis-API

From BitcoinWiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

Bitcoin API call list (as of version 0.3.20.2) with code samples and returned values.

API Calls[edit]

API Calls to JSON-RPC are sent using POST method and parameters are sent as JSON object.

Example Request[edit]

When requesting something from the JSON-RPC server the request is sent to the server with the following URL: http://user:pass@localhost:8332/ with post data that looks something like this:

{"method":"listreceivedbyaccount","params":[0],"id":"listreceivedbyaccount"}:

The Bitcoind server uses JSON notation instead of using regular POST parameters which can cause confusions sometime. Note the trailing colon on the post data above.

The JSON object that is being sent to the server is composed of 3 elements: method, params, and id.

method is what method you want to invoke, this is a simple string representing the method you're invoking.

params is the Array parameters that you're sending with the method invocation. Note that these parameters are sent as an Array notation and not Object notation.

id is used by the app requesting, and I usually just send the method name as the ID

Calls List[edit]

Required arguments are denoted inside < and > Optional arguments are inside [ and ].

backupwallet[edit]

Safely copies wallet.dat to destination, which can be a directory or a path with filename.

Arguments[edit]

[0] <Destination> String The destination of the wallet file it will be copied to. This needs to be a valid directory in your file system passed in linux style (forward slashes (/) as separators - linux style, not backward slashes (\) - windows style). The directory must not have a file named wallet.dat otherwise the operation will fail. Example: "d:/wallet-backup/"

Example Request[edit]

{"method":"backupwallet","params":["d:/wallet-backup/"],"id":"backupwallet"}:

Result[edit]

Success[edit]

result = null

{
    "result": null,
    "error": null,
    "id": "backupwallet"
}
Error[edit]
{
    "result": null,
    "error": {
        "code": -1,
        "message": "boost::filesystem::copy_file: The file exists: \"C:\\Users\\Eli\\AppData\\Roaming\\Bitcoin\\testnet\\wallet.dat\", \"d:\\wallet-backup\\wallet.dat\""
    },
    "id": "backupwallet"
}

There are other errors that can occur, for example if the directory provided is incorrect.


getaccount[edit]

Returns the account associated with the given address.

Arguments[edit]

[0] <Bitcoin Address> String The address being checked. Example: "n3CoNg6qBkJauJq5558PrfEHJd8f1emkQZ" (note that this a testnet address), ""

Example Request[edit]

{"method":"getaccount","params":["n3CoNg6qBkJauJq5558PrfEHJd8f1emkQZ"],"id":"getaccount"}:

Result[edit]

result = String the account that the address is associated with.

Note that some addresses in a bitcoin wallet are not associated with any given account and in those cases the result will be an empty string (i.e. the global account).

Success[edit]
{
    "result": "Testnet Faucet",
    "error": null,
    "id": "getaccount"
}
Error[edit]

The only time that this method returns an error is when the first argument ([0] Bitcoin Address) is not supplied. In any other case the method will return a successful result with an empty "result" value indicating that the address belongs to the global account, even if no address supplied (i.e. empty string: "") or a bad address altogether (i.e. "eli").

{
    "result": null,
    "error": {
        "code": -1,
        "message": "getaccount <bitcoinaddress>\nReturns the account associated with the given address."
    },
    "id": "getaccount"
}



getaccountaddress[edit]

Returns the current bitcoin address for receiving payments to this account.

Arguments[edit]

[0] <Account> String The account that you want to get an address for. An empty string is considered as the global account and will return a valid address. Example: "Testnet Faucet", ""

Example Request[edit]

{"method":"getaccountaddress","params":["Testnet Faucet"],"id":"getaccountaddress"}:

Result[edit]

Success[edit]

result = String an address associated with this account.

{
    "result": "mpFrRfLZRWCKzG2VmmxajJLcGpchsYiFQo",
    "error": null,
    "id": "getaccountaddress"
}
Error[edit]
{
    "result": null,
    "error": {
        "code": -1,
        "message": "getaccountaddress <account>\nReturns the current bitcoin address for receiving payments to this account."
    },
    "id": "getaccountaddress"
}

This error is only returned if no arguments supplied at all (not even an empty string).



getaddressesbyaccount[edit]

Returns the list of addresses for the given account.

Arguments[edit]

[0] <Account> String The account that you want to get addresses for. An empty string is considered as the global account and will return a valid address. Example: "Testnet Faucet", ""

Example Request[edit]

{"method":"getaddressesbyaccount","params":["Testnet Faucet"],"id":"getaddressesbyaccount"}:

Result[edit]

Success[edit]

result = Array An array of addresses associated with the account.

{
    "result": [
        "mpFrRfLZRWCKzG2VmmxajJLcGpchsYiFQo",
        "mv97croRs1krPoTXsfoSnxT7YhUn4zECUs"
    ],
    "error": null,
    "id": "getaddressesbyaccount"
}
Error[edit]
{
    "result": null,
    "error": {
        "code": -1,
        "message": "getaddressesbyaccount <account>\nReturns the list of addresses for the given account."
    },
    "id": "getaddressesbyaccount"
}

This error is only returned if no arguments supplied at all (not even an empty string).



getbalance[edit]

If [Account] is not specified, returns the server's total available balance. If [Account] is specified, returns the balance in the account.

Arguments[edit]

[0] [Account] String The account that you want to balance. An empty string is considered as the global account and will return a the balance of the global account. A null value will return the entire balance available for the server. Example: "Testnet Faucet", "", null

[1] [Minimum Confirmations] Integer The minimum confirmations you want to consider when requesting balance. Default value is 1. If 0 is supplied even unconfirmed transactions will be considered and will show in the balance. Example: 1, 0, null

Example Request[edit]

{"method":"getbalance","params":[],"id":"getbalance"}:

Result[edit]

Success[edit]

result = Float A float representing the balance that the account or the server has to it's disposal.

{
    "result": 256.4985,
    "error": null,
    "id": "getbalance"
}
Error[edit]

No error should be returned with this method.

getblockbycount[edit]

Dumps the block existing at specified height. Note: this is not available in the official release

Arguments[edit]

[0] Height

See Also on BitcoinWiki[edit]