Chia RPC

API Documentation

Version: 2.2.0

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 farmer uses port 8559 by default.

Farmer

getHarvesterPlotsDuplicates

Get a paginated list of duplicate plots.

post

/get_harvester_plots_duplicates

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_harvester_plots_duplicates" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getHarvesterPlotsInvalid

Get a paginated list of invalid plots.

post

/get_harvester_plots_invalid

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_harvester_plots_invalid" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getHarvesterPlotsKeysMissing

Get a paginated list of plots with missing keys.

Get a paginated list of invalid plots with missing keys.

post

/get_harvester_plots_keys_missing

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_harvester_plots_keys_missing" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getHarvesterPlotsValid

Get a paginated list of valid plots.

post

/get_harvester_plots_valid

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_harvester_plots_valid" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getHarvesters

Get the list of harvesters.

post

/get_harvesters

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_harvesters" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getHarvestersSummary

Get a summary of harvesters.

Get a summary of harvesters, similar to get_harvests but with plot counts only.

post

/get_harvesters_summary

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_harvesters_summary" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getPoolLoginLink

Get's the pool login link, if any.

post

/get_pool_login_link

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_pool_login_link" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getPoolState

Get's the state of the pool.

post

/get_pool_state

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_pool_state" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getRewardTargets

Get the farm and pool reward targets.

post

/get_reward_targets

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_reward_targets" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getSignagePoint

Get's a signage point by hash.

post

/get_signage_point

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_signage_point" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getSignagePoints

Get signage points.

post

/get_signage_points

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/get_signage_points" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

setPayoutInstructions

Set's a pool's payout instructions.

post

/set_payout_instructions

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/farmer/private_farmer.crt \
--key ~/.chia/mainnet/config/ssl/farmer/private_farmer.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8559/set_payout_instructions" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema

setRewardTargets

Set the farm and pool reward targets.

post

/set_reward_targets

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema