.NET 6.0
dotnet add package CHIA-RPC --version
NuGet\Install-Package CHIA-RPC -Version
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CHIA-RPC" Version="" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CHIA-RPC --version
#r "nuget: CHIA-RPC,"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install CHIA-RPC as a Cake Addin
#addin nuget:?package=CHIA-RPC&version=

// Install CHIA-RPC as a Cake Tool
#tool nuget:?package=CHIA-RPC&version=

Welcome to the CHIA-RPC Nuget package!

This package is a wrapper for RPC-JSON files used to communicate with the Chia client through the HTTP-API, WebSocket API, or CLI.
The wrapper allows you to easily create the appropriate RPC object for all wallet endpoint calls, and deserialize the response JSON and accessing its objets.

CHIA-RPC ONLY contains the rpc wrappers (.net objects for RPC, Response and Chia Objects) In ;rder to cummiunicate with the chia client, you need to either implement your own client solution or use the Chia-Client-API package which implements all rpc endpoints and supports remote management of the chia client.


General functions

All classes support the following base functions:

  • SaveToFile(string path): saves the rpc as a json-formatted file to the specified path on disk.
  • LoadFromFile(string path): loads an rpc file from the specified path from disk.
  • ToString(): returns a json-formatted string representation of the class.
  • LoadObjectFromString(string json): converts a json string (eg. response) into a given object.


There are 3 types in this library:

  • EndpointName_RPC these classes represent the request content which is issued against the chia client.
  • EndpointName_Response these classes represent the chia clients response and are beeing used to deserialize the server response into workable c# objects
  • ObjectName these classes represent objects in the chia space such as a CoinRecord, a Transaction and so on

RPC Creation

Most endpoints are implemented with a constructor:

// Create a new instance of the SendXCH_RPC class
var rpc = new SendXCH_RPC(1234, "chia1q2jzm7eg5t2k8vnq3tkkf5l7zj9mfx9v7p9t5", 1000, 500, new string[] { "Transaction from Example program" })

If this is not the case or for whatever other reason, You can also creath them like so:

// Create a new instance of the SendXCH_RPC class
var rpc = new SendXCH_RPC
    wallet_id = 1234,
    address = "chia1q2jzm7eg5t2k8vnq3tkkf5l7zj9mfx9v7p9t5",
    amount = 10000,
    fee = 500,
    memos = new string[] { "Transaction from Example program" }

Some endpoints already implement Constructors which make things a litte easier:

GetNextAddress_RPC rpc = new GetNextAddress_RPC(1, false);

Some endpoins already have implicit conversions which make working a lot easier. The support is quite sparse still:

WalletID_Response walletID = WalletID_Response.LoadResponseFromString(serverResponse);
GetNextAddress_RPC rpc = new GetNextAddress_RPC(walletID);


in order to work with the rpcs, you want to serialize/deserialize them to and from json.


All classes have a .ToString() method to convert a class to json content:

WalletID_RPC rpc = new WalletID_RPC(1);
string json = rpc.Tostring();

Deserialisation is implemented as static method and can be used to convert the server response:

GetNextAddress_Response nextAddress = GetNextAddress_Response.LoadResponseFromString(serverResponse);


Often it can be helpful to load and store objects such as an initiated transaction to disk for later reuse:

Saving object to disk

All objects and classes implement a SaveToFile method. The method automatically appends a filename .rpc .response or .object in respect of the basetype

TransactionID_Response pendingTransaction = new TransactionID_Response();
Loading object from disk

Simmilar to the Deserialisation, loading from disk is implemented as a static method:

TransactionID_Response pendingTransaction = TransactionID_Response.LoadResponseFromFile("C:\\temp\\pendingTransactions\\mytransaction-001");


The structure of the chia API can be confusing and many rpcs (eg WalletID_RPC) are used for multiple endpoints so it is strongly recommended to use the Chia-Client-API to see how the interaction with the RPC requests is.

Per default, the chia client will only listen to rpc requests from the local machine.
If you have remote machines to manage, eg a full node or farmers, you need to enable public port listening.
For that, edit the chia configuration (default at ~/.chia/mainnet/config/config.yaml).
Look for a line starting with self-hostname like so: self_hostname: &self_hostname "localhost"
change it to: self_hostname: to listen on all interfaces or to the local interface ip to listen on a specific interface.

For a full documentation besides xml markup, please refer to the official chia documentation:

Thank you for using CHIA-RPC!


Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on CHIA-RPC:

Package Downloads

CHIA-RPC is a C# Nuget library that allows developers to easily communicate with the Chia client. It provides a wrapper for making requests, sending transactions, and minting, making it a versatile tool for interacting with the Chia blockchain. With CHIA-RPC, you can easily integrate Chia functionality into your C# projects.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated 86 8/31/2023
2.0.0 107 8/28/2023 110 8/22/2023 134 8/10/2023 111 8/9/2023 123 8/9/2023 111 8/9/2023 114 8/9/2023
1.8.2 105 7/26/2023 114 6/26/2023 131 6/23/2023 135 6/22/2023 119 6/22/2023 117 6/22/2023 121 6/22/2023 113 6/22/2023 133 6/21/2023 131 6/14/2023 126 6/14/2023 136 6/12/2023 141 6/9/2023 130 6/9/2023 132 6/9/2023 129 6/7/2023 120 6/7/2023
1.8.1 127 6/2/2023
1.8.0 129 5/11/2023
1.7.1 160 4/21/2023 271 2/8/2023 251 2/8/2023 278 2/5/2023 219 2/5/2023 214 2/5/2023 323 1/31/2023 311 1/28/2023 361 1/25/2023 273 1/24/2023 257 1/17/2023 270 1/16/2023 268 1/15/2023 274 1/13/2023
1.6.2 283 1/12/2023 290 1/11/2023 303 1/10/2023 228 1/10/2023 287 12/29/2022
1.6.1 259 12/29/2022
- Marked GetTransactions and corresponding classes/functions as obsolete due to official statement:
"Transaction history is not deterministic due to heuristics we use to counter privacy features of the blockchain. the wallet does a best effort. we are trying to improve this going forward. for accurate records you should keep a local record of TXs made. If the balance is not the same (within a mojos because of dust filtering) please let us know."

- documentation updates according to official documentation
- added signing_mode to verify_signature