mirror of
https://github.com/fullstack-cash/bch-api.git
synced 2026-09-21 16:52:04 -07:00
3099 lines
68 KiB
JSON
3099 lines
68 KiB
JSON
{
|
|
"components": {
|
|
"schemas": {
|
|
"Address": {
|
|
"type": "string"
|
|
},
|
|
"Hash": {
|
|
"type": "string"
|
|
},
|
|
"Txid": {
|
|
"type": "string"
|
|
},
|
|
"SLPConvert": {
|
|
"type": "object",
|
|
"properties": {
|
|
"addresses": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/SLPConvert"
|
|
},
|
|
"example": []
|
|
}
|
|
}
|
|
},
|
|
"SLPTxid": {
|
|
"type": "string"
|
|
},
|
|
"RawTxid": {
|
|
"type": "string"
|
|
},
|
|
"Hex": {
|
|
"type": "string"
|
|
},
|
|
"Height": {
|
|
"type": "number"
|
|
},
|
|
"Proof": {
|
|
"type": "string"
|
|
},
|
|
"Addresses": {
|
|
"type": "object",
|
|
"properties": {
|
|
"addresses": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Address"
|
|
},
|
|
"example": [
|
|
"bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr",
|
|
"bchtest:qp6hgvevf4gzz6l7pgcte3gaaud9km0l459fa23dul"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"Hashes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hashes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Hash"
|
|
},
|
|
"example": [
|
|
"000000000000014c11d5a6fd30e03e56e55d516f193ff0768c9c81177858d12a",
|
|
"000000000001a7c0aaa2630fbb2c0e476aafffc60f82177375b2aaa22209f606"
|
|
]
|
|
},
|
|
"verbose": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"BlockHashes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hashes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Hash"
|
|
},
|
|
"example": []
|
|
}
|
|
}
|
|
},
|
|
"BlockHeights": {
|
|
"type": "object",
|
|
"properties": {
|
|
"heights": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Heights"
|
|
},
|
|
"example": []
|
|
}
|
|
}
|
|
},
|
|
"Heights": {
|
|
"type": "object",
|
|
"properties": {
|
|
"heights": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Heights"
|
|
},
|
|
"example": []
|
|
}
|
|
}
|
|
},
|
|
"Hexes": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hexes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Hex"
|
|
},
|
|
"example": [
|
|
"01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000",
|
|
"01000000013ba3edfd7a7b12b27ac72c3e67768f617fc81bc3888a51323a9fb8aa4b1e5e4a000000006a4730440220540986d1c58d6e76f8f05501c520c38ce55393d0ed7ed3c3a82c69af04221232022058ea43ed6c05fec0eccce749a63332ed4525460105346f11108b9c26df93cd72012103083dfc5a0254613941ddc91af39ff90cd711cdcde03a87b144b883b524660c39ffffffff01807c814a000000001976a914d7e7c4e0b70eaa67ceff9d2823d1bbb9f6df9a5188ac00000000"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"Txids": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txids": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Txid"
|
|
},
|
|
"example": [
|
|
"3ea2767c91d087d14dda8faef736cd39d6c6ebbd5f7d2c7e8de0df3360436bfb",
|
|
"cce4e8eb4b3160b93ceecb0956cde405d85b42cbcb3fa1b4e9a9bedaf3476f05"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"SLPListBulk": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tokenIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/SLPListBulk"
|
|
},
|
|
"example": []
|
|
}
|
|
}
|
|
},
|
|
"SLPTxids": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txids": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/SLPTxid"
|
|
},
|
|
"example": [
|
|
"3ea2767c91d087d14dda8faef736cd39d6c6ebbd5f7d2c7e8de0df3360436bfb",
|
|
"cce4e8eb4b3160b93ceecb0956cde405d85b42cbcb3fa1b4e9a9bedaf3476f05"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"RawTxids": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txids": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/RawTxid"
|
|
},
|
|
"example": [
|
|
"3ea2767c91d087d14dda8faef736cd39d6c6ebbd5f7d2c7e8de0df3360436bfb",
|
|
"cce4e8eb4b3160b93ceecb0956cde405d85b42cbcb3fa1b4e9a9bedaf3476f05"
|
|
]
|
|
},
|
|
"verbose": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"Proofs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"proofs": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Proof"
|
|
},
|
|
"example": [
|
|
"000000207fd83434a2e506e874567d0468e051a1e1a56ae29672db125500ad100000000097833baeefae6471fa1f1040c911d1cf9781b1e0c890ed7a2179eb7361ff4607d237fd5bffff001d11d727fe120000000694897b6e79132eb38bc5eededa7c31876261dc42cb81597b90dbf0c0178c0d2292c8178f0211f94185828b8dee76e0a8169840fd372d38ff3bd835081e308c46fb6b436033dfe08d7e2c7d5fbdebc6d639cd36f7ae8fda4dd187d0917c76a23e8957429343eb39d015012cc6841844ee75b2b1db162ac21c7bcb2113fb9fd04a8d7105af6ff5d10fce215fccf60d28e8c4cc477f9747e11460f1e9db9cf2321ff1358b92e35ccead57f5db006a3a9d07b4a33c8153230bef4935a04f42715a1402d700",
|
|
"00000020f5bcc14625b1a1ce0959465e9002f7e0a02f23039d0759440217000000000000db067508838ed35f03f0a5e6e258b4f0886daaf0729361c70f11ad3f3ced3b693a9ba45b9726021a1d5b3b561b000000065e312e41a47a2874e3eac76a42b8bf6749cd0501dced7365bd5afdc27a89ec013e4dc7f75491345447c16b985a18ff3ef6d38eb5b5562dae3e95a03a36ea3818056f47f3dabea9e9b4a13fcbcb425bd805e4cd5609cbee3cb960314bebe8e4ccc85c3fc0283f706f4708ee14d559d5b3184d9974145d6ad4ade702c8eb8579166b4fa9137e19341f5a6bc3f018c49e3325f625307242fc60811b815f56509cdd74b81f7aa0b43545bbf6e512c47ec90d350c0c655ad2abe9ef72df112845504102d700"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"AddressDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"balance": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"balanceSat": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"totalReceived": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"totalReceivedSat": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"totalSent": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"totalSentSat": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"unconfirmedBalance": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"unconfirmedBalanceSat": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"unconfirmedTxAppearances": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"txAppearances": {
|
|
"type": "number"
|
|
},
|
|
"transactions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"legacyAddress": {
|
|
"type": "string"
|
|
},
|
|
"cashAddress": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"AddressDetailsArray": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/AddressDetails"
|
|
}
|
|
},
|
|
"AddressUtxo": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Utxo"
|
|
}
|
|
},
|
|
"AddressUtxoArray": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/AddressUtxo"
|
|
},
|
|
"example": []
|
|
},
|
|
"Utxo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"vout": {
|
|
"type": "number"
|
|
},
|
|
"scriptPubKey": {
|
|
"type": "string"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"satoshis": {
|
|
"type": "number"
|
|
},
|
|
"height": {
|
|
"type": "number"
|
|
},
|
|
"confirmations": {
|
|
"type": "number"
|
|
},
|
|
"legacyAddress": {
|
|
"type": "string"
|
|
},
|
|
"cashAddress": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"AddressUnconfirmed": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/Unconfirmed"
|
|
}
|
|
},
|
|
"AddressUnconfirmedArray": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/AddressUnconfirmed"
|
|
},
|
|
"example": []
|
|
},
|
|
"Unconfirmed": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"vout": {
|
|
"type": "number"
|
|
},
|
|
"scriptPubKey": {
|
|
"type": "string"
|
|
},
|
|
"amount": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"satoshis": {
|
|
"type": "number"
|
|
},
|
|
"height": {
|
|
"type": "number"
|
|
},
|
|
"confirmations": {
|
|
"type": "number"
|
|
},
|
|
"legacyAddress": {
|
|
"type": "string"
|
|
},
|
|
"cashAddress": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"BlockDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"height": {
|
|
"type": "number"
|
|
},
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"merkleroot": {
|
|
"type": "string"
|
|
},
|
|
"tx": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"time": {
|
|
"type": "number"
|
|
},
|
|
"nonce": {
|
|
"type": "number"
|
|
},
|
|
"bits": {
|
|
"type": "string"
|
|
},
|
|
"difficulty": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"chainwork": {
|
|
"type": "string"
|
|
},
|
|
"confirmations": {
|
|
"type": "number"
|
|
},
|
|
"previousblockhash": {
|
|
"type": "string"
|
|
},
|
|
"nextblockhash": {
|
|
"type": "string"
|
|
},
|
|
"reward": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"isMainChain": {
|
|
"type": "boolean"
|
|
},
|
|
"poolInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"poolName": "string",
|
|
"url": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"BestBlockHash": {
|
|
"type": "string"
|
|
},
|
|
"Block": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"confirmations": {
|
|
"type": "number"
|
|
},
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"height": {
|
|
"type": "number"
|
|
},
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"versionHex": {
|
|
"type": "string"
|
|
},
|
|
"merkleroot": {
|
|
"type": "string"
|
|
},
|
|
"tx": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"time": {
|
|
"type": "number"
|
|
},
|
|
"mediantime": {
|
|
"type": "number"
|
|
},
|
|
"nonce": {
|
|
"type": "number"
|
|
},
|
|
"bits": {
|
|
"type": "string"
|
|
},
|
|
"difficulty": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"chainwork": {
|
|
"type": "string"
|
|
},
|
|
"previousblockhash": {
|
|
"type": "string"
|
|
},
|
|
"nextblockhash": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"BlockchainInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"chain": {
|
|
"type": "string"
|
|
},
|
|
"blocks": {
|
|
"type": "number"
|
|
},
|
|
"headers": {
|
|
"type": "number"
|
|
},
|
|
"bestblockhash": {
|
|
"type": "string"
|
|
},
|
|
"difficulty": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"mediantime": {
|
|
"type": "number"
|
|
},
|
|
"verificationprogress": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"chainwork": {
|
|
"type": "string"
|
|
},
|
|
"pruned": {
|
|
"type": "boolean"
|
|
},
|
|
"softforks": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": "string",
|
|
"version": "number",
|
|
"reject": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": "boolean"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"bip9_softforks": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": "string",
|
|
"startTime": "number",
|
|
"timeout": "number",
|
|
"since": "number"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"BlockCount": {
|
|
"type": "number"
|
|
},
|
|
"BlockHash": {
|
|
"type": "string"
|
|
},
|
|
"BlockHeader": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"confirmations": {
|
|
"type": "number"
|
|
},
|
|
"height": {
|
|
"type": "number"
|
|
},
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"versionHex": {
|
|
"type": "string"
|
|
},
|
|
"merkleroot": {
|
|
"type": "string"
|
|
},
|
|
"time": {
|
|
"type": "number"
|
|
},
|
|
"mediantime": {
|
|
"type": "number"
|
|
},
|
|
"nonce": {
|
|
"type": "number"
|
|
},
|
|
"bits": {
|
|
"type": "string"
|
|
},
|
|
"difficulty": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"chainwork": {
|
|
"type": "string"
|
|
},
|
|
"previousblockhash": {
|
|
"type": "string"
|
|
},
|
|
"nextblockhash": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"Difficulty": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"MempoolInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"bytes": {
|
|
"type": "number"
|
|
},
|
|
"usage": {
|
|
"type": "number"
|
|
},
|
|
"maxmempool": {
|
|
"type": "number"
|
|
},
|
|
"mempoolminfee": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"RawMempool": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"DecodeRawTransaction": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"vin": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"vout": {
|
|
"type": "number"
|
|
},
|
|
"scriptSig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"asm": {
|
|
"type": "string"
|
|
},
|
|
"hex": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"sequence": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"vout": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "number"
|
|
},
|
|
"n": {
|
|
"type": "number"
|
|
},
|
|
"scriptPubkey": {
|
|
"type": "object",
|
|
"properties": {
|
|
"asm": {
|
|
"type": "string"
|
|
},
|
|
"hex": {
|
|
"type": "string"
|
|
},
|
|
"reqSigs": {
|
|
"type": "number"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"addresses": {
|
|
"type": "array",
|
|
"items": {
|
|
"address": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"DecodeScript": {
|
|
"type": "object",
|
|
"properties": {
|
|
"asm": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"p2sh": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"GetRawTransaction": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hex": {
|
|
"type": "string"
|
|
},
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"vin": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"vout": {
|
|
"type": "number"
|
|
},
|
|
"scriptSig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"asm": {
|
|
"type": "string"
|
|
},
|
|
"hex": {
|
|
"type": "string"
|
|
},
|
|
"sequence": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"vout": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "number"
|
|
},
|
|
"n": {
|
|
"type": "number"
|
|
},
|
|
"scriptPubkey": {
|
|
"type": "object",
|
|
"properties": {
|
|
"asm": {
|
|
"type": "string"
|
|
},
|
|
"hex": {
|
|
"type": "string"
|
|
},
|
|
"reqSigs": {
|
|
"type": "number"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"addresses": {
|
|
"type": "array",
|
|
"items": {
|
|
"address": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"blockhash": {
|
|
"type": "string"
|
|
},
|
|
"confirmations": {
|
|
"type": "number"
|
|
},
|
|
"time": {
|
|
"type": "number"
|
|
},
|
|
"blocktime": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"TransactionDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"locktime": {
|
|
"type": "number"
|
|
},
|
|
"vin": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"txid": {
|
|
"type": "string"
|
|
},
|
|
"vout": {
|
|
"type": "number"
|
|
},
|
|
"sequence": {
|
|
"type": "number"
|
|
},
|
|
"n": {
|
|
"type": "number"
|
|
},
|
|
"scriptSig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hex": {
|
|
"type": "string"
|
|
},
|
|
"asm": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
},
|
|
"legacyAddress": {
|
|
"type": "string"
|
|
},
|
|
"cashAddress": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"vout": {
|
|
"type": "array",
|
|
"items": {
|
|
"objects": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "number"
|
|
},
|
|
"n": {
|
|
"type": "number"
|
|
},
|
|
"scriptPubkey": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hex": {
|
|
"type": "string"
|
|
},
|
|
"asm": {
|
|
"type": "string"
|
|
},
|
|
"addresses": {
|
|
"type": "array",
|
|
"items": {
|
|
"address": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"spentTxId": {
|
|
"type": "string"
|
|
},
|
|
"spentIndex": {
|
|
"type": "number"
|
|
},
|
|
"spentHeight": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "number"
|
|
},
|
|
"n": {
|
|
"type": "number"
|
|
},
|
|
"scriptPubkey": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hex": {
|
|
"type": "string"
|
|
},
|
|
"asm": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"spentTxId": {
|
|
"type": "string"
|
|
},
|
|
"spentIndex": {
|
|
"type": "number"
|
|
},
|
|
"spentHeight": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"blockhash": {
|
|
"type": "string"
|
|
},
|
|
"blockheight": {
|
|
"type": "number"
|
|
},
|
|
"confirmations": {
|
|
"type": "number"
|
|
},
|
|
"time": {
|
|
"type": "number"
|
|
},
|
|
"valueOut": {
|
|
"type": "number"
|
|
},
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"valueIn": {
|
|
"type": "number"
|
|
},
|
|
"fees": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"ValidateAddress": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isvalid": {
|
|
"type": "boolean"
|
|
},
|
|
"address": {
|
|
"type": "string"
|
|
},
|
|
"scriptPubKey": {
|
|
"type": "string"
|
|
},
|
|
"ismine": {
|
|
"type": "boolean"
|
|
},
|
|
"iswatchonly": {
|
|
"type": "boolean"
|
|
},
|
|
"isscript": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"Info": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "number"
|
|
},
|
|
"protocolversion": {
|
|
"type": "number"
|
|
},
|
|
"blocks": {
|
|
"type": "number"
|
|
},
|
|
"timeoffset": {
|
|
"type": "number"
|
|
},
|
|
"connections": {
|
|
"type": "number"
|
|
},
|
|
"proxy": {
|
|
"type": "string"
|
|
},
|
|
"difficulty": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"paytxfee": {
|
|
"type": "number"
|
|
},
|
|
"relayfee": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"errors": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"MemoryInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"locked": {
|
|
"type": "object",
|
|
"properties": {
|
|
"used": {
|
|
"type": "number"
|
|
},
|
|
"free": {
|
|
"type": "number"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
},
|
|
"locked": {
|
|
"type": "number"
|
|
},
|
|
"chunks_used": {
|
|
"type": "number"
|
|
},
|
|
"chunks_free": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"MiningInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"blocks": {
|
|
"type": "number"
|
|
},
|
|
"currentblocksize": {
|
|
"type": "number"
|
|
},
|
|
"currentblocktx": {
|
|
"type": "number"
|
|
},
|
|
"difficulty": {
|
|
"type": "number",
|
|
"format": "float"
|
|
},
|
|
"blockprioritypercentage": {
|
|
"type": "number"
|
|
},
|
|
"errors": {
|
|
"type": "string"
|
|
},
|
|
"networkhashps": {
|
|
"type": "number"
|
|
},
|
|
"pooledtx": {
|
|
"type": "number"
|
|
},
|
|
"chain": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"NetworkHashps": {
|
|
"type": "number"
|
|
},
|
|
"ConnectionCount": {
|
|
"type": "number"
|
|
},
|
|
"MempoolAncestors": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"MempoolDescendants": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"description": "trest.bitcoin.com is the REST layer for Bitcoin.com's Cloud. More info: [developer.bitcoin.com/rest](https://developer.bitcoin.com/rest). Chatroom [geni.us/CashDev](http://geni.us/CashDev)",
|
|
"version": "3.3.8",
|
|
"title": "REST",
|
|
"license": {
|
|
"name": "MIT",
|
|
"url": "https://opensource.org/licenses/MIT"
|
|
}
|
|
},
|
|
"paths": {
|
|
"/address/details/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Address details single",
|
|
"description": "Returns the details of an address including balance",
|
|
"operationId": "detailsSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "the address in cashAddr or legacy",
|
|
"required": true,
|
|
"example": "bchtest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2svtllzmlf",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AddressDetails"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid Bitcoin Cash address as input.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid Bitcoin Cash address as input."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/details": {
|
|
"post": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Address details bulk",
|
|
"description": "Returns the details of multiple addresses",
|
|
"operationId": "detailsBulk",
|
|
"requestBody": {
|
|
"description": "Array of addresses",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Addresses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AddressDetailsArray"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid Bitcoin Cash address as input.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid Bitcoin Cash address as input."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/utxo/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Address utxos single",
|
|
"description": "Returns the list of utxo for an address",
|
|
"operationId": "utxoSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "the address or an array of addresses in cashAddr or legacy",
|
|
"required": true,
|
|
"example": "bchtest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2svtllzmlf",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AddressUtxo"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid Bitcoin Cash address as input.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid Bitcoin Cash address as input."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/utxo": {
|
|
"post": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Address utxo bulk",
|
|
"description": "Returns the utxo of multiple addresses",
|
|
"operationId": "utxoBulk",
|
|
"requestBody": {
|
|
"description": "Array of addresses",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Addresses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AddressUtxoArray"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid Bitcoin Cash address as input.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid Bitcoin Cash address as input."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/unconfirmed/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Unconfirmed transactions for an address",
|
|
"description": "Returns the list of unconfirmed transactions for an address",
|
|
"operationId": "unconfirmedSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "the address or an array of addresses in cashAddr or legacy",
|
|
"required": true,
|
|
"example": "bchtest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2svtllzmlf",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AddressUnconfirmed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid Bitcoin Cash address as input.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid Bitcoin Cash address as input."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/unconfirmed": {
|
|
"post": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Unconfirmed transactions for array of addresses",
|
|
"description": "Returns the list of unconfirmed transactions for an array of addresses",
|
|
"operationId": "unconfirmedBulk",
|
|
"requestBody": {
|
|
"description": "Array of addresses",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Addresses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/AddressUtxoArray"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid Bitcoin Cash address as input.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid Bitcoin Cash address as input."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/transactions/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Transactions for an address",
|
|
"description": "Returns the list of transactions for an address",
|
|
"operationId": "transactionsSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "the address in cashAddr or legacy",
|
|
"required": true,
|
|
"example": "bchtest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2svtllzmlf",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid value/s - Null"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/transactions": {
|
|
"post": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Transactions for an array of addresses",
|
|
"description": "Returns the list of transactions for an array of addresses",
|
|
"operationId": "transactionsBulk",
|
|
"requestBody": {
|
|
"description": "Array of addresses",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Addresses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid Bitcoin Cash address as input.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid Bitcoin Cash address as input."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/address/fromXPub/{xpub}": {
|
|
"get": {
|
|
"tags": [
|
|
"address"
|
|
],
|
|
"summary": "Address from extended public key and hdpath",
|
|
"description": "Returns an address for an extended public key and hdpath",
|
|
"operationId": "fromXPubSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "xpub",
|
|
"in": "path",
|
|
"description": "the extended public key",
|
|
"required": true,
|
|
"example": "tpubDHTK2jqg73w3GwoiHfAMbMYML1HN8FhrUxD9rFgbSgHXdwwrY6pAFqKDfUHhqw7vreaZty5hPGjb1S7ZPQeMmu6TFHAKfY9tJpYbvaGjPRM",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "hdPath",
|
|
"in": "query",
|
|
"description": "The HDPath. Defaults to the first BIP44 external change address",
|
|
"required": false,
|
|
"example": "",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid value/s - Null"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/block/detailsByHash/{hash}": {
|
|
"get": {
|
|
"tags": [
|
|
"block"
|
|
],
|
|
"summary": "Block details single",
|
|
"description": "Details about a single block by hash",
|
|
"operationId": "detailsHashSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "hash",
|
|
"in": "path",
|
|
"description": "Block hash",
|
|
"required": true,
|
|
"example": "0000000000262e9a70fae6c38cc9a91af2819b04521d2e9e99b7ae0328ee429d",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockDetails"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid block hash.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid block hash."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/block/detailsByHash": {
|
|
"post": {
|
|
"tags": [
|
|
"block"
|
|
],
|
|
"summary": "Block details bulk",
|
|
"description": "Details about multiple blocks by hashes",
|
|
"operationId": "detailsHashBulk",
|
|
"requestBody": {
|
|
"description": "Array of hashes",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockHashes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockDetails"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid block hash.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid block hash."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/block/detailsByHeight/{height}": {
|
|
"get": {
|
|
"tags": [
|
|
"block"
|
|
],
|
|
"summary": "Block details single",
|
|
"description": "Details about a single block by height",
|
|
"operationId": "detailsHeightSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "height",
|
|
"in": "path",
|
|
"description": "Block height",
|
|
"required": true,
|
|
"example": "500000",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockDetails"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid block height.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid block height."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/block/detailsByHeight": {
|
|
"post": {
|
|
"tags": [
|
|
"block"
|
|
],
|
|
"summary": "Block details bulk",
|
|
"description": "Bulk details about blocks by heights",
|
|
"operationId": "detailsHeightBulk",
|
|
"requestBody": {
|
|
"description": "Array of heights",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockHeights"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockDetails"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Received an invalid block height.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Received an invalid block height."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getBestBlockHash": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Hash of the best block in the longest blockchain.",
|
|
"description": "Returns the hash of the best (tip) block in the longest blockchain.",
|
|
"operationId": "getBestBlockHash",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BestBlockHash"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getBlockchainInfo": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Info regarding blockchain processing",
|
|
"description": "Returns an object containing various state info regarding blockchain processing.",
|
|
"operationId": "getBlockchainInfo",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockchainInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getBlockCount": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Number of blocks in the longest blockchain.",
|
|
"description": "Returns the number of blocks in the longest blockchain.",
|
|
"operationId": "getBlockCount",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockCount"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getBlockHeader/{hash}": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Information about blockheader hash",
|
|
"description": "If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'. If verbose is true, returns an Object with information about blockheader hash.",
|
|
"operationId": "getBlockHeaderSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "hash",
|
|
"in": "path",
|
|
"description": "the block hash",
|
|
"required": true,
|
|
"example": "0000000000262e9a70fae6c38cc9a91af2819b04521d2e9e99b7ae0328ee429d",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "verbose",
|
|
"in": "query",
|
|
"description": "true for a json object, false for the hex encoded data",
|
|
"required": false,
|
|
"example": true,
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockHeader"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Block not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Block not found"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getBlockHeader": {
|
|
"post": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Bulk information about blockheader hash",
|
|
"description": "Bulk information about blockheader hash",
|
|
"operationId": "getBlockHeaderBulk",
|
|
"requestBody": {
|
|
"description": "Array of hashes",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Hashes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BlockHeader"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Block not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"status": 500,
|
|
"message": "Block not found"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getChainTips": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Information about all known tips in the block tree",
|
|
"description": "Return information about all known tips in the block tree, including the main chain as well as orphaned branches.",
|
|
"operationId": "getChainTips",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getDifficulty": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Proof-of-work difficulty",
|
|
"description": "Returns the proof-of-work difficulty as a multiple of the minimum difficulty.",
|
|
"operationId": "getDifficulty",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Difficulty"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getMempoolEntry/{txid}": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Mempool data for transaction",
|
|
"description": "Returns mempool data for given transaction",
|
|
"operationId": "getMempoolEntrySingle",
|
|
"parameters": [
|
|
{
|
|
"name": "txid",
|
|
"in": "path",
|
|
"description": "the transaction id (must be in mempool)",
|
|
"required": true,
|
|
"example": "40112ab9d2b5f98427839272d7a1e23dd2afc6c8355626f373e076c2ab5c2f72",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Transaction not in mempool"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getMempoolEntry": {
|
|
"post": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Mempool data for transaction",
|
|
"description": "Returns mempool data for given transaction",
|
|
"operationId": "getMempoolEntryBulk",
|
|
"requestBody": {
|
|
"description": "Array of txids",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Txids"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Transaction not in mempool"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getMempoolInfo": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "The active state of the TX memory pool.",
|
|
"description": "Returns details on the active state of the TX memory pool.",
|
|
"operationId": "getMempoolInfo",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/MempoolInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getRawMempool": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "All transaction ids in memory pool.",
|
|
"description": "Returns all transaction ids in memory pool as a json array of string transaction ids.",
|
|
"operationId": "getRawMempool",
|
|
"parameters": [
|
|
{
|
|
"name": "verbose",
|
|
"in": "query",
|
|
"description": "True for a json object, false for array of transaction ids",
|
|
"required": false,
|
|
"example": true,
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RawMempool"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getTxOut/{txid}/{n}": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Details about unspent transaction output.",
|
|
"description": "Returns details about an unspent transaction output.",
|
|
"operationId": "getTxOut",
|
|
"parameters": [
|
|
{
|
|
"name": "txid",
|
|
"in": "path",
|
|
"description": "the transaction id",
|
|
"required": true,
|
|
"example": "40112ab9d2b5f98427839272d7a1e23dd2afc6c8355626f373e076c2ab5c2f72",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "n",
|
|
"in": "path",
|
|
"description": "vout number",
|
|
"required": true,
|
|
"example": 0,
|
|
"schema": {
|
|
"type": "number",
|
|
"default": 0
|
|
}
|
|
},
|
|
{
|
|
"name": "mempool",
|
|
"in": "query",
|
|
"description": "Whether to include the mempool",
|
|
"required": false,
|
|
"example": "false",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid value/s - Null"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getTxOutProof/{txid}": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Hex-encoded proof that single txid was included.",
|
|
"description": "Returns a hex-encoded proof that 'txid' was included in a block.",
|
|
"operationId": "getTxOutProofSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "txid",
|
|
"in": "path",
|
|
"description": "a txid string",
|
|
"example": "40112ab9d2b5f98427839272d7a1e23dd2afc6c8355626f373e076c2ab5c2f72",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid tag value"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/getTxOutProof": {
|
|
"post": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Hex-encoded proof that multiple txids wwere included.",
|
|
"description": "Returns a hex-encoded proof that multiple txids were included in a block.",
|
|
"operationId": "getTxOutProofBulk",
|
|
"requestBody": {
|
|
"description": "Array of txids",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Txids"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid tag value"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/verifyTxOutProof/{proof}": {
|
|
"get": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Verify that a single proof points to a transaction in a block",
|
|
"description": "Verifies that a proof points to a transaction in a block, returning the transaction it commits to and throwing an RPC error if the block is not in our best chain",
|
|
"operationId": "verifyTxOutProofSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "proof",
|
|
"in": "path",
|
|
"description": "The hex-encoded proof generated by gettxoutproof",
|
|
"example": "00000020166b6d1080a6d0a48a6c3556e275e86606ae217d7f9c53723b03000000000000a7b3c46a4c4b46cce03ebfe8b7cc32759e4f0dece66a20fb7d79577aadc8edf69425185cffff001d2261092aff00000009e8bfb50fb37d3f40b53eb8229f031a30e897aa9880d6b4db37cbb7c2b83b1e4f609b5095caa6d37d0a374b92e197fd424540f66999c0b6b50681a9ccf2e05ff2722f5cabc276e073f3265635c8c6afd23de2a1d77292832784f9b5d2b92a11408e66784a2e2183a898b03267c115da1b78cf0cd275d83c3cc22bb96940635c41669843b5c9211b26604659ad5943cf2b33217f69f6d67d728ee34bda219ede0a626804059d2540cd7f50114794c6ff18b6a790c671ba488525819c13fd32101932fd3506c9305134c6839c2945b8239ba52a60ac10577d6dc6b158e3c179bb91a7911dc11f8c5f052f808ef76c25ed638aaca31eb045a35ef00718718a0ad914607937c8c3dcee995ac145476cb4d83a4250f46c46990df568b6ee0796b3995f03bb0700",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid tag value"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/blockchain/verifyTxOutProof": {
|
|
"post": {
|
|
"tags": [
|
|
"blockchain"
|
|
],
|
|
"summary": "Verify that bulk proofs point to transactions in a block",
|
|
"description": "Verifies that bulk proofs point to transactions in a block",
|
|
"operationId": "verifyTxOutProofBulk",
|
|
"requestBody": {
|
|
"description": "Array of proofs",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Proofs"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Invalid tag value"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/control/getInfo": {
|
|
"get": {
|
|
"tags": [
|
|
"control"
|
|
],
|
|
"summary": "Various state info.",
|
|
"description": "Returns an object containing various state info.",
|
|
"operationId": "getInfo",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Info"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/mining/getMiningInfo": {
|
|
"get": {
|
|
"tags": [
|
|
"mining"
|
|
],
|
|
"summary": "Returns a json object containing mining-related information.",
|
|
"description": "",
|
|
"operationId": "getMiningInfo",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/MiningInfo"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/mining/getNetworkHashps": {
|
|
"get": {
|
|
"tags": [
|
|
"mining"
|
|
],
|
|
"summary": "Estimated network hashes per second",
|
|
"description": "Returns the estimated network hashes per second based on the last n blocks. Pass in [blocks] to override # of blocks, -1 specifies since last difficulty change. Pass in [height] to estimate the network speed at the time when a certain block was found.",
|
|
"operationId": "getNetworkHashps",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "nblocks",
|
|
"description": "the number of blocks, or -1 for blocks since last difficulty change.",
|
|
"required": false,
|
|
"example": 120,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "height",
|
|
"description": "to estimate at the time of the given height.",
|
|
"required": false,
|
|
"example": -1,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NetworkHashps"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/decodeRawTransaction/{hex}": {
|
|
"get": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Return the hex encoded transaction.",
|
|
"description": "Return a JSON object representing the serialized, hex-encoded transaction.",
|
|
"operationId": "decodeRawTransactionSingle",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "hex",
|
|
"description": "The transaction hex string",
|
|
"required": true,
|
|
"example": "02000000010e991f7ccec410f27d333f737f149b5d3be6728687da81072e638aed0063a176010000006b483045022100cd20443b0af090053450bc4ab00d563d4ac5955bb36e0135b00b8a96a19f233302205047f2c70a08c6ef4b76f2d198b33a31d17edfaa7e1e9e865894da0d396009354121024d4e7f522f67105b7bf5f9dbe557e7b2244613fdfcd6fe09304f93877328f6beffffffff02a0860100000000001976a9140ee020c07f39526ac5505c54fa1ab98490979b8388acb5f0f70b000000001976a9143a9b2b0c12fe722fcf653b6ef5dcc38732d6ff5188ac00000000",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DecodeRawTransaction"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "TX decode failed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/decodeRawTransaction": {
|
|
"post": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Return bulk hex encoded transaction.",
|
|
"description": "Return bulk hex encoded transaction.",
|
|
"operationId": "decodeRawTransactionBulk",
|
|
"requestBody": {
|
|
"description": "Array of hexes",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Hexes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DecodeRawTransaction"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "TX decode failed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/decodeScript/{hex}": {
|
|
"get": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Decode a hex-encoded script.",
|
|
"description": "Decode a hex-encoded script.",
|
|
"operationId": "decodeScriptSingle",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "hex",
|
|
"description": "The hex encoded script",
|
|
"required": true,
|
|
"example": "02000000012d2ec73b12ecb96fbf104fa0325e39bc4e49818709594ba2128635aedfb820a1010000006a47304402203c63866eab7ffca27ed6437a028de9b2cc83dd1ed96f0f496742cf70c6ca50b8022007f3c7fc8729f52d8d0e626c6328012691fa6b3a317c66408e2ccc84a6538e9741210360cfc66fdacb650bc4c83b4e351805181ee696b7d5ab4667c57b2786f51c413dffffffff036a929800000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac00000000000000006a6a4c67087768630000003201000800000000426974636f696e2e636f6d00426974636f696e20466978656420546f6b656e20546573740054535400646576656c6f7065722e626974636f696e2e636f6d004d616465207769746820424954424f5800000000174876e80022020000000000001976a914eb4b180def88e3f5625b2d8ae2c098ff7d85f66488ac00000000",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DecodeScript"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Argument must be hexadecimal string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/decodeScript": {
|
|
"post": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Decode multiple hex-encoded scripts.",
|
|
"description": "Decode multiple hex-encoded scripts.",
|
|
"operationId": "decodeScriptBulk",
|
|
"requestBody": {
|
|
"description": "Array of hexes",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Hexes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "TX decode failed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/getRawTransaction/{txid}": {
|
|
"get": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Return the raw transaction data.",
|
|
"description": "return the raw transaction data. If verbose is 'true', returns an Object with information about 'txid'. If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.",
|
|
"operationId": "getRawTransactionSingle",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "txid",
|
|
"description": "The transaction id",
|
|
"required": true,
|
|
"example": "40112ab9d2b5f98427839272d7a1e23dd2afc6c8355626f373e076c2ab5c2f72",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "verbose",
|
|
"description": "If false, return a string, otherwise return a json object",
|
|
"required": true,
|
|
"example": true,
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/GetRawTransaction"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Transaction not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/getRawTransaction": {
|
|
"post": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Return raw transaction data for multiple transactions.",
|
|
"description": "Return the raw transaction data for multiple transactions. If verbose is 'true', returns an Object with information about 'txid'. If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.",
|
|
"operationId": "getRawTransactionBulk",
|
|
"requestBody": {
|
|
"description": "Array of txids",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RawTxids"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Transaction not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/sendRawTransaction/{hex}": {
|
|
"get": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Submits single raw transactions to local node and network.",
|
|
"description": "Submits single raw transaction (serialized, hex-encoded) to local node and network.",
|
|
"operationId": "sendRawTransactionSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "hex",
|
|
"in": "path",
|
|
"description": "the raw transaction hex",
|
|
"required": true,
|
|
"example": "",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
},
|
|
"400": {
|
|
"description": "Transaction not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/rawtransactions/sendRawTransaction": {
|
|
"post": {
|
|
"tags": [
|
|
"rawtransactions"
|
|
],
|
|
"summary": "Submits multiple raw transactions to local node and network.",
|
|
"description": "Submits multiple raw transaction (serialized, hex-encoded) to local node and network.",
|
|
"operationId": "sendRawTransactionBulk",
|
|
"requestBody": {
|
|
"description": "Array of raw tx hexes",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Hexes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation"
|
|
},
|
|
"400": {
|
|
"description": "Transaction not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/transaction/details/{txid}": {
|
|
"get": {
|
|
"tags": [
|
|
"transaction"
|
|
],
|
|
"summary": "Transaction details single",
|
|
"description": "Details about a single transaction",
|
|
"operationId": "transactionDetailsSingle",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "txid",
|
|
"description": "single txid or url encoded array of txids",
|
|
"required": true,
|
|
"example": "40112ab9d2b5f98427839272d7a1e23dd2afc6c8355626f373e076c2ab5c2f72",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TransactionDetails"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Transaction not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/transaction/details": {
|
|
"post": {
|
|
"tags": [
|
|
"transaction"
|
|
],
|
|
"summary": "Transaction details bulk",
|
|
"description": "Bulk Details about a transaction",
|
|
"operationId": "transactionDetailsBulk",
|
|
"requestBody": {
|
|
"description": "Array of txids",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Txids"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/TransactionDetails"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Transaction not found"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/util/validateAddress/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"util"
|
|
],
|
|
"summary": "Information about single bitcoin cash address.",
|
|
"description": "Return information about single bitcoin cash address.",
|
|
"operationId": "validateAddressSingle",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "address",
|
|
"description": "The bitcoin address to validate",
|
|
"required": true,
|
|
"example": "bchtest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2svtllzmlf",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ValidateAddress"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid Address"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/util/validateAddress": {
|
|
"post": {
|
|
"tags": [
|
|
"util"
|
|
],
|
|
"summary": "Information about bulk bitcoin cash addresses.",
|
|
"description": "Return information about bulk bitcoin cash addresses.",
|
|
"operationId": "validateAddressBulk",
|
|
"requestBody": {
|
|
"description": "Array of Addresses",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Addresses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ValidateAddress"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid Address"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/list": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "list",
|
|
"description": "List all SLP tokens",
|
|
"operationId": "listAll",
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "list token information",
|
|
"description": "List multiple SLP tokens by id",
|
|
"operationId": "listBulk",
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SLPListBulk"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/list/{tokenId}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "list token",
|
|
"description": "List single SLP token by id",
|
|
"operationId": "listSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "tokenId",
|
|
"in": "path",
|
|
"description": "The token id",
|
|
"required": true,
|
|
"example": "650dea14c77f4d749608e36e375450c9ac91deb8b1b53e50cb0de2059a52d19a",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/convert/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "convert address to slpAddr, cashAddr and legacy",
|
|
"description": "convert address to slpAddr, cashAddr and legacy",
|
|
"operationId": "convert",
|
|
"parameters": [
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "The slp address",
|
|
"required": true,
|
|
"example": "",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/convert": {
|
|
"post": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "convert address to slpAddr, cashAddr and legacy",
|
|
"description": "convert address to slpAddr, cashAddr and legacy",
|
|
"operationId": "convertBulk",
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SLPConvert"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/balancesForAddress/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "list slp balances for address",
|
|
"description": "List SLP token balances for address",
|
|
"operationId": "balancesForAddress",
|
|
"parameters": [
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "The slp address",
|
|
"required": true,
|
|
"example": "slptest:qz35h5mfa8w2pqma2jq06lp7dnv5fxkp2shlcycvd5",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/balancesForToken/{tokenId}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "list SLP addresses and balances for tokenId",
|
|
"description": "List SLP addresses and balances for tokenId",
|
|
"operationId": "balancesForTokenSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "tokenId",
|
|
"in": "path",
|
|
"description": "The slp tokenId",
|
|
"required": true,
|
|
"example": "df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/balance/{address}/{tokenId}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "list single slp token balance for address",
|
|
"description": "List single SLP token balance for address",
|
|
"operationId": "singleBalanceForAddress",
|
|
"parameters": [
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "The slp address",
|
|
"required": true,
|
|
"example": "simpleledger:qz9tzs6d5097ejpg279rg0rnlhz546q4fsnck9wh5m",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "tokenId",
|
|
"in": "path",
|
|
"description": "The token id",
|
|
"required": true,
|
|
"example": "1cda254d0a995c713b7955298ed246822bee487458cd9747a91d9e81d9d28125",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/validateTxid/{txid}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "Validate single txid",
|
|
"description": "Validate single txid",
|
|
"operationId": "validateTxidSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "txid",
|
|
"in": "path",
|
|
"description": "The txid",
|
|
"required": true,
|
|
"example": "1cda254d0a995c713b7955298ed246822bee487458cd9747a91d9e81d9d28125",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/validateTxid": {
|
|
"post": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "Validate multiple txids",
|
|
"description": "Validate multiple txids",
|
|
"operationId": "validateTxidBulk",
|
|
"requestBody": {
|
|
"description": "",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SLPTxids"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/tokenStats/{tokenId}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "List stats for a single slp token",
|
|
"description": "List stats for a single slp token",
|
|
"operationId": "singleTokenStats",
|
|
"parameters": [
|
|
{
|
|
"name": "tokenId",
|
|
"in": "path",
|
|
"description": "The token id",
|
|
"required": true,
|
|
"example": "df808a41672a0a0ae6475b44f272a107bc9961b90f29dc918d71301f24fe92fb",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/txDetails/{txid}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "SLP transaction details",
|
|
"description": "Transaction details on a token transfer.",
|
|
"operationId": "txDetails",
|
|
"parameters": [
|
|
{
|
|
"name": "txid",
|
|
"in": "path",
|
|
"description": "The BCH transaction ID",
|
|
"required": true,
|
|
"example": "57b3082a2bf269b3d6f40fee7fb9c664e8256a88ca5ee2697c05b9457822d446",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/slp/transactions/{tokenId}/{address}": {
|
|
"get": {
|
|
"tags": [
|
|
"slp"
|
|
],
|
|
"summary": "SLP transactions by tokenId and address",
|
|
"description": "Transactions by tokenId and address.",
|
|
"operationId": "txsTokenIdAddressSingle",
|
|
"parameters": [
|
|
{
|
|
"name": "tokenId",
|
|
"in": "path",
|
|
"description": "The BCH tokenId",
|
|
"required": true,
|
|
"example": "495322b37d6b2eae81f045eda612b95870a0c2b6069c58f70cf8ef4e6a9fd43a",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "address",
|
|
"in": "path",
|
|
"description": "The slp address",
|
|
"required": true,
|
|
"example": "qrhvcy5xlegs858fjqf8ssl6a4f7wpstaqlsy4gusz",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "successful response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "/v2"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "address",
|
|
"description": "Address details and utxo",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/address"
|
|
}
|
|
},
|
|
{
|
|
"name": "block",
|
|
"description": "Block Details",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/block"
|
|
}
|
|
},
|
|
{
|
|
"name": "blockchain",
|
|
"description": "Interacting w/ the BCH Blockchain",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/blockchain"
|
|
}
|
|
},
|
|
{
|
|
"name": "control",
|
|
"description": "Control your blockchain",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/control"
|
|
}
|
|
},
|
|
{
|
|
"name": "mining",
|
|
"description": "Mining w/ the BCH Blockchain",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/mining"
|
|
}
|
|
},
|
|
{
|
|
"name": "rawtransactions",
|
|
"description": "Create transactions to be transmitted to the network.",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/rawtransactions"
|
|
}
|
|
},
|
|
{
|
|
"name": "transaction",
|
|
"description": "Transaction details.",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/rawtransactions"
|
|
}
|
|
},
|
|
{
|
|
"name": "util",
|
|
"description": "Bitcoin Cash utilities.",
|
|
"externalDocs": {
|
|
"description": "Find out more",
|
|
"url": "https://developer.bitcoin.com/rest/docs/util"
|
|
}
|
|
}
|
|
]
|
|
} |