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 harvester uses port 8560 by default.

Harvester

addPlotDirectory

Add a plot directory to the harvester configuration.

post

/add_plot_directory

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/add_plot_directory" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

deletePlot

Permanently delete a plot file.

post

/delete_plot

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/delete_plot" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

getHarvesterConfig

Gets harvester configuration.

post

/get_harvester_config

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/get_harvester_config" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getPlotDirectories

Get the list of plot directories from the harvester configuration.

post

/get_plot_directories

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/get_plot_directories" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getPlots

Get information about the plots the harvester knows about.

post

/get_plots

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/get_plots" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

refreshPlots

Refresh the list of plots.

post

/refresh_plots

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/refresh_plots" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

removePlotDirectory

Removes a plot directory from the harvester configuration.

post

/remove_plot_directory

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/remove_plot_directory" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

updateHarvesterConfig

Updates the harvester configuration.

post

/update_harvester_config

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/update_harvester_config" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

Shared

closeConnection

Removes a connection.

post

/close_connection

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

fullNodeGetNetworkInfo

Retrieves some information about the current network.

post

/get_network_info

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getConnections

Retrieve the list of connections.

post

/get_connections

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/get_connections" \
-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/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/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/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/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/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/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/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/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/harvester/private_harvester.crt \
--key ~/.chia/mainnet/config/ssl/harvester/private_harvester.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8560/stop_node" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema