diff --git a/docs/redoc/crawler.html b/docs/redoc/crawler.html index faf4009..5640630 100644 --- a/docs/redoc/crawler.html +++ b/docs/redoc/crawler.html @@ -2174,7 +2174,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

Chia RPC (1.6.1)

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 (1.6.2)

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.

@@ -2215,7 +2215,7 @@

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

Responses

+

Status: 200 - OK

+ + + +
+
+
+ +
+ +
+
+
@@ -7276,7 +7703,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_23" + "$ref" : "#/components/schemas/inline_response_200_25" } } } @@ -7390,14 +7817,135 @@

Status: 200 - OK

+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+

didGetInfo

+

Retreives information about a DID.

+
+

Retreives information about a DID

+

post

+ 
/did_get_info
+ +

Usage

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

Parameters

+ + + +
Body parameters
+ + + + + + + + +
NameDescription
body * + + + +
+
+ + + +

Responses

+

Status: 200 - OK

+ +
-
-
+
+
- +
@@ -7534,7 +8082,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_20" + "$ref" : "#/components/schemas/inline_response_200_22" } } } @@ -7663,7 +8211,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_30" + "$ref" : "#/components/schemas/inline_response_200_32" } } } @@ -7792,7 +8340,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_22" + "$ref" : "#/components/schemas/inline_response_200_24" } } } @@ -7921,7 +8469,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_25" + "$ref" : "#/components/schemas/inline_response_200_27" } } } @@ -8050,7 +8598,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_28" + "$ref" : "#/components/schemas/inline_response_200_30" } } } @@ -8079,6 +8627,127 @@

Status: 200 - OK

+
+
+
+
+
+

didMessageSpend

+

Spends a DID message.

+
+

Spends a DID message

+

post

+ 
/did_message_spend
+ +

Usage

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

Parameters

+ + + +
Body parameters
+ + + + + + + + +
NameDescription
body * + + + +
+
+ + + +

Responses

+

Status: 200 - OK

+ + + +
+
+
+ +
+ +
+
+
@@ -8171,7 +8840,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_24" + "$ref" : "#/components/schemas/inline_response_200_26" } } } @@ -8292,7 +8961,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_27" + "$ref" : "#/components/schemas/inline_response_200_29" } } } @@ -8413,7 +9082,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_19" + "$ref" : "#/components/schemas/inline_response_200_21" } } } @@ -8534,7 +9203,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_29" + "$ref" : "#/components/schemas/inline_response_200_31" } } } @@ -10236,7 +10905,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_58" + "$ref" : "#/components/schemas/inline_response_200_60" } } } @@ -10365,7 +11034,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_59" + "$ref" : "#/components/schemas/inline_response_200_61" } } } @@ -10738,7 +11407,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_55" + "$ref" : "#/components/schemas/inline_response_200_57" } } } @@ -10858,8 +11527,130 @@

Status: 200 - OK

-
-
+
+
+ +
+ +
+
+ + +
+
+
+
+

getPublicKeys

+

Retrieves all public keys on the node.

+
+

Retrieves all public keys on the node.

+

post

+ 
/get_public_keys
+ +

Usage

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

Parameters

+ + + +
Body parameters
+ + + + + + + + +
NameDescription
body * + + + +
+
+ + + +

Responses

+

Status: 200 - OK

+ + + +
+
+
- +
-
-
+
+
-

getPublicKeys

-

Retrieves all public keys on the node.

+

logIn

+

Logs in the wallet with a specific key.

-

Retrieves all public keys on the node.

+

Logs in the wallet with a specific key.

post

- 
/get_public_keys
+ 
/log_in

Usage

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

Parameters

@@ -10935,11 +11726,18 @@

Parameters

-
+
@@ -10974,14 +11772,14 @@

Status: 200 - OK

-
-
+
+
- +
-
-
+
+
-

logIn

-

Logs in the wallet with a specific key.

+

verifySignature

+

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

-

Logs in the wallet with a specific key.

+

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

post

- 
/log_in
+ 
/verify_signature

Usage

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

Parameters

@@ -11057,18 +11855,11 @@

Parameters

-
+
@@ -11103,14 +11894,14 @@

Status: 200 - OK

-
-
+
+
- +
@@ -11364,7 +12155,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_11" + "$ref" : "#/components/schemas/inline_response_200_14" } } } @@ -11485,7 +12276,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_16" + "$ref" : "#/components/schemas/inline_response_200_18" } } } @@ -11606,7 +12397,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_13" + "$ref" : "#/components/schemas/inline_response_200_15" } } } @@ -11727,7 +12518,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_17" + "$ref" : "#/components/schemas/inline_response_200_19" } } } @@ -11848,7 +12639,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_12" + "$ref" : "#/components/schemas/inline_response_200_13" } } } @@ -11977,7 +12768,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_14" + "$ref" : "#/components/schemas/inline_response_200_16" } } } @@ -12099,7 +12890,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_15" + "$ref" : "#/components/schemas/inline_response_200_17" } } } @@ -12341,7 +13132,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_11" + "$ref" : "#/components/schemas/inline_response_200_12" } } } @@ -12370,6 +13161,127 @@

Status: 200 - OK

+
+
+
+
+
+

nftSetBulkNftDid

+

Bulk set DID for NFTs across different wallets.

+
+

Bulk set DID for NFTs across different wallets

+

post

+ 
/nft_set_bulk_nft_did
+ +

Usage

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

Parameters

+ + + +
Body parameters
+ + + + + + + + +
NameDescription
body * + + + +
+
+ + + +

Responses

+

Status: 200 - OK

+ + + +
+
+
+ +
+ +
+
+
@@ -12462,7 +13374,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_11" + "$ref" : "#/components/schemas/inline_response_200_14" } } } @@ -12704,7 +13616,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_11" + "$ref" : "#/components/schemas/inline_response_200_14" } } } @@ -12951,7 +13863,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_62" + "$ref" : "#/components/schemas/inline_response_200_64" } } } @@ -13073,7 +13985,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_63" + "$ref" : "#/components/schemas/inline_response_200_65" } } } @@ -13195,7 +14107,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_64" + "$ref" : "#/components/schemas/inline_response_200_66" } } } @@ -13317,7 +14229,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_64" + "$ref" : "#/components/schemas/inline_response_200_67" } } } @@ -13441,7 +14353,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_44" + "$ref" : "#/components/schemas/inline_response_200_46" } } } @@ -13562,7 +14474,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_43" + "$ref" : "#/components/schemas/inline_response_200_45" } } } @@ -13683,7 +14595,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_43" + "$ref" : "#/components/schemas/inline_response_200_45" } } } @@ -13812,7 +14724,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_45" + "$ref" : "#/components/schemas/inline_response_200_47" } } } @@ -14671,7 +15583,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_47" + "$ref" : "#/components/schemas/inline_response_200_49" } } } @@ -14921,7 +15833,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_46" + "$ref" : "#/components/schemas/inline_response_200_48" } } } @@ -15043,7 +15955,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_46" + "$ref" : "#/components/schemas/inline_response_200_48" } } } @@ -15165,7 +16077,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_49" + "$ref" : "#/components/schemas/inline_response_200_51" } } } @@ -15286,7 +16198,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_53" + "$ref" : "#/components/schemas/inline_response_200_55" } } } @@ -15407,7 +16319,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_50" + "$ref" : "#/components/schemas/inline_response_200_52" } } } @@ -15536,7 +16448,7 @@

Status: 200 - OK response with a transaction record and a transaction id. < "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_19" + "$ref" : "#/components/schemas/inline_response_200_21" } } } @@ -15665,7 +16577,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_52" + "$ref" : "#/components/schemas/inline_response_200_54" } } } @@ -15786,7 +16698,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_51" + "$ref" : "#/components/schemas/inline_response_200_53" } } } @@ -15915,7 +16827,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_48" + "$ref" : "#/components/schemas/inline_response_200_50" } } } @@ -16036,7 +16948,7 @@

Status: 200 - OK response with a transaction record and a transaction id. < "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_19" + "$ref" : "#/components/schemas/inline_response_200_21" } } } @@ -16157,7 +17069,7 @@

Status: 200 - OK response with a transaction record and a transaction id. < "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_19" + "$ref" : "#/components/schemas/inline_response_200_21" } } } @@ -16282,7 +17194,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_67" + "$ref" : "#/components/schemas/inline_response_200_71" } } } @@ -16404,7 +17316,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_66" + "$ref" : "#/components/schemas/inline_response_200_70" } } } @@ -16529,7 +17441,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_61" + "$ref" : "#/components/schemas/inline_response_200_63" } } } @@ -16651,7 +17563,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_60" + "$ref" : "#/components/schemas/inline_response_200_62" } } } @@ -16895,7 +17807,7 @@

Status: 200 - OK

"content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/inline_response_200_54" + "$ref" : "#/components/schemas/inline_response_200_56" } } } diff --git a/package-lock.json b/package-lock.json index e3e2a3b..8fa0d80 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "license": "Apache License 2.0", "dependencies": { "@redocly/cli": "^1.0.0-beta.120", - "redoc-cli": "^0.13.20" + "redoc-cli": "^0.13.17" }, "devDependencies": { "js-yaml": "^4.1.0", diff --git a/package.json b/package.json index 2a8506f..121879a 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "homepage": "https://github.com/dkackman/chia-api#readme", "dependencies": { "@redocly/cli": "^1.0.0-beta.120", - "redoc-cli": "^0.13.20" + "redoc-cli": "^0.13.17" }, "devDependencies": { "js-yaml": "^4.1.0",