Each node in the Pactus network can be configured to use the JSON-RPC 2.0 protocol for communication. Here you can find the list of all JSON-RPC methods and messages.
All the amounts and values in JSON-RPC endpoints are in NanoPAC units, which are atomic and the smallest unit in the Pactus blockchain. Each PAC is equivalent to 1,000,000,000 or 109 NanoPACs.
pactus.transaction.get_transaction
pactus.transaction.calculate_fee
pactus.transaction.broadcast_transaction
pactus.transaction.get_raw_transfer_transaction
pactus.transaction.get_raw_bond_transaction
pactus.transaction.get_raw_unbond_transaction
pactus.transaction.get_raw_withdraw_transaction
pactus.blockchain.get_block_hash
pactus.blockchain.get_block_height
pactus.blockchain.get_blockchain_info
pactus.blockchain.get_consensus_info
pactus.blockchain.get_validator
pactus.blockchain.get_validator_by_number
pactus.blockchain.get_validator_addresses
pactus.blockchain.get_public_key
pactus.network.get_network_info
pactus.wallet.get_total_balance
pactus.wallet.sign_raw_transaction
pactus.wallet.get_validator_address
pactus.wallet.get_address_history
pactus.transaction.get_transaction retrieves transaction details based on the provided request parameters.
{
"id": "str", // (string) Transaction ID.
"verbosity": "TRANSACTION_DATA or TRANSACTION_INFO" // (string) Verbosity level for transaction details.
}
{
"block_height": n, // (numeric) Height of the block containing the transaction.
"block_time": n, // (numeric) Time of the block containing the transaction.
"transaction": { // (json object) Information about the transaction.
"bond": { // (json object) Bond payload.
"receiver": "str", // (string) Receiver's address.
"sender": "str", // (string) Sender's address.
"stake": n // (numeric) Stake amount in NanoPAC.
},
"data": "str", // (string) Transaction data.
"fee": n, // (numeric) Transaction fee in NanoPAC.
"id": "str", // (string) Transaction ID.
"lock_time": n, // (numeric) Lock time for the transaction.
"memo": "str", // (string) Transaction memo.
"payload_type": "UNKNOWN or TRANSFER_PAYLOAD or BOND_PAYLOAD
or SORTITION_PAYLOAD or UNBOND_PAYLOAD or WITHDRAW_PAYLOAD", // (string) Type of transaction payload.
"public_key": "str", // (string) Public key associated with the transaction.
"signature": "str", // (string) Transaction signature.
"sortition": { // (json object) Sortition payload.
"address": "str", // (string) Address associated with the sortition.
"proof": "str" // (string) Proof for the sortition.
},
"transfer": { // (json object) Transfer payload.
"amount": n, // (numeric) Transaction amount in NanoPAC.
"receiver": "str", // (string) Receiver's address.
"sender": "str" // (string) Sender's address.
},
"unbond": { // (json object) Unbond payload.
"validator": "str" // (string) Address of the validator to unbond from.
},
"value": n, // (numeric) Transaction value in NanoPAC.
"version": n, // (numeric) Transaction version.
"withdraw": { // (json object) Withdraw payload.
"amount": n, // (numeric) Withdrawal amount in NanoPAC.
"from": "str", // (string) Address to withdraw from.
"to": "str" // (string) Address to withdraw to.
}
}
}
pactus.transaction.calculate_fee calculates the transaction fee based on the specified amount and payload type.
{
"amount": n, // (numeric) Transaction amount in NanoPAC.
"fixed_amount": true|false, // (boolean) Indicates
that amount should be fixed and includes the fee.
"payload_type": "UNKNOWN or TRANSFER_PAYLOAD or
BOND_PAYLOAD or SORTITION_PAYLOAD or UNBOND_PAYLOAD or WITHDRAW_PAYLOAD" // (string) Type of transaction payload.
}
{
"amount": n, // (numeric) Calculated amount in NanoPAC.
"fee": n // (numeric) Calculated transaction fee in NanoPAC.
}
pactus.transaction.broadcast_transaction broadcasts a signed transaction to the network.
{
"signed_raw_transaction": "str" // (string) Signed raw transaction data.
}
{
"id": "str" // (string) Transaction ID.
}
pactus.transaction.get_raw_transfer_transaction retrieves raw details of a transfer transaction.
{
"amount": n, // (numeric) Transfer amount in NanoPAC.\nIt should be greater than 0.
"fee": n, // (numeric) Transaction fee in NanoPAC.\nIf not explicitly set, it is calculated based on the amount.
"lock_time": n, // (numeric) Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.
"memo": "str", // (string) Transaction memo.
"receiver": "str", // (string) Receiver's account address.
"sender": "str" // (string) Sender's account address.
}
{
"raw_transaction": "str" // (string) Raw transaction data.
}
pactus.transaction.get_raw_bond_transaction retrieves raw details of a bond transaction.
{
"fee": n, // (numeric) Transaction fee in NanoPAC.\nIf not explicitly set, it is calculated based on the stake.
"lock_time": n, // (numeric) Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.
"memo": "str", // (string) Transaction memo.
"public_key": "str", // (string) Public key of the validator.
"receiver": "str", // (string) Receiver's validator address.
"sender": "str", // (string) Sender's account address.
"stake": n // (numeric) Stake amount in NanoPAC.\nIt should be greater than 0.
}
{
"raw_transaction": "str" // (string) Raw transaction data.
}
pactus.transaction.get_raw_unbond_transaction retrieves raw details of an unbond transaction.
{
"lock_time": n, // (numeric) Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.
"memo": "str", // (string) Transaction memo.
"validator_address": "str" // (string) Address of the validator to unbond from.
}
{
"raw_transaction": "str" // (string) Raw transaction data.
}
pactus.transaction.get_raw_withdraw_transaction retrieves raw details of a withdraw transaction.
{
"account_address": "str", // (string) Address of the account to withdraw to.
"amount": n, // (numeric) Withdrawal amount in NanoPAC.\nIt should be greater than 0.
"fee": n, // (numeric) Transaction fee in NanoPAC.\nIf not explicitly set, it is calculated based on the amount.
"lock_time": n, // (numeric) Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.
"memo": "str", // (string) Transaction memo.
"validator_address": "str" // (string) Address of the validator to withdraw from.
}
{
"raw_transaction": "str" // (string) Raw transaction data.
}
pactus.blockchain.get_block retrieves information about a block based on the provided request parameters.
{
"height": n, // (numeric) Height of the block.
"verbosity": "BLOCK_DATA or BLOCK_INFO or BLOCK_TRANSACTIONS" // (string) Verbosity level for block information.
}
{
"block_time": n, // (numeric) Block timestamp.
"data": "str", // (string) Block data, only available if the verbosity level is set to BLOCK_DATA.
"hash": "str", // (string) Hash of the block.
"header": { // (json object) Block header information.
"prev_block_hash": "str", // (string) Hash of the previous block.
"proposer_address": "str", // (string) Address of the proposer of the block.
"sortition_seed": "str", // (string) Sortition seed of the block.
"state_root": "str", // (string) State root of the block.
"version": n // (numeric) Block version.
},
"height": n, // (numeric) Height of the block.
"prev_cert": { // (json object) Certificate information of the previous block.
"absentees": [ // (json array) List of absentees in the certificate.
n,
...
],
"committers": [ // (json array) List of committers in the certificate.
n,
...
],
"hash": "str", // (string) Hash of the certificate.
"round": n, // (numeric) Round of the certificate.
"signature": "str" // (string) Certificate signature.
},
"txs": [ // (json array) List of transactions
in the block.\nTransaction information is available when the verbosity level is set to BLOCK_TRANSACTIONS.
{
"bond": { // (json object) Bond payload.
"receiver": "str", // (string) Receiver's address.
"sender": "str", // (string) Sender's address.
"stake": n // (numeric) Stake amount in NanoPAC.
},
"data": "str", // (string) Transaction data.
"fee": n, // (numeric) Transaction fee in NanoPAC.
"id": "str", // (string) Transaction ID.
"lock_time": n, // (numeric) Lock time for the transaction.
"memo": "str", // (string) Transaction memo.
"payload_type": "UNKNOWN or TRANSFER_PAYLOAD
or BOND_PAYLOAD or SORTITION_PAYLOAD or UNBOND_PAYLOAD or WITHDRAW_PAYLOAD", // (string) Type of transaction payload.
"public_key": "str", // (string) Public key associated with the transaction.
"signature": "str", // (string) Transaction signature.
"sortition": { // (json object) Sortition payload.
"address": "str", // (string) Address associated with the sortition.
"proof": "str" // (string) Proof for the sortition.
},
"transfer": { // (json object) Transfer payload.
"amount": n, // (numeric) Transaction amount in NanoPAC.
"receiver": "str", // (string) Receiver's address.
"sender": "str" // (string) Sender's address.
},
"unbond": { // (json object) Unbond payload.
"validator": "str" // (string) Address of the validator to unbond from.
},
"value": n, // (numeric) Transaction value in NanoPAC.
"version": n, // (numeric) Transaction version.
"withdraw": { // (json object) Withdraw payload.
"amount": n, // (numeric) Withdrawal amount in NanoPAC.
"from": "str", // (string) Address to withdraw from.
"to": "str" // (string) Address to withdraw to.
}
},
...
]
}
pactus.blockchain.get_block_hash retrieves the hash of a block at the specified height.
{
"height": n // (numeric) Height of the block.
}
{
"hash": "str" // (string) Hash of the block.
}
pactus.blockchain.get_block_height retrieves the height of a block with the specified hash.
{
"hash": "str" // (string) Hash of the block.
}
{
"height": n // (numeric) Height of the block.
}
pactus.blockchain.get_blockchain_info retrieves general information about the blockchain.
{}
{
"committee_power": n, // (numeric) Power of the committee.
"committee_validators": [ // (json array) List of committee validators.
{
"address": "str", // (string) Address of the validator.
"availability_score": n, // (numeric) Availability score of the validator.
"data": "str", // (string) Validator data.
"hash": "str", // (string) Hash of the validator.
"last_bonding_height": n, // (numeric) Last bonding height.
"last_sortition_height": n, // (numeric) Last sortition height.
"number": n, // (numeric) Validator number.
"public_key": "str", // (string) Public key of the validator.
"stake": n, // (numeric) Validator stake in NanoPAC.
"unbonding_height": n // (numeric) Unbonding height.
},
...
],
"last_block_hash": "str", // (string) Hash of the last block.
"last_block_height": n, // (numeric) Height of the last block.
"total_accounts": n, // (numeric) Total number of accounts.
"total_power": n, // (numeric) Total power in the blockchain.
"total_validators": n // (numeric) Total number of validators.
}
pactus.blockchain.get_consensus_info retrieves information about the consensus instances.
{}
{
"instances": [ // (json array) List of consensus instances.
{
"Active": true|false, // (boolean) Whether the consensus instance is active.
"address": "str", // (string) Address of the consensus instance.
"height": n, // (numeric) Height of the consensus instance.
"round": n, // (numeric) Round of the consensus instance.
"votes": [ // (json array) List of votes in the consensus instance.
{
"block_hash": "str", // (string) Hash of the block being voted on.
"cp_round": n, // (numeric) Consensus round of the vote.
"cp_value": n, // (numeric) Consensus value of the vote.
"round": n, // (numeric) Round of the vote.
"type": "VOTE_UNKNOWN or VOTE_PREPARE or VOTE_PRECOMMIT or VOTE_CHANGE_PROPOSER", // (string) Type of the vote.
"voter": "str" // (string) Voter's address.
},
...
]
},
...
]
}
pactus.blockchain.get_account retrieves information about an account based on the provided address.
{
"address": "str" // (string) Address of the account.
}
{
"account": { // (json object) Account information.
"address": "str", // (string) Address of the account.
"balance": n, // (numeric) Account balance in NanoPAC.
"data": "str", // (string) Account data.
"hash": "str", // (string) Hash of the account.
"number": n // (numeric) Account number.
}
}
pactus.blockchain.get_validator retrieves information about a validator based on the provided address.
{
"address": "str" // (string) Address of the validator.
}
{
"validator": { // (json object) Validator information.
"address": "str", // (string) Address of the validator.
"availability_score": n, // (numeric) Availability score of the validator.
"data": "str", // (string) Validator data.
"hash": "str", // (string) Hash of the validator.
"last_bonding_height": n, // (numeric) Last bonding height.
"last_sortition_height": n, // (numeric) Last sortition height.
"number": n, // (numeric) Validator number.
"public_key": "str", // (string) Public key of the validator.
"stake": n, // (numeric) Validator stake in NanoPAC.
"unbonding_height": n // (numeric) Unbonding height.
}
}
pactus.blockchain.get_validator_by_number retrieves information about a validator based on the provided number.
{
"number": n // (numeric) Validator number.
}
{
"validator": { // (json object) Validator information.
"address": "str", // (string) Address of the validator.
"availability_score": n, // (numeric) Availability score of the validator.
"data": "str", // (string) Validator data.
"hash": "str", // (string) Hash of the validator.
"last_bonding_height": n, // (numeric) Last bonding height.
"last_sortition_height": n, // (numeric) Last sortition height.
"number": n, // (numeric) Validator number.
"public_key": "str", // (string) Public key of the validator.
"stake": n, // (numeric) Validator stake in NanoPAC.
"unbonding_height": n // (numeric) Unbonding height.
}
}
pactus.blockchain.get_validator_addresses retrieves a list of all validator addresses.
{}
{
"addresses": [ // (json array) List of validator addresses.
"str",
...
]
}
pactus.blockchain.get_public_key retrieves the public key of an account based on the provided address.
{
"address": "str" // (string) Address for which public key is requested.
}
{
"public_key": "str" // (string) Public key of the account.
}
pactus.network.get_network_info retrieves information about the overall network.
{}
{
"connected_peers": [ // (json array) List of connected peers.
{
"address": "str", // (string) Network address of the peer.
"agent": "str", // (string) Agent information of the peer.
"completed_sessions": n, // (numeric) Completed sessions with the peer.
"consensus_address": [ // (json array) Consensus address of the peer.
"str",
...
],
"consensus_keys": [ // (json array) Consensus keys used by the peer.
"str",
...
],
"direction": "str", // (string) Direction of connection with the peer.
"height": n, // (numeric) Height of the peer in the blockchain.
"invalid_messages": n, // (numeric) Count of invalid messages received.
"last_block_hash": "str", // (string) Hash of the last block the peer knows.
"last_received": n, // (numeric) Timestamp of the last received message.
"last_sent": n, // (numeric) Timestamp of the last sent message.
"moniker": "str", // (string) Moniker of the peer.
"peer_id": "str", // (string) Peer ID of the peer.
"protocols": [ // (json array) List of protocols supported by the peer.
"str",
...
],
"received_bytes": { // (key:value json object) Bytes received per message type.
...: ...,
n: n
},
"received_messages": n, // (numeric) Count of received messages.
"sent_bytes": { // (key:value json object) Bytes sent per message type.
...: ...,
n: n
},
"services": n, // (numeric) Services provided by the peer.
"status": n, // (numeric) Status of the peer.
"total_sessions": n // (numeric) Total sessions with the peer.
},
...
],
"connected_peers_count": n, // (numeric) Number of connected peers.
"network_name": "str", // (string) Name of the network.
"received_bytes": { // (key:value json object) Bytes received per peer ID.
...: ...,
n: n
},
"sent_bytes": { // (key:value json object) Bytes sent per peer ID.
...: ...,
n: n
},
"total_received_bytes": n, // (numeric) Total bytes received across the network.
"total_sent_bytes": n // (numeric) Total bytes sent across the network.
}
pactus.network.get_node_info retrieves information about a specific node in the network.
{}
{
"addrs": [ // (json array) List of addresses associated with the node.
"str",
...
],
"agent": "str", // (string) Agent information of the node.
"moniker": "str", // (string) Moniker of the node.
"peer_id": "str", // (string) Peer ID of the node.
"protocols": [ // (json array) List of protocols supported by the node.
"str",
...
],
"reachability": "str", // (string) Reachability status of the node.
"services": [ // (json array) List of services provided by the node.
n,
...
],
"services_names": [ // (json array) Names of services provided by the node.
"str",
...
],
"started_at": n // (numeric) Timestamp when the node started.
}
pactus.wallet.create_wallet creates a new wallet with the specified parameters.
{
"language": "str", // (string) Language for the mnemonic.
"mnemonic": "str", // (string) Mnemonic for wallet recovery.
"password": "str", // (string) Password for securing the wallet.
"wallet_name": "str" // (string) Name of the new wallet.
}
{
"wallet_name": "str" // (string) Name of the created wallet.
}
pactus.wallet.load_wallet loads an existing wallet with the given name.
{
"wallet_name": "str" // (string) Name of the wallet to load.
}
{
"wallet_name": "str" // (string) Name of the loaded wallet.
}
pactus.wallet.unload_wallet unloads a currently loaded wallet with the specified name.
{
"wallet_name": "str" // (string) Name of the wallet to unload.
}
{
"wallet_name": "str" // (string) Name of the unloaded wallet.
}
pactus.wallet.lock_wallet locks a currently loaded wallet with the provided password and timeout.
{
"wallet_name": "str" // (string) Name of the wallet to lock.
}
{
"wallet_name": "str" // (string) Name of the locked wallet.
}
pactus.wallet.unlock_wallet unlocks a locked wallet with the provided password and timeout.
{
"password": "str", // (string) Password for unlocking the wallet.
"timeout": n, // (numeric) Timeout duration for the unlocked state.
"wallet_name": "str" // (string) Name of the wallet to unlock.
}
{
"wallet_name": "str" // (string) Name of the unlocked wallet.
}
pactus.wallet.get_total_balance returns the total available balance of the wallet.
{
"wallet_name": "str" // (string) Name of the wallet.
}
{
"total_balance": n, // (numeric) The total balance of the wallet in NanoPAC.
"wallet_name": "str" // (string) Name of the wallet.
}
pactus.wallet.sign_raw_transaction signs a raw transaction for a specified wallet.
{
"password": "str", // (string) Password for unlocking the wallet for signing.
"raw_transaction": "str", // (string) Raw transaction data to be signed.
"wallet_name": "str" // (string) Name of the wallet used for signing.
}
{
"signed_raw_transaction": "str", // (string) Signed raw transaction data.
"transaction_id": "str" // (string) ID of the signed transaction.
}
pactus.wallet.get_validator_address retrieves the validator address associated with a public key.
{
"public_key": "str" // (string) Public key for which the validator address is requested.
}
{
"address": "str" // (string) Validator address associated with the public key.
}
pactus.wallet.get_new_address generates a new address for the specified wallet.
{
"address_type": "ADDRESS_TYPE_TREASURY or
ADDRESS_TYPE_VALIDATOR or ADDRESS_TYPE_BLS_ACCOUNT", // (string) Address type for the new address.
"label": "str", // (string) Label for the new address.
"wallet_name": "str" // (string) Name of the wallet for which the new address is requested.
}
{
"address_info": { // (json object) Address information.
"address": "str", // (string)
"label": "str", // (string)
"path": "str", // (string)
"public_key": "str" // (string)
},
"wallet_name": "str" // (string) Name of the wallet.
}
pactus.wallet.get_address_history retrieve transaction history of an address.
{
"address": "str", // (string) Address to get the transaction history of it.
"wallet_name": "str" // (string) Name of the wallet.
}
{
"history_info": [ // (json array) Array of address history and activities.
{
"amount": n, // (numeric) amount of transaction.
"description": "str", // (string) description of transaction.
"payload_type": "str", // (string) payload type of transaction.
"time": n, // (numeric) transaction timestamp.
"transaction_id": "str" // (string) Hash of transaction.
},
...
]
}