Chia RPC

Blocks

getAdditionsAndRemovals

Retrieves the additions and removals for a certain block.

Retrieves the additions and removals (state transitions) for a certain block. Returns coin records for each addition and removal.

post

/get_additions_and_removals

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_additions_and_removals" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlock

Retrieves a block by header hash.

Retrieves a block by header hash.

post

/get_block

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_block" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlockCountMetrics

Retrieves aggregate information about blocks.

Retrieves aggregate information about blocks.

post

/get_block_count_metrics

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_block_count_metrics" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlockRecord

Retrieves a block record by header hash.

Retrieves a block record by header hash.

post

/get_block_record

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_block_record" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlockRecordByHeight

Retrieves a block record by height.

Retrieves a block record by height (assuming the height <= peak height). Note that not all blocks will have all fields set here (depending on transaction block, finishing sub epoch, etc).

post

/get_block_record_by_height

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_block_record_by_height" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlockRecords

Retrieves block records in a range.

Retrieves block records in a range

post

/get_block_records

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_block_records" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlockSpends

Retrieves the spends in the given block.

Retrieves the spends in the given block.

post

/get_block_spends

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_block_spends" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlockSpendsWithConditions

Retrieves the spends in the given block, including its conditions.

Retrieves the spends in the given block, including its conditions.

post

/get_block_spends_with_conditions

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_block_spends_with_conditions" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlocks

Get the blocks between a start and end height.

Get the blocks between a start and end height

post

/get_blocks

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_blocks" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getRecentSignagePointOrEos

Retrieves a recent signage point or end of slot.

Retrieves a recent signage point or end of slot.

post

/get_recent_signage_point_or_eos

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_recent_signage_point_or_eos" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getUnfinishedBlockHeaders

Retrieves unfinished block headers.

Retrieves unfinished block headers.

post

/get_unfinished_block_headers

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_unfinished_block_headers" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Coins

getCoinRecordByName

Retrieves a coin record by it's name.

Retrieves a coin record by it's name.

post

/get_coin_record_by_name

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_coin_record_by_name" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCoinRecordsByHint

Retrieves coins by hint.

Retrieves coins by hint, by default returns unspent coins.

post

/get_coin_records_by_hint

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_coin_records_by_hint" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCoinRecordsByNames

Retrieves the coins for given coin IDs.

Retrieves the coins for given coin IDs, by default returns unspent coins.

post

/get_coin_records_by_names

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_coin_records_by_names" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCoinRecordsByParentIds

Retrieves the coins for given parent coin IDs.

Retrieves the coins for given parent coin IDs, by default returns unspent coins.

post

/get_coin_records_by_parent_ids

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_coin_records_by_parent_ids" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCoinRecordsByPuzzleHash

Retrieves the coins for a given puzzlehash.

Retrieves the coins for a given puzzlehash, by default returns unspent coins.

post

/get_coin_records_by_puzzle_hash

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_coin_records_by_puzzle_hash" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCoinRecordsByPuzzleHashes

Retrieves the coins for a given puzzlehashes

Retrieves the coins for a given puzzlehashes, by default returns unspent coins.

post

/get_coin_records_by_puzzle_hashes

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_coin_records_by_puzzle_hashes" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getPuzzleAndSolution

Retrieves a coin solution.

Retrieves a coin solution.

post

/get_puzzle_and_solution

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_puzzle_and_solution" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

pushTx

Pushes a transaction/spend bundle to the mempool and blockchain.

Pushes a transaction/spend bundle to the mempool and blockchain. Returns whether the spend bundle was successfully included into the mempool.

post

/push_tx

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/push_tx" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Fees

getFeeEstimate

Estimates the fee for a given spend_bundle.

Estimates the fee for a given spend_bundle.

post

/get_fee_estimate

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_fee_estimate" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

FullNode

fullNodeGetNetworkInfo

Retrieves some information about the current network.

Retrieves some information about the current network.

post

/get_network_info

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_network_info" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getBlockchainState

Retrieves a summary of the current state of the blockchain and full node.

Retrieves a summary of the current state of the blockchain and full node.

post

/get_blockchain_state

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_blockchain_state" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getNetworkSpace

Retrieves an estimate of total space.

Retrieves an estimate of total space validating the chain between two block header hashes.

post

/get_network_space

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_network_space" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Mempool

getAllMempoolItems

Returns all items in the mempool.

Returns all items in the mempool.

post

/get_all_mempool_items

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_all_mempool_items" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getAllMempoolTxIds

Returns a list of all transaction IDs in the mempool.

Returns a list of all transaction IDs (spend bundle hashes) in the mempool.

post

/get_all_mempool_tx_ids

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_all_mempool_tx_ids" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getMempoolItemByTxId

Returns a specific item from the mempool.

Returns a specific item from the mempool.

post

/get_mempool_item_by_tx_id

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_mempool_item_by_tx_id" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getMempoolItemsByCoinName

Gets items in the mempool by a coin name.

Gets items in the mempool by a coin name.

post

/get_mempool_items_by_coin_name

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_mempool_items_by_coin_name" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Shared

closeConnection

Removes a connection.

Removes a connection.

post

/close_connection

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/close_connection" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

getConnections

Retrieve the list of connections.

Retrieve the list of connections.

post

/get_connections

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_connections" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getRoutes

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

post

/get_routes

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/get_routes" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

healthz

Heartbeat.

Heartbeat.

post

/healthz

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/healthz" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

openConnection

Add a connection to another node.

Add a connection to another node.

post

/open_connection

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/open_connection" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

stopNode

Stop the node.

Stop the node.

post

/stop_node

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/full_node/private_full_node.crt \
--key ~/.chia/mainnet/config/ssl/full_node/private_full_node.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8555/stop_node" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values