Chia RPC

CATWallet

cancelOffer

Cancels an offer.

Cancels an offer.

post

/cancel_offer

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

cancelOffers

Cancels multiple offers.

Cancels multiple offers.

post

/cancel_offers

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/cancel_offers" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

catAssetIdToName

Gets the name and wallet id associated with an asset id.

Gets the name and wallet id associated with an asset id.

post

/cat_asset_id_to_name

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/cat_asset_id_to_name" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

catGetAssetId

Gets the asset id of the CAT wallet.

Gets the asset id of the CAT wallet.

post

/cat_get_asset_id

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/cat_get_asset_id" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

catGetName

Gets the name of the CAT wallet.

Gets the name of the CAT wallet.

post

/cat_get_name

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/cat_get_name" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

catSetName

Sets the name of the CAT wallet.

Sets the name of the CAT wallet.

post

/cat_set_name

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/cat_set_name" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

catSpend

Spends an amount from the given wallet.

Spends an amount from the given wallet.

post

/cat_spend

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/cat_spend" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response with a transaction record and a transaction id.

checkOfferValidity

Checks the validity of an offer.

Checks the validity of an offer.

post

/check_offer_validity

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/check_offer_validity" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

createOfferForIds

Creates an offer.

Creates an offer for the given set of wallet id and amount pairs.

post

/create_offer_for_ids

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/create_offer_for_ids" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getAllOffers

Retrieves offers.

Retrieves offers.

post

/get_all_offers

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_all_offers" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCatList

Retrieves the list of CATs.

Retrieves the list of CATs.

post

/get_cat_list

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_cat_list" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getOffer

Retrieves an offer.

Retrieves an offer.

post

/get_offer

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_offer" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getOfferSummary

Get the summary of a given offer.

Get the summary of a given offer.

post

/get_offer_summary

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_offer_summary" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getOffersCount

Retrieves the number of offers.

Retrieves the number of offers.

post

/get_offers_count

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_offers_count" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getStrayCats

Get a list of all unacknowledged CATs.

Get a list of all unacknowledged CATs.

post

/get_stray_cats

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_stray_cats" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

selectCoins

Returns a set of coins that can be used for generating a new transaction.

Returns a set of coins that can be used for generating a new transaction.

post

/select_coins

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/select_coins" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

takeOffer

Takes an offer.

Takes an offer.

post

/take_offer

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

CRCATs

crcatApprovePending

Moving any "pending approval" CR-CATs into the spendable balance of the wallet.

Moving any "pending approval" CR-CATs into the spendable balance of the wallet.

post

/crcat_approve_pending

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/crcat_approve_pending" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Coins

getCoinRecords

Retrieves the coins that match given filter criteria.

Retrieves the coins that match given filter criteria

post

/get_coin_records

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_coin_records" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCoinRecordsByNames

Retrieves the coins for given coin IDs.

Retrieves the coins for given coin IDs, by default returns unspent coins.

post

/get_coin_records_by_names

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_coin_records_by_names" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

DAOWallet

daoAddFundsToTreasury

Adds funds to a DAO's treasury.

Adds funds to a DAO's treasury

post

/dao_add_funds_to_treasury

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_add_funds_to_treasury" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoAdjustFilterLevel

Adjusts the DAO filter level.

Adjusts the DAO filter level

post

/dao_adjust_filter_level

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_adjust_filter_level" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoCloseProposal

Closes a DAO proposal.

Closes a DAO proposal

post

/dao_close_proposal

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_close_proposal" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoCreateProposal

Creates a DAO proposal.

Creates a DAO proposal

post

/dao_create_proposal

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_create_proposal" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoExitLockup

Exits the DAO lockup period.

Exits the DAO lockup period

post

/dao_exit_lockup

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_exit_lockup" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoFreeCoinsFromFinishedProposals

Frees coins from proposals that are finished.

Frees coins from proposals that are finished

post

/dao_free_coins_from_finished_proposals

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_free_coins_from_finished_proposals" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoGetProposalState

Retrieves the state of a DAO proposal

Use this to figure out whether a proposal has passed or failed and whether it can be closed Given a proposal_id: - if required yes votes are recorded then proposal passed. - if timelock and attendance are met then proposal can close Returns a dict of passed and closable bools, and the remaining votes/blocks needed Note that a proposal can be in a passed and closable state now, but become failed if a large number of 'no' votes are received before the soft close is reached.

post

/dao_get_proposal_state

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_get_proposal_state" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoGetProposals

Get all proposals for a given dao wallet.

Get all proposals for a given dao wallet

post

/dao_get_proposals

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_get_proposals" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoGetRules

Retrieves the rules of a DAO wallet.

Retrieves the rules of a DAO wallet

post

/dao_get_rules

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_get_rules" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoGetTreasuryBalance

Retrieves the balance of a DAO's treasury.

Retrieves the balance of a DAO's treasury

post

/dao_get_treasury_balance

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_get_treasury_balance" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoGetTreasuryId

Retrieves the treasury id of a DAO wallet.

Retrieves the treasury id of a DAO wallet

post

/dao_get_treasury_id

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_get_treasury_id" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoParseProposal

Parses a DAO proposal.

Parses a DAO proposal

post

/dao_parse_proposal

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_parse_proposal" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoSendToLockup

Sends the DAO to lockup.

Sends the DAO to lockup

post

/dao_send_to_lockup

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_send_to_lockup" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

daoVoteOnProposal

Vote on a DAO proposal.

Vote on a DAO proposal

post

/dao_vote_on_proposal

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dao_vote_on_proposal" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

DIDWallet

didCreateAttest

Creates an attestment for the given DID wallet.

Creates an attestment for the given DID wallet.

post

/did_create_attest

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_create_attest" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didCreateBackupFile

Creates a backup file for the given DID wallet.

Creates a backup file for the given DID wallet.

post

/did_create_backup_file

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_create_backup_file" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didFindLostDid

Recover a missing or unspendable DID wallet by a coin id of the DID.

Recover a missing or unspendable DID wallet by a coin id of the DID

post

/did_find_lost_did

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_find_lost_did" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetCurrentCoinInfo

Gets information about the DID wallets current coin.

Gets information about the DID wallets current coin.

post

/did_get_current_coin_info

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_current_coin_info" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetDid

Retrieves the distributed identity for a given wallet.

Retrieves the distributed identity for a given wallet.

post

/did_get_did

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_did" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetInfo

Retrieves information about a DID.

Retrieves information about a DID

post

/did_get_info

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_info" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetInformationNeededForRecovery

Retrieves the recovery information needed for the given DID wallet.

Retrieves the recovery information needed for the given DID wallet.

post

/did_get_information_needed_for_recovery

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_information_needed_for_recovery" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetMetadata

Gets the metadata of a DID wallet.

Gets the metadata of a DID wallet.

post

/did_get_metadata

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_metadata" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetPubkey

Retrieves the public key for the given DID wallet.

Retrieves the public key for the given DID wallet.

post

/did_get_pubkey

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_pubkey" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetRecoveryList

Retrieves the recovery list for a given DID wallet.

Retrieves the recovery list for a given DID wallet.

post

/did_get_recovery_list

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_recovery_list" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didGetWalletName

Gets the name of a DID wallet.

Gets the name of a DID wallet.

post

/did_get_wallet_name

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_get_wallet_name" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didMessageSpend

Spends a DID message.

Spends a DID message

post

/did_message_spend

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_message_spend" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didRecoverySpend

Spend from the given DID wallet.

Spend from the given DID wallet.

post

/did_recovery_spend

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_recovery_spend" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didSetWalletName

Sets the name of a DID wallet.

Sets the name of a DID wallet.

post

/did_set_wallet_name

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_set_wallet_name" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didTransferDid

Transfer a DID to another owner.

Transfer the given DID wallet to another owner.

post

/did_transfer_did

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_transfer_did" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didUpdateMetadata

Updates the metadata for a DID wallet.

Updates the metadata for a DID wallet.

post

/did_update_metadata

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_update_metadata" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

didUpdateRecoveryIds

Updates the recovery ids for a DID wallet.

Updates the recovery ids for a DID wallet.

post

/did_update_recovery_ids

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/did_update_recovery_ids" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

DataLayer

dlVerifyProof

Verifies a proof.

Verify a proof of inclusion for a DL singleton.

post

/dl_verify_proof

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_verify_proof" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

DataLayerWallet

createNewDl

Initialize the new data layer wallets.

Initialize the DataLayer Wallet (only one can exist).

post

/create_new_dl

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/create_new_dl" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlDeleteMirror

Remove an existing mirror for a specific singleton.

Remove an existing mirror for a specific singleton.

post

/dl_delete_mirror

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_delete_mirror" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlGetMirrors

Get all of the mirrors for a specific singleton.

Get all of the mirrors for a specific singleton.

post

/dl_get_mirrors

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_get_mirrors" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlHistory

Get the singleton record for the latest singleton of a launcher ID.

Get the singleton record for the latest singleton of a launcher ID.

post

/dl_history

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_history" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlLatestSingleton

Get the singleton records that contain the specified root.

Get the singleton records that contain the specified root.

post

/dl_latest_singleton

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_latest_singleton" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlNewMirror

Add a new on chain message for a specific singleton.

Add a new on chain message for a specific singleton

post

/dl_new_mirror

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_new_mirror" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlOwnedSingletons

Get all owned singleton records.

Get all owned singleton records.

post

/dl_owned_singletons

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_owned_singletons" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlSingletonsByRoot

Get the singleton records that contain the specified root.

Get the singleton records that contain the specified root.

post

/dl_singletons_by_root

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_singletons_by_root" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlStopTracking

Stop tracking the data layer wallets.

Stop tracking the data layer wallet.

post

/dl_stop_tracking

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_stop_tracking" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

dlTrackNew

Track the new data layer wallet

Track the new data layer wallet.

post

/dl_track_new

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_track_new" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

dlUpdateMultiple

Update multiple singletons with new merkle roots.

Update multiple singletons with new merkle roots.

post

/dl_update_multiple

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_update_multiple" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

dlUpdateRoot

Update a data layer root.

Update a data layer root.

post

/dl_update_root

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/dl_update_root" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

KeyManagement

addKey

Generates a new mnemonic phrase.

Generates a new mnemonic phrase.

post

/add_key

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/add_key" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

checkDeleteKey

Determines if it is safe to delete a private key.

Determines if it is safe to delete a private key. Returns whether it is used for farming, pooling, or has a balance.

post

/check_delete_key

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/check_delete_key" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

deleteKey

Deletes all keys which have the given public key fingerprint.

Deletes all keys which have the given public key fingerprint.

post

/delete_key

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

generateMnemonic

Generates a new mnemonic phrase.

Generates a new mnemonic phrase.

post

/generate_mnemonic

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/generate_mnemonic" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getLoggedInFingerprint

Retrieves the logged in fingerprint.

Retrieves the logged in fingerprint.

post

/get_logged_in_fingerprint

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_logged_in_fingerprint" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getPrivateKey

Retrieves the private key by fingerprint.

Retrieves the private key by fingerprint.

post

/get_private_key

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_private_key" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getPublicKeys

Retrieves all public keys on the node.

Retrieves all public keys on the node.

post

/get_public_keys

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_public_keys" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

logIn

Logs in the wallet with a specific key.

Logs in the wallet with a specific key.

post

/log_in

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/log_in" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

verifySignature

Given a public key, message and signature, verify if it is valid.

Given a public key, message and signature, verify if it is valid.

post

/verify_signature

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/verify_signature" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

walletDeleteAllKeys

Deletes all keys from the keychain.

Deletes all keys from the keychain.

post

/delete_all_keys

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/delete_all_keys" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

NFTWallet

nftAddUri

Adds an Uri to an NFT.

Adds a Uri to an NFT.

post

/nft_add_uri

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_add_uri" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftCalculateRoyalties

Transfers an NFT to another address.

Transfers an NFT to another address.

post

/nft_calculate_royalties

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_calculate_royalties" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftCountNfts

Retrieves the number of NFTs in a wallet.

Retrieves the number of NFTs in a wallet

post

/nft_count_nfts

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_count_nfts" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftGetByDid

Gets an NFT wallet by its DID.

Gets an NFT wallet by its DID.

post

/nft_get_by_did

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_get_by_did" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftGetInfo

Gets info about an NFT.

Gets info about an NFT.

post

/nft_get_info

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_get_info" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftGetNfts

Gets NFTs from a wallet.

Gets NFTs from a wallet.

post

/nft_get_nfts

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_get_nfts" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftGetWalletDid

Gets the DID for an NFT wallet.

Gets the DID for an NFT wallet.

post

/nft_get_wallet_did

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_get_wallet_did" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftGetWalletsWithDids

Gets all the wallets with a DID.

Gets all the wallets with a DID.

post

/nft_get_wallets_with_dids

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_get_wallets_with_dids" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftMintBulk

Mints NFTs in bulk.

Mints NFTs in bulk.

post

/nft_mint_bulk

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_mint_bulk" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftMintNft

Mints an NFT.

Mints an NFT.

post

/nft_mint_nft

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_mint_nft" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftSetDidBulk

Bulk set DID for NFTs across different wallets.

Bulk set DID for NFTs across different wallets

post

/nft_set_did_bulk

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_set_did_bulk" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftSetNftDid

Sets the DID of an NFT.

Sets the DID of an NFT.

post

/nft_set_nft_did

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_set_nft_did" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftSetNftStatus

Sets the status of an NFT.

Sets the status of an NFT.

post

/nft_set_nft_status

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_set_nft_status" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

nftTransferBulk

Bulk transfer NFTs to an address.

Bulk transfer NFTs to an address

post

/nft_transfer_bulk

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_transfer_bulk" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

nftTransferNft

Transfers an NFT to another address.

Transfers an NFT to another address.

post

/nft_transfer_nft

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/nft_transfer_nft" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Notifications

deleteNotifications

Deletes notifications.

Deletes notifications.

post

/delete_notifications

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/delete_notifications" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getNotifications

Retrieves notifications.

Retrieves notifications.

post

/get_notifications

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_notifications" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

sendNotification

Sends a notification.

Sends a notification.

post

/send_notification

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/send_notification" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

signMessageByAddress

Given a derived P2 address, sign the message by its private key.

Given a derived P2 address, sign the message by its private key.

post

/sign_message_by_address

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/sign_message_by_address" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

signMessageById

Given a NFT/DID ID, sign the message by the P2 private key.

Given a NFT/DID ID, sign the message by the P2 private key.

post

/sign_message_by_id

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/sign_message_by_id" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

PoolWallet

pwAbsorbRewards

Perform a sweep of the p2_singleton rewards controlled by the pool wallet singleton.

Perform a sweep of the p2_singleton rewards controlled by the pool wallet singleton.

post

/pw_absorb_rewards

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/pw_absorb_rewards" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

pwJoinPool

Joins the given wallet to a pool.

Joins the given wallet to a pool.

post

/pw_join_pool

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/pw_join_pool" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

pwSelfPool

Removes the given wallet to a pool.

Removes the given wallet to a pool.

post

/pw_self_pool

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/pw_self_pool" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

pwStatus

Return the complete state of the given Pool wallet.

Return the complete state of the given Pool wallet.

post

/pw_status

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/pw_status" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Shared

closeConnection

Removes a connection.

Removes a connection.

post

/close_connection

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

getConnections

Retrieve the list of connections.

Retrieve the list of connections.

post

/get_connections

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

healthz

Heartbeat.

Heartbeat.

post

/healthz

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

openConnection

Add a connection to another node.

Add a connection to another node.

post

/open_connection

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

stopNode

Stop the node.

Stop the node.

post

/stop_node

Usage

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

VerifiedCredential

vcAddProofs

Add a set of proofs to the DB that can be used when spending a VC. VCs are near useless until their proofs have been added.

Add a set of proofs to the DB that can be used when spending a VC

post

/vc_add_proofs

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/vc_add_proofs" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

vcGet

Given a launcher ID get the verified credential.

Given a launcher ID get the verified credential

post

/vc_get

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/vc_get" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

vcGetList

Get a list of verified credentials in the specified range and any 'proofs' associated with the roots contained within.

Get a list of verified credentials

post

/vc_get_list

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/vc_get_list" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

vcGetProofsForRoot

Given a specified vc root, get any proofs associated with that root.

Given a specified vc root, get any proofs associated with that root

post

/vc_get_proofs_for_root

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/vc_get_proofs_for_root" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

vcMint

Mint a verified credential using the assigned DID.

Mint a verified credential using the assigned DID

post

/vc_mint

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/vc_mint" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

vcRevoke

Revoke an on chain VC provided the correct DID is available.

Revoke an on chain VC provided the correct DID is available

post

/vc_revoke

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/vc_revoke" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

vcSpend

Spend a verified credential.

Spend a verified credential

post

/vc_spend

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/vc_spend" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

Wallet

createSignedTransaction

Creates and signs a transaction.

Creates and signs a transaction.

post

/create_signed_transaction

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/create_signed_transaction" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

deleteUnconfirmedTransactions

Delete all unconfirmed transactions for a given wallet.

Delete all unconfirmed transactions for a given wallet.

post

/delete_unconfirmed_transactions

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/delete_unconfirmed_transactions" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response without return values

extendDerivationIndex

Extends the current derivation index.

Extends the current derivation index.

post

/extend_derivation_index

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/extend_derivation_index" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getAutoClaim

Get auto claim merkle coins config

Get auto claim merkle coins config

post

/get_auto_claim

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_auto_claim" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getCurrentDerivationIndex

Gets the current derivation index.

Gets the current derivation index.

post

/get_current_derivation_index

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_current_derivation_index" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getFarmedAmount

Retrieves the amount farmed.

Retrieves the amount farmed.

post

/get_farmed_amount

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_farmed_amount" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getNextAddress

Returns a new address.

Returns a new address.

post

/get_next_address

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_next_address" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getSpendableCoins

Retrieves all spendable coins in a wallet.

Retrieves all spendable coins in a wallet.

post

/get_spendable_coins

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_spendable_coins" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getTransaction

Retrieves a specific transaction.

Retrieves a specific transaction.

post

/get_transaction

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_transaction" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response with a transaction record and a transaction id.

getTransactionCount

Retrieves the number of transactions for a wallet.

Retrieves the number of transactions for a wallet.

post

/get_transaction_count

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_transaction_count" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getTransactionMemo

Retrieves the memo from a transaction.

Retrieves the memo from a transaction

post

/get_transaction_memo

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_transaction_memo" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getTransactions

Retrieves a list of transactions from a wallet.

Retrieves a list of transactions from a wallet.

post

/get_transactions

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_transactions" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getWalletBalance

Retrieves the balance of a specific wallet.

Retrieves the balance of a specific wallet (in units of mojos).

post

/get_wallet_balance

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_wallet_balance" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getWalletBalances

Retrieves the balance of a specific list of wallets.

Retrieves the balance of a specific list of wallets (in units of mojos).

post

/get_wallet_balances

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_wallet_balances" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

sendTransaction

Sends an amount of mojo from the given wallet to the given address.

Sends an amount of mojo from the given wallet to the given address.

post

/send_transaction

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/send_transaction" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response with a transaction record and a transaction id.

sendTransactionMulti

Sends multiple transactions from then given wallet.

Sends multiple transactions from then given wallet.

post

/send_transaction_multi

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/send_transaction_multi" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK response with a transaction record and a transaction id.

setAutoClaim

Set auto claim merkle coins config

Set auto claim merkle coins config

post

/set_auto_claim

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/set_auto_claim" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

spendClawbackCoins

Spend clawback coins that were sent (to claw them back) or received (to claim them).

Spend clawback coins that were sent or received

post

/spend_clawback_coins

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/spend_clawback_coins" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

WalletManagement

createNewWallet

Creates a new wallet.

Creates a new wallet.

post

/create_new_wallet

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/create_new_wallet" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

getWallets

Retrieves all of the wallets on the node.

Retrieves all of the wallets on the node.

post

/get_wallets

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_wallets" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK

WalletNode

getHeightInfo

Retrieves the sync height of the wallet.

Retrieves the sync height of the wallet.

post

/get_height_info

Usage

curl -X POST --insecure \
--cert ~/.chia/mainnet/config/ssl/wallet/private_wallet.crt \
--key ~/.chia/mainnet/config/ssl/wallet/private_wallet.key  \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"https://localhost:9256/get_height_info" \
-d "{}"

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK