Walletd API

Walletd API

Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh.

Custom RPC API node

API subtitle address description

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry`s standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled dummy text ever since the 1500s, when an unknown printer took a galley of tydummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled tpe and scrambled


Example: http://0.0.0.0:2093/json_rpc
this password will not be saved on server side



{API}
BlockChain Coin

API METHODS

API subtitle

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry`s standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled dummy text ever since the 1500s, when an unknown printer took a galley of tydummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled tpe and scrambled



Implementation Notes

createAddress() method creates an additional address in your wallet.


Input Parameters

Argument Mandatory Description Format Example
it requires no extra parameters


Implementation Notes

createDelayedTransaction() method creates a delayed transaction. Such transactions are not sent into the network automatically and should be pushed using sendDelayedTransaction method.
Note: if container contains only 1 address, changeAddress field can be left empty and the change is going to be sent to this address
Note: if addresses field contains only 1 address, changeAddress can be left empty and the change is going to be sent to this address
Note: in the rest of the cases, changeAddress field is mandatory and must contain an address.
Note: outputs that were used for this transactions will be locked until the transaction is sent or cancelled


Input Parameters

Argument Mandatory Description Format Example
addresses no array of strings, where each string is an address array
transfers yes array that contains:
  • address - string
  • amount - int64
this is the receiver
array "amount": 10000000000,
"address": "28aYVwSsGMxCWJGCNe26GYPWVR2xLdGnSaHiv5WF8 MSa4CGuWfnj8eY2CrSUqPRjaqbYVApwxPjwtbPpA3XKjCZSUamsrZv"
fee yes transaction fee. Minimal fee in Bytecoin network is .01 BLOC. This parameter should be specified in minimal available BLOC units. For example, if your fee is .01 BLOC, you should pass it as 1000000 uint64 1000000
unlockTime no height of the block until which transaction is going to be locked for spending. uint64 0
anonymity yes privacy level (a discrete number from 1 to infinity). Level 6 and higher is recommended. uint64 6
extra no string of variable length. Can contain A-Z, 0-9 characters. string
paymentId no paymentId string somePaymentId
changeAddress no valid and existing in this container address. string 27eJo2S9eVo5N2G9zyjkqNBZPR6d2qvVD122vQMGAhcrjZjLu8nsMqk3c4KQ9iMJ4AV4fpBMccmjfJ4cu7uprKLNFX4qWNh

input multiple addresses separated by comma (,)
only 1 transfer available
only 1 transfer available

Implementation Notes

deleteAddress() method deletes a specified address.


Input Parameters

Argument Mandatory Description Format Example
address yes an address to be deleted string 2A8CkYbbEqSSeGPZPmfVvyUMR3PB1RxQ4XTGE2x7cFsUhxe4hwPzJJBd4TQ38Mc3R7hqRXuU13ABxUqLbtcoyvETNt7MqSw


Implementation Notes

deleteDelayedTransaction() method deletes a specified delayed transaction.


Input Parameters

Argument Mandatory Description Format Example
transactionHash yes valid, existing delayed transaction string c671d1005eaaf7c51b1e23eeec1c899e43fa7a332cdc2bcf1e45b908e23d8837


Implementation Notes

estimateFusion() method counts the number of unspent outputs of the specified addresses and returns how many of those outputs can be optimized.
This method is used to understand if a fusion transaction can be created. If fusionReadyCount returns a value = 0, then a fusion transaction cannot be created.


Input Parameters

Argument Mandatory Description Format Example
threshold yes value that determines which outputs will be optimized. Only the outputs, lesser than the threshold value, will be included into a fusion transaction uint64 1000000
addresses no array of strings, where each string is an address to take the funds from array

input multiple addresses separated by comma (,)

Implementation Notes

getAddresses() method returns an array of your RPC Wallet's addresses.


Input Parameters

Argument Mandatory Description Format Example
it requires no extra parameters


Implementation Notes

getBalance() method returns a balance for a specified address.
Please note: If address is not specified, returns a cumulative balance of all RPC Wallet's addresses.


Input Parameters

Argument Mandatory Description Format Example
address yes an address to be deleted string 2A8CkYbbEqSSeGPZPmfVvyUMR3PB1RxQ4XTGE2x7cFsUhxe4hwPzJJBd4TQ38Mc3R7hqRXuU13ABxUqLbtcoyvETNt7MqSw


Implementation Notes

getBlockHashes() method returns an array of block hashes for a specified block range.


Input Parameters

Argument Mandatory Description Format Example
firstBlockIndex yes starting height uint32 123123
blockCount yes number of blocks to process uint32 20


Implementation Notes

getDelayedTransactionHashes() method returns hashes of delayed transactions.


Input Parameters

Argument Mandatory Description Format Example
it requires no extra parameters


Implementation Notes

getSpendKeys() method returns your spend keys.


Input Parameters

Argument Mandatory Description Format Example
address yes an address to be deleted string 2A8CkYbbEqSSeGPZPmfVvyUMR3PB1RxQ4XTGE2x7cFsUhxe4hwPzJJBd4TQ38Mc3R7hqRXuU13ABxUqLbtcoyvETNt7MqSw


Implementation Notes

getStatus() method returns information about the current RPC Wallet state: block_count, known_block_count, last_block_hash and peer_count.


Input Parameters

Argument Mandatory Description Format Example
it requires no extra parameters


Implementation Notes

getTransaction() method returns information about a particular transaction.
Transaction consists of transfers. Transfer is an amount-address pair. There could be several transfers in a single transaction.
Note: the transactionHash must belong to your wallet


Input Parameters

Argument Mandatory Description Format Example
transactionHash yes hash of the requested transaction string example


Implementation Notes

getTransactionHashes() method returns an array of block and transaction hashes.
Transaction consists of transfers. Transfer is an amount-address pair. There could be several transfers in a single transaction.
Note: if paymentId parameter is set, getTransactions() method returns transactions that contain specified payment_id. (in the set block range)
Note: if addresses parameter is set, getTransactions() method returns transactions that contain transfer from at least one of specified addresses.
Note: if both above mentioned parameters are set, getTransactions() method returns transactions that contain both specified payment_id and transfer from at least one of specified addresses.


Input Parameters

Argument Mandatory Description Format Example
addresses no array of strings, where each string is an address array 2AFUzhkRatH2kQ19RaUNiE33mMQ3ejvJrGDhdDo77zn3RJQquQG7QBidoe7AD4EgBbChteaVesg3xcLVdq9EoCHH4NV9mxp
blockHash only one of these parameters (blockHash or firstBlockIndex) is allowed hash of the starting block string f8f07ace392474bfbdc0fc30749a45f779a8aea10c489a103270f63ed88178ad
firstBlockIndex only one of these parameters (blockHash or firstBlockIndex) is allowed starting height uint32 123
blockCount yes number of blocks to return transaction hashes from uint32 20
paymentId no valid payment_id string somePaymentId

input multiple addresses separated by comma (,)

Implementation Notes

getTransactions() method returns an array of block and transaction hashes.
Transaction consists of transfers. Transfer is an amount-address pair. There could be several transfers in a single transaction.
Note: if paymentId parameter is set, getTransactions() method returns transactions that contain specified payment_id. (in the set block range)
Note: if addresses parameter is set, getTransactions() method returns transactions that contain transfer from at least one of specified addresses.
Note: if both above mentioned parameters are set, getTransactions() method returns transactions that contain both specified payment_id and transfer from at least one of specified addresses.


Input Parameters

Argument Mandatory Description Format Example
addresses no array of strings, where each string is an address array 2AFUzhkRatH2kQ19RaUNiE33mMQ3ejvJrGDhdDo77zn3RJQquQG7QBidoe7AD4EgBbChteaVesg3xcLVdq9EoCHH4NV9mxp
blockHash only one of these parameters (blockHash or firstBlockIndex) is allowed hash of the starting block string f8f07ace392474bfbdc0fc30749a45f779a8aea10c489a103270f63ed88178ad
firstBlockIndex only one of these parameters (blockHash or firstBlockIndex) is allowed starting height uint32 123
blockCount yes number of blocks to return transaction hashes from uint32 20
paymentId no valid payment_id string somePaymentId

input multiple addresses separated by comma (,)

Implementation Notes

getUnconfirmedTransactionHashes() method returns information about the current unconfirmed transaction pool or for a specified addresses.
Transaction consists of transfers. Transfer is an amount-address pair. There could be several transfers in a single transaction.


Input Parameters

Argument Mandatory Description Format Example
addresses no array of strings, where each string is an address array 2AFUzhkRatH2kQ19RaUNiE33mMQ3ejvJrGDhdDo77zn3RJQquQG7QBidoe7AD4EgBbChteaVesg3xcLVdq9EoCHH4NV9mxp

input multiple addresses separated by comma (,)

Implementation Notes

getViewKey() method returns your view key.


Input Parameters

Argument Mandatory Description Format Example
it requires no extra parameters


Implementation Notes

sendDelayedTransaction() method sends a specified delayed transaction.


Input Parameters

Argument Mandatory Description Format Example
transactionHash yes valid, existing delayed transaction string c671d1005eaaf7c51b1e23eeec1c899e43fa7a332cdc2bcf1e45b908e23d8837


Implementation Notes

sendFusionTransaction() method allows you to send a fusion transaction, by taking funds from selected addresses and transferring them to the destination address.
If there aren't any outputs that can be optimized, sendFusionTransaction() will return an error. You can use estimateFusion to check the outputs, available for the optimization.


Input Parameters

Argument Mandatory Description Format Example
threshold yes value that determines which outputs will be optimized. Only the outputs, lesser than the threshold value, will be included into a fusion transaction uint64 1000000
anonymity yes privacy level (a discrete number from 1 to infinity). Level 6 and higher is recommended uint64 6
addresses no array of strings, where each string is an address to take the funds from array
destinationAddress no an address that the optimized funds will be sent to. Valid and existing in this container address string 27eJo2S9eVo5N2G9zyjkqNBZPR6d2qvVD122vQMGAhcrjZjLu8nsMqk3c4KQ9iMJ4AV4fpBMccmjfJ4cu7uprKLNFX4qWNh

input multiple addresses separated by comma (,)

Implementation Notes

sendTransaction() method allows you to send transaction to one or several addresses. Also, it allows you to use a payment_id for a transaction to a single address.
Note: if container contains only 1 address, changeAddress field can be left empty and the change is going to be sent to this address
Note: if addresses field contains only 1 address, changeAddress can be left empty and the change is going to be sent to this address
Note: in the rest of the cases, changeAddress field is mandatory and must contain an address.


Input Parameters

Argument Mandatory Description Format Example
addresses no array of strings, where each string is an address to take the funds from array
transfers yes array that contains:
  • address - string
  • amount - int64
this is the receiver
array "amount": 10000000000,
"address": "28aYVwSsGMxCWJGCNe26GYPWVR2xLdGnSaHiv5WF8 MSa4CGuWfnj8eY2CrSUqPRjaqbYVApwxPjwtbPpA3XKjCZSUamsrZv"
fee yes transaction fee. Minimal fee in Bytecoin network is .01 BLOC. This parameter should be specified in minimal available BLOC units. For example, if your fee is .01 BLOC, you should pass it as 1000000 uint64 1000000
unlockTime no height of the block until which transaction is going to be locked for spending. uint64 0
anonymity yes privacy level (a discrete number from 1 to infinity). Level 6 and higher is recommended. uint64 6
extra no string of variable length. Can contain A-Z, 0-9 characters. string
paymentId no paymentId string somePaymentId
changeAddress no valid and existing in this container address. string 27eJo2S9eVo5N2G9zyjkqNBZPR6d2qvVD122vQMGAhcrjZjLu8nsMqk3c4KQ9iMJ4AV4fpBMccmjfJ4cu7uprKLNFX4qWNh

only 1 sender available in this example
only 1 receiver available in this example
only 1 receiver transfer available in this example