API docs by Redocly

Chia RPC (2.4.3)

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
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"
}

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",
  • "genesis_challenge": "f4c0c9d5b3cd59d6f7c76ecd780e646a2c55064367d0ddbb42b2b6462a4674b2",
  • "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"
}

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": {
    },
  • "transactions": [
    ],
  • "offer": "string",
  • "signing_responses": [
    ],
  • "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
{
  • "transactions": [
    ],
  • "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
{
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ],
  • "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> [ items <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",
  • "transactions": [
    ],
  • "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",
  • "transactions": [
    ],
  • "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",
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ],
  • "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> [ items <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
{
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ]
}

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> [ items <hex > ]
puzzle_announcements
Array of strings <hex> [ items <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": {
    },
  • "fee_transaction": {
    },
  • "total_fee": 0,
  • "transactions": [
    ],
  • "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": {
    },
  • "fee_transaction": {
    },
  • "total_fee": 0,
  • "transactions": [
    ],
  • "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": {
    },
  • "fee_transaction": {
    },
  • "state": {
    },
  • "transactions": [
    ],
  • "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 <uint32>
end
integer <uint32>

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": {
    },
  • "transactions": [
    ],
  • "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> [ items <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",
  • "transactions": [
    ],
  • "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",
  • "transactions": [
    ],
  • "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",
  • "transactions": [
    ],
  • "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> [ items <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> [ items <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": [
    ],
  • "transactions": [
    ],
  • "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
  • 3 AUTHORIZED_PAYEE
  • 4 MULTI_SIG
  • 5 CUSTODY
  • 6 CAT
  • 7 RECOVERABLE
  • 8 DISTRIBUTED_ID
  • 9 POOLING_WALLET
  • 10 NFT
  • 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
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" "dso_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
{
  • "mode": "new",
  • "dao_rules": {
    },
  • "amount_of_cats": 0,
  • "filter_amount": 0,
  • "fee": 0,
  • "fee_for_cat": 0,
  • "treasury_id": "string",
  • "wallet_type": "cat_wallet",
  • "name": "string",
  • "amount": 0
}

Response samples

Content type
application/json
{
  • "type": 0,
  • "wallet_id": 0,
  • "treasury_id": "string",
  • "cat_wallet_id": 0,
  • "dao_cat_wallet_id": 0,
  • "transactions": [
    ],
  • "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 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": {
    },
  • "transactions": [
    ],
  • "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
fee
integer <uint64>
Default: 0

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "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> [ items <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> [ items <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": [
    ],
  • "transactions": [
    ],
  • "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> [ items <uri > ]
meta_uris
Array of strings <uri> [ items <uri > ]
license_uris
Array of strings <uri> [ items <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",
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ],
  • "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": {
    },
  • "transactions": [
    ],
  • "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> [ items <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
  • 3 AUTHORIZED_PAYEE
  • 4 MULTI_SIG
  • 5 CUSTODY
  • 6 CAT
  • 7 RECOVERABLE
  • 8 DISTRIBUTED_ID
  • 9 POOLING_WALLET
  • 10 NFT
  • 11 DATA_LAYER
  • 12 DATA_LAYER_OFFER
  • 13 VC
  • 57 CRCAT
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:

  • 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"
}

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"
}

DAO Wallet

Get all proposals for a given dao wallet.

Get all proposals for a given dao wallet

Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
include_closed
boolean

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "include_closed": true
}

Response samples

Content type
application/json
{
  • "proposals": [
    ],
  • "proposal_timelock": 0,
  • "soft_close_length": 0,
  • "success": true,
  • "error": "string"
}

Creates a DAO proposal.

Creates a DAO proposal

Authorizations:
bearerAuth
Request Body schema: application/json
required
One of
Array of objects (amount_with_puzzlehash)
amount
integer <uint64>
inner_address
string <hex>
asset_id
string <hex>
wallet_id
required
integer <uint32>
proposal_type
required
string
Enum: "spend" "update" "mint"

Responses

Request samples

Content type
application/json
{
  • "additions": [
    ],
  • "amount": 0,
  • "cat_target_address": "string",
  • "wallet_id": 0,
  • "proposal_type": "spend"
}

Response samples

Content type
application/json
{
  • "proposal_id": "string",
  • "tx_id": "string",
  • "tx": {
    },
  • "transactions": [
    ],
  • "success": true,
  • "error": "string"
}

Parses a DAO proposal.

Parses a DAO proposal

Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
proposal_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "proposal_id": "string"
}

Response samples

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

Vote on a DAO proposal.

Vote on a DAO proposal

Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
proposal_id
required
string <hex>
vote_amount
required
integer <uint64>
is_yes_vote
required
boolean
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "proposal_id": "string",
  • "vote_amount": 0,
  • "is_yes_vote": true,
  • "fee": 0
}

Response samples

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

Retrieves the balance of a DAO's treasury.

Retrieves the balance of a DAO's treasury

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

Responses

Request samples

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

Response samples

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

Retrieves the treasury id of a DAO wallet.

Retrieves the treasury id of a DAO wallet

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

Responses

Request samples

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

Response samples

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

Retrieves the rules of a DAO wallet.

Retrieves the rules of a DAO wallet

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

Responses

Request samples

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

Response samples

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

Closes a DAO proposal.

Closes a DAO proposal

Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
proposal_id
required
string <hex>
genesis_id
string <hex>
self_destruct
string
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "proposal_id": "string",
  • "genesis_id": "string",
  • "self_destruct": "string",
  • "fee": 0
}

Response samples

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

Exits the DAO lockup period.

Exits the DAO lockup period

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

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "coins": [
    ],
  • "fee": 0
}

Response samples

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

Adjusts the DAO filter level.

Adjusts the DAO filter level

Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
filter_level
required
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "filter_level": 0
}

Response samples

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

Adds funds to a DAO's treasury.

Adds funds to a DAO's treasury

Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
funding_wallet_id
required
integer <uint32>
amount
required
integer <uint64>
fee
integer <uint64>
Default: 0

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "funding_wallet_id": 0,
  • "amount": 0,
  • "fee": 0
}

Response samples

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

Sends the DAO to lockup.

Sends the DAO to lockup

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

Responses

Request samples

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

Response samples

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

Retrieves the state of a DAO proposal

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

Authorizations:
bearerAuth
Request Body schema: application/json
required
wallet_id
required
integer <uint32>
proposal_id
required
string <hex>

Responses

Request samples

Content type
application/json
{
  • "wallet_id": 0,
  • "proposal_id": "string"
}

Response samples

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

Frees coins from proposals that are finished.

Frees coins from proposals that are finished

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

Responses

Request samples

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

Response samples

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

Data Layer

Verifies a proof.

Verify a proof of inclusion for a DL singleton.

Authorizations:
bearerAuth
Request Body schema: application/json
required
coin_id
string <bytes32>
inner_puzzle_hash
string <bytes32>
object (store_proofs)

Responses

Request samples

Content type
application/json
{
  • "coin_id": "string",
  • "inner_puzzle_hash": "string",
  • "store_proofs": {
    }
}

Response samples

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

Signing

Gathers information for signing.

Gathers information for signing.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects (spend)

Responses

Request samples

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

Response samples

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

Applies signatures to a list of spends.

Applies signatures to a list of spends.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects (spend)
required
Array of objects (signing_response)

Responses

Request samples

Content type
application/json
{
  • "spends": [
    ],
  • "signing_responses": [
    ]
}

Response samples

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

Submits a list of signed transactions.

Submits a list of signed transactions.

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
Array of objects (signed_transaction)

Responses

Request samples

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

Response samples

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

Executes signing instructions.

Executes signing instructions.

Authorizations:
bearerAuth
Request Body schema: application/json
required
partial_allowed
boolean
Default: false
required
object (signing_instructions)

Responses

Request samples

Content type
application/json
{
  • "partial_allowed": false,
  • "signing_instructions": {
    }
}

Response samples

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