Chia RPC

API Documentation

Version: 2.4.3

The Chia node and services come with a JSON RPC API server that allows you to access information and control the services. These are accessible via HTTPS, WebSockets, or via client SDKs. The ports can be configured in ~/.chia/mainnet/config/config.yaml. The RPC ports should not be exposed to the internet. TLS certificates are used to secure the communication using mutualTLS. The data layer uses port 8562 by default.

DataLayer

addMissingFiles

Complete the data server files.

post

/add_missing_files

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/add_missing_files" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

batchUpdate

Applies a batch of updates.

post

/batch_update

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/batch_update" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

createDataStore

Creates a data store.

post

/create_data_store

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/create_data_store" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

deleteKey

Removes a list of rows.

post

/delete_key

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/delete_key" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getAncestors

Gets the list of ancestors for a given id/hash pair.

post

/get_ancestors

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_ancestors" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getKeys

Get the keys for a given id/root_hash pair.

post

/get_keys

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_keys" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getKeysValues

Get the keys and values for a given id/root_hash pair.

post

/get_keys_values

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_keys_values" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getKvDiff

Get kv diff between two root hashes.

post

/get_kv_diff

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_kv_diff" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getLocalRoot

Gets hash of latest tree root saved in our local datastore.

post

/get_local_root

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_local_root" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getOwnedStores

Gets the list of owned store ids.

post

/get_owned_stores

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_owned_stores" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getProof

Retrieves a proof.

post

/get_proof

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_proof" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getRoot

Gets hash of latest tree root.

post

/get_root

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_root" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getRootHistory

Get history of state hashes for a store.

post

/get_root_history

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_root_history" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getRoots

Gets state hashes for a list of roots

Gets state hashes for a list of roots.

post

/get_roots

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_roots" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getSyncStatus

Gets the sync status of a store.

post

/get_sync_status

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_sync_status" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getValue

Get the value for a given id/key pair.

post

/get_value

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_value" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

insert

Adds a list of clvm objects as bytes to add to table.

post

/insert

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/insert" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

multistoreBatchUpdate

Applies a batch of updates, across 1:n stores.

post

/multistore_batch_update

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/multistore_batch_update" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

submitAllPendingRoots

Submits all pending roots.

post

/submit_all_pending_roots

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/submit_all_pending_roots" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

submitPendingRoot

Submits a pending root.

post

/submit_pending_root

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/submit_pending_root" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

verifyProof

Verifies a proof.

post

/verify_proof

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/verify_proof" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

walletLogIn

Logs into the wallet.

post

/wallet_log_in

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/wallet_log_in" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

Mirrors

addMirror

Adds a mirror.

post

/add_mirror

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/add_mirror" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

deleteMirror

Deletes a mirror.

post

/delete_mirror

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/delete_mirror" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

getMirrors

Gets the mirrors for a given store id.

post

/get_mirrors

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_mirrors" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

Offers

cancelOffer

Cancels an offer.

post

/cancel_offer

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/cancel_offer" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

makeOffer

Makes an offer.

post

/make_offer

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/make_offer" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

takeOffer

Takes an offer.

post

/take_offer

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/take_offer" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

verifyOffer

Verifies an offer.

post

/verify_offer

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/verify_offer" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

Shared

closeConnection

Removes a connection.

post

/close_connection

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

getConnections

Retrieve the list of connections.

post

/get_connections

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getNetworkInfo

Retrieves some information about the current network.

post

/get_network_info

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

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/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_routes" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getVersion

Get the installed version of chia at the endpoint.

post

/get_version

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/get_version" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

healthz

Heartbeat.

post

/healthz

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

openConnection

Add a connection to another node.

post

/open_connection

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

stopNode

Stop the node.

post

/stop_node

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

Subscriptions

checkPlugins

Checks the status of plugins.

post

/check_plugins

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/check_plugins" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

clearPendingRoots

Clears pending roots.

post

/clear_pending_roots

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/clear_pending_roots" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

removeSubscriptions

Removes subscriptions for the given id.

post

/remove_subscriptions

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/remove_subscriptions" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

Subscribe to singleton.

post

/subscribe

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/subscribe" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

subscriptions

List current subscriptions.

post

/subscriptions

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/subscriptions" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

unsubscribe

Unsubscribe from singleton.

post

/unsubscribe

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8562/unsubscribe" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema