diff --git a/docs/redoc/crawler.html b/docs/redoc/crawler.html index d175abf..116b9ce 100644 --- a/docs/redoc/crawler.html +++ b/docs/redoc/crawler.html @@ -12,372 +12,359 @@ margin: 0; } - -
API docs by Redocly
API docs by Redocly

Chia RPC (2.0.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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. + " fill="currentColor">

Chia RPC (2.1.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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.

-
Find out more about chia

Shared

Methods shared by all services.

-

Stop the node.

Stop the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the address of the connection

-
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the node id of the connection

-
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Crawler

The crawler RPC API is exposed, by default, on port 8561 and contains peer metrics.

-

Retrieves aggregate information about peers.

Retrieves aggregate information about peers.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "peer_counts": {
    },
  • "success": true,
  • "error": "string"
}

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

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

Search criteria

-
after
required
integer <timestamp>

The unix timestamp to search for peer connections after

-
offset
integer
Default: 0

An offset into the returned items

-
limit
integer
Default: 10000

The maximum number of result to return

-

Responses

Request samples

Content type
application/json
{
  • "after": 0,
  • "offset": 0,
  • "limit": 10000
}

Response samples

Content type
application/json
{
  • "ips": [
    ],
  • "total": 0,
  • "success": true,
  • "error": "string"
}
+
Find out more about chia

Shared

Methods shared by all services.

+

Stop the node.

Stop the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the address of the connection

+
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the node id of the connection

+
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Crawler

The crawler RPC API is exposed, by default, on port 8561 and contains peer metrics.

+

Retrieves aggregate information about peers.

Retrieves aggregate information about peers.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "peer_counts": {
    },
  • "success": true,
  • "error": "string"
}

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

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Search criteria

+
after
required
integer <timestamp>

The unix timestamp to search for peer connections after

+
offset
integer
Default: 0

An offset into the returned items

+
limit
integer
Default: 10000

The maximum number of result to return

+

Responses

Request samples

Content type
application/json
{
  • "after": 0,
  • "offset": 0,
  • "limit": 10000
}

Response samples

Content type
application/json
{
  • "ips": [
    ],
  • "total": 0,
  • "success": true,
  • "error": "string"
}
-
API docs by Redocly
API docs by Redocly

Chia RPC (2.0.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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. + " fill="currentColor">

Chia RPC (2.1.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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 daemon uses port 55400 by default.

-
Find out more about chia

Daemon

The daemon interface is exposed on port 55400 by default and uses WebSockets only. It can be used to interact with other service endpoints.

-

Registers this daemon to receive messages.

Registers this daemon to receive messages. This is needed to receive responses from services other than the daemon.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the name of a service

-
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "queue": [
    ],
  • "success": true,
  • "error": "string"
}

Starts the named service.

Starts the named service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the name of a service

-
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Stops the named service.

Stops the named service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the name of a service

-
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Ping the daemon.

Ping the daemon.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Tells the daemon at the RPC endpoint to exit.

Tells the daemon at the RPC endpoint to exit. There isn't a way to start the daemon remotely via RPC, so take care that you have access to the RPC host if needed.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Determines if the named service is running.

Determines if the named service is running.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the name of a service

-
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "is_running": true,
  • "success": true,
  • "error": "string"
}

Get the installed version of chia at the endpoint.

Get the installed version of chia at the endpoint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "version": "string",
  • "success": true,
  • "error": "string"
}

Indicator if the genesis block is initialized.

Indicator if the genesis block is initialized.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "genesis_initialized": true,
  • "success": true,
  • "error": "string"
}

Returns the list of running services.

Returns the list of running services.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "running_services": [
    ],
  • "success": true,
  • "error": "string"
}

Returns the list of addresses.

Returns the list of addresses.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Input parameters

-
fingerprints
Array of integers <uint32> [ items <uint32 > ]
index
integer <uint32>
count
integer <uint32>
non_observer_derivation
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "fingerprints": [
    ],
  • "index": 0,
  • "count": 0,
  • "non_observer_derivation": false
}

Response samples

Content type
application/json
{
  • "wallet_addresses": {
    },
  • "success": true,
  • "error": "string"
}

Key Ring

Methods for managing keys and the keyring.

-

Returns whether the keyring is in a locked state.

Returns whether the keyring is in a locked state. If the keyring doesn't have a master passphrase set, or if a master passphrase is set and the cached passphrase is valid, the keyring is "unlocked".

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "is_keyring_locked": true,
  • "success": true,
  • "error": "string"
}

Get detailed status of the key ring.

Get detailed status of the key ring.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "is_keyring_locked": true,
  • "passphrase_support_enabled": true,
  • "can_save_passphrase": true,
  • "user_passphrase_is_set": true,
  • "needs_migration": true,
  • "can_remove_legacy_keys": true,
  • "can_set_passphrase_hint": true,
  • "passphrase_hint": "string",
  • "passphrase_requirements": {
    },
  • "success": true,
  • "error": "string"
}

Unlock the keyring.

Unlock the keyring.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Key ring key

-
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Test the validity of a passphrase.

Test the validity of a passphrase.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The passphrase

-
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Update the key ring passphrase.

Update the key ring passphrase.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The passphrase options

-
current_passphrase
string
new_passphrase
required
string
passphrase_hint
string
save_passphrase
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "current_passphrase": "string",
  • "new_passphrase": "string",
  • "passphrase_hint": "string",
  • "save_passphrase": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Remove the key ring passphrase.

Remove the key ring passphrase.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The passphrase

-
current_passphrase
required
string

Responses

Request samples

Content type
application/json
{
  • "current_passphrase": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Adds a private key to the keychain.

Adds a private key to the keychain, with the given entropy and passphrase. The keychain itself will store the public key, and the entropy bytes, but not the passphrase.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The private key

-
mnemonic
required
string
passphrase
required
string

Responses

Request samples

Content type
application/json
{
  • "mnemonic": "string",
  • "passphrase": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "error_details": {
    },
  • "fingerprint": 0
}

Check the keys.

Check the keys.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The config root path

-
root_path
required
string

Responses

Request samples

Content type
application/json
{
  • "root_path": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "error_details": {
    }
}

Deletes all keys from the keychain.

Deletes all keys from the keychain.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Deletes all keys which have the given public key fingerprint.

Deletes all keys which have the given public key fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The fingerprint

-
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "error_details": {
    }
}

Returns all private keys which can be retrieved, with the given passphrases.

Returns all private keys which can be retrieved, with the given passphrases. A tuple of key, and entropy bytes (i.e. mnemonic) is returned for each key.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "private_keys": [
    ],
  • "success": true,
  • "error": "string"
}

Returns the first key in the keychain.

Returns the first key in the keychain.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "pk": "string",
  • "entropy": "string",
  • "success": true,
  • "error": "string"
}

Locates and returns a private key matching the provided fingerprint.

Locates and returns a private key matching the provided fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The fingerprint

-
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "pk": "string",
  • "entropy": "string",
  • "success": true,
  • "error": "string"
}

Locates and returns KeyData matching the provided fingerprint.

Locates and returns KeyData matching the provided fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The fingerprint

-
fingerprint
required
integer <uint32>
include_secrets
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0,
  • "include_secrets": false
}

Response samples

Content type
application/json
{
  • "fingerprint": 2473794447,
  • "public_key": "0665913196501420c0fe2de6b5ce7b25f749d52dcbf997b069bb2ea8438c6c3c",
  • "label": "string",
  • "secrets": {
    },
  • "success": true,
  • "error": "string"
}

Returns the KeyData of all keys which can be retrieved.

Returns the KeyData of all keys which can be retrieved.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The fingerprint

-
fingerprint
required
integer <uint32>
include_secrets
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0,
  • "include_secrets": false
}

Response samples

Content type
application/json
{
  • "keys": [
    ],
  • "success": true,
  • "error": "string"
}

Assigns the given label to the first key with the given fingerprint.

Assigns the given label to the first key with the given fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The fingerprint

-
fingerprint
required
integer <uint32>
label
required
string

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0,
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes the label assigned to the key with the given fingerprint.

Removes the label assigned to the key with the given fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The fingerprint

-
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Plotter

Methods for creating plots and managing plotters.

-

Get info about installed and installable plotters.

Get info about installed and installable plotters.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "plotters": {
    },
  • "success": true,
  • "error": "string"
}

Starts plotting.

Starts plotting. Returns after request is added to the plotting queue. Does not wait for plotting to finish.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Options for creating the plots

-
delay
integer <int32>

The number of seconds to delay before beginning the plotting.

-
parallel
boolean
Default: false
n
integer <int32>
Default: 1

The number of plots that will be made, in sequence.

-
k
integer (k_size)
Default: 32
Enum: 25 32 33 34 35

Defines the size of a plot. 25 is used for testing only. https://github.com/Chia-Network/chia-blockchain/wiki/k-sizes

-
queue
string
Default: "default"
t
string

Define the temporary directory for plot creation. This is where Plotting Phase 1 (Forward Propagation) and Phase 2 (Backpropagation) both occur. The -t dir requires the largest working space: normally about 2.5 times the size of the final plot.

-
t2
string

Define a secondary temporary directory for plot creation. This is where Plotting Phase 3 (Compression) and Phase 4 (Checkpoints) occur.

-
d
string

Define the final location for plot(s). Of course, -d should have enough free space as the final size of the plot. This directory is automatically added to your ~/.chia/VERSION/config/config.yaml file.

-
b
integer <int32>
Default: 4608

Define memory/RAM usage. Default is 4608 (4.6 GiB). More RAM will marginally increase speed of plot creation. Please bear in mind that this is what is allocated to the plotting algorithm alone. Code, container, libraries etc. will require additional RAM from your system.

-
u
integer <int32>
Default: 128

More buckets require less RAM but more random seeks to disk. With spinning disks you want less buckets and with NVMe more buckets. There is no significant benefit from using smaller buckets - just use 128

-
a
integer or null <uint32>

This is the key Fingerprint used to select both the Farmer and Pool Public Keys to use. Utilize this when you want to select one key out of several in your keychain.

-
c
string

The pool contract address.

-
p
string

This is your "Pool Public Key". Utilise this when you want to create plots on other machines for which you do not want to give full chia account access.

-
f
string

This is your "Farmer Public Key". Utilise this when you want to create plots on other machines for which you do not want to give full chia account access

-
memo
string
e
boolean
Default: false

Setting to true will disable the bitfield plotting algorithm, and revert back to the older b17 plotting style. After 1.0.4 it's better to use bitfield for most cases

-
r
integer <int32>
Default: 2

The number of threads to devote to each plot.

-
x
boolean
Default: false

Skips adding [final dir] to harvester for farming.

-
overrideK
boolean or null
Default: false

Only needed when k is set to 25

-
w
boolean or null
Default: false

BladeBit Only - warm start

-
m
boolean or null
Default: false

BladeBit Only - disable NUMA

-
K
boolean or null
Default: false

MadMax Only - note upper case - Thread multiplier for phase 2

-
G
boolean or null
Default: false

MadMax Only - note upper case - Alternate tmpdir/tmp2dir

-

Responses

Request samples

Content type
application/json
{
  • "delay": 0,
  • "parallel": false,
  • "n": 1,
  • "k": 25,
  • "queue": "default",
  • "t": "string",
  • "t2": "string",
  • "d": "string",
  • "b": 4608,
  • "u": 128,
  • "a": 0,
  • "c": "string",
  • "p": "string",
  • "f": "string",
  • "memo": "string",
  • "e": false,
  • "r": 2,
  • "x": false,
  • "overrideK": false,
  • "w": false,
  • "m": false,
  • "K": false,
  • "G": false
}

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "success": true,
  • "error": "string"
}

Stops the plot with the given id.

Stops the plot with the given id.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The id of the plot to stop

-
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Returns a list of keys.

Returns the list of keys used for plotting.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Input parameters

-
fingerprints
Array of integers <uint32> [ items <uint32 > ]

Responses

Request samples

Content type
application/json
{
  • "fingerprints": [
    ]
}

Response samples

Content type
application/json
{
  • "keys": {
    },
  • "success": true,
  • "error": "string"
}
+
Find out more about chia

Daemon

The daemon interface is exposed on port 55400 by default and uses WebSockets only. It can be used to interact with other service endpoints.

+

Registers this daemon to receive messages.

Registers this daemon to receive messages. This is needed to receive responses from services other than the daemon.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the name of a service

+
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "queue": [
    ],
  • "success": true,
  • "error": "string"
}

Starts the named service.

Starts the named service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the name of a service

+
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Stops the named service.

Stops the named service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the name of a service

+
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Ping the daemon.

Ping the daemon.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Tells the daemon at the RPC endpoint to exit.

Tells the daemon at the RPC endpoint to exit. There isn't a way to start the daemon remotely via RPC, so take care that you have access to the RPC host if needed.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Determines if the named service is running.

Determines if the named service is running.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the name of a service

+
service
required
string

Responses

Request samples

Content type
application/json
{
  • "service": "string"
}

Response samples

Content type
application/json
{
  • "is_running": true,
  • "success": true,
  • "error": "string"
}

Get the installed version of chia at the endpoint.

Get the installed version of chia at the endpoint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "version": "string",
  • "success": true,
  • "error": "string"
}

Indicator if the genesis block is initialized.

Indicator if the genesis block is initialized.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "genesis_initialized": true,
  • "success": true,
  • "error": "string"
}

Returns the list of running services.

Returns the list of running services.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "running_services": [
    ],
  • "success": true,
  • "error": "string"
}

Returns the list of addresses.

Returns the list of addresses.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Input parameters

+
fingerprints
Array of integers <uint32> [ items <uint32 > ]
index
integer <uint32>
count
integer <uint32>
non_observer_derivation
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "fingerprints": [
    ],
  • "index": 0,
  • "count": 0,
  • "non_observer_derivation": false
}

Response samples

Content type
application/json
{
  • "wallet_addresses": {
    },
  • "success": true,
  • "error": "string"
}

Key Ring

Methods for managing keys and the keyring.

+

Returns whether the keyring is in a locked state.

Returns whether the keyring is in a locked state. If the keyring doesn't have a master passphrase set, or if a master passphrase is set and the cached passphrase is valid, the keyring is "unlocked".

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "is_keyring_locked": true,
  • "success": true,
  • "error": "string"
}

Get detailed status of the key ring.

Get detailed status of the key ring.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "is_keyring_locked": true,
  • "passphrase_support_enabled": true,
  • "can_save_passphrase": true,
  • "user_passphrase_is_set": true,
  • "needs_migration": true,
  • "can_remove_legacy_keys": true,
  • "can_set_passphrase_hint": true,
  • "passphrase_hint": "string",
  • "passphrase_requirements": {
    },
  • "success": true,
  • "error": "string"
}

Unlock the keyring.

Unlock the keyring.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Key ring key

+
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Test the validity of a passphrase.

Test the validity of a passphrase.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The passphrase

+
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Update the key ring passphrase.

Update the key ring passphrase.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The passphrase options

+
current_passphrase
string
new_passphrase
required
string
passphrase_hint
string
save_passphrase
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "current_passphrase": "string",
  • "new_passphrase": "string",
  • "passphrase_hint": "string",
  • "save_passphrase": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Remove the key ring passphrase.

Remove the key ring passphrase.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The passphrase

+
current_passphrase
required
string

Responses

Request samples

Content type
application/json
{
  • "current_passphrase": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Adds a private key to the keychain.

Adds a private key to the keychain, with the given entropy and passphrase. The keychain itself will store the public key, and the entropy bytes, but not the passphrase.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The private key

+
mnemonic
required
string
passphrase
required
string

Responses

Request samples

Content type
application/json
{
  • "mnemonic": "string",
  • "passphrase": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "error_details": {
    },
  • "fingerprint": 0
}

Check the keys.

Check the keys.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The config root path

+
root_path
required
string

Responses

Request samples

Content type
application/json
{
  • "root_path": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "error_details": {
    }
}

Deletes all keys from the keychain.

Deletes all keys from the keychain.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Deletes all keys which have the given public key fingerprint.

Deletes all keys which have the given public key fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The fingerprint

+
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "error_details": {
    }
}

Returns all private keys which can be retrieved, with the given passphrases.

Returns all private keys which can be retrieved, with the given passphrases. A tuple of key, and entropy bytes (i.e. mnemonic) is returned for each key.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "private_keys": [
    ],
  • "success": true,
  • "error": "string"
}

Returns the first key in the keychain.

Returns the first key in the keychain.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "pk": "string",
  • "entropy": "string",
  • "success": true,
  • "error": "string"
}

Locates and returns a private key matching the provided fingerprint.

Locates and returns a private key matching the provided fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The fingerprint

+
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "pk": "string",
  • "entropy": "string",
  • "success": true,
  • "error": "string"
}

Locates and returns KeyData matching the provided fingerprint.

Locates and returns KeyData matching the provided fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The fingerprint

+
fingerprint
required
integer <uint32>
include_secrets
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0,
  • "include_secrets": false
}

Response samples

Content type
application/json
{
  • "fingerprint": 2473794447,
  • "public_key": "0665913196501420c0fe2de6b5ce7b25f749d52dcbf997b069bb2ea8438c6c3c",
  • "label": "string",
  • "secrets": {
    },
  • "success": true,
  • "error": "string"
}

Returns the KeyData of all keys which can be retrieved.

Returns the KeyData of all keys which can be retrieved.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The fingerprint

+
fingerprint
required
integer <uint32>
include_secrets
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0,
  • "include_secrets": false
}

Response samples

Content type
application/json
{
  • "keys": [
    ],
  • "success": true,
  • "error": "string"
}

Assigns the given label to the first key with the given fingerprint.

Assigns the given label to the first key with the given fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The fingerprint

+
fingerprint
required
integer <uint32>
label
required
string

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0,
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes the label assigned to the key with the given fingerprint.

Removes the label assigned to the key with the given fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The fingerprint

+
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Plotter

Methods for creating plots and managing plotters.

+

Get info about installed and installable plotters.

Get info about installed and installable plotters.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "plotters": {
    },
  • "success": true,
  • "error": "string"
}

Starts plotting.

Starts plotting. Returns after request is added to the plotting queue. Does not wait for plotting to finish.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Options for creating the plots

+
delay
integer <int32>

The number of seconds to delay before beginning the plotting.

+
parallel
boolean
Default: false
n
integer <int32>
Default: 1

The number of plots that will be made, in sequence.

+
k
integer (k_size)
Default: 32
Enum: 25 32 33 34 35

Defines the size of a plot. 25 is used for testing only. https://github.com/Chia-Network/chia-blockchain/wiki/k-sizes

+
queue
string
Default: "default"
t
string

Define the temporary directory for plot creation. This is where Plotting Phase 1 (Forward Propagation) and Phase 2 (Backpropagation) both occur. The -t dir requires the largest working space: normally about 2.5 times the size of the final plot.

+
t2
string

Define a secondary temporary directory for plot creation. This is where Plotting Phase 3 (Compression) and Phase 4 (Checkpoints) occur.

+
d
string

Define the final location for plot(s). Of course, -d should have enough free space as the final size of the plot. This directory is automatically added to your ~/.chia/VERSION/config/config.yaml file.

+
b
integer <int32>
Default: 4608

Define memory/RAM usage. Default is 4608 (4.6 GiB). More RAM will marginally increase speed of plot creation. Please bear in mind that this is what is allocated to the plotting algorithm alone. Code, container, libraries etc. will require additional RAM from your system.

+
u
integer <int32>
Default: 128

More buckets require less RAM but more random seeks to disk. With spinning disks you want less buckets and with NVMe more buckets. There is no significant benefit from using smaller buckets - just use 128

+
a
integer or null <uint32>

This is the key Fingerprint used to select both the Farmer and Pool Public Keys to use. Utilize this when you want to select one key out of several in your keychain.

+
c
string

The pool contract address.

+
p
string

This is your "Pool Public Key". Utilise this when you want to create plots on other machines for which you do not want to give full chia account access.

+
f
string

This is your "Farmer Public Key". Utilise this when you want to create plots on other machines for which you do not want to give full chia account access

+
memo
string
e
boolean
Default: false

Setting to true will disable the bitfield plotting algorithm, and revert back to the older b17 plotting style. After 1.0.4 it's better to use bitfield for most cases

+
r
integer <int32>
Default: 2

The number of threads to devote to each plot.

+
x
boolean
Default: false

Skips adding [final dir] to harvester for farming.

+
overrideK
boolean or null
Default: false

Only needed when k is set to 25

+
w
boolean or null
Default: false

BladeBit Only - warm start

+
m
boolean or null
Default: false

BladeBit Only - disable NUMA

+
K
boolean or null
Default: false

MadMax Only - note upper case - Thread multiplier for phase 2

+
G
boolean or null
Default: false

MadMax Only - note upper case - Alternate tmpdir/tmp2dir

+

Responses

Request samples

Content type
application/json
{
  • "delay": 0,
  • "parallel": false,
  • "n": 1,
  • "k": 25,
  • "queue": "default",
  • "t": "string",
  • "t2": "string",
  • "d": "string",
  • "b": 4608,
  • "u": 128,
  • "a": 0,
  • "c": "string",
  • "p": "string",
  • "f": "string",
  • "memo": "string",
  • "e": false,
  • "r": 2,
  • "x": false,
  • "overrideK": false,
  • "w": false,
  • "m": false,
  • "K": false,
  • "G": false
}

Response samples

Content type
application/json
{
  • "ids": [
    ],
  • "success": true,
  • "error": "string"
}

Stops the plot with the given id.

Stops the plot with the given id.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The id of the plot to stop

+
id
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Returns a list of keys.

Returns the list of keys used for plotting.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Input parameters

+
fingerprints
Array of integers <uint32> [ items <uint32 > ]

Responses

Request samples

Content type
application/json
{
  • "fingerprints": [
    ]
}

Response samples

Content type
application/json
{
  • "keys": {
    },
  • "success": true,
  • "error": "string"
}
-
API docs by Redocly
API docs by Redocly

Chia RPC (2.0.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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. + " fill="currentColor">

Chia RPC (2.1.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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 data layer uses port 8562 by default.

-
Find out more about chia

Shared

Methods shared by all services.

-

Stop the node.

Stop the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the address of the connection

-
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the node id of the connection

-
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Data Layer

The data layer RPC API is exposed, by default, on port 8561 and contains methods interacting with =off-chain data.

-

Creates a data store.

Creates a data store.

-
Authorizations:
bearerAuth
Request Body schema: application/json
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "txs": [
    ],
  • "id": "string",
  • "success": true,
  • "error": "string"
}

Gets the list of owned store ids.

Gets the list of owned store ids.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "store_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Applies a batch of updates.

Applies a batch of updates.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>
Array of objects
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "changelist": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_id": "string",
  • "success": true,
  • "error": "string"
}

Get the value for a given id/key pair.

Get the value for a given id/key pair.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>
key
required
string <bytes32>
root_hash
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "root_hash": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "success": true,
  • "error": "string"
}

Get the keys for a given id/root_hash pair.

Get the keys for a given id/root_hash pair.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>
root_hash
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "root_hash": "string"
}

Response samples

Content type
application/json
{
  • "keys": [
    ],
  • "success": true,
  • "error": "string"
}

Get the keys and values for a given id/root_hash pair.

Get the keys and values for a given id/root_hash pair.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>
root_hash
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "root_hash": "string"
}

Response samples

Content type
application/json
{
  • "keys_values": [
    ],
  • "success": true,
  • "error": "string"
}

Gets the list of ancestors for a given id/hash pair.

Gets the list of ancestors for a given id/hash pair.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>
hash
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "hash": "string"
}

Response samples

Content type
application/json
{
  • "ancestors": [
    ],
  • "success": true,
  • "error": "string"
}

Gets the sync status of a store.

Gets the sync status of a store.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "sync_status": {
    },
  • "success": true,
  • "error": "string"
}

Gets hash of latest tree root.

Gets hash of latest tree root.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "hash": "string",
  • "confirmed": true,
  • "timestamp": 0,
  • "success": true,
  • "error": "string"
}

Gets hash of latest tree root saved in our local datastore.

Gets hash of latest tree root saved in our local datastore.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "hash": "string",
  • "success": true,
  • "error": "string"
}

Gets state hashes for a list of roots

Gets state hashes for a list of roots.

-
Authorizations:
bearerAuth
Request Body schema: application/json
ids
required
Array of strings <bytes32>

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "root_hashes": [
    ],
  • "success": true,
  • "error": "string"
}

Removes a list of rows.

Removes a list of rows.

-
Authorizations:
bearerAuth
Request Body schema: application/json
key
required
string <bytes32>
id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_id": "string",
  • "success": true,
  • "error": "string"
}

Adds a list of clvm objects as bytes to add to table.

Adds a list of clvm objects as bytes to add to table.

-
Authorizations:
bearerAuth
Request Body schema: application/json
value
required
string <bytes32>
id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_id": "string",
  • "success": true,
  • "error": "string"
}

Get kv diff between two root hashes.

Get kv diff between two root hashes.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>
hash_1
required
string <bytes32>
hash_2
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "hash_1": "string",
  • "hash_2": "string"
}

Response samples

Content type
application/json
{
  • "diff": [
    ],
  • "success": true,
  • "error": "string"
}

Get history of state hashes for a store.

Get history of state hashes for a store.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "root_history": [
    ],
  • "success": true,
  • "error": "string"
}

Complete the data server files.

Complete the data server files.

-
Authorizations:
bearerAuth
Request Body schema: application/json
ids
required
Array of strings <bytes32>
overwrite
boolean
Default: false
foldername
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "overwrite": false,
  • "foldername": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Mirrors

Methods for managing mirrors.

-

Adds a mirror.

Adds a mirror.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>
amount
required
integer <uint64>
urls
required
Array of strings <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "urls": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Deletes a mirror.

Deletes a mirror.

-
Authorizations:
bearerAuth
Request Body schema: application/json
coin_id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Gets the mirrors for a given store id.

Gets the mirrors for a given store id.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "mirrors": [],
  • "success": true,
  • "error": "string"
}

Subscriptions

Methods related to singleton subscriptions.

-

Subscribe to singleton.

Subscribe to singleton.

-
Authorizations:
bearerAuth
Request Body schema: application/json
urls
Array of strings <bytes32>
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "urls": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Unsubscribe from singleton.

Unsubscribe from singleton.

-
Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes subscriptions for the given id.

Removes subscriptions for the given id.

-
Authorizations:
bearerAuth
Request Body schema: application/json
urls
Array of strings <bytes32>
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "urls": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

List current subscriptions.

List current subscriptions.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "store_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Checks the status of plugins.

Checks the status of plugins.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "uploaders": {
    },
  • "downloaders": {
    },
  • "success": true,
  • "error": "string"
}

Clears pending roots.

Clears pending roots.

-
Authorizations:
bearerAuth
Request Body schema: application/json
store_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "store_id": "string"
}

Response samples

Content type
application/json
{
  • "tree_id": "string",
  • "node_hash": "string",
  • "generation": 0,
  • "status": 1,
  • "success": true,
  • "error": "string"
}

Offers

Methods related to offers.

-

Makes an offer.

Makes an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects (offer_store)
required
Array of objects (offer_store)
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "maker": [
    ],
  • "taker": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "offer": {
    },
  • "success": true,
  • "error": "string"
}

Takes an offer.

Takes an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
object (offer)
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "trade_id": "string",
  • "success": true,
  • "error": "string"
}

Verifies an offer.

Verifies an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
object (offer)
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "fee": 0,
  • "success": true,
  • "error": "string"
}

Cancels an offer.

Cancels an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
object
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}
+
Find out more about chia

Shared

Methods shared by all services.

+

Stop the node.

Stop the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the address of the connection

+
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the node id of the connection

+
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Data Layer

The data layer RPC API is exposed, by default, on port 8561 and contains methods interacting with =off-chain data.

+

Creates a data store.

Creates a data store.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "txs": [
    ],
  • "id": "string",
  • "success": true,
  • "error": "string"
}

Gets the list of owned store ids.

Gets the list of owned store ids.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "store_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Applies a batch of updates.

Applies a batch of updates.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
Array of objects
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "changelist": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_id": "string",
  • "success": true,
  • "error": "string"
}

Get the value for a given id/key pair.

Get the value for a given id/key pair.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
key
required
string <bytes32>
root_hash
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "root_hash": "string"
}

Response samples

Content type
application/json
{
  • "value": "string",
  • "success": true,
  • "error": "string"
}

Get the keys for a given id/root_hash pair.

Get the keys for a given id/root_hash pair.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
root_hash
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "root_hash": "string"
}

Response samples

Content type
application/json
{
  • "keys": [
    ],
  • "success": true,
  • "error": "string"
}

Get the keys and values for a given id/root_hash pair.

Get the keys and values for a given id/root_hash pair.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
root_hash
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "root_hash": "string"
}

Response samples

Content type
application/json
{
  • "keys_values": [
    ],
  • "success": true,
  • "error": "string"
}

Gets the list of ancestors for a given id/hash pair.

Gets the list of ancestors for a given id/hash pair.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
hash
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "hash": "string"
}

Response samples

Content type
application/json
{
  • "ancestors": [
    ],
  • "success": true,
  • "error": "string"
}

Gets the sync status of a store.

Gets the sync status of a store.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "sync_status": {
    },
  • "success": true,
  • "error": "string"
}

Gets hash of latest tree root.

Gets hash of latest tree root.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "hash": "string",
  • "confirmed": true,
  • "timestamp": 0,
  • "success": true,
  • "error": "string"
}

Gets hash of latest tree root saved in our local datastore.

Gets hash of latest tree root saved in our local datastore.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "hash": "string",
  • "success": true,
  • "error": "string"
}

Gets state hashes for a list of roots

Gets state hashes for a list of roots.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
ids
required
Array of strings <bytes32>

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "root_hashes": [
    ],
  • "success": true,
  • "error": "string"
}

Removes a list of rows.

Removes a list of rows.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
key
required
string <bytes32>
id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_id": "string",
  • "success": true,
  • "error": "string"
}

Adds a list of clvm objects as bytes to add to table.

Adds a list of clvm objects as bytes to add to table.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
value
required
string <bytes32>
id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_id": "string",
  • "success": true,
  • "error": "string"
}

Get kv diff between two root hashes.

Get kv diff between two root hashes.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
hash_1
required
string <bytes32>
hash_2
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "hash_1": "string",
  • "hash_2": "string"
}

Response samples

Content type
application/json
{
  • "diff": [
    ],
  • "success": true,
  • "error": "string"
}

Get history of state hashes for a store.

Get history of state hashes for a store.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "root_history": [
    ],
  • "success": true,
  • "error": "string"
}

Complete the data server files.

Complete the data server files.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
ids
required
Array of strings <bytes32>
overwrite
boolean
Default: false
foldername
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "overwrite": false,
  • "foldername": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Logs into the wallet.

Logs into the wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Mirrors

Methods for managing mirrors.

+

Adds a mirror.

Adds a mirror.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
amount
required
integer <uint64>
urls
required
Array of strings <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "urls": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Deletes a mirror.

Deletes a mirror.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Gets the mirrors for a given store id.

Gets the mirrors for a given store id.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "mirrors": [],
  • "success": true,
  • "error": "string"
}

Subscriptions

Methods related to singleton subscriptions.

+

Subscribe to singleton.

Subscribe to singleton.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
urls
Array of strings <bytes32>
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "urls": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Unsubscribe from singleton.

Unsubscribe from singleton.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string <bytes32>
retain
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "retain": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes subscriptions for the given id.

Removes subscriptions for the given id.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
urls
Array of strings <bytes32>
id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "urls": [
    ],
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

List current subscriptions.

List current subscriptions.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "store_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Checks the status of plugins.

Checks the status of plugins.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "uploaders": {
    },
  • "downloaders": {
    },
  • "success": true,
  • "error": "string"
}

Clears pending roots.

Clears pending roots.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
store_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "store_id": "string"
}

Response samples

Content type
application/json
{
  • "tree_id": "string",
  • "node_hash": "string",
  • "generation": 0,
  • "status": 1,
  • "success": true,
  • "error": "string"
}

Offers

Methods related to offers.

+

Makes an offer.

Makes an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects (offer_store)
required
Array of objects (offer_store)
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "maker": [
    ],
  • "taker": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "offer": {
    },
  • "success": true,
  • "error": "string"
}

Takes an offer.

Takes an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (offer)
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "trade_id": "string",
  • "success": true,
  • "error": "string"
}

Verifies an offer.

Verifies an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (offer)
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "fee": 0,
  • "success": true,
  • "error": "string"
}

Cancels an offer.

Cancels an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
object
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}
-
API docs by Redocly
API docs by Redocly

Chia RPC (2.0.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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. + " fill="currentColor">

Chia RPC (2.1.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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.

-
Find out more about chia

Shared

Methods shared by all services.

-

Stop the node.

Stop the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the address of the connection

-
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the node id of the connection

-
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Farmer

The farmer RPC API is exposed, by default, on port 8559 and contains methods for managing the farmer.

-

Set the farm and pool reward targets.

Set the farm and pool reward targets.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The updated targets

-
farmer_target
string
pool_target
string

Responses

Request samples

Content type
application/json
{
  • "farmer_target": "string",
  • "pool_target": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get the farm and pool reward targets.

Get the farm and pool reward targets.

-
Authorizations:
bearerAuth
Request Body schema: application/json

indicator of whether to include private keys in the search

-
search_for_private_key
required
boolean
max_ph_to_search
integer <int32>
Default: 500

Responses

Request samples

Content type
application/json
{
  • "search_for_private_key": true,
  • "max_ph_to_search": 500
}

Response samples

Content type
application/json
{
  • "farmer_target": "string",
  • "pool_target": "string",
  • "have_farmer_sk": true,
  • "have_pool_sk": true,
  • "success": true,
  • "error": "string"
}

Get the list of harvesters.

Get the list of harvesters.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "harvesters": [
    ],
  • "success": true,
  • "error": "string"
}

Get a summary of harvesters.

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "harvesters": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of valid plots.

Get a paginated list of valid plots.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Search filter parameters

-
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
Array of objects (filter_item)
sort_key
string
Default: "filename"
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "sort_key": "filename",
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of invalid plots.

Get a paginated list of invalid plots.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Search filter parameters

-
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
filter
Array of strings
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of plots with missing keys.

Get a paginated list of invalid plots with missing keys.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Search filter parameters

-
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
filter
Array of strings
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of duplicate plots.

Get a paginated list of duplicate plots.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Search filter parameters

-
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
filter
Array of strings
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get's the state of the pool.

Get's the state of the pool.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "pool_state": {
    },
  • "success": true,
  • "error": "string"
}

Set's a pool's payout instructions.

Set's a pool's payout instructions.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The id of the pool launcher and payout instructions

-
launcher_id
required
string
payout_instructions
required
string

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "payout_instructions": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get's a signage point by hash.

Get's a signage point by hash.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The signage point hash

-
sp_hash
required
string

Responses

Request samples

Content type
application/json
{
  • "sp_hash": "string"
}

Response samples

Content type
application/json
{
  • "signage_point": {
    },
  • "proofs": [
    ],
  • "success": true,
  • "error": "string"
}

Get signage points.

Get signage points.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "signage_points": [
    ],
  • "success": true,
  • "error": "string"
}
+
Find out more about chia

Shared

Methods shared by all services.

+

Stop the node.

Stop the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the address of the connection

+
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the node id of the connection

+
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Farmer

The farmer RPC API is exposed, by default, on port 8559 and contains methods for managing the farmer.

+

Set the farm and pool reward targets.

Set the farm and pool reward targets.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The updated targets

+
farmer_target
string
pool_target
string

Responses

Request samples

Content type
application/json
{
  • "farmer_target": "string",
  • "pool_target": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get the farm and pool reward targets.

Get the farm and pool reward targets.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

indicator of whether to include private keys in the search

+
search_for_private_key
required
boolean
max_ph_to_search
integer <int32>
Default: 500

Responses

Request samples

Content type
application/json
{
  • "search_for_private_key": true,
  • "max_ph_to_search": 500
}

Response samples

Content type
application/json
{
  • "farmer_target": "string",
  • "pool_target": "string",
  • "have_farmer_sk": true,
  • "have_pool_sk": true,
  • "success": true,
  • "error": "string"
}

Get the list of harvesters.

Get the list of harvesters.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "harvesters": [
    ],
  • "success": true,
  • "error": "string"
}

Get a summary of harvesters.

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "harvesters": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of valid plots.

Get a paginated list of valid plots.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Search filter parameters

+
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
Array of objects (filter_item)
sort_key
string
Default: "filename"
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "sort_key": "filename",
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of invalid plots.

Get a paginated list of invalid plots.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Search filter parameters

+
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
filter
Array of strings
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of plots with missing keys.

Get a paginated list of invalid plots with missing keys.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Search filter parameters

+
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
filter
Array of strings
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get a paginated list of duplicate plots.

Get a paginated list of duplicate plots.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Search filter parameters

+
node_id
string <hex>
page
integer <int32>
page_size
integer <int32>
filter
Array of strings
reverse
boolean

Responses

Request samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_size": 0,
  • "filter": [
    ],
  • "reverse": true
}

Response samples

Content type
application/json
{
  • "node_id": "string",
  • "page": 0,
  • "page_count": 0,
  • "total_count": 0,
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Get's the state of the pool.

Get's the state of the pool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "pool_state": {
    },
  • "success": true,
  • "error": "string"
}

Set's a pool's payout instructions.

Set's a pool's payout instructions.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The id of the pool launcher and payout instructions

+
launcher_id
required
string
payout_instructions
required
string

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "payout_instructions": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get's a signage point by hash.

Get's a signage point by hash.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The signage point hash

+
sp_hash
required
string

Responses

Request samples

Content type
application/json
{
  • "sp_hash": "string"
}

Response samples

Content type
application/json
{
  • "signage_point": {
    },
  • "proofs": [
    ],
  • "success": true,
  • "error": "string"
}

Get signage points.

Get signage points.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "signage_points": [
    ],
  • "success": true,
  • "error": "string"
}
-
API docs by Redocly
API docs by Redocly

Chia RPC (2.0.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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. + " fill="currentColor">

Chia RPC (2.1.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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 full node uses port 8555 by default.

-
Find out more about chia

Blocks

Methods for managing blocks.

-

Retrieves aggregate information about blocks.

Retrieves aggregate information about blocks.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "metrics": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves a block record by header hash.

Retrieves a block record by header hash.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the block's header_hash

-
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "block_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves block records in a range.

Retrieves block records in a range

-
Authorizations:
bearerAuth
Request Body schema: application/json

Start and end heights

-
start
required
integer <uint32>
end
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 0
}

Response samples

Content type
application/json
{
  • "block_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a block record by height.

Retrieves a block record by height (assuming the height <= peak height). Note that not all blocks will have all fields set here (depending on transaction block, finishing sub epoch, etc).

-
Authorizations:
bearerAuth
Request Body schema: application/json

the block height

-
height
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "height": 0
}

Response samples

Content type
application/json
{
  • "block_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves a block by header hash.

Retrieves a block by header hash.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the block's header_hash

-
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "block": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the spends in the given block.

Retrieves the spends in the given block.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the block's header_hash

-
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "block_spends": [
    ],
  • "success": true,
  • "error": "string"
}

Get the blocks between a start and end height.

Get the blocks between a start and end height

-
Authorizations:
bearerAuth
Request Body schema: application/json

Start and end heights

-
start
required
integer <uint32>
end
required
integer <uint32>
exclude_header_hash
boolean
Default: false
exclude_reorged
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 0,
  • "exclude_header_hash": false,
  • "exclude_reorged": false
}

Response samples

Content type
application/json
{
  • "blocks": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves unfinished block headers.

Retrieves unfinished block headers.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "headers": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the additions and removals for a certain block.

Retrieves the additions and removals (state transitions) for a certain block. Returns coin records for each addition and removal.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the block's header_hash

-
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "additions": [
    ],
  • "removals": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a recent signage point or end of slot.

Retrieves a recent signage point or end of slot.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The signage point hash or challenge hash. If both are present sp_hash takes precedence.

-
One of
sp_hash
string <hex>

Responses

Request samples

Content type
application/json
{
  • "challenge_hash": "string"
}

Response samples

Content type
application/json
{
  • "eos": {
    },
  • "time_received": 0,
  • "reverted": true,
  • "success": true,
  • "error": "string"
}

Coins

Methods for managing coins.

-

Retrieves the coins for a given puzzlehash.

Retrieves the coins for a given puzzlehash, by default returns unspent coins.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The puzzle hash.

-
puzzle_hash
required
string <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "puzzle_hash": "string",
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the coins for a given puzzlehashes

Retrieves the coins for a given puzzlehashes, by default returns unspent coins.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The puzzle hashes.

-
puzzle_hashes
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "puzzle_hashes": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves coins by hint.

Retrieves coins by hint, by default returns unspent coins.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The hint.

-
hint
required
string <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "hint": "string",
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a coin record by it's name.

Retrieves a coin record by it's name.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The coin name.

-
name
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "coin_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the coins for given coin IDs.

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

The coin names.

-
names
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "names": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the coins for given parent coin IDs.

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

The parent ids.

-
parent_ids
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "parent_ids": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a coin solution.

Retrieves a coin solution.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The coin id and height

-
coin_id
required
string <hex>
height
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "height": 0
}

Response samples

Content type
application/json
{
  • "coin_solution": {
    },
  • "success": true,
  • "error": "string"
}

Pushes a transaction/spend bundle to the mempool and blockchain.

Pushes a transaction/spend bundle to the mempool and blockchain. Returns whether the spend bundle was successfully included into the mempool.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The spend bundle

-
required
object (spend_bundle)

Responses

Request samples

Content type
application/json
{
  • "spend_bundle": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "success": true,
  • "error": "string"
}

Shared

Methods shared by all services.

-

Stop the node.

Stop the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the address of the connection

-
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the node id of the connection

-
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Full Node

The full node RPC API is exposed, by default, on port 8555. This port must not be exposed publicly for security concerns.

-

Retrieves a summary of the current state of the blockchain and full node.

Retrieves a summary of the current state of the blockchain and full node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "blockchain_state": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves some information about the current network.

Retrieves some information about the current network.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "network_name": "mainnet",
  • "network_prefix": "xch",
  • "success": true,
  • "error": "string"
}

Retrieves an estimate of total space.

Retrieves an estimate of total space validating the chain between two block header hashes.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The block header hashes

-
newer_block_header_hash
required
string <hex>
older_block_header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "newer_block_header_hash": "string",
  • "older_block_header_hash": "string"
}

Response samples

Content type
application/json
{
  • "space": 0,
  • "success": true,
  • "error": "string"
}

Mempool

Get information about the mempool.

-

Returns a list of all transaction IDs in the mempool.

Returns a list of all transaction IDs (spend bundle hashes) in the mempool.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "tx_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Returns all items in the mempool.

Returns all items in the mempool.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "mempool_items": {
    },
  • "success": true,
  • "error": "string"
}

Returns a specific item from the mempool.

Returns a specific item from the mempool.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The tx id.

-
tx_id
required
string <hex>
include_pending
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "tx_id": "string",
  • "include_pending": false
}

Response samples

Content type
application/json
{
  • "mempool_item": {
    },
  • "success": true,
  • "error": "string"
}

Fees

Get information about fees.

-

Estimates the fee for a given spend_bundle.

Estimates the fee for a given spend_bundle.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The spend bundle

-
object (spend_bundle)
cost
integer <uint64>
target_times
Array of integers
spend_type
integer <uint64>
spend_count
integer
Default: 1

Responses

Request samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "cost": 0,
  • "target_times": [
    ],
  • "spend_type": 0,
  • "spend_count": 1
}

Response samples

Content type
application/json
{
  • "estimates": [
    ],
  • "target_times": [
    ],
  • "current_fee_rate": 0,
  • "mempool_size": 0,
  • "mempool_fees": 0,
  • "mempool_max_size": 0,
  • "num_spends": 0,
  • "full_node_synced": true,
  • "peak_height": 0,
  • "last_peak_timestamp": 0,
  • "last_block_cost": 0,
  • "fees_last_block": 0,
  • "fee_rate_last_block": 0,
  • "last_tx_block_height": 0,
  • "node_time_utc": 0,
  • "success": true,
  • "error": "string"
}
+
Find out more about chia

Blocks

Methods for managing blocks.

+

Retrieves aggregate information about blocks.

Retrieves aggregate information about blocks.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "metrics": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves a block record by header hash.

Retrieves a block record by header hash.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the block's header_hash

+
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "block_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves block records in a range.

Retrieves block records in a range

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Start and end heights

+
start
required
integer <uint32>
end
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 0
}

Response samples

Content type
application/json
{
  • "block_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a block record by height.

Retrieves a block record by height (assuming the height <= peak height). Note that not all blocks will have all fields set here (depending on transaction block, finishing sub epoch, etc).

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the block height

+
height
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "height": 0
}

Response samples

Content type
application/json
{
  • "block_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves a block by header hash.

Retrieves a block by header hash.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the block's header_hash

+
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "block": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the spends in the given block.

Retrieves the spends in the given block.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the block's header_hash

+
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "block_spends": [
    ],
  • "success": true,
  • "error": "string"
}

Get the blocks between a start and end height.

Get the blocks between a start and end height

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Start and end heights

+
start
required
integer <uint32>
end
required
integer <uint32>
exclude_header_hash
boolean
Default: false
exclude_reorged
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 0,
  • "exclude_header_hash": false,
  • "exclude_reorged": false
}

Response samples

Content type
application/json
{
  • "blocks": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves unfinished block headers.

Retrieves unfinished block headers.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "headers": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the additions and removals for a certain block.

Retrieves the additions and removals (state transitions) for a certain block. Returns coin records for each addition and removal.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the block's header_hash

+
header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "header_hash": "string"
}

Response samples

Content type
application/json
{
  • "additions": [
    ],
  • "removals": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a recent signage point or end of slot.

Retrieves a recent signage point or end of slot.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The signage point hash or challenge hash. If both are present sp_hash takes precedence.

+
One of
sp_hash
string <hex>

Responses

Request samples

Content type
application/json
{
  • "challenge_hash": "string"
}

Response samples

Content type
application/json
{
  • "eos": {
    },
  • "time_received": 0,
  • "reverted": true,
  • "success": true,
  • "error": "string"
}

Coins

Methods for managing coins.

+

Retrieves the coins for a given puzzlehash.

Retrieves the coins for a given puzzlehash, by default returns unspent coins.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The puzzle hash.

+
puzzle_hash
required
string <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "puzzle_hash": "string",
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the coins for a given puzzlehashes

Retrieves the coins for a given puzzlehashes, by default returns unspent coins.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The puzzle hashes.

+
puzzle_hashes
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "puzzle_hashes": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves coins by hint.

Retrieves coins by hint, by default returns unspent coins.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The hint.

+
hint
required
string <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "hint": "string",
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a coin record by it's name.

Retrieves a coin record by it's name.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The coin name.

+
name
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "coin_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the coins for given coin IDs.

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The coin names.

+
names
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "names": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the coins for given parent coin IDs.

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The parent ids.

+
parent_ids
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "parent_ids": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a coin solution.

Retrieves a coin solution.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The coin id and height

+
coin_id
required
string <hex>
height
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "height": 0
}

Response samples

Content type
application/json
{
  • "coin_solution": {
    },
  • "success": true,
  • "error": "string"
}

Pushes a transaction/spend bundle to the mempool and blockchain.

Pushes a transaction/spend bundle to the mempool and blockchain. Returns whether the spend bundle was successfully included into the mempool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The spend bundle

+
required
object (spend_bundle)

Responses

Request samples

Content type
application/json
{
  • "spend_bundle": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "success": true,
  • "error": "string"
}

Shared

Methods shared by all services.

+

Stop the node.

Stop the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the address of the connection

+
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the node id of the connection

+
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Full Node

The full node RPC API is exposed, by default, on port 8555. This port must not be exposed publicly for security concerns.

+

Retrieves a summary of the current state of the blockchain and full node.

Retrieves a summary of the current state of the blockchain and full node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "blockchain_state": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves some information about the current network.

Retrieves some information about the current network.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "network_name": "mainnet",
  • "network_prefix": "xch",
  • "success": true,
  • "error": "string"
}

Retrieves an estimate of total space.

Retrieves an estimate of total space validating the chain between two block header hashes.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The block header hashes

+
newer_block_header_hash
required
string <hex>
older_block_header_hash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "newer_block_header_hash": "string",
  • "older_block_header_hash": "string"
}

Response samples

Content type
application/json
{
  • "space": 0,
  • "success": true,
  • "error": "string"
}

Mempool

Get information about the mempool.

+

Returns a list of all transaction IDs in the mempool.

Returns a list of all transaction IDs (spend bundle hashes) in the mempool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "tx_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Returns all items in the mempool.

Returns all items in the mempool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "mempool_items": {
    },
  • "success": true,
  • "error": "string"
}

Returns a specific item from the mempool.

Returns a specific item from the mempool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The tx id.

+
tx_id
required
string <hex>
include_pending
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "tx_id": "string",
  • "include_pending": false
}

Response samples

Content type
application/json
{
  • "mempool_item": {
    },
  • "success": true,
  • "error": "string"
}

Gets items in the mempool by a coin name.

Gets items in the mempool by a coin name.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_name
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "coin_name": "string"
}

Response samples

Content type
application/json
{
  • "mempool_items": [
    ],
  • "success": true,
  • "error": "string"
}

Fees

Get information about fees.

+

Estimates the fee for a given spend_bundle.

Estimates the fee for a given spend_bundle.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The spend bundle

+
object (spend_bundle)
cost
integer <uint64>
target_times
Array of integers
spend_type
integer <uint64>
spend_count
integer
Default: 1

Responses

Request samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "cost": 0,
  • "target_times": [
    ],
  • "spend_type": 0,
  • "spend_count": 1
}

Response samples

Content type
application/json
{
  • "estimates": [
    ],
  • "target_times": [
    ],
  • "current_fee_rate": 0,
  • "mempool_size": 0,
  • "mempool_fees": 0,
  • "mempool_max_size": 0,
  • "num_spends": 0,
  • "full_node_synced": true,
  • "peak_height": 0,
  • "last_peak_timestamp": 0,
  • "last_block_cost": 0,
  • "fees_last_block": 0,
  • "fee_rate_last_block": 0,
  • "last_tx_block_height": 0,
  • "node_time_utc": 0,
  • "success": true,
  • "error": "string"
}
-
API docs by Redocly
API docs by Redocly

Chia RPC (2.0.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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. + " fill="currentColor">

Chia RPC (2.1.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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.

-
Find out more about chia

Shared

Methods shared by all services.

-

Stop the node.

Stop the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the address of the connection

-
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the node id of the connection

-
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Harvester

The harvester RPC API is exposed, by default, on port 8560 and contains methods for managing plot files and directories.

-

Add a plot directory to the harvester configuration.

Add a plot directory to the harvester configuration.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The directory name to add

-
dirname
required
string

Responses

Request samples

Content type
application/json
{
  • "dirname": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a plot directory from the harvester configuration.

Removes a plot directory from the harvester configuration.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The directory name to remove

-
dirname
required
string

Responses

Request samples

Content type
application/json
{
  • "dirname": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get the list of plot directories from the harvester configuration.

Get the list of plot directories from the harvester configuration.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "directories": [
    ],
  • "success": true,
  • "error": "string"
}

Refresh the list of plots.

Refresh the list of plots.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get information about the plots the harvester knows about.

Get information about the plots the harvester knows about.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "failed_to_open_filenames": [
    ],
  • "not_found_filenames": [
    ],
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Permanently delete a plot file.

Permanently delete a plot file.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the file name of the plot

-
filename
required
string

Responses

Request samples

Content type
application/json
{
  • "filename": "plot-k33-2021-06-12-03-55-1d5a2afe637578d6c9dfa04484854831012b678921a8dce5a8aee9c0fd3c1470.plot"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Gets harvester configuration.

Gets harvester configuration.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "use_gpu_harvesting": true,
  • "gpu_index": 0,
  • "enforce_gpu_index": true,
  • "disable_cpu_affinity": true,
  • "parallel_decompressor_count": 0,
  • "decompressor_thread_count": 0,
  • "recursive_plot_scan": true,
  • "refresh_parameter_interval_seconds": 0,
  • "success": true,
  • "error": "string"
}

Updates the harvester configuration.

Updates the harvester configuration.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Config details

-
use_gpu_harvesting
boolean
gpu_index
integer <int>
enforce_gpu_index
boolean
disable_cpu_affinity
boolean
parallel_decompressor_count
integer <int>
decompressor_thread_count
integer <int>
recursive_plot_scan
boolean
refresh_parameter_interval_seconds
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "use_gpu_harvesting": true,
  • "gpu_index": 0,
  • "enforce_gpu_index": true,
  • "disable_cpu_affinity": true,
  • "parallel_decompressor_count": 0,
  • "decompressor_thread_count": 0,
  • "recursive_plot_scan": true,
  • "refresh_parameter_interval_seconds": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}
+
Find out more about chia

Shared

Methods shared by all services.

+

Stop the node.

Stop the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the address of the connection

+
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the node id of the connection

+
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

Harvester

The harvester RPC API is exposed, by default, on port 8560 and contains methods for managing plot files and directories.

+

Add a plot directory to the harvester configuration.

Add a plot directory to the harvester configuration.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The directory name to add

+
dirname
required
string

Responses

Request samples

Content type
application/json
{
  • "dirname": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a plot directory from the harvester configuration.

Removes a plot directory from the harvester configuration.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The directory name to remove

+
dirname
required
string

Responses

Request samples

Content type
application/json
{
  • "dirname": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get the list of plot directories from the harvester configuration.

Get the list of plot directories from the harvester configuration.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "directories": [
    ],
  • "success": true,
  • "error": "string"
}

Refresh the list of plots.

Refresh the list of plots.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get information about the plots the harvester knows about.

Get information about the plots the harvester knows about.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "failed_to_open_filenames": [
    ],
  • "not_found_filenames": [
    ],
  • "plots": [
    ],
  • "success": true,
  • "error": "string"
}

Permanently delete a plot file.

Permanently delete a plot file.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the file name of the plot

+
filename
required
string

Responses

Request samples

Content type
application/json
{
  • "filename": "plot-k33-2021-06-12-03-55-1d5a2afe637578d6c9dfa04484854831012b678921a8dce5a8aee9c0fd3c1470.plot"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Gets harvester configuration.

Gets harvester configuration.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "use_gpu_harvesting": true,
  • "gpu_index": 0,
  • "enforce_gpu_index": true,
  • "disable_cpu_affinity": true,
  • "parallel_decompressor_count": 0,
  • "decompressor_thread_count": 0,
  • "recursive_plot_scan": true,
  • "refresh_parameter_interval_seconds": 0,
  • "success": true,
  • "error": "string"
}

Updates the harvester configuration.

Updates the harvester configuration.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Config details

+
use_gpu_harvesting
boolean
gpu_index
integer <int>
enforce_gpu_index
boolean
disable_cpu_affinity
boolean
parallel_decompressor_count
integer <int>
decompressor_thread_count
integer <int>
recursive_plot_scan
boolean
refresh_parameter_interval_seconds
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "use_gpu_harvesting": true,
  • "gpu_index": 0,
  • "enforce_gpu_index": true,
  • "disable_cpu_affinity": true,
  • "parallel_decompressor_count": 0,
  • "decompressor_thread_count": 0,
  • "recursive_plot_scan": true,
  • "refresh_parameter_interval_seconds": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}
-
API docs by Redocly
API docs by Redocly

Chia RPC (2.0.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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. + " fill="currentColor">

Chia RPC (2.1.0)

Download OpenAPI specification:Download

Chia Network: hello@chia.net URL: https://www.chia.net/ License: Apache 2.0 Terms of Service

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 wallet uses port 9256 by default.

-
Find out more about chia

Shared

Methods shared by all services.

-

Stop the node.

Stop the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the address of the connection

-
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

-
Authorizations:
bearerAuth
Request Body schema: application/json

the node id of the connection

-
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

CAT Wallet

CATs, trades, and offers.

-

Takes an offer.

Takes an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
offer
required
string <hex>
fee
integer <uint64>
Default: 0
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
object
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "offer": "string",
  • "fee": 0,
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "solver": {
    },
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "trade_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the number of offers.

Retrieves the number of offers.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "total": 0,
  • "my_offers_count": 0,
  • "taken_offers_count": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the list of CATs.

Retrieves the list of CATs.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "cat_list": [
    ],
  • "success": true,
  • "error": "string"
}

Cancels an offer.

Cancels an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
trade_id
required
string <hex>
fee
integer <uint64>
Default: 0
secure
required
boolean

Responses

Request samples

Content type
application/json
{
  • "trade_id": "string",
  • "fee": 0,
  • "secure": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Cancels multiple offers.

Cancels multiple offers.

-
Authorizations:
bearerAuth
Request Body schema: application/json
batch_fee
integer <uint64>
Default: 0
secure
required
boolean
batch_size
integer <int32>
Default: 5
cancel_all
boolean
Default: false
asset_id
string
Default: "xch"

Responses

Request samples

Content type
application/json
{
  • "batch_fee": 0,
  • "secure": true,
  • "batch_size": 5,
  • "cancel_all": false,
  • "asset_id": "xch"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
amount
required
integer <uint64>
min_coin_amount
integer <uint64>
Default: 0
Array of objects (coin)
max_coin_amount
integer <uint64>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "amount": 0,
  • "min_coin_amount": 0,
  • "excluded_coins": [
    ],
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ]
}

Response samples

Content type
application/json
{
  • "coins": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves an offer.

Retrieves an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
trade_id
required
string <hex>
file_contents
boolean

Indicator as to whether to return the offer contents

-

Responses

Request samples

Content type
application/json
{
  • "trade_id": "string",
  • "file_contents": true
}

Response samples

Content type
application/json
{
  • "trade_record": {
    },
  • "offer": "string",
  • "success": true,
  • "error": "string"
}

Retrieves offers.

Retrieves offers.

-
Authorizations:
bearerAuth
Request Body schema: application/json
start
integer
Default: 0
end
integer
Default: 10
exclude_my_offers
boolean
exclude_taken_offers
boolean
include_completed
boolean
sort_key
string
reverse
boolean
file_contents
boolean

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 10,
  • "exclude_my_offers": true,
  • "exclude_taken_offers": true,
  • "include_completed": true,
  • "sort_key": "string",
  • "reverse": true,
  • "file_contents": true
}

Response samples

Content type
application/json
{
  • "trade_records": [
    ],
  • "offers": [
    ],
  • "success": true,
  • "error": "string"
}

Checks the validity of an offer.

Checks the validity of an offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
offer
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "offer": "string"
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "id": "string",
  • "success": true,
  • "error": "string"
}

Get the summary of a given offer.

Get the summary of a given offer.

-
Authorizations:
bearerAuth
Request Body schema: application/json
offer
required
string <hex>
advanced
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "offer": "string",
  • "advanced": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "summary": {
    },
  • "success": true,
  • "error": "string"
}

Creates an offer.

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
object
fee
integer <uint64>
Default: 0
validate_only
boolean
Default: false
object
min_coin_amount
integer <uint128>
Default: 0
max_coin_amount
integer <uint128>
Default: 0
object
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0,
  • "validate_only": false,
  • "driver_dict": {
    },
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "solver": {
    },
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "offer": "string",
  • "trade_record": {
    },
  • "success": true,
  • "error": "string"
}

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

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
asset_id
required
string

Responses

Request samples

Content type
application/json
{
  • "asset_id": "string"
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string",
  • "success": true,
  • "error": "string"
}

Gets the asset id of the CAT wallet.

Gets the asset id of the CAT wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "asset_id": "string",
  • "success": true,
  • "error": "string"
}

Spends an amount from the given wallet.

Spends an amount from the given wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet.

-
wallet_id
required
integer <uint32>
Array of objects (coin)
amount
required
integer <uint64>
fee
integer <uint64>
Default: 0
inner_address
required
string <hex>
memos
Array of strings
min_coin_amount
integer <uint128>
Default: 0
max_coin_amount
integer <uint128>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
excluded_coin_ids
Array of strings <hex>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coins": [
    ],
  • "amount": 0,
  • "fee": 0,
  • "inner_address": "string",
  • "memos": [
    ],
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ],
  • "excluded_coin_ids": [
    ],
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Sets the name of the CAT wallet.

Sets the name of the CAT wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>
name
required
string

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Gets the name of the CAT wallet.

Gets the name of the CAT wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string",
  • "success": true,
  • "error": "string"
}

Get a list of all unacknowledged CATs.

Get a list of all unacknowledged CATs.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "stray_cats": [
    ],
  • "success": true,
  • "error": "string"
}

DID Wallet

Distributed Identity wallet.

-

Creates a backup file for the given DID wallet.

Creates a backup file for the given DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "backup_data": "string",
  • "success": true,
  • "error": "string"
}

Transfer a DID to another owner.

Transfer the given DID wallet to another owner.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
inner_address
required
string <hex>
fee
integer <uint64>
Default: 0
with_recovery_info
boolean
Default: true
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "inner_address": "string",
  • "fee": 0,
  • "with_recovery_info": true,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the recovery information needed for the given DID wallet.

Retrieves the recovery information needed for the given DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "my_did": "string",
  • "coin_name": "string",
  • "newpuzhash": "string",
  • "pubkey": "string",
  • "backup_dids": [
    ],
  • "success": true,
  • "error": "string"
}

Creates an attestment for the given DID wallet.

Creates an attestment for the given DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
coin_name
required
string <hex>
pubkey
required
string <hex>
puzhash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coin_name": "string",
  • "pubkey": "string",
  • "puzhash": "string"
}

Response samples

Content type
application/json
{
  • "message_spend_bundle": "string",
  • "info": [
    ],
  • "attest_data": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the public key for the given DID wallet.

Retrieves the public key for the given DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "pubkey": "string",
  • "success": true,
  • "error": "string"
}

Gets information about the DID wallets current coin.

Gets information about the DID wallets current coin.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "my_did": "string",
  • "did_parent": "string",
  • "did_innerpuz": "string",
  • "did_amount": 0,
  • "success": true,
  • "error": "string"
}

Spend from the given DID wallet.

Spend from the given DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
attest_data
required
Array of strings
pubkey
string <hex>
puzhash
string <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "attest_data": [
    ],
  • "pubkey": "string",
  • "puzhash": "string"
}

Response samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the recovery list for a given DID wallet.

Retrieves the recovery list for a given DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "recover_list": [
    ],
  • "num_required": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the distributed identity for a given wallet.

Retrieves the distributed identity for a given wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "my_did": "string",
  • "coin_id": "string",
  • "success": true,
  • "error": "string"
}

Updates the recovery ids for a DID wallet.

Updates the recovery ids for a DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
new_list
required
Array of strings <hex>
num_verifications_required
integer <uint64>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "new_list": [
    ],
  • "num_verifications_required": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Sets the name of a DID wallet.

Sets the name of a DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
name
required
string

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0
}

Gets the name of a DID wallet.

Gets the name of a DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0,
  • "name": "string"
}

Updates the metadata for a DID wallet.

Updates the metadata for a DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
object
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "metadata": {
    },
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0,
  • "spend_bundle": {
    }
}

Gets the metadata of a DID wallet.

Gets the metadata of a DID wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0,
  • "metadata": {
    }
}

Spends a DID message.

Spends a DID message

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
coin_announcements
Array of strings <hex>
puzzle_announcements
Array of strings <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coin_announcements": [
    ],
  • "puzzle_announcements": [
    ]
}

Response samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves information about a DID.

Retrieves information about a DID

-
Authorizations:
bearerAuth
Request Body schema: application/json
coin_id
required
string <hex>
latest
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "latest": true
}

Response samples

Content type
application/json
{
  • "latest_coin": "string",
  • "p2_address": "string",
  • "public_key": "string",
  • "recovery_list_hash": "string",
  • "num_verification": 0,
  • "metadata": { },
  • "launcher_id": "string",
  • "full_puzzle": "string",
  • "solution": "string",
  • "hints": [
    ],
  • "did_id": "string",
  • "success": true,
  • "error": "string"
}

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
coin_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string"
}

Response samples

Content type
application/json
{
  • "latest_coin_id": "string",
  • "success": true,
  • "error": "string"
}

Key Management

Methods for managing keys.

-

Logs in the wallet with a specific key.

Logs in the wallet with a specific key.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with a wallet fingerprint.

-
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the logged in fingerprint.

Retrieves the logged in fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "success": true,
  • "error": "string"
}

Retrieves all public keys on the node.

Retrieves all public keys on the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "keyring_is_locked": true,
  • "success": true,
  • "error": "string"
}

Retrieves the private key by fingerprint.

Retrieves the private key by fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with a wallet fingerprint.

-
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "private_key": {
    },
  • "success": true,
  • "error": "string"
}

Generates a new mnemonic phrase.

Generates a new mnemonic phrase.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • "hint",
  • "dice",
  • "session",
  • "fun",
  • "budget",
  • "strong",
  • "album",
  • "lava",
  • "tackle",
  • "sudden",
  • "garage",
  • "people",
  • "bundle",
  • "federal",
  • "chest",
  • "process",
  • "vicious",
  • "behave",
  • "nephew",
  • "zero",
  • "vital",
  • "ocean",
  • "artist",
  • "lawsuit"
]

Generates a new mnemonic phrase.

Generates a new mnemonic phrase.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The mnemonic phrase.

-
Array (= 24 items)
string

Responses

Request samples

Content type
application/json
[
  • "hint",
  • "dice",
  • "session",
  • "fun",
  • "budget",
  • "strong",
  • "album",
  • "lava",
  • "tackle",
  • "sudden",
  • "garage",
  • "people",
  • "bundle",
  • "federal",
  • "chest",
  • "process",
  • "vicious",
  • "behave",
  • "nephew",
  • "zero",
  • "vital",
  • "ocean",
  • "artist",
  • "lawsuit"
]

Response samples

Content type
application/json
{
  • "private_key": {
    },
  • "success": true,
  • "error": "string"
}

Deletes all keys which have the given public key fingerprint.

Deletes all keys which have the given public key fingerprint.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with a wallet fingerprint.

-
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with a wallet fingerprint.

-
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "used_for_farmer_rewards": true,
  • "used_for_pool_rewards": true,
  • "wallet_balance": true,
  • "success": true,
  • "error": "string"
}

Deletes all keys from the keychain.

Deletes all keys from the keychain.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

The coin names.

-
pubkey
required
string <hex>
message
required
string <hex>
signature
required
string <hex>
address
string <hex>
signing_mode
string

Responses

Request samples

Content type
application/json
{
  • "pubkey": "string",
  • "message": "string",
  • "signature": "string",
  • "address": "string",
  • "signing_mode": "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_AUG:CHIP-0002_"
}

Response samples

Content type
application/json
{
  • "isValid": true
}

Pool Wallet

Pool wallet api.

-

Joins the given wallet to a pool.

Joins the given wallet to a pool.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
target_puzzlehash
string <hex>
pool_url
required
string <url>
relative_lock_height
required
integer <uint32>
fee
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "target_puzzlehash": "string",
  • "pool_url": "string",
  • "relative_lock_height": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "total_fee": 0,
  • "success": true,
  • "error": "string"
}

Removes the given wallet to a pool.

Removes the given wallet to a pool.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
fee
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "total_fee": 0,
  • "success": true,
  • "error": "string"
}

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.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
fee
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "state": {
    },
  • "success": true,
  • "error": "string"
}

Return the complete state of the given Pool wallet.

Return the complete state of the given Pool wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "unconfirmed_transactions": [
    ],
  • "state": {
    },
  • "success": true,
  • "error": "string"
}

Notifications

Notification api.

-

Retrieves notifications.

Retrieves notifications.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Notification query inputs

-
ids
Array of strings
start
integer
end
integer

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "start": 0,
  • "end": 0
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "success": true,
  • "error": "string"
}

Deletes notifications.

Deletes notifications.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The notifications to delete

-
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Sends a notification.

Sends a notification.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The notification to send

-
target
required
string <hex>
message
required
string <hex>
amount
required
integer <uint64>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "target": "string",
  • "message": "string",
  • "amount": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx": {
    },
  • "success": true,
  • "error": "string"
}

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

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

The message

-
address
required
string <hex>
message
required
string
is_hex
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "message": "string",
  • "is_hex": false
}

Response samples

Content type
application/json
{
  • "pubkey": "string",
  • "signature": "string",
  • "signing_mode": "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_AUG:CHIP-0002_",
  • "success": true,
  • "error": "string"
}

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.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The message

-
id
required
string <hex>
message
required
string
is_hex
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "message": "string",
  • "is_hex": false
}

Response samples

Content type
application/json
{
  • "pubkey": "string",
  • "signature": "string",
  • "latest_coin_id": "string",
  • "signing_mode": "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_AUG:CHIP-0002_",
  • "success": true,
  • "error": "string"
}

Wallet

Methods for shared wallet operations.

-

Gets the current derivation index.

Gets the current derivation index.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "index": 0,
  • "success": true,
  • "error": "string"
}

Extends the current derivation index.

Extends the current derivation index.

-
Authorizations:
bearerAuth
Request Body schema: application/json
index
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "index": 0
}

Response samples

Content type
application/json
{
  • "index": 0,
  • "success": true,
  • "error": "string"
}

Creates and signs a transaction.

Creates and signs a transaction.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
integer
required
Array of objects (amount_with_puzzlehash)
Array of objects (coin)
Array of objects (coin_announcement)
Array of objects (puzzle_announcement)
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
Array of objects (coin)
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "additions": [
    ],
  • "coins": [
    ],
  • "coin_announcements": [
    ],
  • "puzzle_announcements": [
    ],
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coins": [
    ],
  • "excluded_coin_amounts": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "signed_txs": [
    ],
  • "signed_tx": {
    },
  • "success": true,
  • "error": "string"
}

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.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
amount
required
integer <uint64>
address
required
string <hex>
fee
integer <uint64>
memos
Array of strings
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
excluded_coin_ids
Array of strings <hex>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "amount": 0,
  • "address": "string",
  • "fee": 0,
  • "memos": [
    ],
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ],
  • "excluded_coin_ids": [
    ],
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Sends multiple transactions from then given wallet.

Sends multiple transactions from then given wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
Array of objects (amount_with_puzzlehash)
fee
integer <uint64>
Default: 0
Array of objects (coin)
Array of objects (coin_announcement)
Array of objects (puzzle_announcement)

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "additions": [
    ],
  • "fee": 0,
  • "coins": [
    ],
  • "coin_announcements": [
    ],
  • "puzzle_announcements": [
    ]
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the balance of a specific wallet.

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_balance": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the balance of a specific list of wallets.

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_ids
required
Array of integers <uint32> [ items <uint32 > ]

Responses

Request samples

Content type
application/json
{
  • "wallet_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "wallet_balances": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the amount farmed.

Retrieves the amount farmed.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "farmed_amount": 0,
  • "pool_reward_amount": 0,
  • "farmer_reward_amount": 0,
  • "fee_amount": 0,
  • "last_height_farmed": 0,
  • "blocks_won": 0,
  • "last_time_farmed": 0,
  • "success": true,
  • "error": "string"
}

Delete all unconfirmed transactions for a given wallet.

Delete all unconfirmed transactions for a given wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieves a specific transaction.

Retrieves a specific transaction.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a transaction.

-
transaction_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string"
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Retrieves all spendable coins in a wallet.

Retrieves all spendable coins in a wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
Array of objects (coin)
excluded_coin_ids
Array of strings <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ],
  • "excluded_coins": [
    ],
  • "excluded_coin_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "confirmed_records": [
    ],
  • "unconfirmed_removals": [
    ],
  • "unconfirmed_additions": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a list of transactions from a wallet.

Retrieves a list of transactions from a wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
to_address
string <hex>
start
integer <uint32>
Default: 0
end
integer <uint32>
Default: 50
sort_key
string
reverse
boolean
object (transaction_type_filter)
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "to_address": "string",
  • "start": 0,
  • "end": 50,
  • "sort_key": "string",
  • "reverse": true,
  • "type_filter": {
    },
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the number of transactions for a wallet.

Retrieves the number of transactions for a wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
integer <uint32>
object (transaction_type_filter)

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "type_filter": {
    }
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Returns a new address.

Returns a new address.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
new_address
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "new_address": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "address": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the memo from a transaction.

Retrieves the memo from a transaction

-
Authorizations:
bearerAuth
Request Body schema: application/json
transaction_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    },
  • "success": true,
  • "error": "string"
}

Set auto claim merkle coins config

Set auto claim merkle coins config

-
Authorizations:
bearerAuth
Request Body schema: application/json
enabled
boolean
Default: false
tx_fee
integer <uint64>
Default: 0
min_amount
integer <uint64>
Default: 0
batch_size
integer <uint16>
Default: 50

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "tx_fee": 0,
  • "min_amount": 0,
  • "batch_size": 50
}

Response samples

Content type
application/json
{
  • "enabled": false,
  • "tx_fee": 0,
  • "min_amount": 0,
  • "batch_size": 50,
  • "success": true,
  • "error": "string"
}

Get auto claim merkle coins config

Get auto claim merkle coins config

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "enabled": false,
  • "tx_fee": 0,
  • "min_amount": 0,
  • "batch_size": 50,
  • "success": true,
  • "error": "string"
}

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

Spend clawback coins that were sent or received

-
Authorizations:
bearerAuth
Request Body schema: application/json
coin_ids
required
Array of strings <hex>
fee
integer <uint64>
Default: 0
batch_size
integer <uint16>
Default: 50

Responses

Request samples

Content type
application/json
{
  • "coin_ids": [
    ],
  • "fee": 0,
  • "batch_size": 50
}

Response samples

Content type
application/json
{
  • "transaction_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Wallet Management

Methods for creating and managing wallets.

-

Retrieves all of the wallets on the node.

Retrieves all of the wallets on the node.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Optional wallet type to filter by

-
type
integer <uint8> (wallet_type)
Enum: 0 2 3 4 5 6 7 8 9 10 11 12 13

The type of wallet:

+
Find out more about chia

Shared

Methods shared by all services.

+

Stop the node.

Stop the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Add a connection to another node.

Add a connection to another node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the address of the connection

+
ip
required
string <ipaddress>
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "ip": "string",
  • "port": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Removes a connection.

Removes a connection.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

the node id of the connection

+
node_id
required
string

Responses

Request samples

Content type
application/json
{
  • "node_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of connections.

Retrieve the list of connections.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "connections": [
    ],
  • "success": true,
  • "error": "string"
}

Heartbeat.

Heartbeat.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the list of routes exposed by the service.

Retrieve the list of routes/endpoints exposed by the service.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "routes": [
    ],
  • "success": true,
  • "error": "string"
}

CAT Wallet

CATs, trades, and offers.

+

Takes an offer.

Takes an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
offer
required
string <hex>
fee
integer <uint64>
Default: 0
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
object
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "offer": "string",
  • "fee": 0,
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "solver": {
    },
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "trade_record": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the number of offers.

Retrieves the number of offers.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "total": 0,
  • "my_offers_count": 0,
  • "taken_offers_count": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the list of CATs.

Retrieves the list of CATs.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "cat_list": [
    ],
  • "success": true,
  • "error": "string"
}

Cancels an offer.

Cancels an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
trade_id
required
string <hex>
fee
integer <uint64>
Default: 0
secure
required
boolean

Responses

Request samples

Content type
application/json
{
  • "trade_id": "string",
  • "fee": 0,
  • "secure": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Cancels multiple offers.

Cancels multiple offers.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
batch_fee
integer <uint64>
Default: 0
secure
required
boolean
batch_size
integer <int32>
Default: 5
cancel_all
boolean
Default: false
asset_id
string
Default: "xch"

Responses

Request samples

Content type
application/json
{
  • "batch_fee": 0,
  • "secure": true,
  • "batch_size": 5,
  • "cancel_all": false,
  • "asset_id": "xch"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
amount
required
integer <uint64>
min_coin_amount
integer <uint64>
Default: 0
Array of objects (coin)
max_coin_amount
integer <uint64>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "amount": 0,
  • "min_coin_amount": 0,
  • "excluded_coins": [
    ],
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ]
}

Response samples

Content type
application/json
{
  • "coins": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves an offer.

Retrieves an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
trade_id
required
string <hex>
file_contents
boolean

Indicator as to whether to return the offer contents

+

Responses

Request samples

Content type
application/json
{
  • "trade_id": "string",
  • "file_contents": true
}

Response samples

Content type
application/json
{
  • "trade_record": {
    },
  • "offer": "string",
  • "success": true,
  • "error": "string"
}

Retrieves offers.

Retrieves offers.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
start
integer
Default: 0
end
integer
Default: 10
exclude_my_offers
boolean
exclude_taken_offers
boolean
include_completed
boolean
sort_key
string
reverse
boolean
file_contents
boolean

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 10,
  • "exclude_my_offers": true,
  • "exclude_taken_offers": true,
  • "include_completed": true,
  • "sort_key": "string",
  • "reverse": true,
  • "file_contents": true
}

Response samples

Content type
application/json
{
  • "trade_records": [
    ],
  • "offers": [
    ],
  • "success": true,
  • "error": "string"
}

Checks the validity of an offer.

Checks the validity of an offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
offer
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "offer": "string"
}

Response samples

Content type
application/json
{
  • "valid": true,
  • "id": "string",
  • "success": true,
  • "error": "string"
}

Get the summary of a given offer.

Get the summary of a given offer.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
offer
required
string <hex>
advanced
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "offer": "string",
  • "advanced": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "summary": {
    },
  • "success": true,
  • "error": "string"
}

Creates an offer.

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object
fee
integer <uint64>
Default: 0
validate_only
boolean
Default: false
object
min_coin_amount
integer <uint128>
Default: 0
max_coin_amount
integer <uint128>
Default: 0
object
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "offer": {
    },
  • "fee": 0,
  • "validate_only": false,
  • "driver_dict": {
    },
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "solver": {
    },
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "offer": "string",
  • "trade_record": {
    },
  • "success": true,
  • "error": "string"
}

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

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
asset_id
required
string

Responses

Request samples

Content type
application/json
{
  • "asset_id": "string"
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string",
  • "success": true,
  • "error": "string"
}

Gets the asset id of the CAT wallet.

Gets the asset id of the CAT wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "asset_id": "string",
  • "success": true,
  • "error": "string"
}

Spends an amount from the given wallet.

Spends an amount from the given wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet.

+
wallet_id
required
integer <uint32>
Array of objects (coin)
amount
required
integer <uint64>
fee
integer <uint64>
Default: 0
inner_address
required
string <hex>
memos
Array of strings
min_coin_amount
integer <uint128>
Default: 0
max_coin_amount
integer <uint128>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
excluded_coin_ids
Array of strings <hex>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coins": [
    ],
  • "amount": 0,
  • "fee": 0,
  • "inner_address": "string",
  • "memos": [
    ],
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ],
  • "excluded_coin_ids": [
    ],
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Sets the name of the CAT wallet.

Sets the name of the CAT wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>
name
required
string

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Gets the name of the CAT wallet.

Gets the name of the CAT wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string",
  • "success": true,
  • "error": "string"
}

Get a list of all unacknowledged CATs.

Get a list of all unacknowledged CATs.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "stray_cats": [
    ],
  • "success": true,
  • "error": "string"
}

DID Wallet

Distributed Identity wallet.

+

Creates a backup file for the given DID wallet.

Creates a backup file for the given DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "backup_data": "string",
  • "success": true,
  • "error": "string"
}

Transfer a DID to another owner.

Transfer the given DID wallet to another owner.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
inner_address
required
string <hex>
fee
integer <uint64>
Default: 0
with_recovery_info
boolean
Default: true
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "inner_address": "string",
  • "fee": 0,
  • "with_recovery_info": true,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the recovery information needed for the given DID wallet.

Retrieves the recovery information needed for the given DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "my_did": "string",
  • "coin_name": "string",
  • "newpuzhash": "string",
  • "pubkey": "string",
  • "backup_dids": [
    ],
  • "success": true,
  • "error": "string"
}

Creates an attestment for the given DID wallet.

Creates an attestment for the given DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
coin_name
required
string <hex>
pubkey
required
string <hex>
puzhash
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coin_name": "string",
  • "pubkey": "string",
  • "puzhash": "string"
}

Response samples

Content type
application/json
{
  • "message_spend_bundle": "string",
  • "info": [
    ],
  • "attest_data": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the public key for the given DID wallet.

Retrieves the public key for the given DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "pubkey": "string",
  • "success": true,
  • "error": "string"
}

Gets information about the DID wallets current coin.

Gets information about the DID wallets current coin.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "my_did": "string",
  • "did_parent": "string",
  • "did_innerpuz": "string",
  • "did_amount": 0,
  • "success": true,
  • "error": "string"
}

Spend from the given DID wallet.

Spend from the given DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
attest_data
required
Array of strings
pubkey
string <hex>
puzhash
string <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "attest_data": [
    ],
  • "pubkey": "string",
  • "puzhash": "string"
}

Response samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the recovery list for a given DID wallet.

Retrieves the recovery list for a given DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "recover_list": [
    ],
  • "num_required": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the distributed identity for a given wallet.

Retrieves the distributed identity for a given wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "my_did": "string",
  • "coin_id": "string",
  • "success": true,
  • "error": "string"
}

Updates the recovery ids for a DID wallet.

Updates the recovery ids for a DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
new_list
required
Array of strings <hex>
num_verifications_required
integer <uint64>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "new_list": [
    ],
  • "num_verifications_required": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Sets the name of a DID wallet.

Sets the name of a DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
name
required
string

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0
}

Gets the name of a DID wallet.

Gets the name of a DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0,
  • "name": "string"
}

Updates the metadata for a DID wallet.

Updates the metadata for a DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
object
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "metadata": {
    },
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0,
  • "spend_bundle": {
    }
}

Gets the metadata of a DID wallet.

Gets the metadata of a DID wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string",
  • "wallet_id": 0,
  • "metadata": {
    }
}

Spends a DID message.

Spends a DID message

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
coin_announcements
Array of strings <hex>
puzzle_announcements
Array of strings <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coin_announcements": [
    ],
  • "puzzle_announcements": [
    ]
}

Response samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves information about a DID.

Retrieves information about a DID

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_id
required
string <hex>
latest
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "latest": true
}

Response samples

Content type
application/json
{
  • "latest_coin": "string",
  • "p2_address": "string",
  • "public_key": "string",
  • "recovery_list_hash": "string",
  • "num_verification": 0,
  • "metadata": { },
  • "launcher_id": "string",
  • "full_puzzle": "string",
  • "solution": "string",
  • "hints": [
    ],
  • "did_id": "string",
  • "success": true,
  • "error": "string"
}

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string"
}

Response samples

Content type
application/json
{
  • "latest_coin_id": "string",
  • "success": true,
  • "error": "string"
}

Key Management

Methods for managing keys.

+

Logs in the wallet with a specific key.

Logs in the wallet with a specific key.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with a wallet fingerprint.

+
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the logged in fingerprint.

Retrieves the logged in fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "success": true,
  • "error": "string"
}

Retrieves all public keys on the node.

Retrieves all public keys on the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "keyring_is_locked": true,
  • "success": true,
  • "error": "string"
}

Retrieves the private key by fingerprint.

Retrieves the private key by fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with a wallet fingerprint.

+
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "private_key": {
    },
  • "success": true,
  • "error": "string"
}

Generates a new mnemonic phrase.

Generates a new mnemonic phrase.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • "hint",
  • "dice",
  • "session",
  • "fun",
  • "budget",
  • "strong",
  • "album",
  • "lava",
  • "tackle",
  • "sudden",
  • "garage",
  • "people",
  • "bundle",
  • "federal",
  • "chest",
  • "process",
  • "vicious",
  • "behave",
  • "nephew",
  • "zero",
  • "vital",
  • "ocean",
  • "artist",
  • "lawsuit"
]

Generates a new mnemonic phrase.

Generates a new mnemonic phrase.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The mnemonic phrase.

+
Array (= 24 items)
string

Responses

Request samples

Content type
application/json
[
  • "hint",
  • "dice",
  • "session",
  • "fun",
  • "budget",
  • "strong",
  • "album",
  • "lava",
  • "tackle",
  • "sudden",
  • "garage",
  • "people",
  • "bundle",
  • "federal",
  • "chest",
  • "process",
  • "vicious",
  • "behave",
  • "nephew",
  • "zero",
  • "vital",
  • "ocean",
  • "artist",
  • "lawsuit"
]

Response samples

Content type
application/json
{
  • "private_key": {
    },
  • "success": true,
  • "error": "string"
}

Deletes all keys which have the given public key fingerprint.

Deletes all keys which have the given public key fingerprint.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with a wallet fingerprint.

+
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with a wallet fingerprint.

+
fingerprint
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "fingerprint": 0
}

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "used_for_farmer_rewards": true,
  • "used_for_pool_rewards": true,
  • "wallet_balance": true,
  • "success": true,
  • "error": "string"
}

Deletes all keys from the keychain.

Deletes all keys from the keychain.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The coin names.

+
pubkey
required
string <hex>
message
required
string <hex>
signature
required
string <hex>
address
string <hex>
signing_mode
string

Responses

Request samples

Content type
application/json
{
  • "pubkey": "string",
  • "message": "string",
  • "signature": "string",
  • "address": "string",
  • "signing_mode": "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_AUG:CHIP-0002_"
}

Response samples

Content type
application/json
{
  • "isValid": true
}

Pool Wallet

Pool wallet api.

+

Joins the given wallet to a pool.

Joins the given wallet to a pool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
target_puzzlehash
string <hex>
pool_url
required
string <url>
relative_lock_height
required
integer <uint32>
fee
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "target_puzzlehash": "string",
  • "pool_url": "string",
  • "relative_lock_height": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "total_fee": 0,
  • "success": true,
  • "error": "string"
}

Removes the given wallet to a pool.

Removes the given wallet to a pool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
fee
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "total_fee": 0,
  • "success": true,
  • "error": "string"
}

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.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
fee
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "state": {
    },
  • "success": true,
  • "error": "string"
}

Return the complete state of the given Pool wallet.

Return the complete state of the given Pool wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "unconfirmed_transactions": [
    ],
  • "state": {
    },
  • "success": true,
  • "error": "string"
}

Notifications

Notification api.

+

Retrieves notifications.

Retrieves notifications.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Notification query inputs

+
ids
Array of strings
start
integer
end
integer

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "start": 0,
  • "end": 0
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "success": true,
  • "error": "string"
}

Deletes notifications.

Deletes notifications.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The notifications to delete

+
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Sends a notification.

Sends a notification.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The notification to send

+
target
required
string <hex>
message
required
string <hex>
amount
required
integer <uint64>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "target": "string",
  • "message": "string",
  • "amount": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx": {
    },
  • "success": true,
  • "error": "string"
}

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

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The message

+
address
required
string <hex>
message
required
string
is_hex
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "message": "string",
  • "is_hex": false
}

Response samples

Content type
application/json
{
  • "pubkey": "string",
  • "signature": "string",
  • "signing_mode": "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_AUG:CHIP-0002_",
  • "success": true,
  • "error": "string"
}

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.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The message

+
id
required
string <hex>
message
required
string
is_hex
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "message": "string",
  • "is_hex": false
}

Response samples

Content type
application/json
{
  • "pubkey": "string",
  • "signature": "string",
  • "latest_coin_id": "string",
  • "signing_mode": "BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_AUG:CHIP-0002_",
  • "success": true,
  • "error": "string"
}

Wallet

Methods for shared wallet operations.

+

Gets the current derivation index.

Gets the current derivation index.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "index": 0,
  • "success": true,
  • "error": "string"
}

Extends the current derivation index.

Extends the current derivation index.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
index
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "index": 0
}

Response samples

Content type
application/json
{
  • "index": 0,
  • "success": true,
  • "error": "string"
}

Creates and signs a transaction.

Creates and signs a transaction.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
integer
required
Array of objects (amount_with_puzzlehash)
Array of objects (coin)
Array of objects (coin_announcement)
Array of objects (puzzle_announcement)
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
Array of objects (coin)
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "additions": [
    ],
  • "coins": [
    ],
  • "coin_announcements": [
    ],
  • "puzzle_announcements": [
    ],
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coins": [
    ],
  • "excluded_coin_amounts": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "signed_txs": [
    ],
  • "signed_tx": {
    },
  • "success": true,
  • "error": "string"
}

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.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
amount
required
integer <uint64>
address
required
string <hex>
fee
integer <uint64>
memos
Array of strings
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
excluded_coin_ids
Array of strings <hex>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "amount": 0,
  • "address": "string",
  • "fee": 0,
  • "memos": [
    ],
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ],
  • "excluded_coin_ids": [
    ],
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Sends multiple transactions from then given wallet.

Sends multiple transactions from then given wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
Array of objects (amount_with_puzzlehash)
fee
integer <uint64>
Default: 0
Array of objects (coin)
Array of objects (coin_announcement)
Array of objects (puzzle_announcement)

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "additions": [
    ],
  • "fee": 0,
  • "coins": [
    ],
  • "coin_announcements": [
    ],
  • "puzzle_announcements": [
    ]
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the balance of a specific wallet.

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_balance": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the balance of a specific list of wallets.

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_ids
required
Array of integers <uint32> [ items <uint32 > ]

Responses

Request samples

Content type
application/json
{
  • "wallet_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "wallet_balances": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the amount farmed.

Retrieves the amount farmed.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "farmed_amount": 0,
  • "pool_reward_amount": 0,
  • "farmer_reward_amount": 0,
  • "fee_amount": 0,
  • "last_height_farmed": 0,
  • "blocks_won": 0,
  • "last_time_farmed": 0,
  • "success": true,
  • "error": "string"
}

Delete all unconfirmed transactions for a given wallet.

Delete all unconfirmed transactions for a given wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieves a specific transaction.

Retrieves a specific transaction.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a transaction.

+
transaction_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string"
}

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "transaction_id": "string",
  • "success": true,
  • "error": "string"
}

Retrieves all spendable coins in a wallet.

Retrieves all spendable coins in a wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
min_coin_amount
integer <uint64>
Default: 0
max_coin_amount
integer <uint64>
Default: 0
excluded_coin_amounts
Array of integers <uint64> [ items <uint64 > ]
Array of objects (coin)
excluded_coin_ids
Array of strings <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "min_coin_amount": 0,
  • "max_coin_amount": 0,
  • "excluded_coin_amounts": [
    ],
  • "excluded_coins": [
    ],
  • "excluded_coin_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "confirmed_records": [
    ],
  • "unconfirmed_removals": [
    ],
  • "unconfirmed_additions": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves a list of transactions from a wallet.

Retrieves a list of transactions from a wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
to_address
string <hex>
start
integer <uint32>
Default: 0
end
integer <uint32>
Default: 50
sort_key
string
reverse
boolean
object (transaction_type_filter)
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "to_address": "string",
  • "start": 0,
  • "end": 50,
  • "sort_key": "string",
  • "reverse": true,
  • "type_filter": {
    },
  • "confirmed": true
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Retrieves the number of transactions for a wallet.

Retrieves the number of transactions for a wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
integer <uint32>
object (transaction_type_filter)

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "type_filter": {
    }
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Returns a new address.

Returns a new address.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
new_address
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "new_address": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "address": "string",
  • "success": true,
  • "error": "string"
}

Retrieves the memo from a transaction.

Retrieves the memo from a transaction

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
transaction_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    },
  • "success": true,
  • "error": "string"
}

Set auto claim merkle coins config

Set auto claim merkle coins config

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
enabled
boolean
Default: false
tx_fee
integer <uint64>
Default: 0
min_amount
integer <uint64>
Default: 0
batch_size
integer <uint16>
Default: 50

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "tx_fee": 0,
  • "min_amount": 0,
  • "batch_size": 50
}

Response samples

Content type
application/json
{
  • "enabled": false,
  • "tx_fee": 0,
  • "min_amount": 0,
  • "batch_size": 50,
  • "success": true,
  • "error": "string"
}

Get auto claim merkle coins config

Get auto claim merkle coins config

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "enabled": false,
  • "tx_fee": 0,
  • "min_amount": 0,
  • "batch_size": 50,
  • "success": true,
  • "error": "string"
}

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

Spend clawback coins that were sent or received

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_ids
required
Array of strings <hex>
fee
integer <uint64>
Default: 0
batch_size
integer <uint16>
Default: 50

Responses

Request samples

Content type
application/json
{
  • "coin_ids": [
    ],
  • "fee": 0,
  • "batch_size": 50
}

Response samples

Content type
application/json
{
  • "transaction_ids": [
    ],
  • "success": true,
  • "error": "string"
}

Wallet Management

Methods for creating and managing wallets.

+

Retrieves all of the wallets on the node.

Retrieves all of the wallets on the node.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Optional wallet type to filter by

+
type
integer <uint8> (wallet_type)
Enum: 0 2 3 4 5 6 7 8 9 10 11 12 13 57

The type of wallet:

  • 0 STANDARD_WALLET
  • 2 ATOMIC_SWAP
    • @@ -728,172 +1019,354 @@
  • 11 DATA_LAYER
  • 12 DATA_LAYER_OFFER
  • 13 VC
    • +
  • 57 CRCAT
-
include_data
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "type": 0,
  • "include_data": true
}

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "wallets": [
    ],
  • "success": true,
  • "error": "string"
}

Creates a new wallet.

Creates a new wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Details of the wallet to create.

-
One of
mode
string
Enum: "new" "existing"
asset_id
string

Only used when mode is 'existing'

-
wallet_type
required
string
Enum: "cat_wallet" "did_wallet" "pool_wallet" "nft_wallet"

The type of wallet to create.

-
name
string

User supplied name for the wallet. Will default if not provided.

-
amount
integer <uint64>

The amount of mojo to deposit in the new wallet.

-
fee
integer <uint64>
Default: 0

The transaction fee amount in mojo.

-

Responses

Request samples

Content type
application/json
{
  • "did_id": "string",
  • "name": "string",
  • "wallet_type": "cat_wallet",
  • "amount": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "type": 0,
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Wallet Node

The wallet RPC API is exposed, by default, on port 9256 and contains methods for managing wallet, trades, offers and transactions.

-

Retrieves some information about the current network.

Retrieves some information about the current network.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "network_name": "mainnet",
  • "network_prefix": "xch",
  • "success": true,
  • "error": "string"
}

Retrieves the sync status of the wallet.

Retrieves the sync status of the wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "synced": true,
  • "syncing": true,
  • "genesis_initialized": true,
  • "success": true,
  • "error": "string"
}

Retrieves the sync height of the wallet.

Retrieves the sync height of the wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "height": 0,
  • "success": true,
  • "error": "string"
}

Pushes a transaction/spend bundle to the mempool and blockchain.

Pushes a transaction/spend bundle to the mempool and blockchain. Returns whether the spend bundle was successfully included into the mempool.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The spend bundle

-
required
object (spend_bundle)

Responses

Request samples

Content type
application/json
{
  • "spend_bundle": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Pushes multiple transactions spend bundle to the mempool and blockchain.

Pushes multiple transactions spend bundle to the mempool and blockchain.

-
Authorizations:
bearerAuth
Request Body schema: application/json

The transaction list

-
required
Array of objects (transaction_record)

Responses

Request samples

Content type
application/json
{
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the timestamp for a given block height.

Retrieve the timestamp for a given block height

-
Authorizations:
bearerAuth
Request Body schema: application/json
height
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "height": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "success": true,
  • "error": "string"
}

Resync the current logged in wallet. The transaction and offer records will be kept.

Resync the current logged in wallet

-
Authorizations:
bearerAuth
Request Body schema: application/json
enable
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Data Layer Wallet

Methods for managing a data layer wallet.

-

Initialize the new data layer wallets.

Initialize the DataLayer Wallet (only one can exist).

-
Authorizations:
bearerAuth
Request Body schema: application/json
root
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "root": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "launcher_id": "string",
  • "success": true,
  • "error": "string"
}

Track the new data layer wallet

Track the new data layer wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Stop tracking the data layer wallets.

Stop tracking the data layer wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get the singleton records that contain the specified root.

Get the singleton records that contain the specified root.

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>
root
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "root": "string"
}

Response samples

Content type
application/json
{
  • "singleton": {
    },
  • "success": true,
  • "error": "string"
}

Get the singleton records that contain the specified root.

Get the singleton records that contain the specified root.

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>
root
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "root": "string"
}

Response samples

Content type
application/json
{
  • "singleton": [
    ],
  • "success": true,
  • "error": "string"
}

Update a data layer root.

Update a data layer root.

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>
new_root
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "new_root": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_record": {
    },
  • "success": true,
  • "error": "string"
}

Update multiple singletons with new merkle roots.

Update multiple singletons with new merkle roots.

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

Response samples

Content type
application/json
{
  • "tx_records": [
    ],
  • "success": true,
  • "error": "string"
}

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

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>
min_generation
integer <uint32>
max_generation
integer <uint32>
num_results
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "min_generation": 0,
  • "max_generation": 0,
  • "num_results": 0
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "history": [
    ],
  • "success": true,
  • "error": "string"
}

Get all owned singleton records.

Get all owned singleton records.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "history": [
    ],
  • "success": true,
  • "error": "string"
}

Get all of the mirrors for a specific singleton.

Get all of the mirrors for a specific singleton.

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string"
}

Response samples

Content type
application/json
{
  • "mirrors": [],
  • "success": true,
  • "error": "string"
}

Add a new on chain message for a specific singleton.

Add a new on chain message for a specific singleton

-
Authorizations:
bearerAuth
Request Body schema: application/json
launcher_id
required
string <bytes32>
amount
required
integer <uint64>
urls
required
Array of strings <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "amount": 0,
  • "urls": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

Remove an existing mirror for a specific singleton.

Remove an existing mirror for a specific singleton.

-
Authorizations:
bearerAuth
Request Body schema: application/json
coin_id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

Verified Credential

Methods for managing verified credentials

-

Mint a verified credential using the assigned DID.

Mint a verified credential using the assigned DID

-
Authorizations:
bearerAuth
Request Body schema: application/json
did_id
required
string <hex>
target_address
string <hex>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "did_id": "string",
  • "target_address": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "vc_record": {
    },
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

Given a launcher ID get the verified credential.

Given a launcher ID get the verified credential

-
Authorizations:
bearerAuth
Request Body schema: application/json
vc_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "vc_id": "string"
}

Response samples

Content type
application/json
{
  • "vc_record": {
    },
  • "success": true,
  • "error": "string"
}

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
start
integer <uint32>
end
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 0
}

Response samples

Content type
application/json
{
  • "vc_records": [
    ],
  • "proofs": {
    },
  • "success": true,
  • "error": "string"
}

Spend a verified credential.

Spend a verified credential

-
Authorizations:
bearerAuth
Request Body schema: application/json
vc_id
required
string <bytes32>
new_puzhash
string <bytes32>
new_proof_hash
string <bytes32>
provider_inner_puzhash
string <bytes32>
fee
integer <uint64>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "vc_id": "string",
  • "new_puzhash": "string",
  • "new_proof_hash": "string",
  • "provider_inner_puzhash": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
object (vc_proofs)

Responses

Request samples

Content type
application/json
{
  • "proofs": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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

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

-
Authorizations:
bearerAuth
Request Body schema: application/json
root
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "root": "string"
}

Response samples

Content type
application/json
{
  • "proofs": {
    },
  • "success": true,
  • "error": "string"
}

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

Revoke an on chain VC provided the correct DID is available

-
Authorizations:
bearerAuth
Request Body schema: application/json
vc_parent_id
required
string <bytes32>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "vc_parent_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

NFT Wallet

Mints NFTs in bulk.

Mints NFTs in bulk.

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

A list of dicts containing the metadata for each NFT to be minted

-
wallet_id
required
integer <uint32>
royalty_address
string <hex>
royalty_percentage
integer <uint16>
Default: 0
target_list
Array of strings <hex>

a list of targets for transferring minted NFTs (aka airdrop)

-
mint_number_start
integer
Default: 1

The starting point for mint number used in intermediate launcher puzzle

-
mint_total
integer

The total number of NFTs being minted

-
Array of objects (coin)

For use with bulk minting to provide the coin used for funding the minting spend. This coin can be one that will be created in the future

-
xch_change_target
string <hex>

For use with bulk minting, so we can specify the puzzle hash that the change from the funding transaction goes to.

-
new_innerpuzhash
string <hex>
new_p2_puzhash
string <hex>
object (coin)
did_lineage_parent_hex
string <hex>
mint_from_did
boolean
Default: false
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "metadata_list": [],
  • "wallet_id": 0,
  • "royalty_address": "string",
  • "royalty_percentage": 0,
  • "target_list": [
    ],
  • "mint_number_start": 1,
  • "mint_total": 0,
  • "xch_coins": [
    ],
  • "xch_change_target": "string",
  • "new_innerpuzhash": "string",
  • "new_p2_puzhash": "string",
  • "did_coin": {
    },
  • "did_lineage_parent_hex": "string",
  • "mint_from_did": false,
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "nft_id_list": [
    ],
  • "success": true,
  • "error": "string"
}

Mints an NFT.

Mints an NFT.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
royalty_address
string <hex>
target_address
string <hex>
uris
required
Array of strings <uri>
meta_uris
Array of strings <uri>
license_uris
Array of strings <uri>
hash
required
string <hex>
edition_number
integer <uint64>
Default: 1
edition_total
integer <uint64>
Default: 1
fee
integer <uint64>
Default: 0
meta_hash
string <hex>
license_hash
string <hex>
did_id
string
royalty_percentage
integer <uint16>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "royalty_address": "string",
  • "target_address": "string",
  • "uris": [],
  • "meta_uris": [],
  • "license_uris": [],
  • "hash": "string",
  • "edition_number": 1,
  • "edition_total": 1,
  • "fee": 0,
  • "meta_hash": "string",
  • "license_hash": "string",
  • "did_id": "string",
  • "royalty_percentage": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "nft_id": "string",
  • "success": true,
  • "error": "string"
}

Gets NFTs from a wallet.

Gets NFTs from a wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
start_index
integer <uint32>
Default: 0
num
integer <uint32>
Default: 0
ignore_size_limit
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "start_index": 0,
  • "num": 0,
  • "ignore_size_limit": false
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "nft_list": [
    ],
  • "success": true,
  • "error": "string"
}

Sets the DID of an NFT.

Sets the DID of an NFT.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
did_id
required
string
nft_coin_id
required
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "did_id": "string",
  • "nft_coin_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Gets an NFT wallet by its DID.

Gets an NFT wallet by its DID.

-
Authorizations:
bearerAuth
Request Body schema: application/json
did_id
required
string

Responses

Request samples

Content type
application/json
{
  • "did_id": "string"
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Gets the DID for an NFT wallet.

Gets the DID for an NFT wallet.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "did_id": "string",
  • "success": true,
  • "error": "string"
}

Gets all the wallets with a DID.

Gets all the wallets with a DID.

-
Authorizations:
bearerAuth
Request Body schema: application/json

Empty request body

-
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "nft_wallets": [
    ],
  • "success": true,
  • "error": "string"
}

Sets the status of an NFT.

Sets the status of an NFT.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
coin_id
required
string <hex>
in_transaction
required
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coin_id": "string",
  • "in_transaction": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Transfers an NFT to another address.

Transfers an NFT to another address.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
target_address
required
string <hex>
nft_coin_id
required
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "target_address": "string",
  • "nft_coin_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Transfers an NFT to another address.

Transfers an NFT to another address.

-
Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "royalty_assets": [
    ],
  • "fungible_assets": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ],
  • "success": true,
  • "error": "string"
}

Gets info about an NFT.

Gets info about an NFT.

-
Authorizations:
bearerAuth
Request Body schema: application/json
coin_id
required
string <hex>
latest
boolean
Default: true
ignore_size_limit
boolean
Default: false
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "latest": true,
  • "ignore_size_limit": false,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "nft_info": {
    },
  • "success": true,
  • "error": "string"
}

Adds an Uri to an NFT.

Adds a Uri to an NFT.

-
Authorizations:
bearerAuth
Request Body schema: application/json
wallet_id
required
integer <uint32>
uri
required
string <uri>
key
required
string
Enum: "u" "mu" "lu"

The type of uri:

+
include_data
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "type": 0,
  • "include_data": true
}

Response samples

Content type
application/json
{
  • "fingerprint": 0,
  • "wallets": [
    ],
  • "success": true,
  • "error": "string"
}

Creates a new wallet.

Creates a new wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Details of the wallet to create.

+
One of
mode
string
Enum: "new" "existing"
asset_id
string

Only used when mode is 'existing'

+
wallet_type
required
string
Enum: "cat_wallet" "did_wallet" "pool_wallet" "nft_wallet"

The type of wallet to create.

+
name
string

User supplied name for the wallet. Will default if not provided.

+
amount
integer <uint64>

The amount of mojo to deposit in the new wallet.

+
fee
integer <uint64>
Default: 0

The transaction fee amount in mojo.

+

Responses

Request samples

Content type
application/json
{
  • "did_id": "string",
  • "name": "string",
  • "wallet_type": "cat_wallet",
  • "amount": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "type": 0,
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Wallet Node

The wallet RPC API is exposed, by default, on port 9256 and contains methods for managing wallet, trades, offers and transactions.

+

Retrieves some information about the current network.

Retrieves some information about the current network.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "network_name": "mainnet",
  • "network_prefix": "xch",
  • "success": true,
  • "error": "string"
}

Retrieves the sync status of the wallet.

Retrieves the sync status of the wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "synced": true,
  • "syncing": true,
  • "genesis_initialized": true,
  • "success": true,
  • "error": "string"
}

Retrieves the sync height of the wallet.

Retrieves the sync height of the wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "height": 0,
  • "success": true,
  • "error": "string"
}

Pushes a transaction/spend bundle to the mempool and blockchain.

Pushes a transaction/spend bundle to the mempool and blockchain. Returns whether the spend bundle was successfully included into the mempool.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The spend bundle

+
required
object (spend_bundle)

Responses

Request samples

Content type
application/json
{
  • "spend_bundle": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Pushes multiple transactions spend bundle to the mempool and blockchain.

Pushes multiple transactions spend bundle to the mempool and blockchain.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The transaction list

+
required
Array of objects (transaction_record)

Responses

Request samples

Content type
application/json
{
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Retrieve the timestamp for a given block height.

Retrieve the timestamp for a given block height

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
height
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "height": 0
}

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "success": true,
  • "error": "string"
}

Resync the current logged in wallet. The transaction and offer records will be kept.

Resync the current logged in wallet

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
enable
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Data Layer Wallet

Methods for managing a data layer wallet.

+

Initialize the new data layer wallets.

Initialize the DataLayer Wallet (only one can exist).

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
root
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "root": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "launcher_id": "string",
  • "success": true,
  • "error": "string"
}

Track the new data layer wallet

Track the new data layer wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Stop tracking the data layer wallets.

Stop tracking the data layer wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Get the singleton records that contain the specified root.

Get the singleton records that contain the specified root.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>
root
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "root": "string"
}

Response samples

Content type
application/json
{
  • "singleton": {
    },
  • "success": true,
  • "error": "string"
}

Get the singleton records that contain the specified root.

Get the singleton records that contain the specified root.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>
root
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "root": "string"
}

Response samples

Content type
application/json
{
  • "singleton": [
    ],
  • "success": true,
  • "error": "string"
}

Update a data layer root.

Update a data layer root.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>
new_root
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "new_root": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "tx_record": {
    },
  • "success": true,
  • "error": "string"
}

Update multiple singletons with new merkle roots.

Update multiple singletons with new merkle roots.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "updates": [
    ]
}

Response samples

Content type
application/json
{
  • "tx_records": [
    ],
  • "success": true,
  • "error": "string"
}

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

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>
min_generation
integer <uint32>
max_generation
integer <uint32>
num_results
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "min_generation": 0,
  • "max_generation": 0,
  • "num_results": 0
}

Response samples

Content type
application/json
{
  • "count": 0,
  • "history": [
    ],
  • "success": true,
  • "error": "string"
}

Get all owned singleton records.

Get all owned singleton records.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "history": [
    ],
  • "success": true,
  • "error": "string"
}

Get all of the mirrors for a specific singleton.

Get all of the mirrors for a specific singleton.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string"
}

Response samples

Content type
application/json
{
  • "mirrors": [],
  • "success": true,
  • "error": "string"
}

Add a new on chain message for a specific singleton.

Add a new on chain message for a specific singleton

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
launcher_id
required
string <bytes32>
amount
required
integer <uint64>
urls
required
Array of strings <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "launcher_id": "string",
  • "amount": 0,
  • "urls": [
    ],
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

Remove an existing mirror for a specific singleton.

Remove an existing mirror for a specific singleton.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_id
required
string <bytes32>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

Verified Credential

Methods for managing verified credentials

+

Mint a verified credential using the assigned DID.

Mint a verified credential using the assigned DID

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
did_id
required
string <hex>
target_address
string <hex>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "did_id": "string",
  • "target_address": "string",
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "vc_record": {
    },
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

Given a launcher ID get the verified credential.

Given a launcher ID get the verified credential

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
vc_id
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "vc_id": "string"
}

Response samples

Content type
application/json
{
  • "vc_record": {
    },
  • "success": true,
  • "error": "string"
}

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
start
integer <uint32>
end
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "start": 0,
  • "end": 0
}

Response samples

Content type
application/json
{
  • "vc_records": [
    ],
  • "proofs": {
    },
  • "success": true,
  • "error": "string"
}

Spend a verified credential.

Spend a verified credential

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
vc_id
required
string <bytes32>
new_puzhash
string <bytes32>
new_proof_hash
string <bytes32>
provider_inner_puzhash
string <bytes32>
fee
integer <uint64>
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "vc_id": "string",
  • "new_puzhash": "string",
  • "new_proof_hash": "string",
  • "provider_inner_puzhash": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (vc_proofs)

Responses

Request samples

Content type
application/json
{
  • "proofs": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

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

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
root
required
string <bytes32>

Responses

Request samples

Content type
application/json
{
  • "root": "string"
}

Response samples

Content type
application/json
{
  • "proofs": {
    },
  • "success": true,
  • "error": "string"
}

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

Revoke an on chain VC provided the correct DID is available

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
vc_parent_id
required
string <bytes32>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "vc_parent_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

NFT Wallet

Mints NFTs in bulk.

Mints NFTs in bulk.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects

A list of dicts containing the metadata for each NFT to be minted

+
wallet_id
required
integer <uint32>
royalty_address
string <hex>
royalty_percentage
integer <uint16>
Default: 0
target_list
Array of strings <hex>

a list of targets for transferring minted NFTs (aka airdrop)

+
mint_number_start
integer
Default: 1

The starting point for mint number used in intermediate launcher puzzle

+
mint_total
integer

The total number of NFTs being minted

+
Array of objects (coin)

For use with bulk minting to provide the coin used for funding the minting spend. This coin can be one that will be created in the future

+
xch_change_target
string <hex>

For use with bulk minting, so we can specify the puzzle hash that the change from the funding transaction goes to.

+
new_innerpuzhash
string <hex>
new_p2_puzhash
string <hex>
object (coin)
did_lineage_parent_hex
string <hex>
mint_from_did
boolean
Default: false
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "metadata_list": [],
  • "wallet_id": 0,
  • "royalty_address": "string",
  • "royalty_percentage": 0,
  • "target_list": [
    ],
  • "mint_number_start": 1,
  • "mint_total": 0,
  • "xch_coins": [
    ],
  • "xch_change_target": "string",
  • "new_innerpuzhash": "string",
  • "new_p2_puzhash": "string",
  • "did_coin": {
    },
  • "did_lineage_parent_hex": "string",
  • "mint_from_did": false,
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "spend_bundle": {
    },
  • "nft_id_list": [
    ],
  • "success": true,
  • "error": "string"
}

Mints an NFT.

Mints an NFT.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
royalty_address
string <hex>
target_address
string <hex>
uris
required
Array of strings <uri>
meta_uris
Array of strings <uri>
license_uris
Array of strings <uri>
hash
required
string <hex>
edition_number
integer <uint64>
Default: 1
edition_total
integer <uint64>
Default: 1
fee
integer <uint64>
Default: 0
meta_hash
string <hex>
license_hash
string <hex>
did_id
string
royalty_percentage
integer <uint16>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "royalty_address": "string",
  • "target_address": "string",
  • "uris": [],
  • "meta_uris": [],
  • "license_uris": [],
  • "hash": "string",
  • "edition_number": 1,
  • "edition_total": 1,
  • "fee": 0,
  • "meta_hash": "string",
  • "license_hash": "string",
  • "did_id": "string",
  • "royalty_percentage": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "nft_id": "string",
  • "success": true,
  • "error": "string"
}

Gets NFTs from a wallet.

Gets NFTs from a wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
start_index
integer <uint32>
Default: 0
num
integer <uint32>
Default: 0
ignore_size_limit
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "start_index": 0,
  • "num": 0,
  • "ignore_size_limit": false
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "nft_list": [
    ],
  • "success": true,
  • "error": "string"
}

Sets the DID of an NFT.

Sets the DID of an NFT.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
did_id
required
string
nft_coin_id
required
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "did_id": "string",
  • "nft_coin_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Gets an NFT wallet by its DID.

Gets an NFT wallet by its DID.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
did_id
required
string

Responses

Request samples

Content type
application/json
{
  • "did_id": "string"
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "success": true,
  • "error": "string"
}

Gets the DID for an NFT wallet.

Gets the DID for an NFT wallet.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "did_id": "string",
  • "success": true,
  • "error": "string"
}

Gets all the wallets with a DID.

Gets all the wallets with a DID.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Empty request body

+
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "nft_wallets": [
    ],
  • "success": true,
  • "error": "string"
}

Sets the status of an NFT.

Sets the status of an NFT.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
coin_id
required
string <hex>
in_transaction
required
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coin_id": "string",
  • "in_transaction": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Transfers an NFT to another address.

Transfers an NFT to another address.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
target_address
required
string <hex>
nft_coin_id
required
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "target_address": "string",
  • "nft_coin_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Transfers an NFT to another address.

Transfers an NFT to another address.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "royalty_assets": [
    ],
  • "fungible_assets": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ],
  • "success": true,
  • "error": "string"
}

Gets info about an NFT.

Gets info about an NFT.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_id
required
string <hex>
latest
boolean
Default: true
ignore_size_limit
boolean
Default: false
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "latest": true,
  • "ignore_size_limit": false,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "nft_info": {
    },
  • "success": true,
  • "error": "string"
}

Adds an Uri to an NFT.

Adds a Uri to an NFT.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
uri
required
string <uri>
key
required
string
Enum: "u" "mu" "lu"

The type of uri:

  • u Uri for the NFT data
  • mu Uri for NFT metadata
  • lu Uri for the NFT license
-
nft_coin_id
required
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "uri": "http://example.com",
  • "key": "u",
  • "nft_coin_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Bulk set DID for NFTs across different wallets.

Bulk set DID for NFTs across different wallets

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects <= 25 items
did_id
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "nft_coin_list": [
    ],
  • "did_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "tx_num": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Bulk transfer NFTs to an address.

Bulk transfer NFTs to an address

-
Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects <= 25 items
target_address
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "nft_coin_list": [
    ],
  • "target_address": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "tx_num": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the number of NFTs in a wallet.

Retrieves the number of NFTs in a wallet

-
Authorizations:
bearerAuth
Request Body schema: application/json

Request body with the Id of a wallet

-
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "count": 0,
  • "success": true,
  • "error": "string"
}

Coins

Retrieves the coins for given coin IDs.

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

-
Authorizations:
bearerAuth
Request Body schema: application/json

The coin names.

-
names
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "names": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the coins that match given filter criteria.

Retrieves the coins that match given filter criteria

-
Authorizations:
bearerAuth
Request Body schema: application/json

The coin names.

-
offset
integer <uint32>
Default: 0
limit
integer <uint32>
wallet_id
integer <uint32>
wallet_type
integer <uint8> (wallet_type)
Enum: 0 2 3 4 5 6 7 8 9 10 11 12 13

The type of wallet:

+
nft_coin_id
required
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "uri": "http://example.com",
  • "key": "u",
  • "nft_coin_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Bulk set DID for NFTs across different wallets.

Bulk set DID for NFTs across different wallets

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects <= 25 items
did_id
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "nft_coin_list": [
    ],
  • "did_id": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "tx_num": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Bulk transfer NFTs to an address.

Bulk transfer NFTs to an address

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects <= 25 items
target_address
string <hex>
fee
integer <uint64>
Default: 0
reuse_puzhash
boolean

Responses

Request samples

Content type
application/json
{
  • "nft_coin_list": [
    ],
  • "target_address": "string",
  • "fee": 0,
  • "reuse_puzhash": true
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "tx_num": 0,
  • "spend_bundle": {
    },
  • "success": true,
  • "error": "string"
}

Retrieves the number of NFTs in a wallet.

Retrieves the number of NFTs in a wallet

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body with the Id of a wallet

+
wallet_id
required
integer <uint32>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0
}

Response samples

Content type
application/json
{
  • "wallet_id": 0,
  • "count": 0,
  • "success": true,
  • "error": "string"
}

Coins

Retrieves the coins for given coin IDs.

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

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The coin names.

+
names
required
Array of strings <hex>
start_height
integer <uint32>
end_height
integer <uint32>
include_spent_coins
boolean

Responses

Request samples

Content type
application/json
{
  • "names": [
    ],
  • "start_height": 0,
  • "end_height": 0,
  • "include_spent_coins": true
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "success": true,
  • "error": "string"
}

Retrieves the coins that match given filter criteria.

Retrieves the coins that match given filter criteria

+
Authorizations:
bearerAuth
Request Body schema: application/json
required

The coin names.

+
offset
integer <uint32>
Default: 0
limit
integer <uint32>
wallet_id
integer <uint32>
wallet_type
integer <uint8> (wallet_type)
Enum: 0 2 3 4 5 6 7 8 9 10 11 12 13 57

The type of wallet:

  • 0 STANDARD_WALLET
  • 2 ATOMIC_SWAP
    • @@ -908,23 +1381,47 @@
  • 11 DATA_LAYER
  • 12 DATA_LAYER_OFFER
  • 13 VC
    • +
  • 57 CRCAT
-
coin_type
integer <uint8> (coin_type)
Enum: 0 1

The type of coin:

+
coin_type
integer <uint8> (coin_type)
Enum: 0 1 2 3

The type of coin:

  • 0 NORMAL
  • 1 CLAWBACK
    • +
  • 2 CRCAT_PENDING
    • +
  • 3 CRCAT
-
object (hash_filter)
object (hash_filter)
object (hash_filter)
object (amount_filter)
object (uint64_range)
object (uint32_range)
object (uint32_range)
order
integer <uint8> (coin_record_order)
Enum: 1 2

The sort by item:

+
object (hash_filter)
object (hash_filter)
object (hash_filter)
object (amount_filter)
object (uint64_range)
object (uint32_range)
object (uint32_range)
order
integer <uint8> (coin_record_order)
Enum: 1 2

The sort by item:

  • 1 confirmed_height
  • 2 spent_height
-
reverse
boolean
Default: false
include_total_count
boolean
Default: false

Include the total number of entries for the query without applying offset/limit

-

Responses

Request samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "wallet_id": 0,
  • "wallet_type": 0,
  • "coin_type": 0,
  • "coin_id_filter": {
    },
  • "puzzle_hash_filter": {
    },
  • "parent_coin_id_filter": {
    },
  • "amount_filter": {
    },
  • "amount_range": {
    },
  • "confirmed_range": {
    },
  • "spent_range": {
    },
  • "order": 1,
  • "reverse": false,
  • "include_total_count": false
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "total_count": 0,
  • "success": true,
  • "error": "string"
}
+
reverse
boolean
Default: false
include_total_count
boolean
Default: false

Include the total number of entries for the query without applying offset/limit

+

Responses

Request samples

Content type
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "wallet_id": 0,
  • "wallet_type": 0,
  • "coin_type": 0,
  • "coin_id_filter": {
    },
  • "puzzle_hash_filter": {
    },
  • "parent_coin_id_filter": {
    },
  • "amount_filter": {
    },
  • "amount_range": {
    },
  • "confirmed_range": {
    },
  • "spent_range": {
    },
  • "order": 1,
  • "reverse": false,
  • "include_total_count": false
}

Response samples

Content type
application/json
{
  • "coin_records": [
    ],
  • "total_count": 0,
  • "success": true,
  • "error": "string"
}

CR-CATs

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.

+
Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
min_amount_to_claim
integer <uint64>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "min_amount_to_claim": 0,
  • "fee": 0
}

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}
@@ -2021,6 +2035,9 @@
  • insert
    • +
  • + walletLogIn +
  • Mirrors
    • @@ -2103,7 +2120,7 @@

    Chia RPC

    + +
    +
    +
    +
    +

    walletLogIn

    +

    Logs into the wallet.

    +
    +

    Logs into the wallet.

    +

    post

    + 
    /wallet_log_in
    + +

    Usage

    +
    +
    + 
    curl -X POST --insecure \
+--cert ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.crt \
+--key ~/.chia/mainnet/config/ssl/data_layer/private_data_layer.key  \
+-H "Accept: application/json" \
+-H "Content-Type: application/json" \
+"https://localhost:8562/wallet_log_in" \
+-d "{}"
    +

    Parameters

    + + + +
    Body parameters
    + + + + + + + + +
    NameDescription
    body * + + + +
    +
    + + + +

    Responses

    +

    Status: 200 - OK response without return values

    + + + +
    +
    +
    + +
    + +
    +
    +
    diff --git a/docs/static/farmer.html b/docs/static/farmer.html index 7a1e1c2..008e33c 100644 --- a/docs/static/farmer.html +++ b/docs/static/farmer.html @@ -1447,7 +1447,7 @@

    Chia RPC