HTTP API Documentation

core.Admin

Method Name	Request Type	Response Type
addnode	NodeRequest	ProtocolReply
backupwallet	BackupWalletRequest	BackupWalletReply
clearallowed	ClearAllowedRequest	ProtocolReply
clearbanned	ClearBannedRequest	ProtocolReply
clearbannedminers	ClearBannedMinersRequest	ProtocolReply
decryptwallet	DecryptWalletRequest	ProtocolReply
drainaddress	DrainAddressRequest	DrainAddressReply
dumpprivatekey	DumpPrivateKeyRequest	DumpPrivateKeyReply
encryptwallet	EncryptWalletRequest	ProtocolReply
generatemultisigaddress	GenerateMultisigAddressRequest	GenerateMultisigAddressReply
getbalance	GetBalanceRequest	GetBalanceReply
getbalanceunlockschedule	GetBalanceUnlockScheduleRequest	GetBalanceUnlockScheduleReply
getbitcoinblockindex	GetBitcoinBlockIndexRequest	ProtocolReply
getblocktemplate	GetBlockTemplateRequest	GetBlockTemplateReply
getblocktimes	GetBlockTimesRequest	GetBlockTimesReply
getblockchains	GetBlockchainsRequest	GetBlockchainsReply
getblocks	GetBlocksRequest	GetBlocksReply
getdiagnosticinfo	GetDiagnosticInfoRequest	GetDiagnosticInfoReply
getendorsementsofblock	GetEndorsementsOfBlockRequest	GetEndorsementsOfBlockReply
gethistory	GetHistoryRequest	GetHistoryReply
getinfo	GetInfoRequest	GetInfoReply
getlastbitcoinblock	GetLastBitcoinBlockRequest	GetLastBitcoinBlockReply
getlastblock	GetLastBlockRequest	GetLastBlockReply
getnewaddress	GetNewAddressRequest	GetNewAddressReply
getpeerinfo	GetPeerInfoRequest	GetPeerInfoReply
getpendingtransactions	GetPendingTransactionsRequest	GetPendingTransactionsReply
getpopendorsementsinfo	GetPoPEndorsementsInfoRequest	GetPoPEndorsementsInfoReply
getpoolstate	GetPoolStateRequest	GetPoolStateReply
getpop	GetPopRequest	GetPopReply
getprotectedchildren	GetProtectedChildrenRequest	GetProtectedChildrenReply
getprotectingparents	GetProtectingParentsRequest	GetProtectingParentsReply
getsignatureindex	GetSignatureIndexRequest	GetSignatureIndexReply
getstateinfo	GetStateInfoRequest	GetStateInfoReply
gettransactions	GetTransactionsRequest	GetTransactionsReply
getveriblockpublications	GetVeriBlockPublicationsRequest	GetVeriBlockPublicationsReply
getwallettransactions	GetWalletTransactionsRequest	GetWalletTransactionsReply
importprivatekey	ImportPrivateKeyRequest	ImportPrivateKeyReply
importwallet	ImportWalletRequest	ImportWalletReply
listallowed	ListAllowedRequest	ListAllowedReply
listbanned	ListBannedRequest	ListBannedReply
listbannedminers	ListBannedMinersRequest	ListBannedMinersReply
listblockssince	ListBlocksSinceRequest	ListBlocksSinceReply
lockwallet	LockWalletRequest	ProtocolReply
makeunsignedmultisigtx	MakeUnsignedMultisigTxRequest	MakeUnsignedMultisigTxReply
ping	PingRequest	PingReply
refreshwalletcache	RefreshWalletCacheRequest	ProtocolReply
removenode	NodeRequest	ProtocolReply
restartpoolwebserver	RestartPoolWebServerRequest	RestartPoolWebServerReply
sendaltchainendorsement	SendAltChainEndorsementRequest	SendAltChainEndorsementReply
sendcoins	SendCoinsRequest	SendCoinsReply
setallowed	SetAllowedRequest	ProtocolReply
setban	SetBanRequest	ProtocolReply
setdefaultaddress	SetDefaultAddressRequest	SetDefaultAddressReply
settransactionfee	SetTransactionFeeRequest	ProtocolReply
signmessage	SignMessageRequest	SignMessageReply
startpool	StartPoolRequest	StartPoolReply
startsolopool	StartSoloPoolRequest	StartSoloPoolReply
stopnodecore	StopNodeCoreRequest	ProtocolReply
stoppool	StopPoolRequest	StopPoolReply
submitblocks	SubmitBlocksRequest	ProtocolReply
submitmultisigtx	SubmitMultisigTxRequest	SubmitMultisigTxReply
submitpop	SubmitPopRequest	ProtocolReply
submittransactions	SubmitTransactionsRequest	ProtocolReply
troubleshootpoptransactions	TroubleshootPoPTransactionsRequest	TroubleshootPoPTransactionsReply
unlockwallet	UnlockWalletRequest	ProtocolReply
validateaddress	ValidateAddressRequest	ValidateAddressReply

AddressBalance

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
unlockedAmount	number	INT64
lockedAmount	number	INT64
totalAmount	number	INT64

AddressBalanceSchedule

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
unlockBalance	number	INT64
lockedBalance	number	INT64
totalBalance	number	INT64
schedule	BalanceUnlockEvent[]	BalanceUnlockEvent

AddressHistory

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
balance	number	INT64
blocksMined	number	INT32
confirmedTransactions	TransactionUnion[]	TransactionUnion
pendingTransactions	TransactionUnion[]	TransactionUnion

AddressSet

Field	Type	Proto Type	Notes
addresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)

AddressSignatureIndexes

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
poolIndex	number	INT64
blockchainIndex	number	INT64

AltchainHeaderEndorsementCountPair

Field	Type	Proto Type	Notes
altchainHeader	string	BYTES	Hex-encoded
endorsementCount	number	INT32

AltchainIdAltchainHeaderEndorsementCountsPair

Field	Type	Proto Type	Notes
altchainIdentifier	number	INT64
altchainHeaderEndorsementCountPairs	AltchainHeaderEndorsementCountPair[]	AltchainHeaderEndorsementCountPair

BackupWalletReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

BackupWalletRequest

Field	Type	Proto Type	Notes
targetLocation	string	BYTES	ASCII String

BalanceUnlockEvent

Field	Type	Proto Type	Notes
blockHeight	number	INT32
amountUnlocked	number	INT64
lockedBalance	number	INT64

BitcoinBlockHeader

Field	Type	Proto Type	Notes
header	string	BYTES	Hex-encoded

BitcoinHeaderVeriBlockEndorsementCountsPair

Field	Type	Proto Type	Notes
bitcoinHeader	string	BYTES	Hex-encoded
veriblockHeaderEndorsementCountPairs	VeriBlockHeaderEndorsementCountPair[]	VeriBlockHeaderEndorsementCountPair

BlackListInfo

Field	Type	Proto Type	Notes
id	number	INT32
type	Type	Type
value	string	STRING
reason	string	STRING
timestamp	number	INT32
expiryTimestamp	number	INT32

Block

Field	Type	Proto Type	Notes
number	number	INT32
timestamp	number	INT32
hash	string	BYTES	Hex-encoded
previousHash	string	BYTES	Hex-encoded
secondPreviousHash	string	BYTES	Hex-encoded
thirdPreviousHash	string	BYTES	Hex-encoded
encodedDifficulty	number	INT32
winningNonce	number	SINT32
regularTransactions	TransactionUnion[]	TransactionUnion
popTransactions	TransactionUnion[]	TransactionUnion
totalFees	number	INT64
powCoinbaseReward	number	INT64
popCoinbaseReward	number	INT64
bitcoinBlockHeaders	string[]	BYTES	Hex-encoded
blockContentMetapackage	BlockContentMetapackage	BlockContentMetapackage
size	number	INT32
version	number	INT32
merkleRoot	string	BYTES	Hex-encoded

BlockContentMetapackage

Field	Type	Proto Type	Notes
coinbaseTransaction	CoinbaseTransaction	CoinbaseTransaction
popDatastore	PoPDatastore	PoPDatastore
minerComment	string	BYTES	ASCII String
ledgerHash	string	BYTES	Hex-encoded
extraNonce	number	SINT64
hash	string	BYTES	Hex-encoded
blockFeeTable	BlockFeeTable	BlockFeeTable

BlockFeeTable

Field	Type	Proto Type	Notes
popFeeShare	number	INT64

Field	Type	Proto Type	Notes
hash	string	BYTES	Only one of these fields may be set: hash, index, number; Hex-encoded
index	number	INT32	Only one of these fields may be set: hash, index, number
number	number	INT32	Only one of these fields may be set: hash, index, number

BlockHeader

Field	Type	Proto Type	Notes
header	string	BYTES	Hex-encoded
hash	string	BYTES	Hex-encoded

BlockSummary

Field	Type	Proto Type	Notes
number	number	INT32
timestamp	number	INT32
hash	string	BYTES	Hex-encoded
previousHash	string	BYTES	Hex-encoded
secondPreviousHash	string	BYTES	Hex-encoded
thirdPreviousHash	string	BYTES	Hex-encoded
decodedDifficulty	number	FIXED64
winningNonce	number	SINT32
numRegularTransactions	number	INT32
numPopTransactions	number	INT32
totalFees	number	INT64
powCoinbaseReward	number	INT64
popCoinbaseReward	number	INT64
size	number	INT32
ledgerHash	string	BYTES	Hex-encoded
minerComment	string	BYTES	ASCII String
version	number	INT32
merkleRoot	string	BYTES	Hex-encoded

BlockchainStateInfo

Field	Type	Proto Type	Notes
state	State	State

CandidateTransaction

Field	Type	Proto Type	Notes
fee	number	INT64
weight	number	INT64
required	boolean	BOOL
txId	string	BYTES	Hex-encoded
depends	number[]	INT32
transaction	TransactionUnion	TransactionUnion

ClearAllowedRequest

Field	Type	Proto Type	Notes

ClearBannedMinersRequest

Field	Type	Proto Type	Notes

ClearBannedRequest

Field	Type	Proto Type	Notes

CoinbaseTransaction

Field	Type	Proto Type	Notes
powCoinbaseAmount	number	INT64
popCoinbaseAmount	number	INT64
powFeeShare	number	INT64
popFeeShare	number	INT64
powOutputs	Output[]	Output
popOutputs	Output[]	Output
blockHeight	number	INT32
txId	string	BYTES	Hex-encoded

DecryptWalletRequest

Field	Type	Proto Type	Notes
passphrase	string	STRING

DrainAddressReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
transaction	Transaction	Transaction

DrainAddressRequest

Field	Type	Proto Type	Notes
sourceAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)
destinationAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)

DumpPrivateKeyReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
privateKey	string	BYTES	Hex-encoded

DumpPrivateKeyRequest

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)

EncryptWalletRequest

Field	Type	Proto Type	Notes
passphrase	string	STRING

Endpoint

Field	Type	Proto Type	Notes
address	string	STRING
port	number	INT32

GenerateMultisigAddressReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
sourceAddresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)
signatureThresholdM	number	INT32
multisigAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)

GenerateMultisigAddressRequest

Field	Type	Proto Type	Notes
sourceAddresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)
signatureThresholdM	number	INT32

GetBalanceReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
confirmed	AddressBalance[]	AddressBalance
unconfirmed	Output[]	Output

GetBalanceRequest

Field	Type	Proto Type	Notes
addresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)

GetBalanceUnlockScheduleReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
addressSchedule	AddressBalanceSchedule[]	AddressBalanceSchedule

GetBalanceUnlockScheduleRequest

Field	Type	Proto Type	Notes
addresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)

GetBitcoinBlockIndexRequest

Field	Type	Proto Type	Notes
blockHeader	string	BYTES	Hex-encoded
searchLength	number	INT32

GetBlockTemplateReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
target	number	INT64
sizeLimit	number	INT64
blockHeight	number	INT32
coinbaseValue	number	INT64
minimumTimestamp	number	INT32
currentTimestamp	number	INT32
mutable	string[]	STRING
previousBlockHash	string	BYTES	Hex-encoded
secondPreviousBlockHash	string	BYTES	Hex-encoded
thirdPreviousBlockHash	string	BYTES	Hex-encoded
previousLedgerHash	string	BYTES	Hex-encoded
transactions	CandidateTransaction[]	CandidateTransaction

GetBlockTemplateRequest

Field	Type	Proto Type	Notes
mode	string	STRING
capabilities	string[]	STRING

GetBlockTimesReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
times	number[]	SINT32

GetBlockTimesRequest

Field	Type	Proto Type	Notes
historyLength	number	INT32

GetBlockchainsReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
bestBlockchainLength	number	INT32
longestBlockchainLength	number	INT32

GetBlockchainsRequest

Field	Type	Proto Type	Notes

GetBlocksReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
blocks	Block[]	Block

GetBlocksRequest

Field	Type	Proto Type	Notes
searchLength	number	INT32
filters	BlockFilter[]	BlockFilter

GetDiagnosticInfoReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
userLanguage	string	STRING
javaRuntimeName	string	STRING
sunBootLibraryPath	string	STRING
javaRuntimeVersion	string	STRING
javaSpecificationVersion	string	STRING
osName	string	STRING
osArch	string	STRING
osVersion	string	STRING
memoryTotalGb	string	STRING
memoryMaxGb	string	STRING
processorCount	string	STRING
processorType	string	STRING
workingDirectory	string	STRING
datetimeNowUtc	string	STRING
nodecorePropertiesSource	string	STRING
nodecorePropertiesValues	string[]	STRING

GetDiagnosticInfoRequest

Field	Type	Proto Type	Notes

GetEndorsementsOfBlockReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
endorsements	PoPEndorsement[]	PoPEndorsement

GetEndorsementsOfBlockRequest

Field	Type	Proto Type	Notes
filter	BlockFilter	BlockFilter

GetHistoryReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
addresses	AddressHistory[]	AddressHistory

GetHistoryRequest

Field	Type	Proto Type	Notes
addresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)

GetInfoReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
numberOfBlocks	number	INT32
lastBlock	BlockSummary	BlockSummary
defaultAddress	AddressBalance	AddressBalance
transactionFee	number	INT64
estimatedHashrate	number	INT64
decodedDifficulty	number	FIXED64

GetInfoRequest

Field	Type	Proto Type	Notes

GetLastBitcoinBlockReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
header	string	BYTES	Hex-encoded
height	number	INT32
hash	string	BYTES

GetLastBitcoinBlockRequest

Field	Type	Proto Type	Notes

GetLastBlockReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
header	BlockHeader	BlockHeader

GetLastBlockRequest

Field	Type	Proto Type	Notes

GetNewAddressReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
additionalAddresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)

GetNewAddressRequest

Field	Type	Proto Type	Notes
count	number	INT32

GetPeerInfoReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
endpoints	Endpoint[]	Endpoint
connectedNodes	NodeInfo[]	NodeInfo
disconnectedNodes	NodeInfo[]	NodeInfo
candidateNodes	NodeInfo[]	NodeInfo
nodeHeights	NodeHeight[]	NodeHeight

GetPeerInfoRequest

Field	Type	Proto Type	Notes

GetPendingTransactionsReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
transactions	Transaction[]	Transaction

GetPendingTransactionsRequest

Field	Type	Proto Type	Notes

GetPoPEndorsementsInfoReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
popEndorsements	PoPEndorsementInfo[]	PoPEndorsementInfo

GetPoPEndorsementsInfoRequest

Field	Type	Proto Type	Notes
searchLength	number	INT32
addresses	StandardAddress[]	StandardAddress

GetPoolStateReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
running	boolean	BOOL
configuration	PoolConfiguration	PoolConfiguration
stats	PoolStats	PoolStats

GetPoolStateRequest

Field	Type	Proto Type	Notes

GetPopReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
blockHeight	number	INT32
version	number	INT32
previousBlockHash	string	BYTES	Hex-encoded
secondPreviousBlockHash	string	BYTES	Hex-encoded
thirdPreviousBlockHash	string	BYTES	Hex-encoded
merkleRoot	string	BYTES
timestamp	number	INT32
encodedDifficulty	number	INT32
nonce	number	SINT32
popMinerAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)
fullPop	string	BYTES	Hex-encoded
lastKnownBlock	BitcoinBlockHeader	BitcoinBlockHeader
lastKnownBlockContext	BitcoinBlockHeader[]	BitcoinBlockHeader

GetPopRequest

Field	Type	Proto Type	Notes
blockNum	number	INT32

GetProtectedChildrenReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
popEndorsements	PoPEndorsementInfo[]	PoPEndorsementInfo

GetProtectedChildrenRequest

Field	Type	Proto Type	Notes
searchLength	number	INT32
veriblockBlockHash	string	BYTES	Hex-encoded

GetProtectingParentsReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
popEndorsements	PoPEndorsementInfo[]	PoPEndorsementInfo

GetProtectingParentsRequest

Field	Type	Proto Type	Notes
searchLength	number	INT32
veriblockBlockHash	string	BYTES	Hex-encoded

GetSignatureIndexReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
indexes	AddressSignatureIndexes[]	AddressSignatureIndexes

GetSignatureIndexRequest

Field	Type	Proto Type	Notes
addresses	string[]	BYTES	Base58-encoded address (or Base59 for multisig)

GetStateInfoReply

Field	Type	Proto Type	Notes
blockchainState	BlockchainStateInfo	BlockchainStateInfo
operatingState	OperatingStateInfo	OperatingStateInfo
networkState	NetworkStateInfo	NetworkStateInfo
connectedPeerCount	number	INT32
currentSyncPeer	string	STRING
networkHeight	number	INT32
localBlockchainHeight	number	INT32
success	boolean	BOOL
results	Result[]	Result
networkVersion	string	STRING
dataDirectory	string	STRING
programVersion	string	STRING
nodecoreStarttime	number	INT64
walletCacheSyncHeight	number	INT32
walletState	WalletState	WalletState

GetStateInfoRequest

Field	Type	Proto Type	Notes

GetTransactionsReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
transactions	TransactionInfo[]	TransactionInfo

GetTransactionsRequest

Field	Type	Proto Type	Notes
searchLength	number	INT32
ids	string[]	BYTES	Hex-encoded

GetVeriBlockPublicationsReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
publications	VeriBlockPublication[]	VeriBlockPublication

GetVeriBlockPublicationsRequest

Field	Type	Proto Type	Notes
keystoneHash	string	BYTES	Hex-encoded
contextHash	string	BYTES	Hex-encoded

GetWalletTransactionsReply

Field	Type	Proto Type	Notes
next	Paging	Paging
transactions	WalletTransaction[]	WalletTransaction
cacheState	CacheState	CacheState
message	string	STRING
success	boolean	BOOL
results	Result[]	Result

GetWalletTransactionsRequest

Field	Type	Proto Type	Notes
requestType	Type	Type
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
transactionType	Type	Type
status	Status	Status
amountFilter	NumericFilter	NumericFilter
timestampFilter	NumericFilter	NumericFilter
page	Paging	Paging

ImportPrivateKeyReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
resultantAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)

ImportPrivateKeyRequest

Field	Type	Proto Type	Notes
privateKey	string	BYTES	Hex-encoded

ImportWalletReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

ImportWalletRequest

Field	Type	Proto Type	Notes
sourceLocation	string	BYTES	ASCII String
passphrase	string	STRING

ListAllowedReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
entries	WhiteListInfo[]	WhiteListInfo

ListAllowedRequest

Field	Type	Proto Type	Notes

ListBannedMinersReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
clients	string[]	STRING

ListBannedMinersRequest

Field	Type	Proto Type	Notes

ListBannedReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
entries	BlackListInfo[]	BlackListInfo

ListBannedRequest

Field	Type	Proto Type	Notes

ListBlocksSinceReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
removed	BlockHeader[]	BlockHeader
added	BlockHeader[]	BlockHeader

ListBlocksSinceRequest

Field	Type	Proto Type	Notes
hash	string	BYTES	Hex-encoded

LockWalletRequest

Field	Type	Proto Type	Notes

MakeUnsignedMultisigTxReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
signatureThresholdM	number	INT32
addressCompositionCountN	number	INT32
unsignedMultisigTransactionWithIndex	UnsignedMultisigTransactionWithIndex	UnsignedMultisigTransactionWithIndex
txid	string	BYTES	Hex-encoded
signatureIndex	number	INT64

MakeUnsignedMultisigTxRequest

Field	Type	Proto Type	Notes
sourceMultisigAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)
amounts	Output[]	Output
fee	number	INT64
signatureIndexString	string	BYTES	Hex-encoded

MultisigBundle

Field	Type	Proto Type	Notes
slots	MultisigSlot[]	MultisigSlot

MultisigSlot

Field	Type	Proto Type	Notes
populated	boolean	BOOL
signature	string	BYTES	Hex-encoded
publicKey	string	BYTES	Hex-encoded
ownerAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)

NetworkStateInfo

Field	Type	Proto Type	Notes
state	State	State

NodeHeight

Field	Type	Proto Type	Notes
peer	string	STRING
height	number	INT32

NodeInfo

Field	Type	Proto Type	Notes
address	string	STRING
port	number	INT32
application	string	STRING
protocolVersion	number	INT32
platform	string	STRING
startTimestamp	number	INT32
id	string	STRING
share	boolean	BOOL
capabilities	number	INT64

NodeRequest

Field	Type	Proto Type	Notes
endpoint	Endpoint[]	Endpoint

NumericFilter

Field	Type	Proto Type	Notes
operator	Operator	Operator
value	number	SINT64
secondaryValue	number	SINT64

OperatingStateInfo

Field	Type	Proto Type	Notes
state	State	State

Output

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
amount	number	INT64

Paging

Field	Type	Proto Type	Notes
pageNumber	number	INT32
resultsPerPage	number	INT32

PingReply

Field	Type	Proto Type	Notes

PingRequest

Field	Type	Proto Type	Notes

PoPDatastore

Field	Type	Proto Type	Notes
datastoreHash	string	BYTES	Hex-encoded
endorsedVeriblockHeadersHash	string	BYTES	Hex-encoded
endorsedAltchainHeadersHash	string	BYTES	Hex-encoded
veriblockHeaderEndorsements	BitcoinHeaderVeriBlockEndorsementCountsPair[]	BitcoinHeaderVeriBlockEndorsementCountsPair
altchainHeaderEndorsements	AltchainIdAltchainHeaderEndorsementCountsPair[]	AltchainIdAltchainHeaderEndorsementCountsPair

PoPEndorsement

Field	Type	Proto Type	Notes
endorsedBlockHeader	string	BYTES	Hex-encoded
bitcoinTransaction	string	BYTES	Hex-encoded
bitcoinMerklePathToRoot	string	BYTES	Hex-encoded
bitcoinBlockHeaderOfProof	BitcoinBlockHeader	BitcoinBlockHeader
address	string	BYTES	Base58-encoded address (or Base59 for multisig)

PoPEndorsementInfo

Field	Type	Proto Type	Notes
minerAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)
endorsedVeriblockBlockHash	string	BYTES	Hex-encoded
containedInVeriblockBlockHash	string	BYTES	Hex-encoded
veriblockTxId	string	BYTES	Hex-encoded
bitcoinTransaction	string	BYTES	Hex-encoded
bitcoinTxId	string	BYTES	Hex-encoded
bitcoinBlockHeader	string	BYTES	Hex-encoded
bitcoinBlockHeaderHash	string	BYTES	Hex-encoded
reward	number	INT64
finalized	boolean	BOOL
endorsedBlockNumber	number	INT32

PoPTransactionProblemReport

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
txid	string	BYTES	Hex-encoded
endorsedVbkBlockHash	string	BYTES	Hex-encoded
endorsedVbkBlockIndex	number	INT32
includedInVbkBlockHash	string	BYTES	Hex-encoded
includedInVbkBlockIndex	number	INT32
popPayoutVbkBlockHash	string	BYTES	Hex-encoded
popPayoutVbkBlockIndex	number	INT32
paidOutInPopPayoutVbkBlock	boolean	BOOL
popPayoutVbkAmount	number	INT64
bitcoinTxid	string	BYTES	Hex-encoded
includedInBtcBlockHash	string	BYTES	Hex-encoded
includedInBtcBlockIndex	number	INT32
endorsedVbkBlockInMainChain	boolean	BOOL
includedInVbkBlockInMainChain	boolean	BOOL
includedInBtcBlockInMainChain	boolean	BOOL
firstBtcBlockOfEquivalentPopEndorsementsIndex	number	INT32
currentBlockHeight	number	INT32

PoolConfiguration

Field	Type	Proto Type	Notes
solo	boolean	BOOL
type	string	STRING
poolTarget	string	STRING
poolAddress	string	STRING
operatorAddress	string	STRING
operatorFee	number	DOUBLE
coinbaseComment	string	STRING

PoolStats

Field	Type	Proto Type	Notes
currentRound	number	INT32
miningBlockNumber	number	INT32
lastBlockNumber	number	INT32
recentHashRate	string	STRING

ProtocolReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

RefreshWalletCacheRequest

Field	Type	Proto Type	Notes

RestartPoolWebServerReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

RestartPoolWebServerRequest

Field	Type	Proto Type	Notes

Result

Field	Type	Proto Type	Notes
error	boolean	BOOL
code	string	STRING
message	string	STRING
details	string	STRING

SendAltChainEndorsementReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
transaction	SignedTransaction	SignedTransaction

SendAltChainEndorsementRequest

Field	Type	Proto Type	Notes
publicationData	string	BYTES	Hex-encoded

SendCoinsReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
txIds	string[]	BYTES	Hex-encoded

SendCoinsRequest

Field	Type	Proto Type	Notes
sourceAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)
amounts	Output[]	Output

SetAllowedRequest

Field	Type	Proto Type	Notes
command	Command	Command
value	string	STRING

SetBanRequest

Field	Type	Proto Type	Notes
command	Command	Command
value	string	STRING
reason	string	STRING
expiryTimestamp	number	INT32

SetDefaultAddressReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

SetDefaultAddressRequest

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)

SetTransactionFeeRequest

Field	Type	Proto Type	Notes
amount	number	INT64

SignMessageReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
signedMessage	string	BYTES	Hex-encoded
publicKey	string	BYTES	Hex-encoded

SignMessageRequest

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
message	string	BYTES	Hex-encoded

SignedMultisigTransaction

Field	Type	Proto Type	Notes
signatureBundle	MultisigBundle	MultisigBundle
transaction	Transaction	Transaction
signatureIndex	number	INT64

SignedTransaction

Field	Type	Proto Type	Notes
signature	string	BYTES	Hex-encoded
publicKey	string	BYTES	Hex-encoded
signatureIndex	number	INT64
transaction	Transaction	Transaction

StandardAddress

Field	Type	Proto Type	Notes
standardAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)

StartPoolReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

StartPoolRequest

Field	Type	Proto Type	Notes
type	string	BYTES	UTF-8 String

StartSoloPoolReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

StartSoloPoolRequest

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)

StopNodeCoreRequest

Field	Type	Proto Type	Notes

StopPoolReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result

StopPoolRequest

Field	Type	Proto Type	Notes

SubmitBlocksRequest

Field	Type	Proto Type	Notes
blocks	Block[]	Block

SubmitMultisigTxReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
txid	string	BYTES	Hex-encoded
signedMultisigTransaction	SignedMultisigTransaction	SignedMultisigTransaction

SubmitMultisigTxRequest

Field	Type	Proto Type	Notes
multisigTransaction	SignedMultisigTransaction	SignedMultisigTransaction

SubmitPopRequest

Field	Type	Proto Type	Notes
endorsedBlockHeader	string	BYTES	Hex-encoded
bitcoinTransaction	string	BYTES	Hex-encoded
bitcoinMerklePathToRoot	string	BYTES	Hex-encoded
bitcoinBlockHeaderOfProof	BitcoinBlockHeader	BitcoinBlockHeader
contextBitcoinBlockHeaders	BitcoinBlockHeader[]	BitcoinBlockHeader
address	string	BYTES	Base58-encoded address (or Base59 for multisig)

SubmitTransactionsRequest

Field	Type	Proto Type	Notes
transactions	TransactionUnion[]	TransactionUnion

Transaction

Field	Type	Proto Type	Notes
type	Type	Type
sourceAddress	string	BYTES	Base58-encoded address (or Base59 for multisig)
sourceAmount	number	INT64
outputs	Output[]	Output
transactionFee	number	INT64
data	string	BYTES	Hex-encoded
bitcoinTransaction	string	BYTES	Hex-encoded
endorsedBlockHeader	string	BYTES	Hex-encoded
bitcoinBlockHeaderOfProof	BitcoinBlockHeader	BitcoinBlockHeader
merklePath	string	STRING
contextBitcoinBlockHeaders	BitcoinBlockHeader[]	BitcoinBlockHeader
timestamp	number	INT32
size	number	INT32
txId	string	BYTES	Hex-encoded

TransactionInfo

Field	Type	Proto Type	Notes
confirmations	number	INT32
transaction	Transaction	Transaction
blockNumber	number	INT32
timestamp	number	INT32
endorsedBlockHash	string	BYTES	Hex-encoded
bitcoinBlockHash	string	BYTES	Hex-encoded
bitcoinTxId	string	BYTES	Hex-encoded

TransactionMeta

Field	Type	Proto Type	Notes
txId	string	BYTES	Hex-encoded
blockHeader	string	BYTES	Hex-encoded
appearsIn	string[]	BYTES	Hex-encoded
confirmations	number	INT32
status	Status	Status

TransactionSet

Field	Type	Proto Type	Notes
txids	string[]	BYTES	Hex-encoded

TransactionUnion

Field	Type	Proto Type	Notes
unsigned	Transaction	Transaction	Only one of these fields may be set: unsigned, signed, signedMultisig
signed	SignedTransaction	SignedTransaction	Only one of these fields may be set: unsigned, signed, signedMultisig
signedMultisig	SignedMultisigTransaction	SignedMultisigTransaction	Only one of these fields may be set: unsigned, signed, signedMultisig

TroubleshootPoPTransactionsReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
popProblemReports	PoPTransactionProblemReport[]	PoPTransactionProblemReport

TroubleshootPoPTransactionsRequest

Field	Type	Proto Type	Notes
onlyFailures	boolean	BOOL
searchLength	number	INT32
addresses	AddressSet	AddressSet	Only one of these fields may be set: addresses, transactions
transactions	TransactionSet	TransactionSet	Only one of these fields may be set: addresses, transactions

UnlockWalletRequest

Field	Type	Proto Type	Notes
passphrase	string	STRING

UnsignedMultisigTransactionWithIndex

Field	Type	Proto Type	Notes
unsignedMultisigTansaction	Transaction	Transaction
signatureIndex	number	INT64

ValidateAddressReply

Field	Type	Proto Type	Notes
success	boolean	BOOL
results	Result[]	Result
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
publicKey	string	BYTES	Hex-encoded
isRemote	boolean	BOOL

ValidateAddressRequest

Field	Type	Proto Type	Notes
address	string	BYTES	Base58-encoded address (or Base59 for multisig)

VeriBlockHeaderEndorsementCountPair

Field	Type	Proto Type	Notes
veriblockHeader	string	BYTES	Hex-encoded
endorsementCount	number	INT32

VeriBlockPublication

Field	Type	Proto Type	Notes
popTransaction	SignedTransaction	SignedTransaction
compactMerklePath	string	STRING
containingBlock	string	BYTES	Hex-encoded
contextToEndorsed	string[]	BYTES	Hex-encoded
contextToContaining	string[]	BYTES	Hex-encoded
blockOfProof	string	BYTES	Hex-encoded

WalletTransaction

Field	Type	Proto Type	Notes
txId	string	BYTES	Hex-encoded
address	string	BYTES	Base58-encoded address (or Base59 for multisig)
timestamp	number	INT32
type	Type	Type
netAmount	number	SINT64
input	Output	Output
outputs	Output[]	Output
meta	TransactionMeta	TransactionMeta

WhiteListInfo

Field	Type	Proto Type	Notes
id	number	INT32
type	Type	Type
value	string	STRING
timestamp	number	INT32

CacheState

Name	Number
UNKNOWN	0
BUILDING	1
CURRENT	2
ERRORED	3

Command

Name	Number
ADD	0
REMOVE	1

Operator

Name	Number
EQUAL	0
LESS_THAN	1
LESS_THAN_OR_EQUAL	2
GREATER_THAN	3
GREATER_THAN_OR_EQUAL	4
BETWEEN	5

State

Name	Number
LOADING	0
NORMAL	1
PAUSED	3
STALE	4
LOADED	5

Status

Name	Number
UNKNOWN	0
PENDING	1
CONFIRMED	2
DEAD	3

Type

Name	Number
ZERO_UNUSED	0
STANDARD	1
PROOF_OF_PROOF	2
MULTISIG	3

WalletState

Name	Number
DEFAULT	0
LOCKED	1
UNLOCKED	2

HTTP API Documentation

Table of Contents

core.Admin

AddressBalance

AddressBalanceSchedule

AddressHistory

AddressSet

AddressSignatureIndexes

AltchainHeaderEndorsementCountPair

AltchainIdAltchainHeaderEndorsementCountsPair

BackupWalletReply

BackupWalletRequest

BalanceUnlockEvent

BitcoinBlockHeader

BitcoinHeaderVeriBlockEndorsementCountsPair

BlackListInfo

Block

BlockContentMetapackage

BlockFeeTable

BlockFilter

BlockHeader

BlockSummary

BlockchainStateInfo

CandidateTransaction

ClearAllowedRequest

ClearBannedMinersRequest

ClearBannedRequest

CoinbaseTransaction

DecryptWalletRequest

DrainAddressReply

DrainAddressRequest

DumpPrivateKeyReply

DumpPrivateKeyRequest

EncryptWalletRequest

Endpoint

GenerateMultisigAddressReply

GenerateMultisigAddressRequest

GetBalanceReply

GetBalanceRequest

GetBalanceUnlockScheduleReply

GetBalanceUnlockScheduleRequest

GetBitcoinBlockIndexRequest

GetBlockTemplateReply

GetBlockTemplateRequest

GetBlockTimesReply

GetBlockTimesRequest

GetBlockchainsReply

GetBlockchainsRequest

GetBlocksReply

GetBlocksRequest

GetDiagnosticInfoReply

GetDiagnosticInfoRequest

GetEndorsementsOfBlockReply

GetEndorsementsOfBlockRequest

GetHistoryReply

GetHistoryRequest

GetInfoReply

GetInfoRequest

GetLastBitcoinBlockReply

GetLastBitcoinBlockRequest

GetLastBlockReply

GetLastBlockRequest

GetNewAddressReply

GetNewAddressRequest

GetPeerInfoReply

GetPeerInfoRequest

GetPendingTransactionsReply

GetPendingTransactionsRequest

GetPoPEndorsementsInfoReply

GetPoPEndorsementsInfoRequest

GetPoolStateReply

GetPoolStateRequest

GetPopReply

GetPopRequest

GetProtectedChildrenReply

GetProtectedChildrenRequest

GetProtectingParentsReply

GetProtectingParentsRequest

GetSignatureIndexReply

GetSignatureIndexRequest