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 crawler uses port 8561 by default.

Crawler

getIpsAfterTimestamp

Retrieves ip addresses of peers that have connected after a given time.

post

/get_ips_after_timestamp

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/crawler/private_crawler.crt \
--key ~/.chia/mainnet/config/ssl/crawler/private_crawler.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:8561/get_ips_after_timestamp" \
-d "{}"

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK

Schema

getPeerCounts

Retrieves aggregate information about peers.

post

/get_peer_counts

Usage

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

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - OK response without return values

Schema