\n Hosted Endpoint only available for hosted variant.\n
\n", - "x-codeSamples": [ - { - "lang": "Shell", - "label": "cURL", - "source": "# Assuming `data` is a serialized transaction on the file-system.\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/tx/submit\" \\\n -X POST \\\n -H \"Content-Type: application/cbor\" \\\n -H \"project_id: $PROJECT_ID\" \\\n --data-binary @./data\n" - }, + "summary": "Transaction UTXOs", + "description": "Return the inputs and UTXOs of the specific transaction.", + "parameters": [ { - "lang": "Shell", - "label": "cardano-cli", - "source": "# Assuming `tx.signed` is signed transaction constructed by cardano-cli\nxxd -r -p <<< $(jq .cborHex tx.signed) > tx.submit-api.raw\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/tx/submit\" \\\n -X POST \\\n -H \"Content-Type: application/cbor\" \\\n -H \"project_id: $PROJECT_ID\" \\\n --data-binary @./tx.submit-api.raw\n" + "in": "path", + "name": "hash", + "required": true, + "schema": { + "type": "string", + "format": "64-character case-sensitive hexadecimal string" + }, + "description": "Hash of the requested transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], - "requestBody": { - "description": "The transaction to submit, serialized in CBOR.\n", - "required": true, - "content": { - "application/cbor": { - "schema": { - "type": "string", - "description": "The transaction to submit, serialized in CBOR.\n" - }, - "example": "83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573\n" - } - } - }, "responses": { "200": { - "description": "Return the ID of the submitted transaction.", + "description": "Return the contents of the transaction.", "content": { "application/json": { "schema": { - "type": "string", - "format": "hex", - "minLength": 64, - "maxLength": 64, - "example": "d1662b24fa9fe985fc2dce47455df399cb2e31e1e1819339e885801cc3578908" + "$ref": "#/components/schemas/tx_content_utxo" } } } @@ -2293,9 +2392,6 @@ "418": { "$ref": "#/components/responses/418" }, - "425": { - "$ref": "#/components/responses/425" - }, "429": { "$ref": "#/components/responses/429" }, @@ -2305,32 +2401,33 @@ } } }, - "/accounts/{stake_address}": { + "/txs/{hash}/stakes": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Specific account address", - "description": "Obtain information about a specific stake account.\n", + "summary": "Transaction stake addresses certificates", + "description": "Obtain information about (de)registration of stake addresses within a transaction.\n", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "64-character case-sensitive hexadecimal string." }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" + "description": "Hash of the requested transaction.", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account content.", + "description": "Obtain information about (de)registration of stake addresses within a transaction.\n", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_content" + "$ref": "#/components/schemas/tx_content_stake_addr" } } } @@ -2356,70 +2453,33 @@ } } }, - "/accounts/{stake_address}/rewards": { + "/txs/{hash}/delegations": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Account reward history", - "description": "Obtain information about the reward history of a specific account.\n", + "summary": "Transaction delegation certificates", + "description": "Obtain information about delegation certificates of a specific transaction.\n", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, - "schema": { - "type": "string" - }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "format": "64-character case-sensitive hexadecimal string" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the requested transaction.", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account content.", + "description": "Obtain information about delegation certificates of a specific transaction", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_reward_content" + "$ref": "#/components/schemas/tx_content_delegations" } } } @@ -2445,70 +2505,85 @@ } } }, - "/accounts/{stake_address}/history": { + "/txs/{hash}/withdrawals": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Account history", - "description": "Obtain information about the history of a specific account.\n", + "summary": "Transaction withdrawal", + "description": "Obtain information about withdrawals of a specific transaction.", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "64-character case-sensitive hexadecimal string" }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" + "description": "Hash of the requested transaction.", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" + } + ], + "responses": { + "200": { + "description": "Obtain information about withdrawals of a specific transaction.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tx_content_withdrawals" + } + } + } }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." + "400": { + "$ref": "#/components/responses/400" }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/txs/{hash}/mirs": { + "get": { + "tags": [ + "Cardano » Transactions" + ], + "summary": "Transaction MIRs", + "description": "Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction.", + "parameters": [ { - "in": "query", - "name": "order", - "required": false, + "in": "path", + "name": "hash", + "required": true, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "format": "64-character case-sensitive hexadecimal string" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the requested transaction.", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account content.", + "description": "Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_history_content" + "$ref": "#/components/schemas/tx_content_mirs" } } } @@ -2534,70 +2609,33 @@ } } }, - "/accounts/{stake_address}/delegations": { + "/txs/{hash}/pool_updates": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Account delegation history", - "description": "Obtain information about the delegation of a specific account.", + "summary": "Transaction stake pool registration and update certificates", + "description": "Obtain information about stake pool registration and update certificates of a specific transaction.\n", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, - "schema": { - "type": "string" - }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "format": "64-character case-sensitive hexadecimal string" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the requested transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account delegations content", + "description": "Obtain information about stake pool certificates of a specific transaction", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_delegation_content" + "$ref": "#/components/schemas/tx_content_pool_certs" } } } @@ -2623,70 +2661,33 @@ } } }, - "/accounts/{stake_address}/registrations": { + "/txs/{hash}/pool_retires": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Account registration history", - "description": "Obtain information about the registrations and deregistrations of a specific account.\n", + "summary": "Transaction stake pool retirement certificates", + "description": "Obtain information about stake pool retirements within a specific transaction.\n", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, - "schema": { - "type": "string" - }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "format": "64-character case-sensitive hexadecimal string." }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the requested transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account registration content.", + "description": "Obtain information about stake pool retirements within a specific transaction.\n", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_registration_content" + "$ref": "#/components/schemas/tx_content_pool_retires" } } } @@ -2712,70 +2713,33 @@ } } }, - "/accounts/{stake_address}/withdrawals": { + "/txs/{hash}/metadata": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Account withdrawal history", - "description": "Obtain information about the withdrawals of a specific account.\n", + "summary": "Transaction metadata", + "description": "Obtain the transaction metadata.", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, - "schema": { - "type": "string" - }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "format": "64-character case-sensitive hexadecimal string." }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the requested transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account withdrawal content.", + "description": "Obtain metadata information associated with a specific transaction.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_withdrawal_content" + "$ref": "#/components/schemas/tx_content_metadata" } } } @@ -2801,70 +2765,33 @@ } } }, - "/accounts/{stake_address}/mirs": { + "/txs/{hash}/metadata/cbor": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Account MIR history", - "description": "Obtain information about the MIRs of a specific account.\n", + "summary": "Transaction metadata in CBOR", + "description": "Obtain the transaction metadata in CBOR.", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "64-character case-sensitive hexadecimal string." }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the requested transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account MIR content.", + "description": "Obtain metadata information associated with a specific transaction.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_mir_content" + "$ref": "#/components/schemas/tx_content_metadata_cbor" } } } @@ -2890,70 +2817,33 @@ } } }, - "/accounts/{stake_address}/addresses": { + "/txs/{hash}/redeemers": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Account associated addresses", - "description": "Obtain information about the addresses of a specific account.\nBe careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.\n", + "summary": "Transaction redeemers", + "description": "Obtain the transaction redeemers.", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, - "schema": { - "type": "string" - }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "format": "64-character case-sensitive hexadecimal string." }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the requested transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account addresses content", + "description": "Obtain information about redeemers within a specific transaction.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_addresses_content" + "$ref": "#/components/schemas/tx_content_redeemers" } } } @@ -2979,70 +2869,33 @@ } } }, - "/accounts/{stake_address}/addresses/assets": { + "/txs/{hash}/required_signers": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Assets associated with the account addresses", - "description": "Obtain information about assets associated with addresses of a specific account.\nBe careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.\n", + "summary": "Transaction required signers", + "description": "Obtain the extra transaction witnesses.", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, - "schema": { - "type": "string" - }, - "description": "Bech32 stake address.", - "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "format": "64-character case-sensitive hexadecimal string." }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the account addresses content", + "description": "Query required signers (extra transaction witnesses)", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_addresses_assets" + "$ref": "#/components/schemas/tx_content_required_signers" } } } @@ -3068,32 +2921,33 @@ } } }, - "/accounts/{stake_address}/addresses/total": { + "/txs/{hash}/cbor": { "get": { "tags": [ - "Cardano » Accounts" + "Cardano » Transactions" ], - "summary": "Detailed information about account associated addresses", - "description": "Obtain summed details about all addresses associated with a given account.\nBe careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.\n", + "summary": "Transaction CBOR", + "description": "Obtain the CBOR serialized transaction", "parameters": [ { "in": "path", - "name": "stake_address", + "name": "hash", "required": true, "schema": { - "type": "string" + "type": "string", + "format": "64-character case-sensitive hexadecimal string." }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + "description": "Hash of the transaction", + "example": "6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the Address details.", + "description": "Query transaction CBOR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/account_addresses_total" + "$ref": "#/components/schemas/tx_content_cbor" } } } @@ -3119,60 +2973,49 @@ } } }, - "/mempool": { - "get": { + "/tx/submit": { + "post": { "tags": [ - "Cardano » Mempool" + "Cardano » Transactions" ], - "summary": "Mempool", - "description": "Return transactions that are currently stored in Blockfrost mempool,\nwaiting to be included in a newly minted block.\nShows only transactions submitted via Blockfrost.io.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", - "parameters": [ - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, + "summary": "Submit a transaction", + "description": "Submit an already serialized transaction to the network.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "x-codeSamples": [ { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." + "lang": "Shell", + "label": "cURL", + "source": "# Assuming `data` is a serialized transaction on the file-system.\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/tx/submit\" \\\n -X POST \\\n -H \"Content-Type: application/cbor\" \\\n -H \"project_id: $PROJECT_ID\" \\\n --data-binary @./data\n" }, { - "in": "query", - "name": "order", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - }, - "description": "Ordered by the time of transaction submission.\nBy default, we return oldest first, newest last.\n" + "lang": "Shell", + "label": "cardano-cli", + "source": "# Assuming `tx.signed` is signed transaction constructed by cardano-cli\nxxd -r -p <<< $(jq .cborHex tx.signed) > tx.submit-api.raw\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/tx/submit\" \\\n -X POST \\\n -H \"Content-Type: application/cbor\" \\\n -H \"project_id: $PROJECT_ID\" \\\n --data-binary @./tx.submit-api.raw\n" } ], + "requestBody": { + "description": "The transaction to submit, serialized in CBOR.\n", + "required": true, + "content": { + "application/cbor": { + "schema": { + "type": "string", + "description": "The transaction to submit, serialized in CBOR.\n" + }, + "example": "83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573\n" + } + } + }, "responses": { "200": { - "description": "Return the contents of the mempool", + "description": "Return the ID of the submitted transaction.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/mempool_content" + "type": "string", + "format": "hex", + "minLength": 64, + "maxLength": 64, + "example": "d1662b24fa9fe985fc2dce47455df399cb2e31e1e1819339e885801cc3578908" } } } @@ -3189,6 +3032,9 @@ "418": { "$ref": "#/components/responses/418" }, + "425": { + "$ref": "#/components/responses/425" + }, "429": { "$ref": "#/components/responses/429" }, @@ -3198,33 +3044,32 @@ } } }, - "/mempool/{hash}": { + "/accounts/{stake_address}": { "get": { "tags": [ - "Cardano » Mempool" + "Cardano » Accounts" ], - "summary": "Specific transaction in the mempool", - "description": "Return content of the requested transaction.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Specific account address", + "description": "Obtain information about a specific stake account.\n", "parameters": [ { "in": "path", - "name": "hash", + "name": "stake_address", "required": true, "schema": { - "type": "string", - "format": "64-character case-sensitive hexadecimal string." + "type": "string" }, - "description": "Hash of the requested transaction", - "example": "6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" } ], "responses": { "200": { - "description": "Return the contents of the transaction.", + "description": "Return the account content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/mempool_tx_content" + "$ref": "#/components/schemas/account_content" } } } @@ -3250,24 +3095,23 @@ } } }, - "/mempool/addresses/{address}": { + "/accounts/{stake_address}/rewards": { "get": { "tags": [ - "Cardano » Mempool" + "Cardano » Accounts" ], - "summary": "Mempool by address", - "description": "List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address.\nShows only transactions submitted via Blockfrost.io.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Account reward history", + "description": "Obtain information about the reward history of a specific account.\n", "parameters": [ { "in": "path", - "name": "address", + "name": "stake_address", "required": true, "schema": { - "type": "string", - "format": "64-character case-sensitive hexadecimal string." + "type": "string" }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" }, { "in": "query", @@ -3305,16 +3149,16 @@ ], "default": "asc" }, - "description": "Ordered by the time of transaction submission.\nBy default, we return oldest first, newest last.\n" + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the contents of the mempool", + "description": "Return the account content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/mempool_addresses_content" + "$ref": "#/components/schemas/account_reward_content" } } } @@ -3340,14 +3184,24 @@ } } }, - "/metadata/txs/labels": { + "/accounts/{stake_address}/history": { "get": { "tags": [ - "Cardano » Metadata" + "Cardano » Accounts" ], - "summary": "Transaction metadata labels", - "description": "List of all used transaction metadata labels.\n", + "summary": "Account history", + "description": "Obtain information about the history of a specific account.\n", "parameters": [ + { + "in": "path", + "name": "stake_address", + "required": true, + "schema": { + "type": "string" + }, + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" + }, { "in": "query", "name": "count", @@ -3389,11 +3243,11 @@ ], "responses": { "200": { - "description": "Return the account metadata content in CBOR", + "description": "Return the account content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/tx_metadata_labels" + "$ref": "#/components/schemas/account_history_content" } } } @@ -3419,23 +3273,23 @@ } } }, - "/metadata/txs/labels/{label}": { + "/accounts/{stake_address}/delegations": { "get": { "tags": [ - "Cardano » Metadata" + "Cardano » Accounts" ], - "summary": "Transaction metadata content in JSON", - "description": "Transaction metadata per label.", + "summary": "Account delegation history", + "description": "Obtain information about the delegation of a specific account.", "parameters": [ { "in": "path", - "name": "label", + "name": "stake_address", "required": true, "schema": { "type": "string" }, - "description": "Metadata label", - "example": "1990" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" }, { "in": "query", @@ -3478,11 +3332,11 @@ ], "responses": { "200": { - "description": "Return the account metadata content", + "description": "Return the account delegations content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/tx_metadata_label_json" + "$ref": "#/components/schemas/account_delegation_content" } } } @@ -3508,23 +3362,23 @@ } } }, - "/metadata/txs/labels/{label}/cbor": { + "/accounts/{stake_address}/registrations": { "get": { "tags": [ - "Cardano » Metadata" + "Cardano » Accounts" ], - "summary": "Transaction metadata content in CBOR", - "description": "Transaction metadata per label.", + "summary": "Account registration history", + "description": "Obtain information about the registrations and deregistrations of a specific account.\n", "parameters": [ { "in": "path", - "name": "label", + "name": "stake_address", "required": true, "schema": { "type": "string" }, - "description": "Metadata label", - "example": "1990" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" }, { "in": "query", @@ -3567,11 +3421,11 @@ ], "responses": { "200": { - "description": "Return the account metadata content in CBOR", + "description": "Return the account registration content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/tx_metadata_label_cbor" + "$ref": "#/components/schemas/account_registration_content" } } } @@ -3597,134 +3451,70 @@ } } }, - "/addresses/{address}": { + "/accounts/{stake_address}/withdrawals": { "get": { "tags": [ - "Cardano » Addresses" + "Cardano » Accounts" ], - "summary": "Specific address", - "description": "Obtain information about a specific address.", + "summary": "Account withdrawal history", + "description": "Obtain information about the withdrawals of a specific account.\n", "parameters": [ { "in": "path", - "name": "address", + "name": "stake_address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" - } - ], - "responses": { - "200": { - "description": "Return the address content.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/address_content" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "418": { - "$ref": "#/components/responses/418" - }, - "429": { - "$ref": "#/components/responses/429" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" }, - "500": { - "$ref": "#/components/responses/500" - } - } - } - }, - "/addresses/{address}/extended": { - "get": { - "tags": [ - "Cardano » Addresses" - ], - "summary": "Extended information of a specific address", - "description": "Obtain extended information about a specific address.\n", - "parameters": [ { - "in": "path", - "name": "address", - "required": true, + "in": "query", + "name": "count", + "required": false, "schema": { - "type": "string" + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" - } - ], - "responses": { - "200": { - "description": "Return the address content.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/address_content_extended" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "418": { - "$ref": "#/components/responses/418" + "description": "The number of results displayed on one page." }, - "429": { - "$ref": "#/components/responses/429" + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." }, - "500": { - "$ref": "#/components/responses/500" - } - } - } - }, - "/addresses/{address}/total": { - "get": { - "tags": [ - "Cardano » Addresses" - ], - "summary": "Address details", - "description": "Obtain details about an address.", - "parameters": [ { - "in": "path", - "name": "address", - "required": true, + "in": "query", + "name": "order", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the Address details.", + "description": "Return the account withdrawal content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/address_content_total" + "$ref": "#/components/schemas/account_withdrawal_content" } } } @@ -3750,23 +3540,23 @@ } } }, - "/addresses/{address}/utxos": { + "/accounts/{stake_address}/mirs": { "get": { "tags": [ - "Cardano » Addresses" + "Cardano » Accounts" ], - "summary": "Address UTXOs", - "description": "UTXOs of the address.", + "summary": "Account MIR history", + "description": "Obtain information about the MIRs of a specific account.\n", "parameters": [ { "in": "path", - "name": "address", + "name": "stake_address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" }, { "in": "query", @@ -3809,11 +3599,11 @@ ], "responses": { "200": { - "description": "Return the address content", + "description": "Return the account MIR content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/address_utxo_content" + "$ref": "#/components/schemas/account_mir_content" } } } @@ -3839,33 +3629,23 @@ } } }, - "/addresses/{address}/utxos/{asset}": { + "/accounts/{stake_address}/addresses": { "get": { "tags": [ - "Cardano » Addresses" + "Cardano » Accounts" ], - "summary": "Address UTXOs of a given asset", - "description": "UTXOs of the address.", + "summary": "Account associated addresses", + "description": "Obtain information about the addresses of a specific account.\nBe careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.\n", "parameters": [ { "in": "path", - "name": "address", - "required": true, - "schema": { - "type": "string" - }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" - }, - { - "in": "path", - "name": "asset", + "name": "stake_address", "required": true, "schema": { "type": "string" }, - "description": "Concatenation of the policy_id and hex-encoded asset_name", - "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" }, { "in": "query", @@ -3908,11 +3688,11 @@ ], "responses": { "200": { - "description": "Return the address content", + "description": "Return the account addresses content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/address_utxo_content" + "$ref": "#/components/schemas/account_addresses_content" } } } @@ -3938,24 +3718,23 @@ } } }, - "/addresses/{address}/txs": { + "/accounts/{stake_address}/addresses/assets": { "get": { - "deprecated": true, "tags": [ - "Cardano » Addresses" + "Cardano » Accounts" ], - "summary": "Address txs", - "description": "Transactions on the address.", + "summary": "Assets associated with the account addresses", + "description": "Obtain information about assets associated with addresses of a specific account.\nBe careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.\n", "parameters": [ { "in": "path", - "name": "address", + "name": "stake_address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 address.", - "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + "description": "Bech32 stake address.", + "example": "stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc" }, { "in": "query", @@ -3967,7 +3746,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of transactions per page." + "description": "The number of results displayed on one page." }, { "in": "query", @@ -3998,11 +3777,11 @@ ], "responses": { "200": { - "description": "Return the address content", + "description": "Return the account addresses content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/address_txs_content" + "$ref": "#/components/schemas/account_addresses_assets" } } } @@ -4028,24 +3807,65 @@ } } }, - "/addresses/{address}/transactions": { + "/accounts/{stake_address}/addresses/total": { "get": { "tags": [ - "Cardano » Addresses" + "Cardano » Accounts" ], - "summary": "Address transactions", - "description": "Transactions on the address.", + "summary": "Detailed information about account associated addresses", + "description": "Obtain summed details about all addresses associated with a given account.\nBe careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.\n", "parameters": [ { "in": "path", - "name": "address", + "name": "stake_address", "required": true, "schema": { "type": "string" }, "description": "Bech32 address.", "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + } + ], + "responses": { + "200": { + "description": "Return the Address details.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/account_addresses_total" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/mempool": { + "get": { + "tags": [ + "Cardano » Mempool" + ], + "summary": "Mempool", + "description": "Return transactions that are currently stored in Blockfrost mempool,\nwaiting to be included in a newly minted block.\nShows only transactions submitted via Blockfrost.io.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "parameters": [ { "in": "query", "name": "count", @@ -4056,7 +3876,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of addresses per page." + "description": "The number of results displayed on one page." }, { "in": "query", @@ -4082,36 +3902,68 @@ ], "default": "asc" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Ordered by the time of transaction submission.\nBy default, we return oldest first, newest last.\n" + } + ], + "responses": { + "200": { + "description": "Return the contents of the mempool", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mempool_content" + } + } + } }, - { - "in": "query", - "name": "from", - "required": false, - "schema": { - "type": "string" - }, - "description": "The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon.\nHas to be lower than or equal to `to` parameter.\n", - "example": "8929261" + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/mempool/{hash}": { + "get": { + "tags": [ + "Cardano » Mempool" + ], + "summary": "Specific transaction in the mempool", + "description": "Return content of the requested transaction.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "parameters": [ { - "in": "query", - "name": "to", - "required": false, + "in": "path", + "name": "hash", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "64-character case-sensitive hexadecimal string." }, - "description": "The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon.\nHas to be higher than or equal to `from` parameter.\n", - "example": "9999269:10" + "description": "Hash of the requested transaction", + "example": "6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b" } ], "responses": { "200": { - "description": "Return the address content", + "description": "Return the contents of the transaction.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/address_transactions_content" + "$ref": "#/components/schemas/mempool_tx_content" } } } @@ -4137,14 +3989,25 @@ } } }, - "/pools": { + "/mempool/addresses/{address}": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Mempool" ], - "summary": "List of stake pools", - "description": "List of registered stake pools.", + "summary": "Mempool by address", + "description": "List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address.\nShows only transactions submitted via Blockfrost.io.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", "parameters": [ + { + "in": "path", + "name": "address", + "required": true, + "schema": { + "type": "string", + "format": "64-character case-sensitive hexadecimal string." + }, + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + }, { "in": "query", "name": "count", @@ -4155,7 +4018,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of pools per page." + "description": "The number of results displayed on one page." }, { "in": "query", @@ -4181,16 +4044,16 @@ ], "default": "asc" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Ordered by the time of transaction submission.\nBy default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the list of pools.", + "description": "Return the contents of the mempool", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_list" + "$ref": "#/components/schemas/mempool_addresses_content" } } } @@ -4216,13 +4079,13 @@ } } }, - "/pools/extended": { + "/metadata/txs/labels": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Metadata" ], - "summary": "List of stake pools with additional information", - "description": "List of registered stake pools with additional information.", + "summary": "Transaction metadata labels", + "description": "List of all used transaction metadata labels.\n", "parameters": [ { "in": "query", @@ -4234,7 +4097,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of pools per page." + "description": "The number of results displayed on one page." }, { "in": "query", @@ -4265,11 +4128,11 @@ ], "responses": { "200": { - "description": "Return the list of pools.", + "description": "Return the account metadata content in CBOR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_list_extended" + "$ref": "#/components/schemas/tx_metadata_labels" } } } @@ -4295,14 +4158,24 @@ } } }, - "/pools/retired": { + "/metadata/txs/labels/{label}": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Metadata" ], - "summary": "List of retired stake pools", - "description": "List of already retired pools.", + "summary": "Transaction metadata content in JSON", + "description": "Transaction metadata per label.", "parameters": [ + { + "in": "path", + "name": "label", + "required": true, + "schema": { + "type": "string" + }, + "description": "Metadata label", + "example": "1990" + }, { "in": "query", "name": "count", @@ -4313,7 +4186,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of pools per page." + "description": "The number of results displayed on one page." }, { "in": "query", @@ -4344,11 +4217,11 @@ ], "responses": { "200": { - "description": "Return the pool information content", + "description": "Return the account metadata content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_list_retire" + "$ref": "#/components/schemas/tx_metadata_label_json" } } } @@ -4374,14 +4247,24 @@ } } }, - "/pools/retiring": { + "/metadata/txs/labels/{label}/cbor": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Metadata" ], - "summary": "List of retiring stake pools", - "description": "List of stake pools retiring in the upcoming epochs", + "summary": "Transaction metadata content in CBOR", + "description": "Transaction metadata per label.", "parameters": [ + { + "in": "path", + "name": "label", + "required": true, + "schema": { + "type": "string" + }, + "description": "Metadata label", + "example": "1990" + }, { "in": "query", "name": "count", @@ -4423,11 +4306,11 @@ ], "responses": { "200": { - "description": "Return the pool information content", + "description": "Return the account metadata content in CBOR", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_list_retire" + "$ref": "#/components/schemas/tx_metadata_label_cbor" } } } @@ -4453,32 +4336,32 @@ } } }, - "/pools/{pool_id}": { + "/addresses/{address}": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Addresses" ], - "summary": "Specific stake pool", - "description": "Pool information.", + "summary": "Specific address", + "description": "Obtain information about a specific address.", "parameters": [ { "in": "path", - "name": "pool_id", + "name": "address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 or hexadecimal pool ID.", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" } ], "responses": { "200": { - "description": "Return the pool information content", + "description": "Return the address content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool" + "$ref": "#/components/schemas/address_content" } } } @@ -4504,70 +4387,32 @@ } } }, - "/pools/{pool_id}/history": { + "/addresses/{address}/extended": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Addresses" ], - "summary": "Stake pool history", - "description": "History of stake pool parameters over epochs.\n", + "summary": "Extended information of a specific address", + "description": "Obtain extended information about a specific address.\n", "parameters": [ { "in": "path", - "name": "pool_id", + "name": "address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 or hexadecimal pool ID.", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results" - }, - { - "in": "query", - "name": "order", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" } ], "responses": { "200": { - "description": "Return the pool information content.", + "description": "Return the address content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_history" + "$ref": "#/components/schemas/address_content_extended" } } } @@ -4593,39 +4438,32 @@ } } }, - "/pools/{pool_id}/metadata": { + "/addresses/{address}/total": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Addresses" ], - "summary": "Stake pool metadata", - "description": "Stake pool registration metadata.\n", + "summary": "Address details", + "description": "Obtain details about an address.", "parameters": [ { "in": "path", - "name": "pool_id", + "name": "address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 or hexadecimal pool ID.", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" } ], "responses": { "200": { - "description": "Return the pool metadata content.", + "description": "Return the Address details.", "content": { "application/json": { "schema": { - "anyOf": [ - { - "$ref": "#/components/schemas/pool_metadata" - }, - { - "$ref": "#/components/schemas/empty_object" - } - ] + "$ref": "#/components/schemas/address_content_total" } } } @@ -4651,32 +4489,70 @@ } } }, - "/pools/{pool_id}/relays": { + "/addresses/{address}/utxos": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Addresses" ], - "summary": "Stake pool relays", - "description": "Relays of a stake pool.", + "summary": "Address UTXOs", + "description": "UTXOs of the address.", "parameters": [ { "in": "path", - "name": "pool_id", + "name": "address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 or hexadecimal pool ID.", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the pool relays information content.", + "description": "Return the address content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_relays" + "$ref": "#/components/schemas/address_utxo_content" } } } @@ -4702,23 +4578,33 @@ } } }, - "/pools/{pool_id}/delegators": { + "/addresses/{address}/utxos/{asset}": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Addresses" ], - "summary": "Stake pool delegators", - "description": "List of current stake pools delegators.", + "summary": "Address UTXOs of a given asset", + "description": "UTXOs of the address.", "parameters": [ { "in": "path", - "name": "pool_id", + "name": "address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 or hexadecimal pool ID.", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" + }, + { + "in": "path", + "name": "asset", + "required": true, + "schema": { + "type": "string" + }, + "description": "Concatenation of the policy_id and hex-encoded asset_name", + "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" }, { "in": "query", @@ -4761,11 +4647,11 @@ ], "responses": { "200": { - "description": "Return the pool delegations.", + "description": "Return the address content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_delegators" + "$ref": "#/components/schemas/address_utxo_content" } } } @@ -4791,23 +4677,24 @@ } } }, - "/pools/{pool_id}/blocks": { + "/addresses/{address}/txs": { "get": { + "deprecated": true, "tags": [ - "Cardano » Pools" + "Cardano » Addresses" ], - "summary": "Stake pool blocks", - "description": "List of stake pools blocks.", + "summary": "Address txs", + "description": "Transactions on the address.", "parameters": [ { "in": "path", - "name": "pool_id", + "name": "address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 or hexadecimal pool ID.", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" }, { "in": "query", @@ -4819,7 +4706,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of results displayed on one page." + "description": "The number of transactions per page." }, { "in": "query", @@ -4850,11 +4737,11 @@ ], "responses": { "200": { - "description": "Return the pool block list", + "description": "Return the address content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_blocks" + "$ref": "#/components/schemas/address_txs_content" } } } @@ -4880,23 +4767,23 @@ } } }, - "/pools/{pool_id}/updates": { + "/addresses/{address}/transactions": { "get": { "tags": [ - "Cardano » Pools" + "Cardano » Addresses" ], - "summary": "Stake pool updates", - "description": "List of certificate updates to the stake pool.", + "summary": "Address transactions", + "description": "Transactions on the address.", "parameters": [ { "in": "path", - "name": "pool_id", + "name": "address", "required": true, "schema": { "type": "string" }, - "description": "Bech32 or hexadecimal pool ID.", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + "description": "Bech32 address.", + "example": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz" }, { "in": "query", @@ -4908,7 +4795,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of results displayed on one page." + "description": "The number of addresses per page." }, { "in": "query", @@ -4935,15 +4822,35 @@ "default": "asc" }, "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + }, + { + "in": "query", + "name": "from", + "required": false, + "schema": { + "type": "string" + }, + "description": "The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon.\nHas to be lower than or equal to `to` parameter.\n", + "example": "8929261" + }, + { + "in": "query", + "name": "to", + "required": false, + "schema": { + "type": "string" + }, + "description": "The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon.\nHas to be higher than or equal to `from` parameter.\n", + "example": "9999269:10" } ], "responses": { "200": { - "description": "Return the pool updates history", + "description": "Return the address content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/pool_updates" + "$ref": "#/components/schemas/address_transactions_content" } } } @@ -4969,13 +4876,13 @@ } } }, - "/assets": { + "/pools": { "get": { "tags": [ - "Cardano » Assets" + "Cardano » Pools" ], - "summary": "Assets", - "description": "List of assets. If an asset is completely burned,\nit will stay on the list with quantity 0 (order of assets is immutable).\n", + "summary": "List of stake pools", + "description": "List of registered stake pools.", "parameters": [ { "in": "query", @@ -4987,7 +4894,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of results displayed on one page." + "description": "The number of pools per page." }, { "in": "query", @@ -5013,16 +4920,16 @@ ], "default": "asc" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\nOrdering in this case is based on the time of the first mint transaction.\n" + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return list of assets", + "description": "Return the list of pools.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/assets" + "$ref": "#/components/schemas/pool_list" } } } @@ -5048,32 +4955,60 @@ } } }, - "/assets/{asset}": { + "/pools/extended": { "get": { "tags": [ - "Cardano » Assets" + "Cardano » Pools" ], - "summary": "Specific asset", - "description": "Information about a specific asset", + "summary": "List of stake pools with additional information", + "description": "List of registered stake pools with additional information.", "parameters": [ { - "in": "path", - "name": "asset", - "required": true, + "in": "query", + "name": "count", + "required": false, "schema": { - "type": "string" + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 }, - "description": "Concatenation of the policy_id and hex-encoded asset_name", - "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" + "description": "The number of pools per page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the information about a specific asset", + "description": "Return the list of pools.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/asset" + "$ref": "#/components/schemas/pool_list_extended" } } } @@ -5099,24 +5034,14 @@ } } }, - "/assets/{asset}/history": { + "/pools/retired": { "get": { "tags": [ - "Cardano » Assets" + "Cardano » Pools" ], - "summary": "Asset history", - "description": "History of a specific asset", + "summary": "List of retired stake pools", + "description": "List of already retired pools.", "parameters": [ - { - "in": "path", - "name": "asset", - "required": true, - "schema": { - "type": "string" - }, - "description": "Concatenation of the policy_id and hex-encoded asset_name", - "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" - }, { "in": "query", "name": "count", @@ -5127,7 +5052,7 @@ "maximum": 100, "default": 100 }, - "description": "The number of results displayed on one page." + "description": "The number of pools per page." }, { "in": "query", @@ -5158,11 +5083,11 @@ ], "responses": { "200": { - "description": "Return the information about the history of a specific asset", + "description": "Return the pool information content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/asset_history" + "$ref": "#/components/schemas/pool_list_retire" } } } @@ -5188,25 +5113,14 @@ } } }, - "/assets/{asset}/txs": { + "/pools/retiring": { "get": { - "deprecated": true, "tags": [ - "Cardano » Assets" + "Cardano » Pools" ], - "summary": "Asset txs", - "description": "List of a specific asset transactions", + "summary": "List of retiring stake pools", + "description": "List of stake pools retiring in the upcoming epochs", "parameters": [ - { - "in": "path", - "name": "asset", - "required": true, - "schema": { - "type": "string" - }, - "description": "Concatenation of the policy_id and hex-encoded asset_name", - "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" - }, { "in": "query", "name": "count", @@ -5248,11 +5162,11 @@ ], "responses": { "200": { - "description": "Return the information about the history of a specific asset", + "description": "Return the pool information content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/asset_txs" + "$ref": "#/components/schemas/pool_list_retire" } } } @@ -5278,70 +5192,32 @@ } } }, - "/assets/{asset}/transactions": { + "/pools/{pool_id}": { "get": { "tags": [ - "Cardano » Assets" + "Cardano » Pools" ], - "summary": "Asset transactions", - "description": "List of a specific asset transactions", + "summary": "Specific stake pool", + "description": "Pool information.", "parameters": [ { "in": "path", - "name": "asset", + "name": "pool_id", "required": true, "schema": { "type": "string" }, - "description": "Concatenation of the policy_id and hex-encoded asset_name", - "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" } ], "responses": { "200": { - "description": "Return the information about the history of a specific asset", + "description": "Return the pool information content", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/asset_transactions" + "$ref": "#/components/schemas/pool" } } } @@ -5367,23 +5243,23 @@ } } }, - "/assets/{asset}/addresses": { + "/pools/{pool_id}/history": { "get": { "tags": [ - "Cardano » Assets" + "Cardano » Pools" ], - "summary": "Asset addresses", - "description": "List of a addresses containing a specific asset", + "summary": "Stake pool history", + "description": "History of stake pool parameters over epochs.\n", "parameters": [ { "in": "path", - "name": "asset", + "name": "pool_id", "required": true, "schema": { "type": "string" }, - "description": "Concatenation of the policy_id and hex-encoded asset_name", - "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" }, { "in": "query", @@ -5407,7 +5283,7 @@ "maximum": 21474836, "default": 1 }, - "description": "The page number for listing the results." + "description": "The page number for listing the results" }, { "in": "query", @@ -5426,11 +5302,11 @@ ], "responses": { "200": { - "description": "Return the information about the history of a specific asset", + "description": "Return the pool information content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/asset_addresses" + "$ref": "#/components/schemas/pool_history" } } } @@ -5456,70 +5332,39 @@ } } }, - "/assets/policy/{policy_id}": { + "/pools/{pool_id}/metadata": { "get": { "tags": [ - "Cardano » Assets" + "Cardano » Pools" ], - "summary": "Assets of a specific policy", - "description": "List of asset minted under a specific policy", + "summary": "Stake pool metadata", + "description": "Stake pool registration metadata.\n", "parameters": [ { "in": "path", - "name": "policy_id", + "name": "pool_id", "required": true, "schema": { "type": "string" }, - "description": "Specific policy_id", - "example": "476039a0949cf0b22f6a800f56780184c44533887ca6e821007840c3" - }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" } ], "responses": { "200": { - "description": "Return the information about a specific asset", + "description": "Return the pool metadata content.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/asset_policy" + "anyOf": [ + { + "$ref": "#/components/schemas/pool_metadata" + }, + { + "$ref": "#/components/schemas/empty_object" + } + ] } } } @@ -5545,22 +5390,83 @@ } } }, - "/scripts": { + "/pools/{pool_id}/relays": { "get": { "tags": [ - "Cardano » Scripts" + "Cardano » Pools" ], - "summary": "Scripts", - "description": "List of scripts.", + "summary": "Stake pool relays", + "description": "Relays of a stake pool.", "parameters": [ { - "in": "query", - "name": "count", - "required": false, + "in": "path", + "name": "pool_id", + "required": true, "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, + "type": "string" + }, + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + } + ], + "responses": { + "200": { + "description": "Return the pool relays information content.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pool_relays" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/pools/{pool_id}/delegators": { + "get": { + "tags": [ + "Cardano » Pools" + ], + "summary": "Stake pool delegators", + "description": "List of current stake pools delegators.", + "parameters": [ + { + "in": "path", + "name": "pool_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, "default": 100 }, "description": "The number of results displayed on one page." @@ -5594,11 +5500,11 @@ ], "responses": { "200": { - "description": "Return list of scripts", + "description": "Return the pool delegations.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/scripts" + "$ref": "#/components/schemas/pool_delegators" } } } @@ -5624,32 +5530,70 @@ } } }, - "/scripts/{script_hash}": { + "/pools/{pool_id}/blocks": { "get": { "tags": [ - "Cardano » Scripts" + "Cardano » Pools" ], - "summary": "Specific script", - "description": "Information about a specific script", + "summary": "Stake pool blocks", + "description": "List of stake pools blocks.", "parameters": [ { "in": "path", - "name": "script_hash", + "name": "pool_id", "required": true, "schema": { "type": "string" }, - "description": "Hash of the script", - "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the information about a specific script", + "description": "Return the pool block list", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/script" + "$ref": "#/components/schemas/pool_blocks" } } } @@ -5675,32 +5619,70 @@ } } }, - "/scripts/{script_hash}/json": { + "/pools/{pool_id}/updates": { "get": { "tags": [ - "Cardano » Scripts" + "Cardano » Pools" ], - "summary": "Script JSON", - "description": "JSON representation of a `timelock` script", + "summary": "Stake pool updates", + "description": "List of certificate updates to the stake pool.", "parameters": [ { "in": "path", - "name": "script_hash", + "name": "pool_id", "required": true, "schema": { "type": "string" }, - "description": "Hash of the script", - "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the JSON representation of a `timelock` script", + "description": "Return the pool updates history", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/script_json" + "$ref": "#/components/schemas/pool_updates" } } } @@ -5726,32 +5708,70 @@ } } }, - "/scripts/{script_hash}/cbor": { + "/pools/{pool_id}/votes": { "get": { "tags": [ - "Cardano » Scripts" + "Cardano » Pools" ], - "summary": "Script CBOR", - "description": "CBOR representation of a `plutus` script", + "summary": "Stake pool votes", + "description": "History of stake pools votes.", "parameters": [ { "in": "path", - "name": "script_hash", + "name": "pool_id", "required": true, "schema": { "type": "string" }, - "description": "Hash of the script", - "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" + "description": "Bech32 or hexadecimal pool ID.", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the CBOR representation of a `plutus` script", + "description": "Return the pool votes.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/script_cbor" + "$ref": "#/components/schemas/pool_votes" } } } @@ -5777,24 +5797,14 @@ } } }, - "/scripts/{script_hash}/redeemers": { + "/assets": { "get": { "tags": [ - "Cardano » Scripts" + "Cardano » Assets" ], - "summary": "Redeemers of a specific script", - "description": "List of redeemers of a specific script", + "summary": "Assets", + "description": "List of assets. If an asset is completely burned,\nit will stay on the list with quantity 0 (order of assets is immutable).\n", "parameters": [ - { - "in": "path", - "name": "script_hash", - "required": true, - "schema": { - "type": "string" - }, - "description": "Hash of the script", - "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" - }, { "in": "query", "name": "count", @@ -5831,16 +5841,16 @@ ], "default": "asc" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\nOrdering in this case is based on the time of the first mint transaction.\n" } ], "responses": { "200": { - "description": "Return the information about redeemers of a specific script", + "description": "Return list of assets", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/script_redeemers" + "$ref": "#/components/schemas/assets" } } } @@ -5866,32 +5876,32 @@ } } }, - "/scripts/datum/{datum_hash}": { + "/assets/{asset}": { "get": { "tags": [ - "Cardano » Scripts" + "Cardano » Assets" ], - "summary": "Datum value", - "description": "Query JSON value of a datum by its hash", + "summary": "Specific asset", + "description": "Information about a specific asset", "parameters": [ { "in": "path", - "name": "datum_hash", + "name": "asset", "required": true, "schema": { "type": "string" }, - "description": "Hash of the datum", - "example": "db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d" + "description": "Concatenation of the policy_id and hex-encoded asset_name", + "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" } ], "responses": { "200": { - "description": "Return the datum value", + "description": "Return the information about a specific asset", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/script_datum" + "$ref": "#/components/schemas/asset" } } } @@ -5917,32 +5927,70 @@ } } }, - "/scripts/datum/{datum_hash}/cbor": { + "/assets/{asset}/history": { "get": { "tags": [ - "Cardano » Scripts" + "Cardano » Assets" ], - "summary": "Datum CBOR value", - "description": "Query CBOR serialised datum by its hash", + "summary": "Asset history", + "description": "History of a specific asset", "parameters": [ { "in": "path", - "name": "datum_hash", + "name": "asset", "required": true, "schema": { "type": "string" }, - "description": "Hash of the datum", - "example": "db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d" + "description": "Concatenation of the policy_id and hex-encoded asset_name", + "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return the CBOR serialised datum value", + "description": "Return the information about the history of a specific asset", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/script_datum_cbor" + "$ref": "#/components/schemas/asset_history" } } } @@ -5968,52 +6016,71 @@ } } }, - "/utils/addresses/xpub/{xpub}/{role}/{index}": { + "/assets/{asset}/txs": { "get": { + "deprecated": true, "tags": [ - "Cardano » Utilities" + "Cardano » Assets" ], - "summary": "Derive an address", - "description": "Derive Shelley address from an xpub", + "summary": "Asset txs", + "description": "List of a specific asset transactions", "parameters": [ { "in": "path", - "name": "xpub", + "name": "asset", "required": true, "schema": { "type": "string" }, - "description": "Hex xpub", - "example": "d507c8f866691bd96e131334c355188b1a1d0b2fa0ab11545075aab332d77d9eb19657ad13ee581b56b0f8d744d66ca356b93d42fe176b3de007d53e9c4c4e7a" + "description": "Concatenation of the policy_id and hex-encoded asset_name", + "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" }, { - "in": "path", - "name": "role", - "required": true, + "in": "query", + "name": "count", + "required": false, "schema": { - "type": "integer" + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 }, - "description": "Account role", - "example": 0 + "description": "The number of results displayed on one page." }, { - "in": "path", - "name": "index", - "required": true, + "in": "query", + "name": "page", + "required": false, "schema": { - "type": "integer" + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 }, - "description": "Address index", - "example": 2 + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Return derivated Shelley address", + "description": "Return the information about the history of a specific asset", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/utils_addresses_xpub" + "$ref": "#/components/schemas/asset_txs" } } } @@ -6039,54 +6106,70 @@ } } }, - "/utils/txs/evaluate": { - "post": { + "/assets/{asset}/transactions": { + "get": { "tags": [ - "Cardano » Utilities" + "Cardano » Assets" ], - "summary": "Submit a transaction for execution units evaluation", - "description": "Submit an already serialized transaction to evaluate how much execution units it requires.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Asset transactions", + "description": "List of a specific asset transactions", "parameters": [ { - "in": "header", - "name": "Content-Type", + "in": "path", + "name": "asset", "required": true, + "schema": { + "type": "string" + }, + "description": "Concatenation of the policy_id and hex-encoded asset_name", + "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, "schema": { "type": "string", "enum": [ - "application/cbor" - ] - } - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "label": "cURL", - "source": "# Assuming `tx.data` is a CBOR serialized transaction on the file-system.\n# (encoded using base16 or base64)\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/utils/txs/evaluate\" \\\n -X POST \\\n -H \"Content-Type: application/cbor\" \\\n -H \"project_id: $PROJECT_ID\" \\\n --data @./tx.data\n" + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], - "requestBody": { - "description": "The transaction to submit, serialized in CBOR.\n", - "required": true, - "content": { - "application/cbor": { - "schema": { - "type": "string", - "description": "The transaction to submit, serialized in CBOR.\n" - }, - "example": "83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573\n" - } - } - }, "responses": { "200": { - "description": "\n
\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Asset addresses", + "description": "List of a addresses containing a specific asset", "parameters": [ { - "in": "header", - "name": "Content-Type", + "in": "path", + "name": "asset", "required": true, "schema": { - "type": "string", - "enum": [ - "application/json" - ] - } - } - ], - "requestBody": { - "description": "JSON payload", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cbor": { - "type": "string", - "description": "Transaction CBOR (encoded using base64 or base16)." - }, - "additionalUtxoSet": { - "type": "array", - "description": "Additional UTXO as an array of tuples [TxIn, TxOut]. See https://ogmios.dev/mini-protocols/local-tx-submission/#additional-utxo-set.", - "items": { - "type": "array", - "minItems": 2, - "maxItems": 2, - "items": { - "anyOf": [ - { - "type": "object", - "description": "TxIn", - "properties": { - "txId": { - "type": "string", - "description": "Transaction hash for the input" - }, - "index": { - "type": "number", - "description": "Index of the output within the transaction" - } - } - }, - { - "type": "object", - "description": "TxOut", - "properties": { - "address": { - "type": "string", - "description": "Output address" - }, - "value": { - "type": "object", - "properties": { - "coins": { - "type": "number", - "description": "Lovelace amount" - }, - "assets": { - "type": "object", - "description": "Assets amount", - "additionalProperties": { - "type": "number" - } - } - }, - "required": [ - "coins" - ] - }, - "datum_hash": { - "type": "string" - }, - "datum": { - "type": "object", - "additionalProperties": true - }, - "script": { - "type": "object", - "additionalProperties": true - } - }, - "required": [ - "address", - "value" - ] - } - ] - } - } - } - }, - "required": [ - "cbor" - ] - } - } - } - }, - "x-codeSamples": [ + "type": "string" + }, + "description": "Concatenation of the policy_id and hex-encoded asset_name", + "example": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e" + }, { - "lang": "Shell", - "label": "cURL", - "source": "# Assuming TxCbor is a CBOR serialized transaction encoded using base16 or base64\n# For a structure of additional UTXO set see https://ogmios.dev/mini-protocols/local-tx-submission/#additional-utxo-set\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/utils/txs/evaluate/utxos\" \\\n -X POST \\\n -H \"Content-Type: application/json\" \\\n -H \"project_id: $PROJECT_ID\" \\\n -d '{\"cbor\":\"\n
\n Hosted Endpoint only available for hosted variant.\n
\n", - "x-codeSamples": [ + "summary": "Assets of a specific policy", + "description": "List of asset minted under a specific policy", + "parameters": [ { - "lang": "Shell", - "label": "cURL", - "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/add\" \\\n -X POST \\\n -H \"project_id: $PROJECT_ID\" \\\n -F \"file=@./README.md\"\n" + "in": "path", + "name": "policy_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "Specific policy_id", + "example": "476039a0949cf0b22f6a800f56780184c44533887ca6e821007840c3" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary" - } - } - } - } - } - }, "responses": { "200": { - "description": "Returns information about added IPFS object", + "description": "Return the information about a specific asset", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "example": "README.md", - "description": "Name of the file" - }, - "ipfs_hash": { - "type": "string", - "example": "QmZbHqiCxKEVX7QfijzJTkZiSi3WEVTcvANgNAWzDYgZDr", - "description": "IPFS hash of the file" - }, - "size": { - "type": "string", - "example": "125297", - "description": "IPFS node size in Bytes" - } - }, - "required": [ - "name", - "ipfs_hash", - "size" - ] + "$ref": "#/components/schemas/asset_policy" } } } @@ -6358,37 +6373,60 @@ } } }, - "/ipfs/gateway/{IPFS_path}": { - "servers": [ - { - "url": "https://ipfs.blockfrost.io/api/v0" - } - ], + "/scripts": { "get": { "tags": [ - "IPFS » Gateway" + "Cardano » Scripts" ], - "summary": "Relay to an IPFS gateway", - "description": "Retrieve an object from the IPFS gateway (useful if you do not want to rely on a public gateway, such as `ipfs.blockfrost.dev`).\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Scripts", + "description": "List of scripts.", "parameters": [ { - "in": "path", - "required": true, - "name": "IPFS_path", + "in": "query", + "name": "count", + "required": false, "schema": { - "type": "string", - "description": "Path to the IPFS object" - } + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Returns the object content", + "description": "Return list of scripts", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/scripts" } } } @@ -6414,55 +6452,32 @@ } } }, - "/ipfs/pin/add/{IPFS_path}": { - "servers": [ - { - "url": "https://ipfs.blockfrost.io/api/v0" - } - ], - "post": { + "/scripts/{script_hash}": { + "get": { "tags": [ - "IPFS » Pins" + "Cardano » Scripts" ], - "summary": "Pin an object", - "description": "Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.", + "summary": "Specific script", + "description": "Information about a specific script", "parameters": [ { "in": "path", + "name": "script_hash", "required": true, - "name": "IPFS_path", "schema": { - "type": "string", - "description": "Path to the IPFS object" - } + "type": "string" + }, + "description": "Hash of the script", + "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" } ], "responses": { "200": { - "description": "Returns pinned object", + "description": "Return the information about a specific script", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "ipfs_hash": { - "type": "string", - "example": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8", - "description": "IPFS hash of the pinned object" - }, - "state": { - "type": "string", - "enum": [ - "queued|pinned|unpinned|failed|gc" - ], - "example": "queued", - "description": "State of the pin action" - } - }, - "required": [ - "ipfs_hash", - "state" - ] + "$ref": "#/components/schemas/script" } } } @@ -6479,9 +6494,6 @@ "418": { "$ref": "#/components/responses/418" }, - "425": { - "$ref": "#/components/responses/425-2" - }, "429": { "$ref": "#/components/responses/429" }, @@ -6491,105 +6503,32 @@ } } }, - "/ipfs/pin/list": { - "servers": [ - { - "url": "https://ipfs.blockfrost.io/api/v0" - } - ], + "/scripts/{script_hash}/json": { "get": { "tags": [ - "IPFS » Pins" + "Cardano » Scripts" ], - "summary": "List pinned objects", - "description": "List objects pinned to local storage\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Script JSON", + "description": "JSON representation of a `timelock` script", "parameters": [ { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." - }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." - }, - { - "in": "query", - "name": "order", - "required": false, + "in": "path", + "name": "script_hash", + "required": true, "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" + "type": "string" }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Hash of the script", + "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" } ], "responses": { "200": { - "description": "Returns pinned objects", + "description": "Return the JSON representation of a `timelock` script", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "time_created": { - "type": "integer", - "description": "Creation time of the IPFS object on our backends", - "example": 1615551024 - }, - "time_pinned": { - "type": "integer", - "description": "Pin time of the IPFS object on our backends", - "example": 1615551024 - }, - "ipfs_hash": { - "type": "string", - "description": "IPFS hash of the pinned object", - "example": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx" - }, - "size": { - "type": "string", - "description": "Size of the object in Bytes", - "example": "1615551024" - }, - "state": { - "type": "string", - "enum": [ - "queued|pinned|unpinned|failed|gc" - ], - "description": "State of the pinned object, which is `queued` when we are retriving object. If this\nis successful the state is changed to `pinned` or `failed` if not. The state `gc` means the\npinned item has been garbage collected due to account being over storage quota or after it has\nbeen moved to `unpinned` state by removing the object pin.\n", - "example": "pinned" - } - }, - "required": [ - "time_created", - "time_pinned", - "ipfs_hash", - "size", - "state" - ] - } + "$ref": "#/components/schemas/script_json" } } } @@ -6615,73 +6554,32 @@ } } }, - "/ipfs/pin/list/{IPFS_path}": { - "servers": [ - { - "url": "https://ipfs.blockfrost.io/api/v0" - } - ], + "/scripts/{script_hash}/cbor": { "get": { "tags": [ - "IPFS » Pins" + "Cardano » Scripts" ], - "summary": "Get details about pinned object", - "description": "Get information about locally pinned IPFS object\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Script CBOR", + "description": "CBOR representation of a `plutus` script", "parameters": [ { "in": "path", + "name": "script_hash", "required": true, - "name": "IPFS_path", "schema": { - "type": "string", - "description": "The path to the IPFS object" - } + "type": "string" + }, + "description": "Hash of the script", + "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" } ], "responses": { "200": { - "description": "Returns the pins pinned", + "description": "Return the CBOR representation of a `plutus` script", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "time_created": { - "type": "integer", - "description": "Time of the creation of the IPFS object on our backends", - "example": 1615551024 - }, - "time_pinned": { - "type": "integer", - "description": "Time of the pin of the IPFS object on our backends", - "example": 1615551024 - }, - "ipfs_hash": { - "type": "string", - "description": "IPFS hash of the pinned object", - "example": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx" - }, - "size": { - "type": "string", - "description": "Size of the object in Bytes", - "example": "1615551024" - }, - "state": { - "type": "string", - "enum": [ - "queued|pinned|unpinned|failed|gc" - ], - "description": "State of the pinned object. We define 5 states: `queued`, `pinned`, `unpinned`, `failed`, `gc`.\nWhen the object is pending retrieval (i.e. after `/ipfs/pin/add/{IPFS_path}`), the state is `queued`.\nIf the object is already successfully retrieved, state is changed to `pinned` or `failed` otherwise.\nWhen object is unpinned (i.e. after `/ipfs/pin/remove/{IPFS_path}`) it is marked for garbage collection.\nState `gc` means that a previously `unpinned` item has been garbage collected due to account being over storage quota.\n", - "example": "pinned" - } - }, - "required": [ - "time_created", - "time_pinned", - "ipfs_hash", - "size", - "state" - ] + "$ref": "#/components/schemas/script_cbor" } } } @@ -6707,55 +6605,70 @@ } } }, - "/ipfs/pin/remove/{IPFS_path}": { - "servers": [ - { - "url": "https://ipfs.blockfrost.io/api/v0" - } - ], - "post": { + "/scripts/{script_hash}/redeemers": { + "get": { "tags": [ - "IPFS » Pins" + "Cardano » Scripts" ], - "summary": "Remove a IPFS pin", - "description": "Remove pinned objects from local storage\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "summary": "Redeemers of a specific script", + "description": "List of redeemers of a specific script", "parameters": [ { "in": "path", + "name": "script_hash", "required": true, - "name": "IPFS_path", + "schema": { + "type": "string" + }, + "description": "Hash of the script", + "example": "e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e" + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, "schema": { "type": "string", - "description": "The path to the IPFS object" - } + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" } ], "responses": { "200": { - "description": "Returns the pins removed", + "description": "Return the information about redeemers of a specific script", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "ipfs_hash": { - "type": "string", - "example": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8", - "description": "IPFS hash of the pinned object" - }, - "state": { - "type": "string", - "enum": [ - "queued|pinned|unpinned|failed|gc" - ], - "example": "unpinned", - "description": "State of the pin action" - } - }, - "required": [ - "ipfs_hash", - "state" - ] + "$ref": "#/components/schemas/script_redeemers" } } } @@ -6781,20 +6694,32 @@ } } }, - "/metrics": { + "/scripts/datum/{datum_hash}": { "get": { "tags": [ - "Metrics" + "Cardano » Scripts" + ], + "summary": "Datum value", + "description": "Query JSON value of a datum by its hash", + "parameters": [ + { + "in": "path", + "name": "datum_hash", + "required": true, + "schema": { + "type": "string" + }, + "description": "Hash of the datum", + "example": "db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d" + } ], - "summary": "Blockfrost usage metrics", - "description": "History of your Blockfrost usage metrics in the past 30 days.", "responses": { "200": { - "description": "Return the last 30 days of metrics", + "description": "Return the datum value", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/metrics" + "$ref": "#/components/schemas/script_datum" } } } @@ -6820,20 +6745,32 @@ } } }, - "/metrics/endpoints": { + "/scripts/datum/{datum_hash}/cbor": { "get": { "tags": [ - "Metrics" + "Cardano » Scripts" + ], + "summary": "Datum CBOR value", + "description": "Query CBOR serialised datum by its hash", + "parameters": [ + { + "in": "path", + "name": "datum_hash", + "required": true, + "schema": { + "type": "string" + }, + "description": "Hash of the datum", + "example": "db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d" + } ], - "summary": "Blockfrost endpoint usage metrics", - "description": "History of your Blockfrost usage metrics per endpoint in the past 30 days.\n", "responses": { "200": { - "description": "Return the last 30 days of metrics", + "description": "Return the CBOR serialised datum value", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/metrics_endpoints" + "$ref": "#/components/schemas/script_datum_cbor" } } } @@ -6859,59 +6796,52 @@ } } }, - "/network": { + "/utils/addresses/xpub/{xpub}/{role}/{index}": { "get": { "tags": [ - "Cardano » Network" + "Cardano » Utilities" ], - "summary": "Network information", - "description": "Return detailed network information.", - "responses": { - "200": { - "description": "Return detailed network information.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/network" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "418": { - "$ref": "#/components/responses/418" + "summary": "Derive an address", + "description": "Derive Shelley address from an xpub", + "parameters": [ + { + "in": "path", + "name": "xpub", + "required": true, + "schema": { + "type": "string" + }, + "description": "Hex xpub", + "example": "d507c8f866691bd96e131334c355188b1a1d0b2fa0ab11545075aab332d77d9eb19657ad13ee581b56b0f8d744d66ca356b93d42fe176b3de007d53e9c4c4e7a" }, - "429": { - "$ref": "#/components/responses/429" + { + "in": "path", + "name": "role", + "required": true, + "schema": { + "type": "integer" + }, + "description": "Account role", + "example": 0 }, - "500": { - "$ref": "#/components/responses/500" + { + "in": "path", + "name": "index", + "required": true, + "schema": { + "type": "integer" + }, + "description": "Address index", + "example": 2 } - } - } - }, - "/network/eras": { - "get": { - "tags": [ - "Cardano » Network" ], - "summary": "Query summary of blockchain eras", - "description": "Returns start and end of each era along with\nparameters that can vary between hard forks.\n", "responses": { "200": { - "description": "Returns era summaries content.", + "description": "Return derivated Shelley address", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/network-eras" + "$ref": "#/components/schemas/utils_addresses_xpub" } } } @@ -6928,9 +6858,6 @@ "418": { "$ref": "#/components/responses/418" }, - "425": { - "$ref": "#/components/responses/425" - }, "429": { "$ref": "#/components/responses/429" }, @@ -6940,31 +6867,54 @@ } } }, - "/nutlink/{address}": { - "get": { + "/utils/txs/evaluate": { + "post": { "tags": [ - "Nut.link" + "Cardano » Utilities" ], - "summary": "Specific nut.link address", - "description": "List metadata about specific address", + "summary": "Submit a transaction for execution units evaluation", + "description": "Submit an already serialized transaction to evaluate how much execution units it requires.\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", "parameters": [ { - "in": "path", + "in": "header", + "name": "Content-Type", "required": true, - "name": "address", "schema": { "type": "string", - "description": "Address of a metadata oracle" + "enum": [ + "application/cbor" + ] } } ], + "x-codeSamples": [ + { + "lang": "Shell", + "label": "cURL", + "source": "# Assuming `tx.data` is a CBOR serialized transaction on the file-system.\n# (encoded using base16 or base64)\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/utils/txs/evaluate\" \\\n -X POST \\\n -H \"Content-Type: application/cbor\" \\\n -H \"project_id: $PROJECT_ID\" \\\n --data @./tx.data\n" + } + ], + "requestBody": { + "description": "The transaction to submit, serialized in CBOR.\n", + "required": true, + "content": { + "application/cbor": { + "schema": { + "type": "string", + "description": "The transaction to submit, serialized in CBOR.\n" + }, + "example": "83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573\n" + } + } + }, "responses": { "200": { - "description": "Return the metadata about metadata oracle", + "description": "\n
\n Hosted Endpoint only available for hosted variant.\n
\n", "parameters": [ { - "in": "path", + "in": "header", + "name": "Content-Type", "required": true, - "name": "address", "schema": { "type": "string", - "description": "Address of a metadata oracle" + "enum": [ + "application/json" + ] } - }, + } + ], + "requestBody": { + "description": "JSON payload", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cbor": { + "type": "string", + "description": "Transaction CBOR (encoded using base64 or base16)." + }, + "additionalUtxoSet": { + "type": "array", + "description": "Additional UTXO as an array of tuples [TxIn, TxOut]. See https://ogmios.dev/mini-protocols/local-tx-submission/#additional-utxo-set.", + "items": { + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "anyOf": [ + { + "type": "object", + "description": "TxIn", + "properties": { + "txId": { + "type": "string", + "description": "Transaction hash for the input" + }, + "index": { + "type": "number", + "description": "Index of the output within the transaction" + } + } + }, + { + "type": "object", + "description": "TxOut", + "properties": { + "address": { + "type": "string", + "description": "Output address" + }, + "value": { + "type": "object", + "properties": { + "coins": { + "type": "number", + "description": "Lovelace amount" + }, + "assets": { + "type": "object", + "description": "Assets amount", + "additionalProperties": { + "type": "number" + } + } + }, + "required": [ + "coins" + ] + }, + "datum_hash": { + "type": "string" + }, + "datum": { + "type": "object", + "additionalProperties": true + }, + "script": { + "type": "object", + "additionalProperties": true + } + }, + "required": [ + "address", + "value" + ] + } + ] + } + } + } + }, + "required": [ + "cbor" + ] + } + } + } + }, + "x-codeSamples": [ { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." + "lang": "Shell", + "label": "cURL", + "source": "# Assuming TxCbor is a CBOR serialized transaction encoded using base16 or base64\n# For a structure of additional UTXO set see https://ogmios.dev/mini-protocols/local-tx-submission/#additional-utxo-set\ncurl \"https://cardano-mainnet.blockfrost.io/api/v0/utils/txs/evaluate/utxos\" \\\n -X POST \\\n -H \"Content-Type: application/json\" \\\n -H \"project_id: $PROJECT_ID\" \\\n -d '{\"cbor\":\"\n
\n Hosted Endpoint only available for hosted variant.\n
\n", + "x-codeSamples": [ { - "in": "query", - "name": "order", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "lang": "Shell", + "label": "cURL", + "source": "curl \"https://ipfs.blockfrost.io/api/v0/ipfs/add\" \\\n -X POST \\\n -H \"project_id: $PROJECT_ID\" \\\n -F \"file=@./README.md\"\n" } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary" + } + } + } + } + } + }, "responses": { "200": { - "description": "Return the tickers provided by the metadata oracle", + "description": "Returns information about added IPFS object", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/nutlink_address_tickers" + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "README.md", + "description": "Name of the file" + }, + "ipfs_hash": { + "type": "string", + "example": "QmZbHqiCxKEVX7QfijzJTkZiSi3WEVTcvANgNAWzDYgZDr", + "description": "IPFS hash of the file" + }, + "size": { + "type": "string", + "example": "125297", + "description": "IPFS node size in Bytes" + } + }, + "required": [ + "name", + "ipfs_hash", + "size" + ] } } } @@ -7078,78 +7186,111 @@ } } }, - "/nutlink/{address}/tickers/{ticker}": { + "/ipfs/gateway/{IPFS_path}": { + "servers": [ + { + "url": "https://ipfs.blockfrost.io/api/v0" + } + ], "get": { "tags": [ - "Nut.link" + "IPFS » Gateway" ], - "summary": "Specific ticker for an address", - "description": "List of records of a specific ticker", + "summary": "Relay to an IPFS gateway", + "description": "Retrieve an object from the IPFS gateway (useful if you do not want to rely on a public gateway, such as `ipfs.blockfrost.dev`).\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", "parameters": [ { "in": "path", "required": true, - "name": "address", + "name": "IPFS_path", "schema": { "type": "string", - "description": "Address of a metadata oracle" + "description": "Path to the IPFS object" } - }, - { - "in": "path", - "required": true, - "name": "ticker", - "schema": { - "type": "string", - "description": "Ticker for the pool record" + } + ], + "responses": { + "200": { + "description": "Returns the object content", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } } }, - { - "in": "query", - "name": "count", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "default": 100 - }, - "description": "The number of results displayed on one page." + "400": { + "$ref": "#/components/responses/400" }, - { - "in": "query", - "name": "page", - "required": false, - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 21474836, - "default": 1 - }, - "description": "The page number for listing the results." + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/ipfs/pin/add/{IPFS_path}": { + "servers": [ + { + "url": "https://ipfs.blockfrost.io/api/v0" + } + ], + "post": { + "tags": [ + "IPFS » Pins" + ], + "summary": "Pin an object", + "description": "Pinning is necessary to avoid regular garbage collection (deletion) of IPFS objects. Non-pinned objects are regularly being removed without prior notice. Pinned objects are counted in your user storage quota.", + "parameters": [ { - "in": "query", - "name": "order", - "required": false, + "in": "path", + "required": true, + "name": "IPFS_path", "schema": { "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "asc" - }, - "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + "description": "Path to the IPFS object" + } } ], "responses": { "200": { - "description": "Return the tickers provided by the metadata oracle", + "description": "Returns pinned object", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/nutlink_address_ticker" + "type": "object", + "properties": { + "ipfs_hash": { + "type": "string", + "example": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8", + "description": "IPFS hash of the pinned object" + }, + "state": { + "type": "string", + "enum": [ + "queued|pinned|unpinned|failed|gc" + ], + "example": "queued", + "description": "State of the pin action" + } + }, + "required": [ + "ipfs_hash", + "state" + ] } } } @@ -7166,6 +7307,9 @@ "418": { "$ref": "#/components/responses/418" }, + "425": { + "$ref": "#/components/responses/425-2" + }, "429": { "$ref": "#/components/responses/429" }, @@ -7175,23 +7319,19 @@ } } }, - "/nutlink/tickers/{ticker}": { + "/ipfs/pin/list": { + "servers": [ + { + "url": "https://ipfs.blockfrost.io/api/v0" + } + ], "get": { "tags": [ - "Nut.link" + "IPFS » Pins" ], - "summary": "Specific ticker", - "description": "List of records of a specific ticker", + "summary": "List pinned objects", + "description": "List objects pinned to local storage\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", "parameters": [ - { - "in": "path", - "required": true, - "name": "ticker", - "schema": { - "type": "string", - "description": "Ticker for the pool record" - } - }, { "in": "query", "name": "count", @@ -7233,11 +7373,51 @@ ], "responses": { "200": { - "description": "Return the tickers provided by the metadata oracle", + "description": "Returns pinned objects", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/nutlink_tickers_ticker" + "type": "array", + "items": { + "type": "object", + "properties": { + "time_created": { + "type": "integer", + "description": "Creation time of the IPFS object on our backends", + "example": 1615551024 + }, + "time_pinned": { + "type": "integer", + "description": "Pin time of the IPFS object on our backends", + "example": 1615551024 + }, + "ipfs_hash": { + "type": "string", + "description": "IPFS hash of the pinned object", + "example": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx" + }, + "size": { + "type": "string", + "description": "Size of the object in Bytes", + "example": "1615551024" + }, + "state": { + "type": "string", + "enum": [ + "queued|pinned|unpinned|failed|gc" + ], + "description": "State of the pinned object, which is `queued` when we are retriving object. If this\nis successful the state is changed to `pinned` or `failed` if not. The state `gc` means the\npinned item has been garbage collected due to account being over storage quota or after it has\nbeen moved to `unpinned` state by removing the object pin.\n", + "example": "pinned" + } + }, + "required": [ + "time_created", + "time_pinned", + "ipfs_hash", + "size", + "state" + ] + } } } } @@ -7262,277 +7442,1429 @@ } } } - } - }, - "components": { - "schemas": { - "onchain_metadata_cip25": { - "$ref": "#/components/schemas/asset_onchain_metadata_cip25" - }, - "onchain_metadata_cip68_ft_333": { - "$ref": "#/components/schemas/asset_onchain_metadata_cip68_ft_333" - }, - "onchain_metadata_cip68_nft_222": { - "$ref": "#/components/schemas/asset_onchain_metadata_cip68_nft_222" - }, - "onchain_metadata_cip68_rft_444": { - "$ref": "#/components/schemas/asset_onchain_metadata_cip68_rft_444" - }, - "block_content": { - "type": "object", - "properties": { - "time": { - "type": "integer", - "example": 1641338934, - "description": "Block creation time in UNIX time" - }, - "height": { - "type": "integer", - "nullable": true, - "example": 15243593, - "description": "Block number" - }, - "hash": { - "type": "string", - "example": "4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a", - "description": "Hash of the block" - }, - "slot": { - "type": "integer", - "nullable": true, - "example": 412162133, - "description": "Slot number" - }, - "epoch": { - "type": "integer", - "nullable": true, - "example": 425, - "description": "Epoch number" - }, - "epoch_slot": { - "type": "integer", - "nullable": true, - "example": 12, - "description": "Slot within the epoch" - }, - "slot_leader": { - "type": "string", - "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy", - "description": "Bech32 ID of the slot leader or specific block description in case there is no slot leader" - }, - "size": { - "type": "integer", - "example": 3, - "description": "Block size in Bytes" - }, - "tx_count": { - "type": "integer", - "example": 1, - "description": "Number of transactions in the block" - }, - "output": { - "type": "string", - "nullable": true, - "example": "128314491794", - "description": "Total output within the block in Lovelaces" - }, - "fees": { - "type": "string", - "nullable": true, + }, + "/ipfs/pin/list/{IPFS_path}": { + "servers": [ + { + "url": "https://ipfs.blockfrost.io/api/v0" + } + ], + "get": { + "tags": [ + "IPFS » Pins" + ], + "summary": "Get details about pinned object", + "description": "Get information about locally pinned IPFS object\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "parameters": [ + { + "in": "path", + "required": true, + "name": "IPFS_path", + "schema": { + "type": "string", + "description": "The path to the IPFS object" + } + } + ], + "responses": { + "200": { + "description": "Returns the pins pinned", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "time_created": { + "type": "integer", + "description": "Time of the creation of the IPFS object on our backends", + "example": 1615551024 + }, + "time_pinned": { + "type": "integer", + "description": "Time of the pin of the IPFS object on our backends", + "example": 1615551024 + }, + "ipfs_hash": { + "type": "string", + "description": "IPFS hash of the pinned object", + "example": "QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx" + }, + "size": { + "type": "string", + "description": "Size of the object in Bytes", + "example": "1615551024" + }, + "state": { + "type": "string", + "enum": [ + "queued|pinned|unpinned|failed|gc" + ], + "description": "State of the pinned object. We define 5 states: `queued`, `pinned`, `unpinned`, `failed`, `gc`.\nWhen the object is pending retrieval (i.e. after `/ipfs/pin/add/{IPFS_path}`), the state is `queued`.\nIf the object is already successfully retrieved, state is changed to `pinned` or `failed` otherwise.\nWhen object is unpinned (i.e. after `/ipfs/pin/remove/{IPFS_path}`) it is marked for garbage collection.\nState `gc` means that a previously `unpinned` item has been garbage collected due to account being over storage quota.\n", + "example": "pinned" + } + }, + "required": [ + "time_created", + "time_pinned", + "ipfs_hash", + "size", + "state" + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/ipfs/pin/remove/{IPFS_path}": { + "servers": [ + { + "url": "https://ipfs.blockfrost.io/api/v0" + } + ], + "post": { + "tags": [ + "IPFS » Pins" + ], + "summary": "Remove a IPFS pin", + "description": "Remove pinned objects from local storage\n\n\n Hosted Endpoint only available for hosted variant.\n
\n", + "parameters": [ + { + "in": "path", + "required": true, + "name": "IPFS_path", + "schema": { + "type": "string", + "description": "The path to the IPFS object" + } + } + ], + "responses": { + "200": { + "description": "Returns the pins removed", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ipfs_hash": { + "type": "string", + "example": "QmPojRfAXYAXV92Dof7gtSgaVuxEk64xx9CKvprqu9VwA8", + "description": "IPFS hash of the pinned object" + }, + "state": { + "type": "string", + "enum": [ + "queued|pinned|unpinned|failed|gc" + ], + "example": "unpinned", + "description": "State of the pin action" + } + }, + "required": [ + "ipfs_hash", + "state" + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/metrics": { + "get": { + "tags": [ + "Metrics" + ], + "summary": "Blockfrost usage metrics", + "description": "History of your Blockfrost usage metrics in the past 30 days.", + "responses": { + "200": { + "description": "Return the last 30 days of metrics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/metrics" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/metrics/endpoints": { + "get": { + "tags": [ + "Metrics" + ], + "summary": "Blockfrost endpoint usage metrics", + "description": "History of your Blockfrost usage metrics per endpoint in the past 30 days.\n", + "responses": { + "200": { + "description": "Return the last 30 days of metrics", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/metrics_endpoints" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/network": { + "get": { + "tags": [ + "Cardano » Network" + ], + "summary": "Network information", + "description": "Return detailed network information.", + "responses": { + "200": { + "description": "Return detailed network information.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/network" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/network/eras": { + "get": { + "tags": [ + "Cardano » Network" + ], + "summary": "Query summary of blockchain eras", + "description": "Returns start and end of each era along with\nparameters that can vary between hard forks.\n", + "responses": { + "200": { + "description": "Returns era summaries content.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/network-eras" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "425": { + "$ref": "#/components/responses/425" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/nutlink/{address}": { + "get": { + "tags": [ + "Nut.link" + ], + "summary": "Specific nut.link address", + "description": "List metadata about specific address", + "parameters": [ + { + "in": "path", + "required": true, + "name": "address", + "schema": { + "type": "string", + "description": "Address of a metadata oracle" + } + } + ], + "responses": { + "200": { + "description": "Return the metadata about metadata oracle", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nutlink_address" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/nutlink/{address}/tickers": { + "get": { + "tags": [ + "Nut.link" + ], + "summary": "List of tickers of an oracle", + "description": "List of records of a specific oracle", + "parameters": [ + { + "in": "path", + "required": true, + "name": "address", + "schema": { + "type": "string", + "description": "Address of a metadata oracle" + } + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + } + ], + "responses": { + "200": { + "description": "Return the tickers provided by the metadata oracle", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nutlink_address_tickers" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/nutlink/{address}/tickers/{ticker}": { + "get": { + "tags": [ + "Nut.link" + ], + "summary": "Specific ticker for an address", + "description": "List of records of a specific ticker", + "parameters": [ + { + "in": "path", + "required": true, + "name": "address", + "schema": { + "type": "string", + "description": "Address of a metadata oracle" + } + }, + { + "in": "path", + "required": true, + "name": "ticker", + "schema": { + "type": "string", + "description": "Ticker for the pool record" + } + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + } + ], + "responses": { + "200": { + "description": "Return the tickers provided by the metadata oracle", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nutlink_address_ticker" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + }, + "/nutlink/tickers/{ticker}": { + "get": { + "tags": [ + "Nut.link" + ], + "summary": "Specific ticker", + "description": "List of records of a specific ticker", + "parameters": [ + { + "in": "path", + "required": true, + "name": "ticker", + "schema": { + "type": "string", + "description": "Ticker for the pool record" + } + }, + { + "in": "query", + "name": "count", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 100 + }, + "description": "The number of results displayed on one page." + }, + { + "in": "query", + "name": "page", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 21474836, + "default": 1 + }, + "description": "The page number for listing the results." + }, + { + "in": "query", + "name": "order", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "description": "The ordering of items from the point of view of the blockchain,\nnot the page listing itself. By default, we return oldest first, newest last.\n" + } + ], + "responses": { + "200": { + "description": "Return the tickers provided by the metadata oracle", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/nutlink_tickers_ticker" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "418": { + "$ref": "#/components/responses/418" + }, + "429": { + "$ref": "#/components/responses/429" + }, + "500": { + "$ref": "#/components/responses/500" + } + } + } + } + }, + "components": { + "schemas": { + "onchain_metadata_cip25": { + "$ref": "#/components/schemas/asset_onchain_metadata_cip25" + }, + "onchain_metadata_cip68_ft_333": { + "$ref": "#/components/schemas/asset_onchain_metadata_cip68_ft_333" + }, + "onchain_metadata_cip68_nft_222": { + "$ref": "#/components/schemas/asset_onchain_metadata_cip68_nft_222" + }, + "onchain_metadata_cip68_rft_444": { + "$ref": "#/components/schemas/asset_onchain_metadata_cip68_rft_444" + }, + "block_content": { + "type": "object", + "properties": { + "time": { + "type": "integer", + "example": 1641338934, + "description": "Block creation time in UNIX time" + }, + "height": { + "type": "integer", + "nullable": true, + "example": 15243593, + "description": "Block number" + }, + "hash": { + "type": "string", + "example": "4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a", + "description": "Hash of the block" + }, + "slot": { + "type": "integer", + "nullable": true, + "example": 412162133, + "description": "Slot number" + }, + "epoch": { + "type": "integer", + "nullable": true, + "example": 425, + "description": "Epoch number" + }, + "epoch_slot": { + "type": "integer", + "nullable": true, + "example": 12, + "description": "Slot within the epoch" + }, + "slot_leader": { + "type": "string", + "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy", + "description": "Bech32 ID of the slot leader or specific block description in case there is no slot leader" + }, + "size": { + "type": "integer", + "example": 3, + "description": "Block size in Bytes" + }, + "tx_count": { + "type": "integer", + "example": 1, + "description": "Number of transactions in the block" + }, + "output": { + "type": "string", + "nullable": true, + "example": "128314491794", + "description": "Total output within the block in Lovelaces" + }, + "fees": { + "type": "string", + "nullable": true, "example": "592661", "description": "Total fees within the block in Lovelaces" }, - "block_vrf": { - "type": "string", - "nullable": true, - "example": "vrf_vk1wf2k6lhujezqcfe00l6zetxpnmh9n6mwhpmhm0dvfh3fxgmdnrfqkms8ty", - "description": "VRF key of the block", - "minLength": 65, - "maxLength": 65 + "block_vrf": { + "type": "string", + "nullable": true, + "example": "vrf_vk1wf2k6lhujezqcfe00l6zetxpnmh9n6mwhpmhm0dvfh3fxgmdnrfqkms8ty", + "description": "VRF key of the block", + "minLength": 65, + "maxLength": 65 + }, + "op_cert": { + "type": "string", + "nullable": true, + "example": "da905277534faf75dae41732650568af545134ee08a3c0392dbefc8096ae177c", + "description": "The hash of the operational certificate of the block producer" + }, + "op_cert_counter": { + "type": "string", + "nullable": true, + "example": "18", + "description": "The value of the counter used to produce the operational certificate" + }, + "previous_block": { + "type": "string", + "nullable": true, + "example": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05", + "description": "Hash of the previous block" + }, + "next_block": { + "type": "string", + "nullable": true, + "example": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa", + "description": "Hash of the next block" + }, + "confirmations": { + "type": "integer", + "example": 4698, + "description": "Number of block confirmations" + } + }, + "required": [ + "time", + "height", + "hash", + "slot", + "epoch", + "epoch_slot", + "slot_leader", + "size", + "tx_count", + "output", + "fees", + "block_vrf", + "op_cert", + "op_cert_counter", + "previous_block", + "next_block", + "confirmations" + ] + }, + "block_content_txs": { + "type": "array", + "items": { + "type": "string", + "description": "Hash of the transaction" + }, + "example": [ + "8788591983aa73981fc92d6cddbbe643959f5a784e84b8bee0db15823f575a5b", + "4eef6bb7755d8afbeac526b799f3e32a624691d166657e9d862aaeb66682c036", + "52e748c4dec58b687b90b0b40d383b9fe1f24c1a833b7395cdf07dd67859f46f", + "e8073fd5318ff43eca18a852527166aa8008bee9ee9e891f585612b7e4ba700b" + ] + }, + "block_content_array": { + "type": "array", + "items": { + "$ref": "#/components/schemas/block_content" + } + }, + "block_content_addresses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "address": { + "type": "string", + "description": "Address that was affected in the specified block" + }, + "transactions": { + "type": "array", + "description": "List of transactions containing the address either in their inputs or outputs. Sorted by transaction index within a block, ascending.", + "items": { + "type": "object", + "properties": { + "tx_hash": { + "type": "string" + } + }, + "required": [ + "tx_hash" + ] + } + } + }, + "required": [ + "address", + "transactions" + ] + }, + "example": [ + { + "address": "addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv", + "transactions": [ + { + "tx_hash": "1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157f0" + } + ] + }, + { + "address": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz", + "transactions": [ + { + "tx_hash": "1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157d0" + } + ] + } + ] + }, + "genesis_content": { + "type": "object", + "properties": { + "active_slots_coefficient": { + "type": "number", + "example": 0.05, + "description": "The proportion of slots in which blocks should be issued" + }, + "update_quorum": { + "type": "integer", + "example": 5, + "description": "Determines the quorum needed for votes on the protocol parameter updates" + }, + "max_lovelace_supply": { + "type": "string", + "example": "45000000000000000", + "description": "The total number of lovelace in the system" + }, + "network_magic": { + "type": "integer", + "example": 764824073, + "description": "Network identifier" + }, + "epoch_length": { + "type": "integer", + "example": 432000, + "description": "Number of slots in an epoch" + }, + "system_start": { + "type": "integer", + "example": 1506203091, + "description": "Time of slot 0 in UNIX time" }, - "op_cert": { - "type": "string", - "nullable": true, - "example": "da905277534faf75dae41732650568af545134ee08a3c0392dbefc8096ae177c", - "description": "The hash of the operational certificate of the block producer" + "slots_per_kes_period": { + "type": "integer", + "example": 129600, + "description": "Number of slots in an KES period" }, - "op_cert_counter": { + "slot_length": { + "type": "integer", + "example": 1, + "description": "Duration of one slot in seconds" + }, + "max_kes_evolutions": { + "type": "integer", + "example": 62, + "description": "The maximum number of time a KES key can be evolved before a pool operator must create a new operational certificate" + }, + "security_param": { + "type": "integer", + "example": 2160, + "description": "Security parameter k" + } + }, + "required": [ + "active_slots_coefficient", + "update_quorum", + "max_lovelace_supply", + "network_magic", + "epoch_length", + "system_start", + "slots_per_kes_period", + "slot_length", + "max_kes_evolutions", + "security_param" + ] + }, + "drep_content": { + "type": "array", + "items": { + "type": "object", + "properties": { + "drep_id": { + "type": "string", + "description": "The Bech32 encoded DRep address" + }, + "hex": { + "type": "string", + "description": "The raw bytes of the DRep" + } + }, + "required": [ + "drep_id", + "hex" + ] + }, + "example": [ + { + "drep_id": "drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn", + "hex": "db1bc3c3f99ce68977ceaf27ab4dd917123ef9e73f85c304236eab23" + }, + { + "drep_id": "drep1cxayn4fgy27yaucvhamsvqj3v6835mh3tjjx6x8hdnr4", + "hex": "c1ba49d52822bc4ef30cbf77060251668f1a6ef15ca46d18f76cc758" + } + ] + }, + "drep_details_content": { + "type": "object", + "properties": { + "drep_id": { "type": "string", - "nullable": true, - "example": "18", - "description": "The value of the counter used to produce the operational certificate" + "description": "Bech32 encoded DRep address" }, - "previous_block": { + "hex": { "type": "string", - "nullable": true, - "example": "43ebccb3ac72c7cebd0d9b755a4b08412c9f5dcb81b8a0ad1e3c197d29d47b05", - "description": "Hash of the previous block" + "description": "The raw bytes of the DRep" }, - "next_block": { + "amount": { "type": "string", - "nullable": true, - "example": "8367f026cf4b03e116ff8ee5daf149b55ba5a6ec6dec04803b8dc317721d15fa", - "description": "Hash of the next block" + "description": "The total amount of voting power this DRep is delegated." }, - "confirmations": { + "active": { + "type": "boolean", + "description": "Registration state of the DRep" + }, + "active_epoch": { "type": "integer", - "example": 4698, - "description": "Number of block confirmations" + "nullable": true, + "description": "Epoch of the most recent action - registration or deregistration" + }, + "has_script": { + "type": "boolean", + "description": "Flag which shows if this DRep credentials are a script hash" } }, "required": [ - "time", - "height", - "hash", - "slot", - "epoch", - "epoch_slot", - "slot_leader", - "size", - "tx_count", - "output", - "fees", - "block_vrf", - "op_cert", - "op_cert_counter", - "previous_block", - "next_block", - "confirmations" + "drep_id", + "hex", + "amount", + "active", + "active_epoch", + "has_script" + ], + "example": [ + { + "drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc", + "hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d", + "amount": "2000000", + "active": true, + "active_epoch": 420, + "has_script": true + } ] }, - "block_content_txs": { + "drep_delegators": { "type": "array", "items": { - "type": "string", - "description": "Hash of the transaction" + "type": "object", + "properties": { + "address": { + "type": "string", + "description": "Bech32 encoded stake addresses" + }, + "amount": { + "type": "string", + "description": "Currently delegated amount" + } + }, + "required": [ + "address", + "amount" + ] }, "example": [ - "8788591983aa73981fc92d6cddbbe643959f5a784e84b8bee0db15823f575a5b", - "4eef6bb7755d8afbeac526b799f3e32a624691d166657e9d862aaeb66682c036", - "52e748c4dec58b687b90b0b40d383b9fe1f24c1a833b7395cdf07dd67859f46f", - "e8073fd5318ff43eca18a852527166aa8008bee9ee9e891f585612b7e4ba700b" + { + "address": "stake1ux4vspfvwuus9uwyp5p3f0ky7a30jq5j80jxse0fr7pa56sgn8kha", + "amount": "1137959159981411" + }, + { + "address": "stake1uylayej7esmarzd4mk4aru37zh9yz0luj3g9fsvgpfaxulq564r5u", + "amount": "16958865648" + }, + { + "address": "stake1u8lr2pnrgf8f7vrs9lt79hc3sxm8s2w4rwvgpncks3axx6q93d4ck", + "amount": "18605647" + } ] }, - "block_content_array": { + "drep_metadata": { + "type": "object", + "properties": { + "drep_id": { + "type": "string", + "description": "Bech32 encoded addresses" + }, + "hex": { + "type": "string", + "description": "The raw bytes of the DRep" + }, + "url": { + "type": "string", + "nullable": true, + "example": "https://stakenuts.com/drep.json", + "description": "URL to the drep metadata" + }, + "hash": { + "type": "string", + "nullable": true, + "example": "69c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c\"", + "description": "Hash of the metadata file" + } + }, + "required": [ + "drep_id", + "hex", + "url", + "hash" + ], + "example": [ + { + "drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc", + "hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d", + "url": "https://stakenuts.com/drep.json", + "hash": "69c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c" + } + ] + }, + "drep_updates": { "type": "array", "items": { - "$ref": "#/components/schemas/block_content" - } + "type": "object", + "properties": { + "tx_hash": { + "type": "string", + "description": "Transaction ID" + }, + "cert_index": { + "type": "integer", + "description": "Certificate within the transaction" + }, + "action": { + "type": "string", + "enum": [ + "registered", + "deregistered" + ], + "description": "Action in the certificate" + } + }, + "required": [ + "tx_hash", + "cert_index", + "action" + ] + }, + "example": [ + { + "tx_hash": "f4097fbdb87ab7c7ab44b30d4e2b81713a058488975d1ab8b05c381dd946a393", + "cert_index": 0, + "action": "registered" + }, + { + "tx_hash": "dd3243af975be4b5bedce4e5f5b483b2386d5ad207d05e0289c1df0eb261447e", + "cert_index": 0, + "action": "deregistered" + } + ] }, - "block_content_addresses": { + "drep_votes": { "type": "array", "items": { "type": "object", "properties": { - "address": { + "tx_hash": { "type": "string", - "description": "Address that was affected in the specified block" + "description": "Hash of the proposal transaction." }, - "transactions": { - "type": "array", - "description": "List of transactions containing the address either in their inputs or outputs. Sorted by transaction index within a block, ascending.", - "items": { - "type": "object", - "properties": { - "tx_hash": { - "type": "string" - } - }, - "required": [ - "tx_hash" - ] - } + "cert_index": { + "type": "integer", + "description": "Index of the certificate within the proposal transaction." + }, + "vote": { + "type": "string", + "enum": [ + "yes", + "no", + "abstain" + ], + "description": "The Vote. Can be one of yes, no, abstain." + } + }, + "required": [ + "tx_hash", + "cert_index", + "vote" + ] + }, + "example": [ + { + "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + "cert_index": 2, + "vote": "yes" + }, + { + "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + "cert_index": 3, + "vote": "abstain" + } + ] + }, + "proposal_content": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tx_hash": { + "type": "string", + "description": "Hash of the proposal transaction." + }, + "cert_index": { + "type": "integer", + "description": "Index of the certificate within the proposal transaction." + }, + "governance_type": { + "type": "string", + "enum": [ + "hard_fork_initiation", + "new_committee", + "new_constitution", + "info_action", + "no_confidence", + "parameter_change", + "treasury_withdrawals" + ], + "description": "Type of proposal." } }, "required": [ - "address", - "transactions" + "tx_hash", + "cert_index", + "governance_type" ] }, "example": [ { - "address": "addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv", - "transactions": [ - { - "tx_hash": "1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157f0" - } - ] + "tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531", + "cert_index": 1, + "governance_type": "treasury_withdrawals" }, { - "address": "addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz", - "transactions": [ - { - "tx_hash": "1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157d0" - } - ] + "tx_hash": "71317e951b20aa46e9fbf45a46a6e950d5723a481225519655bf6c60", + "cert_index": 4, + "governance_type": "no_confidence" } ] }, - "genesis_content": { + "proposal_details_content": { "type": "object", "properties": { - "active_slots_coefficient": { - "type": "number", - "example": 0.05, - "description": "The proportion of slots in which blocks should be issued" + "tx_hash": { + "type": "string", + "description": "Hash of the proposal transaction." }, - "update_quorum": { + "cert_index": { "type": "integer", - "example": 5, - "description": "Determines the quorum needed for votes on the protocol parameter updates" + "description": "Index of the certificate within the proposal transaction." }, - "max_lovelace_supply": { + "governance_type": { "type": "string", - "example": "45000000000000000", - "description": "The total number of lovelace in the system" + "enum": [ + "hard_fork_initiation", + "new_committee", + "new_constitution", + "info_action", + "no_confidence", + "parameter_change", + "treasury_withdrawals" + ], + "description": "Type of proposal." }, - "network_magic": { - "type": "integer", - "example": 764824073, - "description": "Network identifier" + "governance_description": { + "additionalProperties": true, + "type": "object", + "nullable": true, + "description": "An object describing the content of this GovActionProposal in a readable way." }, - "epoch_length": { - "type": "integer", - "example": 432000, - "description": "Number of slots in an epoch" + "deposit": { + "type": "string", + "description": "The deposit amount paid for this proposal." }, - "system_start": { + "return_address": { + "type": "string", + "description": "Bech32 stake address of the reward address to receive the deposit when it is repaid." + }, + "ratified_epoch": { "type": "integer", - "example": 1506203091, - "description": "Time of slot 0 in UNIX time" + "nullable": true }, - "slots_per_kes_period": { + "enacted_epoch": { "type": "integer", - "example": 129600, - "description": "Number of slots in an KES period" + "nullable": true }, - "slot_length": { + "dropped_epoch": { "type": "integer", - "example": 1, - "description": "Duration of one slot in seconds" + "nullable": true }, - "max_kes_evolutions": { + "expired_epoch": { "type": "integer", - "example": 62, - "description": "The maximum number of time a KES key can be evolved before a pool operator must create a new operational certificate" + "nullable": true }, - "security_param": { + "expiration": { "type": "integer", - "example": 2160, - "description": "Security parameter k" + "description": "Shows the epoch at which this governance action will expire." + }, + "anchor_url": { + "type": "string", + "nullable": true, + "description": "The URL of the offchain anchor data." + }, + "anchor_hash": { + "type": "string", + "nullable": true, + "description": "The hash of the offchain anchor data." } }, "required": [ - "active_slots_coefficient", - "update_quorum", - "max_lovelace_supply", - "network_magic", - "epoch_length", - "system_start", - "slots_per_kes_period", - "slot_length", - "max_kes_evolutions", - "security_param" + "tx_hash", + "cert_index", + "governance_type", + "deposit", + "return_address", + "governance_description", + "ratified_epoch", + "enacted_epoch", + "dropped_epoch", + "expired_epoch", + "expiration", + "anchor_url", + "anchor_hash" + ], + "example": [ + { + "tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531", + "cert_index": 1, + "governance_type": "treasury_withdrawals", + "deposit": 12000, + "return_address": "stake_test1urd3hs7rlxwwdzthe6hj026dmyt3y0heuulctscyydh2kgck6nkmz", + "governance_description": "TreasuryWithdrawals (fromList [(RewardAcnt {getRwdNetwork = Testnet, getRwdCred = KeyHashObj (KeyHash \"71317e951b20aa46e9fbf45a46a6e950d5723a481225519655bf6c60\")},Coin 20000000)])", + "ratified_epoch": null, + "enacted_epoch": 123, + "dropped_epoch": null, + "expired_epoch": null, + "expiration": 120, + "anchor_url": "https://gist.github.com/123", + "anchor_hash": "50b340624d49823720505e3f0095be0d6cd8f26501e094a6ab9068dd" + } + ] + }, + "proposal_details_votes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tx_hash": { + "type": "string", + "description": "Hash of the voting transaction." + }, + "cert_index": { + "type": "integer", + "description": "Index of the certificate within the voting transaction." + }, + "voter_role": { + "type": "string", + "enum": [ + "constitutional_committee", + "drep", + "spo" + ], + "description": "The role of the voter. Can be one of constitutional_committee, drep, spo." + }, + "voter": { + "type": "string", + "description": "The actual voter." + }, + "vote": { + "type": "string", + "enum": [ + "yes", + "no", + "abstain" + ], + "description": "The Vote. Can be one of yes, no, abstain." + } + }, + "required": [ + "tx_hash", + "cert_index", + "voter_role", + "voter", + "vote" + ] + }, + "example": [ + { + "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + "cert_index": 2, + "voter_role": "drep", + "voter": "drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn", + "vote": "yes" + }, + { + "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + "cert_index": 3, + "voter_role": "constitutional_committee", + "voter": "53a42debdc7ffd90085ab7fd9800b63e6d1c9ac481ba6eb7b6a844e4", + "vote": "abstain" + } + ] + }, + "vote_content": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tx_hash": { + "type": "string", + "description": "Hash of the proposal transaction." + }, + "cert_index": { + "type": "integer", + "description": "Index of the certificate within the proposal transaction." + }, + "voter_role": { + "type": "string", + "enum": [ + "constitutional_committee", + "drep", + "spo" + ], + "description": "The role of the voter. Can be one of constitutional_committee, drep, spo." + }, + "voter": { + "type": "string", + "description": "The actual voter." + }, + "vote": { + "type": "string", + "enum": [ + "yes", + "no", + "abstain" + ], + "description": "The Vote. Can be one of yes, no, abstain." + } + }, + "required": [ + "tx_hash", + "cert_index", + "voter_role", + "voter", + "vote" + ] + }, + "example": [ + { + "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + "cert_index": 2, + "voter_role": "spo", + "voter": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy", + "vote": "yes" + }, + { + "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + "cert_index": 3, + "voter_role": "constitutional_committee", + "voter": "53a42debdc7ffd90085ab7fd9800b63e6d1c9ac481ba6eb7b6a844e4", + "vote": "abstain" + } ] }, "epoch_content": { @@ -7788,8 +9120,113 @@ "type": "string", "nullable": true, "example": "34482", - "description": "Cost per UTxO word for Alonzo. Cost per UTxO byte for Babbage and later.", - "deprecated": true + "deprecated": true, + "description": "Cost per UTxO word for Alonzo. Cost per UTxO byte for Babbage and later." + }, + "pvt_motion_no_confidence": { + "type": "number", + "nullable": true, + "description": "Pool Voting threshold for motion of no-confidence." + }, + "pvt_committee_normal": { + "nullable": true, + "type": "number", + "description": "Pool Voting threshold for new committee/threshold (normal state)." + }, + "pvt_committee_no_confidence": { + "nullable": true, + "type": "number", + "description": "Pool Voting threshold for new committee/threshold (state of no-confidence)." + }, + "pvt_hard_fork_initiation": { + "nullable": true, + "type": "number", + "description": "Pool Voting threshold for hard-fork initiation." + }, + "dvt_motion_no_confidence": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for motion of no-confidence." + }, + "dvt_committee_normal": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for new committee/threshold (normal state)." + }, + "dvt_committee_no_confidence": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for new committee/threshold (state of no-confidence)." + }, + "dvt_update_to_constitution": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for update to the Constitution." + }, + "dvt_hard_fork_initiation": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for hard-fork initiation." + }, + "dvt_p_p_network_group": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for protocol parameter changes, network group." + }, + "dvt_p_p_economic_group": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for protocol parameter changes, economic group." + }, + "dvt_p_p_technical_group": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for protocol parameter changes, technical group." + }, + "dvt_p_p_gov_group": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for protocol parameter changes, governance group." + }, + "dvt_treasury_withdrawal": { + "nullable": true, + "type": "number", + "description": "DRep Vote threshold for treasury withdrawal." + }, + "committee_min_size": { + "type": "string", + "nullable": true, + "description": "Minimal constitutional committee size." + }, + "committee_max_term_length": { + "type": "string", + "nullable": true, + "description": "Constitutional committee term limits." + }, + "gov_action_lifetime": { + "type": "string", + "nullable": true, + "description": "Governance action expiration." + }, + "gov_action_deposit": { + "type": "string", + "nullable": true, + "description": "Governance action deposit." + }, + "drep_deposit": { + "type": "string", + "nullable": true, + "description": "DRep deposit amount." + }, + "drep_activity": { + "type": "string", + "nullable": true, + "description": "DRep activity period." + }, + "registered_tx_id": { + "type": "integer", + "nullable": true, + "description": "The Tx table index for the transaction that contains this parameter proposal." } }, "required": [ @@ -7824,7 +9261,28 @@ "collateral_percent", "max_collateral_inputs", "coins_per_utxo_size", - "coins_per_utxo_word" + "coins_per_utxo_word", + "pvt_motion_no_confidence", + "pvt_committee_normal", + "pvt_committee_no_confidence", + "pvt_hard_fork_initiation", + "dvt_motion_no_confidence", + "dvt_committee_normal", + "dvt_committee_no_confidence", + "dvt_update_to_constitution", + "dvt_hard_fork_initiation", + "dvt_p_p_network_group", + "dvt_p_p_economic_group", + "dvt_p_p_technical_group", + "dvt_p_p_gov_group", + "dvt_treasury_withdrawal", + "committee_min_size", + "committee_max_term_length", + "gov_action_lifetime", + "gov_action_deposit", + "drep_deposit", + "drep_activity", + "registered_tx_id" ] }, "epoch_content_array": { @@ -8806,7 +10264,13 @@ "type": "string", "nullable": true, "example": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy", - "description": "Bech32 pool ID that owns the account" + "description": "Bech32 pool ID to which this account is delegated" + }, + "drep_id": { + "type": "string", + "nullable": true, + "example": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc", + "description": "Bech32 drep ID to which this account is delegated" } }, "required": [ @@ -8819,7 +10283,8 @@ "reserves_sum", "treasury_sum", "withdrawable_amount", - "pool_id" + "pool_id", + "drep_id" ] }, "account_reward_content": { @@ -10641,6 +12106,43 @@ } ] }, + "pool_votes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tx_hash": { + "type": "string", + "description": "Hash of the proposal transaction." + }, + "cert_index": { + "type": "integer", + "description": "Index of the certificate within the proposal transaction." + }, + "vote": { + "type": "string", + "enum": [ + "yes", + "no", + "abstain" + ], + "description": "The Vote. Can be one of yes, no, abstain." + } + }, + "required": [ + "tx_hash", + "cert_index", + "vote" + ] + }, + "example": [ + { + "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + "cert_index": 2, + "vote": "yes" + } + ] + }, "assets": { "type": "array", "items": { diff --git a/openapi.yaml b/openapi.yaml index 69b95e70..e5bbc628 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.0 info: - version: 0.1.64 + version: 0.1.65 title: Blockfrost.io ~ API Documentation x-logo: url: https://staging.blockfrost.io/images/logo.svg @@ -260,6 +260,7 @@ tags: - name: Cardano » Assets - name: Cardano » Blocks - name: Cardano » Epochs + - name: Cardano » Governance - name: Cardano » Ledger - name: Cardano » Mempool - name: Cardano » Metadata @@ -280,7 +281,7 @@ paths: description: | Root endpoint has no other function than to point end users to documentation. responses: - '200': + "200": description: Information pointing to the documentation. content: application/json: @@ -296,16 +297,16 @@ paths: required: - url - version - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /health: get: tags: @@ -315,7 +316,7 @@ paths: description: | Return backend status as a boolean. Your application should handle situations when backend for the given chain is unavailable. responses: - '200': + "200": description: Return the boolean indicating the health of the backend. content: application/json: @@ -327,16 +328,16 @@ paths: example: true required: - is_healthy - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /health/clock: get: tags: @@ -346,7 +347,7 @@ paths: This endpoint provides the current UNIX time. Your application might use this to verify if the client clock is not out of sync. responses: - '200': + "200": description: Return the current UNIX time in milliseconds. content: application/json: @@ -359,16 +360,16 @@ paths: example: 1603400958947 required: - server_time - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/latest: get: tags: @@ -378,24 +379,24 @@ paths: Return the latest block available to the backends, also known as the tip of the blockchain. responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/latest/txs: get: tags: @@ -435,24 +436,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content_txs' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content_txs" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/{hash_or_number}: get: tags: @@ -470,24 +471,24 @@ paths: description: Hash or number of the requested block. example: 4ea1ba291e8eef538635a53e59fddba7810d1679631cc3aed7c8e6c4091a516a responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/{hash_or_number}/next: get: tags: @@ -523,24 +524,24 @@ paths: default: 1 description: The page number for listing the results. responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content_array' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content_array" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/{hash_or_number}/previous: get: tags: @@ -556,7 +557,7 @@ paths: type: string format: 64-character case-sensitive hexadecimal string or block number. description: Hash of the requested block - example: '4873401' + example: "4873401" - in: query name: count required: false @@ -576,24 +577,24 @@ paths: default: 1 description: The page number for listing the results. responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content_array' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content_array" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/slot/{slot_number}: get: tags: @@ -611,24 +612,24 @@ paths: description: Slot position for requested block. example: 30895909 responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/epoch/{epoch_number}/slot/{slot_number}: get: tags: @@ -654,24 +655,24 @@ paths: description: Slot position for requested block. example: 30895909 responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/{hash_or_number}/txs: get: tags: @@ -686,7 +687,7 @@ paths: type: string format: 64-character case-sensitive hexadecimal string or block number. description: Hash of the requested block. - example: '4873401' + example: "4873401" - in: query name: count required: false @@ -719,24 +720,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content_txs' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content_txs" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /blocks/{hash_or_number}/addresses: get: tags: @@ -751,7 +752,7 @@ paths: type: string format: 64-character case-sensitive hexadecimal string or block number. description: Hash of the requested block. - example: '4873401' + example: "4873401" - in: query name: count required: false @@ -771,24 +772,24 @@ paths: default: 1 description: The page number for listing the results. responses: - '200': + "200": description: Return the contents of the block content: application/json: schema: - $ref: '#/components/schemas/block_content_addresses' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/block_content_addresses" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /genesis: get: tags: @@ -796,22 +797,538 @@ paths: summary: Blockchain genesis description: Return the information about blockchain genesis. responses: - '200': + "200": description: Return the genesis parameters. content: application/json: schema: - $ref: '#/components/schemas/genesis_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/genesis_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/dreps: + get: + tags: + - Cardano » Governance + summary: Delegate Representatives (DReps) + description: Return the information about Delegate Representatives (DReps) + parameters: + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + Ordering in this case is based on the time of the first mint transaction. + responses: + "200": + description: Paginated array with the Delegate Representatives (DReps) data + content: + application/json: + schema: + $ref: "#/components/schemas/drep_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/dreps/{drep_id}: + get: + tags: + - Cardano » Governance + summary: Specific DRep + description: DRep information. + parameters: + - in: path + name: drep_id + required: true + schema: + type: string + description: Bech32 or hexadecimal DRep ID. + example: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc + responses: + "200": + description: Return the DRep information content + content: + application/json: + schema: + $ref: "#/components/schemas/drep_details_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/dreps/{drep_id}/delegators: + get: + tags: + - Cardano » Governance + summary: DRep delegators + description: List of Drep delegators. + parameters: + - in: path + name: drep_id + required: true + schema: + type: string + description: Bech32 or hexadecimal drep ID. + example: drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + responses: + "200": + description: Return the DRep delegations + content: + application/json: + schema: + $ref: "#/components/schemas/drep_delegators" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/dreps/{drep_id}/metadata: + get: + tags: + - Cardano » Governance + summary: DRep metadata + description: DRep metadata information. + parameters: + - in: path + name: drep_id + required: true + schema: + type: string + description: Bech32 or hexadecimal DRep ID. + example: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc + responses: + "200": + description: Return the DRep metadata content. + content: + application/json: + schema: + $ref: "#/components/schemas/drep_metadata" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/dreps/{drep_id}/updates: + get: + tags: + - Cardano » Governance + summary: DRep updates + description: List of certificate updates to the DRep. + parameters: + - in: path + name: drep_id + required: true + schema: + type: string + description: Bech32 or hexadecimal DRep ID. + example: drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + responses: + "200": + description: Return the Drep updates history + content: + application/json: + schema: + $ref: "#/components/schemas/drep_updates" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/dreps/{drep_id}/votes: + get: + tags: + - Cardano » Governance + summary: DRep votes + description: History of Drep votes. + parameters: + - in: path + name: drep_id + required: true + schema: + type: string + description: Bech32 or hexadecimal drep ID. + example: drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + responses: + "200": + description: Return the DRep votes + content: + application/json: + schema: + $ref: "#/components/schemas/drep_votes" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/proposals: + get: + tags: + - Cardano » Governance + summary: Proposals + description: Return the information about Proposals + parameters: + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + Ordering in this case is based on the time of the first mint transaction. + responses: + "200": + description: Paginated array with the proposal data + content: + application/json: + schema: + $ref: "#/components/schemas/proposal_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/proposals/{tx_hash}/{cert_index}: + get: + tags: + - Cardano » Governance + summary: Specific proposal + description: Proposal information. + parameters: + - in: path + name: tx_hash + required: true + schema: + type: string + description: Transaction hash. + example: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531 + - in: path + name: cert_index + required: true + schema: + type: integer + description: Transaction index. + example: 1 + responses: + "200": + description: Return the proposal information content + content: + application/json: + schema: + $ref: "#/components/schemas/proposal_details_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/proposals/{tx_hash}/{cert_index}/votes: + get: + tags: + - Cardano » Governance + summary: Proposal votes + description: History of Proposal votes. + parameters: + - in: path + name: tx_hash + required: true + schema: + type: string + description: Transaction hash. + example: 2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531 + - in: path + name: cert_index + required: true + schema: + type: integer + description: Transaction index. + example: 1 + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + responses: + "200": + description: Return the Proposal votes + content: + application/json: + schema: + $ref: "#/components/schemas/proposal_details_votes" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /governance/votes: + get: + tags: + - Cardano » Governance + summary: Votes + description: Return the information about votes + parameters: + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + Ordering in this case is based on the time of the first mint transaction. + responses: + "200": + description: Paginated array with the votes data + content: + application/json: + schema: + $ref: "#/components/schemas/vote_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/latest: get: tags: @@ -819,24 +1336,24 @@ paths: summary: Latest epoch description: Return the information about the latest, therefore current, epoch. responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/latest/parameters: get: tags: @@ -844,24 +1361,24 @@ paths: summary: Latest epoch protocol parameters description: Return the protocol parameters for the latest epoch. responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_param_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_param_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}: get: tags: @@ -877,24 +1394,24 @@ paths: description: Number of the epoch example: 225 responses: - '200': + "200": description: Return the epoch data. content: application/json: schema: - $ref: '#/components/schemas/epoch_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}/next: get: tags: @@ -928,24 +1445,24 @@ paths: default: 1 description: The page number for listing the results. responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_content_array' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_content_array" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}/previous: get: tags: @@ -979,24 +1496,24 @@ paths: default: 1 description: The page number for listing the results responses: - '200': + "200": description: Return the epoch data content: application/json: schema: - $ref: '#/components/schemas/epoch_content_array' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_content_array" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}/stakes: get: tags: @@ -1030,24 +1547,24 @@ paths: default: 1 description: The page number for listing the results. responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_stake_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_stake_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}/stakes/{pool_id}: get: tags: @@ -1088,24 +1605,24 @@ paths: default: 1 description: The page number for listing the results. responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_stake_pool_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_stake_pool_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}/blocks: get: tags: @@ -1151,24 +1668,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_block_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_block_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}/blocks/{pool_id}: get: tags: @@ -1221,24 +1738,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_block_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_block_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /epochs/{number}/parameters: get: tags: @@ -1254,24 +1771,24 @@ paths: description: Number of the epoch example: 225 responses: - '200': + "200": description: Return the data about the epoch content: application/json: schema: - $ref: '#/components/schemas/epoch_param_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/epoch_param_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}: get: tags: @@ -1288,24 +1805,24 @@ paths: description: Hash of the requested transaction example: 6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Return the contents of the transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/utxos: get: tags: @@ -1322,24 +1839,24 @@ paths: description: Hash of the requested transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Return the contents of the transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_utxo' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_utxo" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/stakes: get: tags: @@ -1357,25 +1874,25 @@ paths: description: Hash of the requested transaction. example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: | Obtain information about (de)registration of stake addresses within a transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_stake_addr' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_stake_addr" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/delegations: get: tags: @@ -1393,24 +1910,24 @@ paths: description: Hash of the requested transaction. example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Obtain information about delegation certificates of a specific transaction content: application/json: schema: - $ref: '#/components/schemas/tx_content_delegations' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_delegations" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/withdrawals: get: tags: @@ -1427,24 +1944,24 @@ paths: description: Hash of the requested transaction. example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Obtain information about withdrawals of a specific transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_withdrawals' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_withdrawals" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/mirs: get: tags: @@ -1461,24 +1978,24 @@ paths: description: Hash of the requested transaction. example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_mirs' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_mirs" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/pool_updates: get: tags: @@ -1496,24 +2013,24 @@ paths: description: Hash of the requested transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Obtain information about stake pool certificates of a specific transaction content: application/json: schema: - $ref: '#/components/schemas/tx_content_pool_certs' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_pool_certs" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/pool_retires: get: tags: @@ -1531,25 +2048,25 @@ paths: description: Hash of the requested transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: | Obtain information about stake pool retirements within a specific transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_pool_retires' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_pool_retires" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/metadata: get: tags: @@ -1566,24 +2083,24 @@ paths: description: Hash of the requested transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Obtain metadata information associated with a specific transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_metadata' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_metadata" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/metadata/cbor: get: tags: @@ -1600,24 +2117,24 @@ paths: description: Hash of the requested transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Obtain metadata information associated with a specific transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_metadata_cbor' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_metadata_cbor" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/redeemers: get: tags: @@ -1634,24 +2151,24 @@ paths: description: Hash of the requested transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Obtain information about redeemers within a specific transaction. content: application/json: schema: - $ref: '#/components/schemas/tx_content_redeemers' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_redeemers" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/required_signers: get: tags: @@ -1668,24 +2185,24 @@ paths: description: Hash of the transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Query required signers (extra transaction witnesses) content: application/json: schema: - $ref: '#/components/schemas/tx_content_required_signers' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_required_signers" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /txs/{hash}/cbor: get: tags: @@ -1702,24 +2219,24 @@ paths: description: Hash of the transaction example: 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Query transaction CBOR content: application/json: schema: - $ref: '#/components/schemas/tx_content_cbor' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_content_cbor" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /tx/submit: post: tags: @@ -1764,7 +2281,7 @@ paths: example: | 83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573 responses: - '200': + "200": description: Return the ID of the submitted transaction. content: application/json: @@ -1774,20 +2291,20 @@ paths: minLength: 64 maxLength: 64 example: d1662b24fa9fe985fc2dce47455df399cb2e31e1e1819339e885801cc3578908 - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '425': - $ref: '#/components/responses/425' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "425": + $ref: "#/components/responses/425" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}: get: tags: @@ -1804,24 +2321,24 @@ paths: description: Bech32 stake address. example: stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc responses: - '200': + "200": description: Return the account content. content: application/json: schema: - $ref: '#/components/schemas/account_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/rewards: get: tags: @@ -1868,24 +2385,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account content. content: application/json: schema: - $ref: '#/components/schemas/account_reward_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_reward_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/history: get: tags: @@ -1932,24 +2449,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account content. content: application/json: schema: - $ref: '#/components/schemas/account_history_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_history_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/delegations: get: tags: @@ -1995,24 +2512,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account delegations content content: application/json: schema: - $ref: '#/components/schemas/account_delegation_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_delegation_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/registrations: get: tags: @@ -2059,24 +2576,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account registration content. content: application/json: schema: - $ref: '#/components/schemas/account_registration_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_registration_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/withdrawals: get: tags: @@ -2123,24 +2640,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account withdrawal content. content: application/json: schema: - $ref: '#/components/schemas/account_withdrawal_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_withdrawal_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/mirs: get: tags: @@ -2187,24 +2704,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account MIR content. content: application/json: schema: - $ref: '#/components/schemas/account_mir_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_mir_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/addresses: get: tags: @@ -2252,24 +2769,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account addresses content content: application/json: schema: - $ref: '#/components/schemas/account_addresses_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_addresses_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/addresses/assets: get: tags: @@ -2317,24 +2834,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account addresses content content: application/json: schema: - $ref: '#/components/schemas/account_addresses_assets' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_addresses_assets" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /accounts/{stake_address}/addresses/total: get: tags: @@ -2352,24 +2869,24 @@ paths: description: Bech32 address. example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz responses: - '200': + "200": description: Return the Address details. content: application/json: schema: - $ref: '#/components/schemas/account_addresses_total' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/account_addresses_total" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /mempool: get: tags: @@ -2415,24 +2932,24 @@ paths: Ordered by the time of transaction submission. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the contents of the mempool content: application/json: schema: - $ref: '#/components/schemas/mempool_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/mempool_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /mempool/{hash}: get: tags: @@ -2454,24 +2971,24 @@ paths: description: Hash of the requested transaction example: 6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b responses: - '200': + "200": description: Return the contents of the transaction. content: application/json: schema: - $ref: '#/components/schemas/mempool_tx_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/mempool_tx_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /mempool/addresses/{address}: get: tags: @@ -2524,24 +3041,24 @@ paths: Ordered by the time of transaction submission. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the contents of the mempool content: application/json: schema: - $ref: '#/components/schemas/mempool_addresses_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/mempool_addresses_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /metadata/txs/labels: get: tags: @@ -2581,24 +3098,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account metadata content in CBOR content: application/json: schema: - $ref: '#/components/schemas/tx_metadata_labels' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_metadata_labels" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /metadata/txs/labels/{label}: get: tags: @@ -2612,7 +3129,7 @@ paths: schema: type: string description: Metadata label - example: '1990' + example: "1990" - in: query name: count required: false @@ -2644,24 +3161,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account metadata content content: application/json: schema: - $ref: '#/components/schemas/tx_metadata_label_json' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_metadata_label_json" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /metadata/txs/labels/{label}/cbor: get: tags: @@ -2675,7 +3192,7 @@ paths: schema: type: string description: Metadata label - example: '1990' + example: "1990" - in: query name: count required: false @@ -2707,24 +3224,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the account metadata content in CBOR content: application/json: schema: - $ref: '#/components/schemas/tx_metadata_label_cbor' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/tx_metadata_label_cbor" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /addresses/{address}: get: tags: @@ -2740,24 +3257,24 @@ paths: description: Bech32 address. example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz responses: - '200': + "200": description: Return the address content. content: application/json: schema: - $ref: '#/components/schemas/address_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/address_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /addresses/{address}/extended: get: tags: @@ -2774,24 +3291,24 @@ paths: description: Bech32 address. example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz responses: - '200': + "200": description: Return the address content. content: application/json: schema: - $ref: '#/components/schemas/address_content_extended' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/address_content_extended" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /addresses/{address}/total: get: tags: @@ -2807,24 +3324,24 @@ paths: description: Bech32 address. example: addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz responses: - '200': + "200": description: Return the Address details. content: application/json: schema: - $ref: '#/components/schemas/address_content_total' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/address_content_total" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /addresses/{address}/utxos: get: tags: @@ -2870,24 +3387,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the address content content: application/json: schema: - $ref: '#/components/schemas/address_utxo_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/address_utxo_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /addresses/{address}/utxos/{asset}: get: tags: @@ -2940,24 +3457,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the address content content: application/json: schema: - $ref: '#/components/schemas/address_utxo_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/address_utxo_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /addresses/{address}/txs: get: deprecated: true @@ -3004,24 +3521,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the address content content: application/json: schema: - $ref: '#/components/schemas/address_txs_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/address_txs_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /addresses/{address}/transactions: get: tags: @@ -3074,7 +3591,7 @@ paths: description: | The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. Has to be lower than or equal to `to` parameter. - example: '8929261' + example: "8929261" - in: query name: to required: false @@ -3083,26 +3600,26 @@ paths: description: | The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. Has to be higher than or equal to `from` parameter. - example: '9999269:10' + example: "9999269:10" responses: - '200': + "200": description: Return the address content content: application/json: schema: - $ref: '#/components/schemas/address_transactions_content' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/address_transactions_content" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools: get: tags: @@ -3141,24 +3658,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the list of pools. content: application/json: schema: - $ref: '#/components/schemas/pool_list' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool_list" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/extended: get: tags: @@ -3197,24 +3714,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the list of pools. content: application/json: schema: - $ref: '#/components/schemas/pool_list_extended' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool_list_extended" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/retired: get: tags: @@ -3253,24 +3770,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the pool information content content: application/json: schema: - $ref: '#/components/schemas/pool_list_retire' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool_list_retire" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/retiring: get: tags: @@ -3309,24 +3826,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the pool information content content: application/json: schema: - $ref: '#/components/schemas/pool_list_retire' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool_list_retire" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/{pool_id}: get: tags: @@ -3342,24 +3859,24 @@ paths: description: Bech32 or hexadecimal pool ID. example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy responses: - '200': + "200": description: Return the pool information content content: application/json: schema: - $ref: '#/components/schemas/pool' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/{pool_id}/history: get: tags: @@ -3406,24 +3923,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the pool information content. content: application/json: schema: - $ref: '#/components/schemas/pool_history' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool_history" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/{pool_id}/metadata: get: tags: @@ -3440,26 +3957,26 @@ paths: description: Bech32 or hexadecimal pool ID. example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy responses: - '200': + "200": description: Return the pool metadata content. content: application/json: schema: anyOf: - - $ref: '#/components/schemas/pool_metadata' - - $ref: '#/components/schemas/empty_object' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + - $ref: "#/components/schemas/pool_metadata" + - $ref: "#/components/schemas/empty_object" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/{pool_id}/relays: get: tags: @@ -3475,24 +3992,24 @@ paths: description: Bech32 or hexadecimal pool ID. example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy responses: - '200': + "200": description: Return the pool relays information content. content: application/json: schema: - $ref: '#/components/schemas/pool_relays' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool_relays" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /pools/{pool_id}/delegators: get: tags: @@ -3538,30 +4055,93 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the pool delegations. content: application/json: schema: - $ref: '#/components/schemas/pool_delegators' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' - /pools/{pool_id}/blocks: + $ref: "#/components/schemas/pool_delegators" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /pools/{pool_id}/blocks: + get: + tags: + - Cardano » Pools + summary: Stake pool blocks + description: List of stake pools blocks. + parameters: + - in: path + name: pool_id + required: true + schema: + type: string + description: Bech32 or hexadecimal pool ID. + example: pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + - in: query + name: count + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 100 + description: The number of results displayed on one page. + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + maximum: 21474836 + default: 1 + description: The page number for listing the results. + - in: query + name: order + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + description: | + The ordering of items from the point of view of the blockchain, + not the page listing itself. By default, we return oldest first, newest last. + responses: + "200": + description: Return the pool block list + content: + application/json: + schema: + $ref: "#/components/schemas/pool_blocks" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /pools/{pool_id}/updates: get: tags: - Cardano » Pools - summary: Stake pool blocks - description: List of stake pools blocks. + summary: Stake pool updates + description: List of certificate updates to the stake pool. parameters: - in: path name: pool_id @@ -3601,30 +4181,30 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': - description: Return the pool block list + "200": + description: Return the pool updates history content: application/json: schema: - $ref: '#/components/schemas/pool_blocks' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' - /pools/{pool_id}/updates: + $ref: "#/components/schemas/pool_updates" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" + /pools/{pool_id}/votes: get: tags: - Cardano » Pools - summary: Stake pool updates - description: List of certificate updates to the stake pool. + summary: Stake pool votes + description: History of stake pools votes. parameters: - in: path name: pool_id @@ -3664,24 +4244,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': - description: Return the pool updates history + "200": + description: Return the pool votes. content: application/json: schema: - $ref: '#/components/schemas/pool_updates' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/pool_votes" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /assets: get: tags: @@ -3723,24 +4303,24 @@ paths: not the page listing itself. By default, we return oldest first, newest last. Ordering in this case is based on the time of the first mint transaction. responses: - '200': + "200": description: Return list of assets content: application/json: schema: - $ref: '#/components/schemas/assets' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/assets" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /assets/{asset}: get: tags: @@ -3756,24 +4336,24 @@ paths: description: Concatenation of the policy_id and hex-encoded asset_name example: b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e responses: - '200': + "200": description: Return the information about a specific asset content: application/json: schema: - $ref: '#/components/schemas/asset' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/asset" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /assets/{asset}/history: get: tags: @@ -3819,24 +4399,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the information about the history of a specific asset content: application/json: schema: - $ref: '#/components/schemas/asset_history' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/asset_history" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /assets/{asset}/txs: get: deprecated: true @@ -3883,24 +4463,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the information about the history of a specific asset content: application/json: schema: - $ref: '#/components/schemas/asset_txs' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/asset_txs" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /assets/{asset}/transactions: get: tags: @@ -3946,24 +4526,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the information about the history of a specific asset content: application/json: schema: - $ref: '#/components/schemas/asset_transactions' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/asset_transactions" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /assets/{asset}/addresses: get: tags: @@ -4009,24 +4589,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the information about the history of a specific asset content: application/json: schema: - $ref: '#/components/schemas/asset_addresses' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/asset_addresses" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /assets/policy/{policy_id}: get: tags: @@ -4072,24 +4652,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the information about a specific asset content: application/json: schema: - $ref: '#/components/schemas/asset_policy' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/asset_policy" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /scripts: get: tags: @@ -4128,24 +4708,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return list of scripts content: application/json: schema: - $ref: '#/components/schemas/scripts' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/scripts" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /scripts/{script_hash}: get: tags: @@ -4161,24 +4741,24 @@ paths: description: Hash of the script example: e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e responses: - '200': + "200": description: Return the information about a specific script content: application/json: schema: - $ref: '#/components/schemas/script' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/script" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /scripts/{script_hash}/json: get: tags: @@ -4194,24 +4774,24 @@ paths: description: Hash of the script example: e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e responses: - '200': + "200": description: Return the JSON representation of a `timelock` script content: application/json: schema: - $ref: '#/components/schemas/script_json' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/script_json" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /scripts/{script_hash}/cbor: get: tags: @@ -4227,24 +4807,24 @@ paths: description: Hash of the script example: e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e responses: - '200': + "200": description: Return the CBOR representation of a `plutus` script content: application/json: schema: - $ref: '#/components/schemas/script_cbor' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/script_cbor" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /scripts/{script_hash}/redeemers: get: tags: @@ -4290,24 +4870,24 @@ paths: The ordering of items from the point of view of the blockchain, not the page listing itself. By default, we return oldest first, newest last. responses: - '200': + "200": description: Return the information about redeemers of a specific script content: application/json: schema: - $ref: '#/components/schemas/script_redeemers' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/script_redeemers" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /scripts/datum/{datum_hash}: get: tags: @@ -4323,24 +4903,24 @@ paths: description: Hash of the datum example: db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d responses: - '200': + "200": description: Return the datum value content: application/json: schema: - $ref: '#/components/schemas/script_datum' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/script_datum" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /scripts/datum/{datum_hash}/cbor: get: tags: @@ -4356,24 +4936,24 @@ paths: description: Hash of the datum example: db583ad85881a96c73fbb26ab9e24d1120bb38f45385664bb9c797a2ea8d9a2d responses: - '200': + "200": description: Return the CBOR serialised datum value content: application/json: schema: - $ref: '#/components/schemas/script_datum_cbor' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/script_datum_cbor" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /utils/addresses/xpub/{xpub}/{role}/{index}: get: tags: @@ -4403,24 +4983,24 @@ paths: description: Address index example: 2 responses: - '200': + "200": description: Return derivated Shelley address content: application/json: schema: - $ref: '#/components/schemas/utils_addresses_xpub' - '400': - $ref: '#/components/responses/400' - '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '418': - $ref: '#/components/responses/418' - '429': - $ref: '#/components/responses/429' - '500': - $ref: '#/components/responses/500' + $ref: "#/components/schemas/utils_addresses_xpub" + "400": + $ref: "#/components/responses/400" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "418": + $ref: "#/components/responses/418" + "429": + $ref: "#/components/responses/429" + "500": + $ref: "#/components/responses/500" /utils/txs/evaluate: post: tags: @@ -4464,7 +5044,7 @@ paths: example: | 83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573 responses: - '200': + "200": description: |
- * Hosted Endpoint only available for hosted variant. - *
+ * Transaction delegation certificates + * @description Obtain information about delegation certificates of a specific transaction. */ - post: { - /** @description The transaction to submit, serialized in CBOR. */ - requestBody: { - content: { - /** @example 83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573 */ - "application/cbor": string; + get: { + parameters: { + path: { + /** + * @description Hash of the requested transaction. + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b + */ + hash: string; }; }; responses: { - /** @description Return the ID of the submitted transaction. */ + /** @description Obtain information about delegation certificates of a specific transaction */ 200: { content: { - "application/json": string; + "application/json": components["schemas"]["tx_content_delegations"]; }; }; 400: components["responses"]["400"]; 403: components["responses"]["403"]; 404: components["responses"]["404"]; 418: components["responses"]["418"]; - 425: components["responses"]["425"]; 429: components["responses"]["429"]; 500: components["responses"]["500"]; }; }; }; - "/accounts/{stake_address}": { + "/txs/{hash}/withdrawals": { /** - * Specific account address - * @description Obtain information about a specific stake account. + * Transaction withdrawal + * @description Obtain information about withdrawals of a specific transaction. */ get: { parameters: { path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the requested transaction. + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account content. */ + /** @description Obtain information about withdrawals of a specific transaction. */ 200: { content: { - "application/json": components["schemas"]["account_content"]; + "application/json": components["schemas"]["tx_content_withdrawals"]; }; }; 400: components["responses"]["400"]; @@ -1236,37 +1297,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/rewards": { + "/txs/{hash}/mirs": { /** - * Account reward history - * @description Obtain information about the reward history of a specific account. + * Transaction MIRs + * @description Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the requested transaction. + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account content. */ + /** @description Obtain information about Move Instantaneous Rewards (MIRs) of a specific transaction. */ 200: { content: { - "application/json": components["schemas"]["account_reward_content"]; + "application/json": components["schemas"]["tx_content_mirs"]; }; }; 400: components["responses"]["400"]; @@ -1278,37 +1328,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/history": { + "/txs/{hash}/pool_updates": { /** - * Account history - * @description Obtain information about the history of a specific account. + * Transaction stake pool registration and update certificates + * @description Obtain information about stake pool registration and update certificates of a specific transaction. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the requested transaction + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account content. */ + /** @description Obtain information about stake pool certificates of a specific transaction */ 200: { content: { - "application/json": components["schemas"]["account_history_content"]; + "application/json": components["schemas"]["tx_content_pool_certs"]; }; }; 400: components["responses"]["400"]; @@ -1320,37 +1359,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/delegations": { + "/txs/{hash}/pool_retires": { /** - * Account delegation history - * @description Obtain information about the delegation of a specific account. + * Transaction stake pool retirement certificates + * @description Obtain information about stake pool retirements within a specific transaction. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the requested transaction + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account delegations content */ + /** @description Obtain information about stake pool retirements within a specific transaction. */ 200: { content: { - "application/json": components["schemas"]["account_delegation_content"]; + "application/json": components["schemas"]["tx_content_pool_retires"]; }; }; 400: components["responses"]["400"]; @@ -1362,37 +1390,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/registrations": { + "/txs/{hash}/metadata": { /** - * Account registration history - * @description Obtain information about the registrations and deregistrations of a specific account. + * Transaction metadata + * @description Obtain the transaction metadata. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the requested transaction + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account registration content. */ + /** @description Obtain metadata information associated with a specific transaction. */ 200: { content: { - "application/json": components["schemas"]["account_registration_content"]; + "application/json": components["schemas"]["tx_content_metadata"]; }; }; 400: components["responses"]["400"]; @@ -1404,37 +1421,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/withdrawals": { + "/txs/{hash}/metadata/cbor": { /** - * Account withdrawal history - * @description Obtain information about the withdrawals of a specific account. + * Transaction metadata in CBOR + * @description Obtain the transaction metadata in CBOR. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the requested transaction + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account withdrawal content. */ + /** @description Obtain metadata information associated with a specific transaction. */ 200: { content: { - "application/json": components["schemas"]["account_withdrawal_content"]; + "application/json": components["schemas"]["tx_content_metadata_cbor"]; }; }; 400: components["responses"]["400"]; @@ -1446,37 +1452,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/mirs": { + "/txs/{hash}/redeemers": { /** - * Account MIR history - * @description Obtain information about the MIRs of a specific account. + * Transaction redeemers + * @description Obtain the transaction redeemers. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the requested transaction + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account MIR content. */ + /** @description Obtain information about redeemers within a specific transaction. */ 200: { content: { - "application/json": components["schemas"]["account_mir_content"]; + "application/json": components["schemas"]["tx_content_redeemers"]; }; }; 400: components["responses"]["400"]; @@ -1488,38 +1483,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/addresses": { + "/txs/{hash}/required_signers": { /** - * Account associated addresses - * @description Obtain information about the addresses of a specific account. - * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account. + * Transaction required signers + * @description Obtain the extra transaction witnesses. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the transaction + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account addresses content */ + /** @description Query required signers (extra transaction witnesses) */ 200: { content: { - "application/json": components["schemas"]["account_addresses_content"]; + "application/json": components["schemas"]["tx_content_required_signers"]; }; }; 400: components["responses"]["400"]; @@ -1531,38 +1514,26 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/addresses/assets": { + "/txs/{hash}/cbor": { /** - * Assets associated with the account addresses - * @description Obtain information about assets associated with addresses of a specific account. - * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account. + * Transaction CBOR + * @description Obtain the CBOR serialized transaction */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 stake address. - * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + * @description Hash of the transaction + * @example 6e5f825c82c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - stake_address: string; + hash: string; }; }; responses: { - /** @description Return the account addresses content */ + /** @description Query transaction CBOR */ 200: { content: { - "application/json": components["schemas"]["account_addresses_assets"]; + "application/json": components["schemas"]["tx_content_cbor"]; }; }; 400: components["responses"]["400"]; @@ -1574,68 +1545,60 @@ export interface paths { }; }; }; - "/accounts/{stake_address}/addresses/total": { + "/tx/submit": { /** - * Detailed information about account associated addresses - * @description Obtain summed details about all addresses associated with a given account. - * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account. + * Submit a transaction + * @description Submit an already serialized transaction to the network. + * + *+ * Hosted Endpoint only available for hosted variant. + *
*/ - get: { - parameters: { - path: { - /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz - */ - stake_address: string; + post: { + /** @description The transaction to submit, serialized in CBOR. */ + requestBody: { + content: { + /** @example 83a400818258208911f640d452c3be4ff3d89db63b41ce048c056951286e2e28bbf8a51588ab44000181825839009493315cd92eb5d8c4304e67b7e16ae36d61d34502694657811a2c8e32c728d3861e164cab28cb8f006448139c8f1740ffb8e7aa9e5232dc1a10b2531f021a00029519075820cb798b0bce50604eaf2e0dc89367896b18f0a6ef6b32b57e3c9f83f8ee71e608a1008182582073fea80d424276ad0978d4fe5310e8bc2d485f5f6bb3bf87612989f112ad5a7d5840c40425229749a9434763cf01b492057fd56d7091a6372eaa777a1c9b1ca508c914e6a4ee9c0d40fc10952ed668e9ad65378a28b149de6bd4204bd9f095b0a902a11907b0a1667469636b657281a266736f757263656b736f757263655f6e616d656576616c7565736675676961742076656e69616d206d696e7573 */ + "application/cbor": string; }; }; responses: { - /** @description Return the Address details. */ + /** @description Return the ID of the submitted transaction. */ 200: { content: { - "application/json": components["schemas"]["account_addresses_total"]; + "application/json": string; }; }; 400: components["responses"]["400"]; 403: components["responses"]["403"]; 404: components["responses"]["404"]; 418: components["responses"]["418"]; + 425: components["responses"]["425"]; 429: components["responses"]["429"]; 500: components["responses"]["500"]; }; }; }; - "/mempool": { + "/accounts/{stake_address}": { /** - * Mempool - * @description Return transactions that are currently stored in Blockfrost mempool, - * waiting to be included in a newly minted block. - * Shows only transactions submitted via Blockfrost.io. - * - *- * Hosted Endpoint only available for hosted variant. - *
+ * Specific account address + * @description Obtain information about a specific stake account. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; + path: { /** - * @description Ordered by the time of transaction submission. - * By default, we return oldest first, newest last. + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc */ - order?: "asc" | "desc"; + stake_address: string; }; }; responses: { - /** @description Return the contents of the mempool */ + /** @description Return the account content. */ 200: { content: { - "application/json": components["schemas"]["mempool_content"]; + "application/json": components["schemas"]["account_content"]; }; }; 400: components["responses"]["400"]; @@ -1647,30 +1610,37 @@ export interface paths { }; }; }; - "/mempool/{hash}": { + "/accounts/{stake_address}/rewards": { /** - * Specific transaction in the mempool - * @description Return content of the requested transaction. - * - *- * Hosted Endpoint only available for hosted variant. - *
+ * Account reward history + * @description Obtain information about the reward history of a specific account. */ get: { parameters: { - path: { - /** - * @description Hash of the requested transaction - * @example 6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. */ - hash: string; + order?: "asc" | "desc"; + }; + path: { + /** + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + */ + stake_address: string; }; }; responses: { - /** @description Return the contents of the transaction. */ + /** @description Return the account content. */ 200: { content: { - "application/json": components["schemas"]["mempool_tx_content"]; + "application/json": components["schemas"]["account_reward_content"]; }; }; 400: components["responses"]["400"]; @@ -1682,15 +1652,10 @@ export interface paths { }; }; }; - "/mempool/addresses/{address}": { + "/accounts/{stake_address}/history": { /** - * Mempool by address - * @description List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address. - * Shows only transactions submitted via Blockfrost.io. - * - *- * Hosted Endpoint only available for hosted variant. - *
+ * Account history + * @description Obtain information about the history of a specific account. */ get: { parameters: { @@ -1700,24 +1665,24 @@ export interface paths { /** @description The page number for listing the results. */ page?: number; /** - * @description Ordered by the time of transaction submission. - * By default, we return oldest first, newest last. + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. */ order?: "asc" | "desc"; }; path: { /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc */ - address: string; + stake_address: string; }; }; responses: { - /** @description Return the contents of the mempool */ + /** @description Return the account content. */ 200: { content: { - "application/json": components["schemas"]["mempool_addresses_content"]; + "application/json": components["schemas"]["account_history_content"]; }; }; 400: components["responses"]["400"]; @@ -1729,10 +1694,10 @@ export interface paths { }; }; }; - "/metadata/txs/labels": { + "/accounts/{stake_address}/delegations": { /** - * Transaction metadata labels - * @description List of all used transaction metadata labels. + * Account delegation history + * @description Obtain information about the delegation of a specific account. */ get: { parameters: { @@ -1747,12 +1712,19 @@ export interface paths { */ order?: "asc" | "desc"; }; + path: { + /** + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc + */ + stake_address: string; + }; }; responses: { - /** @description Return the account metadata content in CBOR */ + /** @description Return the account delegations content */ 200: { content: { - "application/json": components["schemas"]["tx_metadata_labels"]; + "application/json": components["schemas"]["account_delegation_content"]; }; }; 400: components["responses"]["400"]; @@ -1764,10 +1736,10 @@ export interface paths { }; }; }; - "/metadata/txs/labels/{label}": { + "/accounts/{stake_address}/registrations": { /** - * Transaction metadata content in JSON - * @description Transaction metadata per label. + * Account registration history + * @description Obtain information about the registrations and deregistrations of a specific account. */ get: { parameters: { @@ -1784,17 +1756,17 @@ export interface paths { }; path: { /** - * @description Metadata label - * @example 1990 + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc */ - label: string; + stake_address: string; }; }; responses: { - /** @description Return the account metadata content */ + /** @description Return the account registration content. */ 200: { content: { - "application/json": components["schemas"]["tx_metadata_label_json"]; + "application/json": components["schemas"]["account_registration_content"]; }; }; 400: components["responses"]["400"]; @@ -1806,10 +1778,10 @@ export interface paths { }; }; }; - "/metadata/txs/labels/{label}/cbor": { + "/accounts/{stake_address}/withdrawals": { /** - * Transaction metadata content in CBOR - * @description Transaction metadata per label. + * Account withdrawal history + * @description Obtain information about the withdrawals of a specific account. */ get: { parameters: { @@ -1826,17 +1798,17 @@ export interface paths { }; path: { /** - * @description Metadata label - * @example 1990 + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc */ - label: string; + stake_address: string; }; }; responses: { - /** @description Return the account metadata content in CBOR */ + /** @description Return the account withdrawal content. */ 200: { content: { - "application/json": components["schemas"]["tx_metadata_label_cbor"]; + "application/json": components["schemas"]["account_withdrawal_content"]; }; }; 400: components["responses"]["400"]; @@ -1848,57 +1820,37 @@ export interface paths { }; }; }; - "/addresses/{address}": { + "/accounts/{stake_address}/mirs": { /** - * Specific address - * @description Obtain information about a specific address. + * Account MIR history + * @description Obtain information about the MIRs of a specific account. */ get: { parameters: { - path: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. */ - address: string; - }; - }; - responses: { - /** @description Return the address content. */ - 200: { - content: { - "application/json": components["schemas"]["address_content"]; - }; + order?: "asc" | "desc"; }; - 400: components["responses"]["400"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 418: components["responses"]["418"]; - 429: components["responses"]["429"]; - 500: components["responses"]["500"]; - }; - }; - }; - "/addresses/{address}/extended": { - /** - * Extended information of a specific address - * @description Obtain extended information about a specific address. - */ - get: { - parameters: { path: { /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc */ - address: string; + stake_address: string; }; }; responses: { - /** @description Return the address content. */ + /** @description Return the account MIR content. */ 200: { content: { - "application/json": components["schemas"]["address_content_extended"]; + "application/json": components["schemas"]["account_mir_content"]; }; }; 400: components["responses"]["400"]; @@ -1910,26 +1862,38 @@ export interface paths { }; }; }; - "/addresses/{address}/total": { + "/accounts/{stake_address}/addresses": { /** - * Address details - * @description Obtain details about an address. + * Account associated addresses + * @description Obtain information about the addresses of a specific account. + * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account. */ get: { parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; path: { /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc */ - address: string; + stake_address: string; }; }; responses: { - /** @description Return the Address details. */ + /** @description Return the account addresses content */ 200: { content: { - "application/json": components["schemas"]["address_content_total"]; + "application/json": components["schemas"]["account_addresses_content"]; }; }; 400: components["responses"]["400"]; @@ -1941,10 +1905,11 @@ export interface paths { }; }; }; - "/addresses/{address}/utxos": { + "/accounts/{stake_address}/addresses/assets": { /** - * Address UTXOs - * @description UTXOs of the address. + * Assets associated with the account addresses + * @description Obtain information about assets associated with addresses of a specific account. + * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account. */ get: { parameters: { @@ -1961,17 +1926,17 @@ export interface paths { }; path: { /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + * @description Bech32 stake address. + * @example stake1u9ylzsgxaa6xctf4juup682ar3juj85n8tx3hthnljg47zctvm3rc */ - address: string; + stake_address: string; }; }; responses: { - /** @description Return the address content */ + /** @description Return the account addresses content */ 200: { content: { - "application/json": components["schemas"]["address_utxo_content"]; + "application/json": components["schemas"]["account_addresses_assets"]; }; }; 400: components["responses"]["400"]; @@ -1983,42 +1948,27 @@ export interface paths { }; }; }; - "/addresses/{address}/utxos/{asset}": { + "/accounts/{stake_address}/addresses/total": { /** - * Address UTXOs of a given asset - * @description UTXOs of the address. + * Detailed information about account associated addresses + * @description Obtain summed details about all addresses associated with a given account. + * Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** * @description Bech32 address. * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - address: string; - /** - * @description Concatenation of the policy_id and hex-encoded asset_name - * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e - */ - asset: string; + stake_address: string; }; }; responses: { - /** @description Return the address content */ + /** @description Return the Address details. */ 200: { content: { - "application/json": components["schemas"]["address_utxo_content"]; + "application/json": components["schemas"]["account_addresses_total"]; }; }; 400: components["responses"]["400"]; @@ -2030,38 +1980,36 @@ export interface paths { }; }; }; - "/addresses/{address}/txs": { + "/mempool": { /** - * Address txs - * @deprecated - * @description Transactions on the address. + * Mempool + * @description Return transactions that are currently stored in Blockfrost mempool, + * waiting to be included in a newly minted block. + * Shows only transactions submitted via Blockfrost.io. + * + *+ * Hosted Endpoint only available for hosted variant. + *
*/ get: { parameters: { query?: { - /** @description The number of transactions per page. */ + /** @description The number of results displayed on one page. */ count?: number; /** @description The page number for listing the results. */ page?: number; /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. + * @description Ordered by the time of transaction submission. + * By default, we return oldest first, newest last. */ order?: "asc" | "desc"; }; - path: { - /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz - */ - address: string; - }; }; responses: { - /** @description Return the address content */ + /** @description Return the contents of the mempool */ 200: { content: { - "application/json": components["schemas"]["address_txs_content"]; + "application/json": components["schemas"]["mempool_content"]; }; }; 400: components["responses"]["400"]; @@ -2073,51 +2021,30 @@ export interface paths { }; }; }; - "/addresses/{address}/transactions": { + "/mempool/{hash}": { /** - * Address transactions - * @description Transactions on the address. - */ + * Specific transaction in the mempool + * @description Return content of the requested transaction. + * + *+ * Hosted Endpoint only available for hosted variant. + *
+ */ get: { parameters: { - query?: { - /** @description The number of addresses per page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - /** - * @description The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. - * Has to be lower than or equal to `to` parameter. - * - * @example 8929261 - */ - from?: string; - /** - * @description The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. - * Has to be higher than or equal to `from` parameter. - * - * @example 9999269:10 - */ - to?: string; - }; path: { /** - * @description Bech32 address. - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + * @description Hash of the requested transaction + * @example 6e5f825c42c1c6d6b77f2a14092f3b78c8f1b66db6f4cf8caec1555b6f967b3b */ - address: string; + hash: string; }; }; responses: { - /** @description Return the address content */ + /** @description Return the contents of the transaction. */ 200: { content: { - "application/json": components["schemas"]["address_transactions_content"]; + "application/json": components["schemas"]["mempool_tx_content"]; }; }; 400: components["responses"]["400"]; @@ -2129,30 +2056,42 @@ export interface paths { }; }; }; - "/pools": { + "/mempool/addresses/{address}": { /** - * List of stake pools - * @description List of registered stake pools. + * Mempool by address + * @description List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address. + * Shows only transactions submitted via Blockfrost.io. + * + *+ * Hosted Endpoint only available for hosted variant. + *
*/ get: { parameters: { query?: { - /** @description The number of pools per page. */ + /** @description The number of results displayed on one page. */ count?: number; /** @description The page number for listing the results. */ page?: number; /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. + * @description Ordered by the time of transaction submission. + * By default, we return oldest first, newest last. */ order?: "asc" | "desc"; }; + path: { + /** + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + */ + address: string; + }; }; responses: { - /** @description Return the list of pools. */ + /** @description Return the contents of the mempool */ 200: { content: { - "application/json": components["schemas"]["pool_list"]; + "application/json": components["schemas"]["mempool_addresses_content"]; }; }; 400: components["responses"]["400"]; @@ -2164,15 +2103,15 @@ export interface paths { }; }; }; - "/pools/extended": { + "/metadata/txs/labels": { /** - * List of stake pools with additional information - * @description List of registered stake pools with additional information. + * Transaction metadata labels + * @description List of all used transaction metadata labels. */ get: { parameters: { query?: { - /** @description The number of pools per page. */ + /** @description The number of results displayed on one page. */ count?: number; /** @description The page number for listing the results. */ page?: number; @@ -2184,10 +2123,10 @@ export interface paths { }; }; responses: { - /** @description Return the list of pools. */ + /** @description Return the account metadata content in CBOR */ 200: { content: { - "application/json": components["schemas"]["pool_list_extended"]; + "application/json": components["schemas"]["tx_metadata_labels"]; }; }; 400: components["responses"]["400"]; @@ -2199,15 +2138,15 @@ export interface paths { }; }; }; - "/pools/retired": { + "/metadata/txs/labels/{label}": { /** - * List of retired stake pools - * @description List of already retired pools. + * Transaction metadata content in JSON + * @description Transaction metadata per label. */ get: { parameters: { query?: { - /** @description The number of pools per page. */ + /** @description The number of results displayed on one page. */ count?: number; /** @description The page number for listing the results. */ page?: number; @@ -2217,12 +2156,19 @@ export interface paths { */ order?: "asc" | "desc"; }; + path: { + /** + * @description Metadata label + * @example 1990 + */ + label: string; + }; }; responses: { - /** @description Return the pool information content */ + /** @description Return the account metadata content */ 200: { content: { - "application/json": components["schemas"]["pool_list_retire"]; + "application/json": components["schemas"]["tx_metadata_label_json"]; }; }; 400: components["responses"]["400"]; @@ -2234,10 +2180,10 @@ export interface paths { }; }; }; - "/pools/retiring": { + "/metadata/txs/labels/{label}/cbor": { /** - * List of retiring stake pools - * @description List of stake pools retiring in the upcoming epochs + * Transaction metadata content in CBOR + * @description Transaction metadata per label. */ get: { parameters: { @@ -2252,43 +2198,19 @@ export interface paths { */ order?: "asc" | "desc"; }; - }; - responses: { - /** @description Return the pool information content */ - 200: { - content: { - "application/json": components["schemas"]["pool_list_retire"]; - }; - }; - 400: components["responses"]["400"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 418: components["responses"]["418"]; - 429: components["responses"]["429"]; - 500: components["responses"]["500"]; - }; - }; - }; - "/pools/{pool_id}": { - /** - * Specific stake pool - * @description Pool information. - */ - get: { - parameters: { path: { /** - * @description Bech32 or hexadecimal pool ID. - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Metadata label + * @example 1990 */ - pool_id: string; + label: string; }; }; responses: { - /** @description Return the pool information content */ + /** @description Return the account metadata content in CBOR */ 200: { content: { - "application/json": components["schemas"]["pool"]; + "application/json": components["schemas"]["tx_metadata_label_cbor"]; }; }; 400: components["responses"]["400"]; @@ -2300,37 +2222,26 @@ export interface paths { }; }; }; - "/pools/{pool_id}/history": { + "/addresses/{address}": { /** - * Stake pool history - * @description History of stake pool parameters over epochs. + * Specific address + * @description Obtain information about a specific address. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Bech32 or hexadecimal pool ID. - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - pool_id: string; + address: string; }; }; responses: { - /** @description Return the pool information content. */ + /** @description Return the address content. */ 200: { content: { - "application/json": components["schemas"]["pool_history"]; + "application/json": components["schemas"]["address_content"]; }; }; 400: components["responses"]["400"]; @@ -2342,26 +2253,26 @@ export interface paths { }; }; }; - "/pools/{pool_id}/metadata": { + "/addresses/{address}/extended": { /** - * Stake pool metadata - * @description Stake pool registration metadata. + * Extended information of a specific address + * @description Obtain extended information about a specific address. */ get: { parameters: { path: { /** - * @description Bech32 or hexadecimal pool ID. - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - pool_id: string; + address: string; }; }; responses: { - /** @description Return the pool metadata content. */ + /** @description Return the address content. */ 200: { content: { - "application/json": components["schemas"]["pool_metadata"] | components["schemas"]["empty_object"]; + "application/json": components["schemas"]["address_content_extended"]; }; }; 400: components["responses"]["400"]; @@ -2373,26 +2284,26 @@ export interface paths { }; }; }; - "/pools/{pool_id}/relays": { + "/addresses/{address}/total": { /** - * Stake pool relays - * @description Relays of a stake pool. + * Address details + * @description Obtain details about an address. */ get: { parameters: { path: { /** - * @description Bech32 or hexadecimal pool ID. - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - pool_id: string; + address: string; }; }; responses: { - /** @description Return the pool relays information content. */ + /** @description Return the Address details. */ 200: { content: { - "application/json": components["schemas"]["pool_relays"]; + "application/json": components["schemas"]["address_content_total"]; }; }; 400: components["responses"]["400"]; @@ -2404,10 +2315,10 @@ export interface paths { }; }; }; - "/pools/{pool_id}/delegators": { + "/addresses/{address}/utxos": { /** - * Stake pool delegators - * @description List of current stake pools delegators. + * Address UTXOs + * @description UTXOs of the address. */ get: { parameters: { @@ -2424,17 +2335,17 @@ export interface paths { }; path: { /** - * @description Bech32 or hexadecimal pool ID. - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - pool_id: string; + address: string; }; }; responses: { - /** @description Return the pool delegations. */ + /** @description Return the address content */ 200: { content: { - "application/json": components["schemas"]["pool_delegators"]; + "application/json": components["schemas"]["address_utxo_content"]; }; }; 400: components["responses"]["400"]; @@ -2446,10 +2357,10 @@ export interface paths { }; }; }; - "/pools/{pool_id}/blocks": { + "/addresses/{address}/utxos/{asset}": { /** - * Stake pool blocks - * @description List of stake pools blocks. + * Address UTXOs of a given asset + * @description UTXOs of the address. */ get: { parameters: { @@ -2466,17 +2377,22 @@ export interface paths { }; path: { /** - * @description Bech32 or hexadecimal pool ID. - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - pool_id: string; + address: string; + /** + * @description Concatenation of the policy_id and hex-encoded asset_name + * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e + */ + asset: string; }; }; responses: { - /** @description Return the pool block list */ + /** @description Return the address content */ 200: { content: { - "application/json": components["schemas"]["pool_blocks"]; + "application/json": components["schemas"]["address_utxo_content"]; }; }; 400: components["responses"]["400"]; @@ -2488,15 +2404,16 @@ export interface paths { }; }; }; - "/pools/{pool_id}/updates": { + "/addresses/{address}/txs": { /** - * Stake pool updates - * @description List of certificate updates to the stake pool. + * Address txs + * @deprecated + * @description Transactions on the address. */ get: { parameters: { query?: { - /** @description The number of results displayed on one page. */ + /** @description The number of transactions per page. */ count?: number; /** @description The page number for listing the results. */ page?: number; @@ -2508,17 +2425,17 @@ export interface paths { }; path: { /** - * @description Bech32 or hexadecimal pool ID. - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - pool_id: string; + address: string; }; }; responses: { - /** @description Return the pool updates history */ + /** @description Return the address content */ 200: { content: { - "application/json": components["schemas"]["pool_updates"]; + "application/json": components["schemas"]["address_txs_content"]; }; }; 400: components["responses"]["400"]; @@ -2530,63 +2447,51 @@ export interface paths { }; }; }; - "/assets": { + "/addresses/{address}/transactions": { /** - * Assets - * @description List of assets. If an asset is completely burned, - * it will stay on the list with quantity 0 (order of assets is immutable). + * Address transactions + * @description Transactions on the address. */ get: { parameters: { query?: { - /** @description The number of results displayed on one page. */ + /** @description The number of addresses per page. */ count?: number; /** @description The page number for listing the results. */ page?: number; /** * @description The ordering of items from the point of view of the blockchain, * not the page listing itself. By default, we return oldest first, newest last. - * Ordering in this case is based on the time of the first mint transaction. */ order?: "asc" | "desc"; + /** + * @description The block number and optionally also index from which (inclusive) to start search for results, concatenated using colon. + * Has to be lower than or equal to `to` parameter. + * + * @example 8929261 + */ + from?: string; + /** + * @description The block number and optionally also index where (inclusive) to end the search for results, concatenated using colon. + * Has to be higher than or equal to `from` parameter. + * + * @example 9999269:10 + */ + to?: string; }; - }; - responses: { - /** @description Return list of assets */ - 200: { - content: { - "application/json": components["schemas"]["assets"]; - }; - }; - 400: components["responses"]["400"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 418: components["responses"]["418"]; - 429: components["responses"]["429"]; - 500: components["responses"]["500"]; - }; - }; - }; - "/assets/{asset}": { - /** - * Specific asset - * @description Information about a specific asset - */ - get: { - parameters: { path: { /** - * @description Concatenation of the policy_id and hex-encoded asset_name - * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e + * @description Bech32 address. + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz */ - asset: string; + address: string; }; }; responses: { - /** @description Return the information about a specific asset */ + /** @description Return the address content */ 200: { content: { - "application/json": components["schemas"]["asset"]; + "application/json": components["schemas"]["address_transactions_content"]; }; }; 400: components["responses"]["400"]; @@ -2598,15 +2503,15 @@ export interface paths { }; }; }; - "/assets/{asset}/history": { + "/pools": { /** - * Asset history - * @description History of a specific asset + * List of stake pools + * @description List of registered stake pools. */ get: { parameters: { query?: { - /** @description The number of results displayed on one page. */ + /** @description The number of pools per page. */ count?: number; /** @description The page number for listing the results. */ page?: number; @@ -2616,19 +2521,12 @@ export interface paths { */ order?: "asc" | "desc"; }; - path: { - /** - * @description Concatenation of the policy_id and hex-encoded asset_name - * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e - */ - asset: string; - }; }; responses: { - /** @description Return the information about the history of a specific asset */ + /** @description Return the list of pools. */ 200: { content: { - "application/json": components["schemas"]["asset_history"]; + "application/json": components["schemas"]["pool_list"]; }; }; 400: components["responses"]["400"]; @@ -2640,16 +2538,15 @@ export interface paths { }; }; }; - "/assets/{asset}/txs": { + "/pools/extended": { /** - * Asset txs - * @deprecated - * @description List of a specific asset transactions + * List of stake pools with additional information + * @description List of registered stake pools with additional information. */ get: { parameters: { query?: { - /** @description The number of results displayed on one page. */ + /** @description The number of pools per page. */ count?: number; /** @description The page number for listing the results. */ page?: number; @@ -2659,19 +2556,12 @@ export interface paths { */ order?: "asc" | "desc"; }; - path: { - /** - * @description Concatenation of the policy_id and hex-encoded asset_name - * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e - */ - asset: string; - }; }; responses: { - /** @description Return the information about the history of a specific asset */ + /** @description Return the list of pools. */ 200: { content: { - "application/json": components["schemas"]["asset_txs"]; + "application/json": components["schemas"]["pool_list_extended"]; }; }; 400: components["responses"]["400"]; @@ -2683,15 +2573,15 @@ export interface paths { }; }; }; - "/assets/{asset}/transactions": { + "/pools/retired": { /** - * Asset transactions - * @description List of a specific asset transactions + * List of retired stake pools + * @description List of already retired pools. */ get: { parameters: { query?: { - /** @description The number of results displayed on one page. */ + /** @description The number of pools per page. */ count?: number; /** @description The page number for listing the results. */ page?: number; @@ -2701,19 +2591,12 @@ export interface paths { */ order?: "asc" | "desc"; }; - path: { - /** - * @description Concatenation of the policy_id and hex-encoded asset_name - * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e - */ - asset: string; - }; }; responses: { - /** @description Return the information about the history of a specific asset */ + /** @description Return the pool information content */ 200: { content: { - "application/json": components["schemas"]["asset_transactions"]; + "application/json": components["schemas"]["pool_list_retire"]; }; }; 400: components["responses"]["400"]; @@ -2725,10 +2608,10 @@ export interface paths { }; }; }; - "/assets/{asset}/addresses": { + "/pools/retiring": { /** - * Asset addresses - * @description List of a addresses containing a specific asset + * List of retiring stake pools + * @description List of stake pools retiring in the upcoming epochs */ get: { parameters: { @@ -2743,19 +2626,12 @@ export interface paths { */ order?: "asc" | "desc"; }; - path: { - /** - * @description Concatenation of the policy_id and hex-encoded asset_name - * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e - */ - asset: string; - }; }; responses: { - /** @description Return the information about the history of a specific asset */ + /** @description Return the pool information content */ 200: { content: { - "application/json": components["schemas"]["asset_addresses"]; + "application/json": components["schemas"]["pool_list_retire"]; }; }; 400: components["responses"]["400"]; @@ -2767,37 +2643,26 @@ export interface paths { }; }; }; - "/assets/policy/{policy_id}": { + "/pools/{pool_id}": { /** - * Assets of a specific policy - * @description List of asset minted under a specific policy + * Specific stake pool + * @description Pool information. */ get: { parameters: { - query?: { - /** @description The number of results displayed on one page. */ - count?: number; - /** @description The page number for listing the results. */ - page?: number; - /** - * @description The ordering of items from the point of view of the blockchain, - * not the page listing itself. By default, we return oldest first, newest last. - */ - order?: "asc" | "desc"; - }; path: { /** - * @description Specific policy_id - * @example 476039a0949cf0b22f6a800f56780184c44533887ca6e821007840c3 + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy */ - policy_id: string; + pool_id: string; }; }; responses: { - /** @description Return the information about a specific asset */ + /** @description Return the pool information content */ 200: { content: { - "application/json": components["schemas"]["asset_policy"]; + "application/json": components["schemas"]["pool"]; }; }; 400: components["responses"]["400"]; @@ -2809,17 +2674,17 @@ export interface paths { }; }; }; - "/scripts": { + "/pools/{pool_id}/history": { /** - * Scripts - * @description List of scripts. + * Stake pool history + * @description History of stake pool parameters over epochs. */ get: { parameters: { query?: { /** @description The number of results displayed on one page. */ count?: number; - /** @description The page number for listing the results. */ + /** @description The page number for listing the results */ page?: number; /** * @description The ordering of items from the point of view of the blockchain, @@ -2827,12 +2692,19 @@ export interface paths { */ order?: "asc" | "desc"; }; + path: { + /** + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + */ + pool_id: string; + }; }; responses: { - /** @description Return list of scripts */ + /** @description Return the pool information content. */ 200: { content: { - "application/json": components["schemas"]["scripts"]; + "application/json": components["schemas"]["pool_history"]; }; }; 400: components["responses"]["400"]; @@ -2844,26 +2716,28 @@ export interface paths { }; }; }; - "/scripts/{script_hash}": { + "/pools/{pool_id}/metadata": { /** - * Specific script - * @description Information about a specific script + * Stake pool metadata + * @description Stake pool registration metadata. */ get: { parameters: { path: { /** - * @description Hash of the script - * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy */ - script_hash: string; + pool_id: string; }; }; responses: { - /** @description Return the information about a specific script */ + /** @description Return the pool metadata content. */ 200: { content: { - "application/json": components["schemas"]["script"]; + "application/json": + | components["schemas"]["pool_metadata"] + | components["schemas"]["empty_object"]; }; }; 400: components["responses"]["400"]; @@ -2875,26 +2749,26 @@ export interface paths { }; }; }; - "/scripts/{script_hash}/json": { + "/pools/{pool_id}/relays": { /** - * Script JSON - * @description JSON representation of a `timelock` script + * Stake pool relays + * @description Relays of a stake pool. */ get: { parameters: { path: { /** - * @description Hash of the script - * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy */ - script_hash: string; + pool_id: string; }; }; responses: { - /** @description Return the JSON representation of a `timelock` script */ + /** @description Return the pool relays information content. */ 200: { content: { - "application/json": components["schemas"]["script_json"]; + "application/json": components["schemas"]["pool_relays"]; }; }; 400: components["responses"]["400"]; @@ -2906,26 +2780,37 @@ export interface paths { }; }; }; - "/scripts/{script_hash}/cbor": { + "/pools/{pool_id}/delegators": { /** - * Script CBOR - * @description CBOR representation of a `plutus` script + * Stake pool delegators + * @description List of current stake pools delegators. */ get: { parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; path: { /** - * @description Hash of the script - * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy */ - script_hash: string; + pool_id: string; }; }; responses: { - /** @description Return the CBOR representation of a `plutus` script */ + /** @description Return the pool delegations. */ 200: { content: { - "application/json": components["schemas"]["script_cbor"]; + "application/json": components["schemas"]["pool_delegators"]; }; }; 400: components["responses"]["400"]; @@ -2937,10 +2822,10 @@ export interface paths { }; }; }; - "/scripts/{script_hash}/redeemers": { + "/pools/{pool_id}/blocks": { /** - * Redeemers of a specific script - * @description List of redeemers of a specific script + * Stake pool blocks + * @description List of stake pools blocks. */ get: { parameters: { @@ -2957,17 +2842,17 @@ export interface paths { }; path: { /** - * @description Hash of the script - * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy */ - script_hash: string; + pool_id: string; }; }; responses: { - /** @description Return the information about redeemers of a specific script */ + /** @description Return the pool block list */ 200: { content: { - "application/json": components["schemas"]["script_redeemers"]; + "application/json": components["schemas"]["pool_blocks"]; }; }; 400: components["responses"]["400"]; @@ -2979,10 +2864,543 @@ export interface paths { }; }; }; - "/scripts/datum/{datum_hash}": { + "/pools/{pool_id}/updates": { /** - * Datum value - * @description Query JSON value of a datum by its hash + * Stake pool updates + * @description List of certificate updates to the stake pool. + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + */ + pool_id: string; + }; + }; + responses: { + /** @description Return the pool updates history */ + 200: { + content: { + "application/json": components["schemas"]["pool_updates"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/pools/{pool_id}/votes": { + /** + * Stake pool votes + * @description History of stake pools votes. + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Bech32 or hexadecimal pool ID. + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + */ + pool_id: string; + }; + }; + responses: { + /** @description Return the pool votes. */ + 200: { + content: { + "application/json": components["schemas"]["pool_votes"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/assets": { + /** + * Assets + * @description List of assets. If an asset is completely burned, + * it will stay on the list with quantity 0 (order of assets is immutable). + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + * Ordering in this case is based on the time of the first mint transaction. + */ + order?: "asc" | "desc"; + }; + }; + responses: { + /** @description Return list of assets */ + 200: { + content: { + "application/json": components["schemas"]["assets"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/assets/{asset}": { + /** + * Specific asset + * @description Information about a specific asset + */ + get: { + parameters: { + path: { + /** + * @description Concatenation of the policy_id and hex-encoded asset_name + * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e + */ + asset: string; + }; + }; + responses: { + /** @description Return the information about a specific asset */ + 200: { + content: { + "application/json": components["schemas"]["asset"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/assets/{asset}/history": { + /** + * Asset history + * @description History of a specific asset + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Concatenation of the policy_id and hex-encoded asset_name + * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e + */ + asset: string; + }; + }; + responses: { + /** @description Return the information about the history of a specific asset */ + 200: { + content: { + "application/json": components["schemas"]["asset_history"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/assets/{asset}/txs": { + /** + * Asset txs + * @deprecated + * @description List of a specific asset transactions + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Concatenation of the policy_id and hex-encoded asset_name + * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e + */ + asset: string; + }; + }; + responses: { + /** @description Return the information about the history of a specific asset */ + 200: { + content: { + "application/json": components["schemas"]["asset_txs"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/assets/{asset}/transactions": { + /** + * Asset transactions + * @description List of a specific asset transactions + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Concatenation of the policy_id and hex-encoded asset_name + * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e + */ + asset: string; + }; + }; + responses: { + /** @description Return the information about the history of a specific asset */ + 200: { + content: { + "application/json": components["schemas"]["asset_transactions"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/assets/{asset}/addresses": { + /** + * Asset addresses + * @description List of a addresses containing a specific asset + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Concatenation of the policy_id and hex-encoded asset_name + * @example b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e + */ + asset: string; + }; + }; + responses: { + /** @description Return the information about the history of a specific asset */ + 200: { + content: { + "application/json": components["schemas"]["asset_addresses"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/assets/policy/{policy_id}": { + /** + * Assets of a specific policy + * @description List of asset minted under a specific policy + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Specific policy_id + * @example 476039a0949cf0b22f6a800f56780184c44533887ca6e821007840c3 + */ + policy_id: string; + }; + }; + responses: { + /** @description Return the information about a specific asset */ + 200: { + content: { + "application/json": components["schemas"]["asset_policy"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/scripts": { + /** + * Scripts + * @description List of scripts. + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + }; + responses: { + /** @description Return list of scripts */ + 200: { + content: { + "application/json": components["schemas"]["scripts"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/scripts/{script_hash}": { + /** + * Specific script + * @description Information about a specific script + */ + get: { + parameters: { + path: { + /** + * @description Hash of the script + * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + */ + script_hash: string; + }; + }; + responses: { + /** @description Return the information about a specific script */ + 200: { + content: { + "application/json": components["schemas"]["script"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/scripts/{script_hash}/json": { + /** + * Script JSON + * @description JSON representation of a `timelock` script + */ + get: { + parameters: { + path: { + /** + * @description Hash of the script + * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + */ + script_hash: string; + }; + }; + responses: { + /** @description Return the JSON representation of a `timelock` script */ + 200: { + content: { + "application/json": components["schemas"]["script_json"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/scripts/{script_hash}/cbor": { + /** + * Script CBOR + * @description CBOR representation of a `plutus` script + */ + get: { + parameters: { + path: { + /** + * @description Hash of the script + * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + */ + script_hash: string; + }; + }; + responses: { + /** @description Return the CBOR representation of a `plutus` script */ + 200: { + content: { + "application/json": components["schemas"]["script_cbor"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/scripts/{script_hash}/redeemers": { + /** + * Redeemers of a specific script + * @description List of redeemers of a specific script + */ + get: { + parameters: { + query?: { + /** @description The number of results displayed on one page. */ + count?: number; + /** @description The page number for listing the results. */ + page?: number; + /** + * @description The ordering of items from the point of view of the blockchain, + * not the page listing itself. By default, we return oldest first, newest last. + */ + order?: "asc" | "desc"; + }; + path: { + /** + * @description Hash of the script + * @example e1457a0c47dfb7a2f6b8fbb059bdceab163c05d34f195b87b9f2b30e + */ + script_hash: string; + }; + }; + responses: { + /** @description Return the information about redeemers of a specific script */ + 200: { + content: { + "application/json": components["schemas"]["script_redeemers"]; + }; + }; + 400: components["responses"]["400"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 418: components["responses"]["418"]; + 429: components["responses"]["429"]; + 500: components["responses"]["500"]; + }; + }; + }; + "/scripts/datum/{datum_hash}": { + /** + * Datum value + * @description Query JSON value of a datum by its hash */ get: { parameters: { @@ -3152,12 +3570,14 @@ export interface paths { /** @description Transaction CBOR (encoded using base64 or base16). */ cbor: string; /** @description Additional UTXO as an array of tuples [TxIn, TxOut]. See https://ogmios.dev/mini-protocols/local-tx-submission/#additional-utxo-set. */ - additionalUtxoSet?: (({ + additionalUtxoSet?: ( + | { /** @description Transaction hash for the input */ txId?: string; /** @description Index of the output within the transaction */ index?: number; - } | { + } + | { /** @description Output address */ address: string; value: { @@ -3175,7 +3595,8 @@ export interface paths { script?: { [key: string]: unknown; }; - })[])[]; + } + )[][]; }; }; }; @@ -3315,38 +3736,38 @@ export interface paths { /** @description Returns pinned objects */ 200: { content: { - "application/json": ({ - /** - * @description Creation time of the IPFS object on our backends - * @example 1615551024 - */ - time_created: number; - /** - * @description Pin time of the IPFS object on our backends - * @example 1615551024 - */ - time_pinned: number; - /** - * @description IPFS hash of the pinned object - * @example QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx - */ - ipfs_hash: string; - /** - * @description Size of the object in Bytes - * @example 1615551024 - */ - size: string; - /** - * @description State of the pinned object, which is `queued` when we are retriving object. If this - * is successful the state is changed to `pinned` or `failed` if not. The state `gc` means the - * pinned item has been garbage collected due to account being over storage quota or after it has - * been moved to `unpinned` state by removing the object pin. - * - * @example pinned - * @enum {string} - */ - state: "queued|pinned|unpinned|failed|gc"; - })[]; + "application/json": { + /** + * @description Creation time of the IPFS object on our backends + * @example 1615551024 + */ + time_created: number; + /** + * @description Pin time of the IPFS object on our backends + * @example 1615551024 + */ + time_pinned: number; + /** + * @description IPFS hash of the pinned object + * @example QmdVMnULrY95mth2XkwjxDtMHvzuzmvUPTotKE1tgqKbCx + */ + ipfs_hash: string; + /** + * @description Size of the object in Bytes + * @example 1615551024 + */ + size: string; + /** + * @description State of the pinned object, which is `queued` when we are retriving object. If this + * is successful the state is changed to `pinned` or `failed` if not. The state `gc` means the + * pinned item has been garbage collected due to account being over storage quota or after it has + * been moved to `unpinned` state by removing the object pin. + * + * @example pinned + * @enum {string} + */ + state: "queued|pinned|unpinned|failed|gc"; + }[]; }; }; 400: components["responses"]["400"]; @@ -3824,13 +4245,13 @@ export interface components { * ] */ block_content_addresses: { - /** @description Address that was affected in the specified block */ - address: string; - /** @description List of transactions containing the address either in their inputs or outputs. Sorted by transaction index within a block, ascending. */ - transactions: { - tx_hash: string; - }[]; + /** @description Address that was affected in the specified block */ + address: string; + /** @description List of transactions containing the address either in their inputs or outputs. Sorted by transaction index within a block, ascending. */ + transactions: { + tx_hash: string; }[]; + }[]; genesis_content: { /** * @description The proportion of slots in which blocks should be issued @@ -3883,6 +4304,307 @@ export interface components { */ security_param: number; }; + /** + * @example [ + * { + * "drep_id": "drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn", + * "hex": "db1bc3c3f99ce68977ceaf27ab4dd917123ef9e73f85c304236eab23" + * }, + * { + * "drep_id": "drep1cxayn4fgy27yaucvhamsvqj3v6835mh3tjjx6x8hdnr4", + * "hex": "c1ba49d52822bc4ef30cbf77060251668f1a6ef15ca46d18f76cc758" + * } + * ] + */ + drep_content: { + /** @description The Bech32 encoded DRep address */ + drep_id: string; + /** @description The raw bytes of the DRep */ + hex: string; + }[]; + /** + * @example [ + * { + * "drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc", + * "hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d", + * "amount": "2000000", + * "active": true, + * "active_epoch": 420, + * "has_script": true + * } + * ] + */ + drep_details_content: { + /** @description Bech32 encoded DRep address */ + drep_id: string; + /** @description The raw bytes of the DRep */ + hex: string; + /** @description The total amount of voting power this DRep is delegated. */ + amount: string; + /** @description Registration state of the DRep */ + active: boolean; + /** @description Epoch of the most recent action - registration or deregistration */ + active_epoch: number | null; + /** @description Flag which shows if this DRep credentials are a script hash */ + has_script: boolean; + }; + /** + * @example [ + * { + * "address": "stake1ux4vspfvwuus9uwyp5p3f0ky7a30jq5j80jxse0fr7pa56sgn8kha", + * "amount": "1137959159981411" + * }, + * { + * "address": "stake1uylayej7esmarzd4mk4aru37zh9yz0luj3g9fsvgpfaxulq564r5u", + * "amount": "16958865648" + * }, + * { + * "address": "stake1u8lr2pnrgf8f7vrs9lt79hc3sxm8s2w4rwvgpncks3axx6q93d4ck", + * "amount": "18605647" + * } + * ] + */ + drep_delegators: { + /** @description Bech32 encoded stake addresses */ + address: string; + /** @description Currently delegated amount */ + amount: string; + }[]; + /** + * @example [ + * { + * "drep_id": "drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc", + * "hex": "a61261172624e8333ceff098648d90f8e404e2e36d5b5f5985cbd35d", + * "url": "https://stakenuts.com/drep.json", + * "hash": "69c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c" + * } + * ] + */ + drep_metadata: { + /** @description Bech32 encoded addresses */ + drep_id: string; + /** @description The raw bytes of the DRep */ + hex: string; + /** + * @description URL to the drep metadata + * @example https://stakenuts.com/drep.json + */ + url: string | null; + /** + * @description Hash of the metadata file + * @example 69c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c" + */ + hash: string | null; + }; + /** + * @example [ + * { + * "tx_hash": "f4097fbdb87ab7c7ab44b30d4e2b81713a058488975d1ab8b05c381dd946a393", + * "cert_index": 0, + * "action": "registered" + * }, + * { + * "tx_hash": "dd3243af975be4b5bedce4e5f5b483b2386d5ad207d05e0289c1df0eb261447e", + * "cert_index": 0, + * "action": "deregistered" + * } + * ] + */ + drep_updates: { + /** @description Transaction ID */ + tx_hash: string; + /** @description Certificate within the transaction */ + cert_index: number; + /** + * @description Action in the certificate + * @enum {string} + */ + action: "registered" | "deregistered"; + }[]; + /** + * @example [ + * { + * "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + * "cert_index": 2, + * "vote": "yes" + * }, + * { + * "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + * "cert_index": 3, + * "vote": "abstain" + * } + * ] + */ + drep_votes: { + /** @description Hash of the proposal transaction. */ + tx_hash: string; + /** @description Index of the certificate within the proposal transaction. */ + cert_index: number; + /** + * @description The Vote. Can be one of yes, no, abstain. + * @enum {string} + */ + vote: "yes" | "no" | "abstain"; + }[]; + /** + * @example [ + * { + * "tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531", + * "cert_index": 1, + * "governance_type": "treasury_withdrawals" + * }, + * { + * "tx_hash": "71317e951b20aa46e9fbf45a46a6e950d5723a481225519655bf6c60", + * "cert_index": 4, + * "governance_type": "no_confidence" + * } + * ] + */ + proposal_content: { + /** @description Hash of the proposal transaction. */ + tx_hash: string; + /** @description Index of the certificate within the proposal transaction. */ + cert_index: number; + /** + * @description Type of proposal. + * @enum {string} + */ + governance_type: + | "hard_fork_initiation" + | "new_committee" + | "new_constitution" + | "info_action" + | "no_confidence" + | "parameter_change" + | "treasury_withdrawals"; + }[]; + /** + * @example [ + * { + * "tx_hash": "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531", + * "cert_index": 1, + * "governance_type": "treasury_withdrawals", + * "deposit": 12000, + * "return_address": "stake_test1urd3hs7rlxwwdzthe6hj026dmyt3y0heuulctscyydh2kgck6nkmz", + * "governance_description": "TreasuryWithdrawals (fromList [(RewardAcnt {getRwdNetwork = Testnet, getRwdCred = KeyHashObj (KeyHash \"71317e951b20aa46e9fbf45a46a6e950d5723a481225519655bf6c60\")},Coin 20000000)])", + * "ratified_epoch": null, + * "enacted_epoch": 123, + * "dropped_epoch": null, + * "expired_epoch": null, + * "expiration": 120, + * "anchor_url": "https://gist.github.com/123", + * "anchor_hash": "50b340624d49823720505e3f0095be0d6cd8f26501e094a6ab9068dd" + * } + * ] + */ + proposal_details_content: { + /** @description Hash of the proposal transaction. */ + tx_hash: string; + /** @description Index of the certificate within the proposal transaction. */ + cert_index: number; + /** + * @description Type of proposal. + * @enum {string} + */ + governance_type: + | "hard_fork_initiation" + | "new_committee" + | "new_constitution" + | "info_action" + | "no_confidence" + | "parameter_change" + | "treasury_withdrawals"; + /** @description An object describing the content of this GovActionProposal in a readable way. */ + governance_description: { + [key: string]: unknown; + } | null; + /** @description The deposit amount paid for this proposal. */ + deposit: string; + /** @description Bech32 stake address of the reward address to receive the deposit when it is repaid. */ + return_address: string; + ratified_epoch: number | null; + enacted_epoch: number | null; + dropped_epoch: number | null; + expired_epoch: number | null; + /** @description Shows the epoch at which this governance action will expire. */ + expiration: number; + /** @description The URL of the offchain anchor data. */ + anchor_url: string | null; + /** @description The hash of the offchain anchor data. */ + anchor_hash: string | null; + }; + /** + * @example [ + * { + * "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + * "cert_index": 2, + * "voter_role": "drep", + * "voter": "drep1mvdu8slennngja7w4un6knwezufra70887zuxpprd64jxfveahn", + * "vote": "yes" + * }, + * { + * "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + * "cert_index": 3, + * "voter_role": "constitutional_committee", + * "voter": "53a42debdc7ffd90085ab7fd9800b63e6d1c9ac481ba6eb7b6a844e4", + * "vote": "abstain" + * } + * ] + */ + proposal_details_votes: { + /** @description Hash of the voting transaction. */ + tx_hash: string; + /** @description Index of the certificate within the voting transaction. */ + cert_index: number; + /** + * @description The role of the voter. Can be one of constitutional_committee, drep, spo. + * @enum {string} + */ + voter_role: "constitutional_committee" | "drep" | "spo"; + /** @description The actual voter. */ + voter: string; + /** + * @description The Vote. Can be one of yes, no, abstain. + * @enum {string} + */ + vote: "yes" | "no" | "abstain"; + }[]; + /** + * @example [ + * { + * "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + * "cert_index": 2, + * "voter_role": "spo", + * "voter": "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2qnikdy", + * "vote": "yes" + * }, + * { + * "tx_hash": "b302de601defdf11a5261ed31a263804dac4a582a888c998ce24dec5", + * "cert_index": 3, + * "voter_role": "constitutional_committee", + * "voter": "53a42debdc7ffd90085ab7fd9800b63e6d1c9ac481ba6eb7b6a844e4", + * "vote": "abstain" + * } + * ] + */ + vote_content: { + /** @description Hash of the proposal transaction. */ + tx_hash: string; + /** @description Index of the certificate within the proposal transaction. */ + cert_index: number; + /** + * @description The role of the voter. Can be one of constitutional_committee, drep, spo. + * @enum {string} + */ + voter_role: "constitutional_committee" | "drep" | "spo"; + /** @description The actual voter. */ + voter: string; + /** + * @description The Vote. Can be one of yes, no, abstain. + * @enum {string} + */ + vote: "yes" | "no" | "abstain"; + }[]; epoch_content: { /** * @description Epoch number @@ -4109,37 +4831,79 @@ export interface components { * @example 34482 */ coins_per_utxo_word: string | null; + /** @description Pool Voting threshold for motion of no-confidence. */ + pvt_motion_no_confidence: number | null; + /** @description Pool Voting threshold for new committee/threshold (normal state). */ + pvt_committee_normal: number | null; + /** @description Pool Voting threshold for new committee/threshold (state of no-confidence). */ + pvt_committee_no_confidence: number | null; + /** @description Pool Voting threshold for hard-fork initiation. */ + pvt_hard_fork_initiation: number | null; + /** @description DRep Vote threshold for motion of no-confidence. */ + dvt_motion_no_confidence: number | null; + /** @description DRep Vote threshold for new committee/threshold (normal state). */ + dvt_committee_normal: number | null; + /** @description DRep Vote threshold for new committee/threshold (state of no-confidence). */ + dvt_committee_no_confidence: number | null; + /** @description DRep Vote threshold for update to the Constitution. */ + dvt_update_to_constitution: number | null; + /** @description DRep Vote threshold for hard-fork initiation. */ + dvt_hard_fork_initiation: number | null; + /** @description DRep Vote threshold for protocol parameter changes, network group. */ + dvt_p_p_network_group: number | null; + /** @description DRep Vote threshold for protocol parameter changes, economic group. */ + dvt_p_p_economic_group: number | null; + /** @description DRep Vote threshold for protocol parameter changes, technical group. */ + dvt_p_p_technical_group: number | null; + /** @description DRep Vote threshold for protocol parameter changes, governance group. */ + dvt_p_p_gov_group: number | null; + /** @description DRep Vote threshold for treasury withdrawal. */ + dvt_treasury_withdrawal: number | null; + /** @description Minimal constitutional committee size. */ + committee_min_size: string | null; + /** @description Constitutional committee term limits. */ + committee_max_term_length: string | null; + /** @description Governance action expiration. */ + gov_action_lifetime: string | null; + /** @description Governance action deposit. */ + gov_action_deposit: string | null; + /** @description DRep deposit amount. */ + drep_deposit: string | null; + /** @description DRep activity period. */ + drep_activity: string | null; + /** @description The Tx table index for the transaction that contains this parameter proposal. */ + registered_tx_id: number | null; }; epoch_content_array: components["schemas"]["epoch_content"][]; epoch_stake_content: { - /** - * @description Stake address - * @example stake1u9l5q5jwgelgagzyt6nuaasefgmn8pd25c8e9qpeprq0tdcp0e3uk - */ - stake_address: string; - /** - * @description Bech32 prefix of the pool delegated to - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy - */ - pool_id: string; - /** - * @description Amount of active delegated stake in Lovelaces - * @example 4440295078 - */ - amount: string; - }[]; + /** + * @description Stake address + * @example stake1u9l5q5jwgelgagzyt6nuaasefgmn8pd25c8e9qpeprq0tdcp0e3uk + */ + stake_address: string; + /** + * @description Bech32 prefix of the pool delegated to + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + */ + pool_id: string; + /** + * @description Amount of active delegated stake in Lovelaces + * @example 4440295078 + */ + amount: string; + }[]; epoch_stake_pool_content: { - /** - * @description Stake address - * @example stake1u9l5q5jwgelgagzyt6nuaasefgmn8pd25c8e9qpeprq0tdcp0e3uk - */ - stake_address: string; - /** - * @description Amount of active delegated stake in Lovelaces - * @example 4440295078 - */ - amount: string; - }[]; + /** + * @description Stake address + * @example stake1u9l5q5jwgelgagzyt6nuaasefgmn8pd25c8e9qpeprq0tdcp0e3uk + */ + stake_address: string; + /** + * @description Amount of active delegated stake in Lovelaces + * @example 4440295078 + */ + amount: string; + }[]; /** * @example [ * "d0fa315687e99ccdc96b14cc2ea74a767405d64427b648c470731a9b69e4606e", @@ -4192,14 +4956,14 @@ export interface components { * ] */ output_amount: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** * @description Fees of the transaction in Lovelaces * @example 182485 @@ -4282,327 +5046,327 @@ export interface components { * @example 1e043f100dce12d107f679685acd2fc0610e10f72a92d412794c9773d11d8477 */ hash: string; - inputs: ({ - /** - * @description Input address - * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv - */ - address: string; - /** - * @example [ - * { - * "unit": "lovelace", - * "quantity": "42000000" - * }, - * { - * "unit": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e", - * "quantity": "12" - * } - * ] - */ - amount: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; - /** - * @description Hash of the UTXO transaction - * @example 1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157f0 - */ - tx_hash: string; - /** - * @description UTXO index in the transaction - * @example 0 - */ - output_index: number; - /** - * @description The hash of the transaction output datum - * @example 9e478573ab81ea7a8e31891ce0648b81229f408d596a3483e6f4f9b92d3cf710 - */ - data_hash: string | null; - /** - * @description CBOR encoded inline datum - * @example 19a6aa - */ - inline_datum: string | null; - /** - * @description The hash of the reference script of the input - * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 - */ - reference_script_hash: string | null; - /** - * @description Whether the input is a collateral consumed on script validation failure - * @example false - */ - collateral: boolean; - /** - * @description Whether the input is a reference transaction input - * @example false - */ - reference?: boolean; - })[]; - outputs: ({ - /** - * @description Output address - * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv - */ - address: string; - /** - * @example [ - * { - * "unit": "lovelace", - * "quantity": "42000000" - * }, - * { - * "unit": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e", - * "quantity": "12" - * } - * ] - */ - amount: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; - /** - * @description UTXO index in the transaction - * @example 0 - */ - output_index: number; - /** - * @description The hash of the transaction output datum - * @example 9e478573ab81ea7a8e31891ce0648b81229f408d596a3483e6f4f9b92d3cf710 - */ - data_hash: string | null; - /** - * @description CBOR encoded inline datum - * @example 19a6aa - */ - inline_datum: string | null; - /** - * @description Whether the output is a collateral output - * @example false - */ - collateral: boolean; - /** - * @description The hash of the reference script of the output - * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 - */ - reference_script_hash: string | null; - })[]; - }; - tx_content_stake_addr: { + inputs: { /** - * @description Index of the certificate within the transaction - * @example 0 + * @description Input address + * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv */ - cert_index: number; + address: string; /** - * @description Delegation stake address - * @example stake1u9t3a0tcwune5xrnfjg4q7cpvjlgx9lcv0cuqf5mhfjwrvcwrulda + * @example [ + * { + * "unit": "lovelace", + * "quantity": "42000000" + * }, + * { + * "unit": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e", + * "quantity": "12" + * } + * ] */ - address: string; + amount: { + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** - * @description Registration boolean, false if deregistration - * @example true + * @description Hash of the UTXO transaction + * @example 1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157f0 */ - registration: boolean; - }[]; - tx_content_delegations: { + tx_hash: string; /** - * @deprecated - * @description Index of the certificate within the transaction + * @description UTXO index in the transaction * @example 0 */ - index: number; + output_index: number; + /** + * @description The hash of the transaction output datum + * @example 9e478573ab81ea7a8e31891ce0648b81229f408d596a3483e6f4f9b92d3cf710 + */ + data_hash: string | null; /** - * @description Index of the certificate within the transaction - * @example 0 + * @description CBOR encoded inline datum + * @example 19a6aa */ - cert_index: number; + inline_datum: string | null; /** - * @description Bech32 delegation stake address - * @example stake1u9r76ypf5fskppa0cmttas05cgcswrttn6jrq4yd7jpdnvc7gt0yc + * @description The hash of the reference script of the input + * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 */ - address: string; + reference_script_hash: string | null; /** - * @description Bech32 ID of delegated stake pool - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description Whether the input is a collateral consumed on script validation failure + * @example false */ - pool_id: string; + collateral: boolean; /** - * @description Epoch in which the delegation becomes active - * @example 210 + * @description Whether the input is a reference transaction input + * @example false */ - active_epoch: number; + reference?: boolean; }[]; - tx_content_withdrawals: { + outputs: { /** - * @description Bech32 withdrawal address - * @example stake1u9r76ypf5fskppa0cmttas05cgcswrttn6jrq4yd7jpdnvc7gt0yc + * @description Output address + * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv */ address: string; /** - * @description Withdrawal amount in Lovelaces - * @example 431833601 + * @example [ + * { + * "unit": "lovelace", + * "quantity": "42000000" + * }, + * { + * "unit": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e", + * "quantity": "12" + * } + * ] */ - amount: string; - }[]; - tx_content_mirs: ({ + amount: { + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** - * @description Source of MIR funds - * @example reserve - * @enum {string} + * @description UTXO index in the transaction + * @example 0 */ - pot: "reserve" | "treasury"; + output_index: number; /** - * @description Index of the certificate within the transaction - * @example 0 + * @description The hash of the transaction output datum + * @example 9e478573ab81ea7a8e31891ce0648b81229f408d596a3483e6f4f9b92d3cf710 */ - cert_index: number; + data_hash: string | null; /** - * @description Bech32 stake address - * @example stake1u9r76ypf5fskppa0cmttas05cgcswrttn6jrq4yd7jpdnvc7gt0yc + * @description CBOR encoded inline datum + * @example 19a6aa */ - address: string; + inline_datum: string | null; /** - * @description MIR amount in Lovelaces - * @example 431833601 + * @description Whether the output is a collateral output + * @example false */ - amount: string; - })[]; - tx_content_pool_certs: ({ + collateral: boolean; /** - * @description Index of the certificate within the transaction - * @example 0 + * @description The hash of the reference script of the output + * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 */ - cert_index: number; + reference_script_hash: string | null; + }[]; + }; + tx_content_stake_addr: { + /** + * @description Index of the certificate within the transaction + * @example 0 + */ + cert_index: number; + /** + * @description Delegation stake address + * @example stake1u9t3a0tcwune5xrnfjg4q7cpvjlgx9lcv0cuqf5mhfjwrvcwrulda + */ + address: string; + /** + * @description Registration boolean, false if deregistration + * @example true + */ + registration: boolean; + }[]; + tx_content_delegations: { + /** + * @deprecated + * @description Index of the certificate within the transaction + * @example 0 + */ + index: number; + /** + * @description Index of the certificate within the transaction + * @example 0 + */ + cert_index: number; + /** + * @description Bech32 delegation stake address + * @example stake1u9r76ypf5fskppa0cmttas05cgcswrttn6jrq4yd7jpdnvc7gt0yc + */ + address: string; + /** + * @description Bech32 ID of delegated stake pool + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + */ + pool_id: string; + /** + * @description Epoch in which the delegation becomes active + * @example 210 + */ + active_epoch: number; + }[]; + tx_content_withdrawals: { + /** + * @description Bech32 withdrawal address + * @example stake1u9r76ypf5fskppa0cmttas05cgcswrttn6jrq4yd7jpdnvc7gt0yc + */ + address: string; + /** + * @description Withdrawal amount in Lovelaces + * @example 431833601 + */ + amount: string; + }[]; + tx_content_mirs: { + /** + * @description Source of MIR funds + * @example reserve + * @enum {string} + */ + pot: "reserve" | "treasury"; + /** + * @description Index of the certificate within the transaction + * @example 0 + */ + cert_index: number; + /** + * @description Bech32 stake address + * @example stake1u9r76ypf5fskppa0cmttas05cgcswrttn6jrq4yd7jpdnvc7gt0yc + */ + address: string; + /** + * @description MIR amount in Lovelaces + * @example 431833601 + */ + amount: string; + }[]; + tx_content_pool_certs: { + /** + * @description Index of the certificate within the transaction + * @example 0 + */ + cert_index: number; + /** + * @description Bech32 encoded pool ID + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + */ + pool_id: string; + /** + * @description VRF key hash + * @example 0b5245f9934ec2151116fb8ec00f35fd00e0aa3b075c4ed12cce440f999d8233 + */ + vrf_key: string; + /** + * @description Stake pool certificate pledge in Lovelaces + * @example 5000000000 + */ + pledge: string; + /** + * @description Margin tax cost of the stake pool + * @example 0.05 + */ + margin_cost: number; + /** + * @description Fixed tax cost of the stake pool in Lovelaces + * @example 340000000 + */ + fixed_cost: string; + /** + * @description Bech32 reward account of the stake pool + * @example stake1uxkptsa4lkr55jleztw43t37vgdn88l6ghclfwuxld2eykgpgvg3f + */ + reward_account: string; + /** + * @example [ + * "stake1u98nnlkvkk23vtvf9273uq7cph5ww6u2yq2389psuqet90sv4xv9v" + * ] + */ + owners: string[]; + metadata: { /** - * @description Bech32 encoded pool ID - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description URL to the stake pool metadata + * @example https://stakenuts.com/mainnet.json */ - pool_id: string; + url: string | null; /** - * @description VRF key hash - * @example 0b5245f9934ec2151116fb8ec00f35fd00e0aa3b075c4ed12cce440f999d8233 + * @description Hash of the metadata file + * @example 47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c */ - vrf_key: string; + hash: string | null; /** - * @description Stake pool certificate pledge in Lovelaces - * @example 5000000000 + * @description Ticker of the stake pool + * @example NUTS */ - pledge: string; + ticker: string | null; /** - * @description Margin tax cost of the stake pool - * @example 0.05 + * @description Name of the stake pool + * @example Stake Nuts */ - margin_cost: number; + name: string | null; /** - * @description Fixed tax cost of the stake pool in Lovelaces - * @example 340000000 + * @description Description of the stake pool + * @example The best pool ever */ - fixed_cost: string; + description: string | null; /** - * @description Bech32 reward account of the stake pool - * @example stake1uxkptsa4lkr55jleztw43t37vgdn88l6ghclfwuxld2eykgpgvg3f + * @description Home page of the stake pool + * @example https://stakentus.com/ */ - reward_account: string; + homepage: string | null; + } | null; + relays: { /** - * @example [ - * "stake1u98nnlkvkk23vtvf9273uq7cph5ww6u2yq2389psuqet90sv4xv9v" - * ] + * @description IPv4 address of the relay + * @example 4.4.4.4 */ - owners: string[]; - metadata: ({ - /** - * @description URL to the stake pool metadata - * @example https://stakenuts.com/mainnet.json - */ - url: string | null; - /** - * @description Hash of the metadata file - * @example 47c0c68cb57f4a5b4a87bad896fc274678e7aea98e200fa14a1cb40c0cab1d8c - */ - hash: string | null; - /** - * @description Ticker of the stake pool - * @example NUTS - */ - ticker: string | null; - /** - * @description Name of the stake pool - * @example Stake Nuts - */ - name: string | null; - /** - * @description Description of the stake pool - * @example The best pool ever - */ - description: string | null; - /** - * @description Home page of the stake pool - * @example https://stakentus.com/ - */ - homepage: string | null; - }) | null; - relays: ({ - /** - * @description IPv4 address of the relay - * @example 4.4.4.4 - */ - ipv4: string | null; - /** - * @description IPv6 address of the relay - * @example https://stakenuts.com/mainnet.json - */ - ipv6: string | null; - /** - * @description DNS name of the relay - * @example relay1.stakenuts.com - */ - dns: string | null; - /** - * @description DNS SRV entry of the relay - * @example _relays._tcp.relays.stakenuts.com - */ - dns_srv: string | null; - /** - * @description Network port of the relay - * @example 3001 - */ - port: number; - })[]; + ipv4: string | null; /** - * @description Epoch in which the update becomes active - * @example 210 + * @description IPv6 address of the relay + * @example https://stakenuts.com/mainnet.json */ - active_epoch: number; - })[]; - tx_content_pool_retires: { + ipv6: string | null; /** - * @description Index of the certificate within the transaction - * @example 0 + * @description DNS name of the relay + * @example relay1.stakenuts.com */ - cert_index: number; + dns: string | null; /** - * @description Bech32 stake pool ID - * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + * @description DNS SRV entry of the relay + * @example _relays._tcp.relays.stakenuts.com */ - pool_id: string; + dns_srv: string | null; /** - * @description Epoch in which the pool becomes retired - * @example 216 + * @description Network port of the relay + * @example 3001 */ - retiring_epoch: number; + port: number; }[]; + /** + * @description Epoch in which the update becomes active + * @example 210 + */ + active_epoch: number; + }[]; + tx_content_pool_retires: { + /** + * @description Index of the certificate within the transaction + * @example 0 + */ + cert_index: number; + /** + * @description Bech32 stake pool ID + * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy + */ + pool_id: string; + /** + * @description Epoch in which the pool becomes retired + * @example 216 + */ + retiring_epoch: number; + }[]; /** * @example [ * { @@ -4626,13 +5390,18 @@ export interface components { * ] */ tx_content_metadata: { - /** @description Metadata label */ - label: string; - /** @description Content of the metadata */ - json_metadata: OneOf<[string, { - [key: string]: unknown; - }]>; - }[]; + /** @description Metadata label */ + label: string; + /** @description Content of the metadata */ + json_metadata: OneOf< + [ + string, + { + [key: string]: unknown; + }, + ] + >; + }[]; /** * @example [ * { @@ -4642,68 +5411,68 @@ export interface components { * } * ] */ - tx_content_metadata_cbor: ({ - /** @description Metadata label */ - label: string; - /** - * @deprecated - * @description Content of the CBOR metadata - */ - cbor_metadata: string | null; - /** @description Content of the CBOR metadata in hex */ - metadata: string | null; - })[]; - tx_content_redeemers: ({ - /** - * @description Index of the redeemer within the transaction - * @example 0 - */ - tx_index: number; - /** - * @description Validation purpose - * @example spend - * @enum {string} - */ - purpose: "spend" | "mint" | "cert" | "reward"; - /** - * @description Script hash - * @example ec26b89af41bef0f7585353831cb5da42b5b37185e0c8a526143b824 - */ - script_hash: string; - /** - * @description Redeemer data hash - * @example 923918e403bf43c34b4ef6b48eb2ee04babed17320d8d1b9ff9ad086e86f44ec - */ - redeemer_data_hash: string; - /** - * @deprecated - * @description Datum hash - * @example 923918e403bf43c34b4ef6b48eb2ee04babed17320d8d1b9ff9ad086e86f44ec - */ - datum_hash: string; - /** - * @description The budget in Memory to run a script - * @example 1700 - */ - unit_mem: string; - /** - * @description The budget in CPU steps to run a script - * @example 476468 - */ - unit_steps: string; - /** - * @description The fee consumed to run the script - * @example 172033 - */ - fee: string; - })[]; + tx_content_metadata_cbor: { + /** @description Metadata label */ + label: string; + /** + * @deprecated + * @description Content of the CBOR metadata + */ + cbor_metadata: string | null; + /** @description Content of the CBOR metadata in hex */ + metadata: string | null; + }[]; + tx_content_redeemers: { + /** + * @description Index of the redeemer within the transaction + * @example 0 + */ + tx_index: number; + /** + * @description Validation purpose + * @example spend + * @enum {string} + */ + purpose: "spend" | "mint" | "cert" | "reward"; + /** + * @description Script hash + * @example ec26b89af41bef0f7585353831cb5da42b5b37185e0c8a526143b824 + */ + script_hash: string; + /** + * @description Redeemer data hash + * @example 923918e403bf43c34b4ef6b48eb2ee04babed17320d8d1b9ff9ad086e86f44ec + */ + redeemer_data_hash: string; + /** + * @deprecated + * @description Datum hash + * @example 923918e403bf43c34b4ef6b48eb2ee04babed17320d8d1b9ff9ad086e86f44ec + */ + datum_hash: string; + /** + * @description The budget in Memory to run a script + * @example 1700 + */ + unit_mem: string; + /** + * @description The budget in CPU steps to run a script + * @example 476468 + */ + unit_steps: string; + /** + * @description The fee consumed to run the script + * @example 172033 + */ + fee: string; + }[]; tx_content_required_signers: { - /** - * @description Hash of the witness - * @example d52e11f3e48436dd42dbec6d88c239732e503b8b7a32af58e5f87625 - */ - witness_hash: string; - }[]; + /** + * @description Hash of the witness + * @example d52e11f3e48436dd42dbec6d88c239732e503b8b7a32af58e5f87625 + */ + witness_hash: string; + }[]; /** * @example { * "cbor": "84a40081825820203e5b61e0949ffc8fe594727cf7ed73c7396cc2bd212af9a680c9423b5880eb00018282583900f0c60254ecb0addd4c7e40c28fd05b65014ab4c8ecece06c7dcee5a0724bf93336a8225e7ef152b41aea955173be91af19250edea1ddafab1a000f42408258390014beadb876d0a2a593fe2f1b539389e00731290910170e9a1be78e847d2ccdc7af469706878018739bcfde9ae23f009c4ae38aee0a4b4f3a1b0000000253fa0f93021a0002922d031a0303c827a100818258207d3ae39f9a1c916ac7c13f10c7d67c70b870c286a1af71485455c5022a3f391d5840e2f481acd1601a3f39fa976317bba685ddd774621a92611edaaa3df9f48a3b13d8b25ecb2f28b031c1602512418efed3033e463a0dcd22a856c808033cc9e00ff5f6" @@ -4760,10 +5529,15 @@ export interface components { */ withdrawable_amount: string; /** - * @description Bech32 pool ID that owns the account + * @description Bech32 pool ID to which this account is delegated * @example pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy */ pool_id: string | null; + /** + * @description Bech32 drep ID to which this account is delegated + * @example drep15cfxz9exyn5rx0807zvxfrvslrjqfchrd4d47kv9e0f46uedqtc + */ + drep_id: string | null; }; /** * @example [ @@ -4805,19 +5579,19 @@ export interface components { * } * ] */ - account_reward_content: ({ - /** @description Epoch of the associated reward */ - epoch: number; - /** @description Rewards for given epoch in Lovelaces */ - amount: string; - /** @description Bech32 pool ID being delegated to */ - pool_id: string; - /** - * @description Type of the reward - * @enum {string} - */ - type: "leader" | "member" | "pool_deposit_refund"; - })[]; + account_reward_content: { + /** @description Epoch of the associated reward */ + epoch: number; + /** @description Rewards for given epoch in Lovelaces */ + amount: string; + /** @description Bech32 pool ID being delegated to */ + pool_id: string; + /** + * @description Type of the reward + * @enum {string} + */ + type: "leader" | "member" | "pool_deposit_refund"; + }[]; /** * @example [ * { @@ -4833,16 +5607,16 @@ export interface components { * ] */ account_history_content: { - /** - * @description Epoch in which the stake was active - * @example 210 - */ - active_epoch: number; - /** @description Stake amount in Lovelaces */ - amount: string; - /** @description Bech32 ID of pool being delegated to */ - pool_id: string; - }[]; + /** + * @description Epoch in which the stake was active + * @example 210 + */ + active_epoch: number; + /** @description Stake amount in Lovelaces */ + amount: string; + /** @description Bech32 ID of pool being delegated to */ + pool_id: string; + }[]; /** * @example [ * { @@ -4860,18 +5634,18 @@ export interface components { * ] */ account_delegation_content: { - /** - * @description Epoch in which the delegation becomes active - * @example 210 - */ - active_epoch: number; - /** @description Hash of the transaction containing the delegation */ - tx_hash: string; - /** @description Rewards for given epoch in Lovelaces */ - amount: string; - /** @description Bech32 ID of pool being delegated to */ - pool_id: string; - }[]; + /** + * @description Epoch in which the delegation becomes active + * @example 210 + */ + active_epoch: number; + /** @description Hash of the transaction containing the delegation */ + tx_hash: string; + /** @description Rewards for given epoch in Lovelaces */ + amount: string; + /** @description Bech32 ID of pool being delegated to */ + pool_id: string; + }[]; /** * @example [ * { @@ -4884,15 +5658,15 @@ export interface components { * } * ] */ - account_registration_content: ({ - /** @description Hash of the transaction containing the (de)registration certificate */ - tx_hash: string; - /** - * @description Action in the certificate - * @enum {string} - */ - action: "registered" | "deregistered"; - })[]; + account_registration_content: { + /** @description Hash of the transaction containing the (de)registration certificate */ + tx_hash: string; + /** + * @description Action in the certificate + * @enum {string} + */ + action: "registered" | "deregistered"; + }[]; /** * @example [ * { @@ -4906,11 +5680,11 @@ export interface components { * ] */ account_withdrawal_content: { - /** @description Hash of the transaction containing the withdrawal */ - tx_hash: string; - /** @description Withdrawal amount in Lovelaces */ - amount: string; - }[]; + /** @description Hash of the transaction containing the withdrawal */ + tx_hash: string; + /** @description Withdrawal amount in Lovelaces */ + amount: string; + }[]; /** * @example [ * { @@ -4924,11 +5698,11 @@ export interface components { * ] */ account_mir_content: { - /** @description Hash of the transaction containing the MIR */ - tx_hash: string; - /** @description MIR amount in Lovelaces */ - amount: string; - }[]; + /** @description Hash of the transaction containing the MIR */ + tx_hash: string; + /** @description MIR amount in Lovelaces */ + amount: string; + }[]; /** * @example [ * { @@ -4946,9 +5720,9 @@ export interface components { * ] */ account_addresses_content: { - /** @description Address associated with the stake key */ - address: string; - }[]; + /** @description Address associated with the stake key */ + address: string; + }[]; /** * @example [ * { @@ -4962,14 +5736,14 @@ export interface components { * ] */ account_addresses_assets: { - /** - * Format: Concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; account_addresses_total: { /** * @description Bech32 encoded stake address @@ -4989,14 +5763,14 @@ export interface components { * ] */ received_sum: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** * @example [ * { @@ -5010,14 +5784,14 @@ export interface components { * ] */ sent_sum: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** * @description Count of all transactions for all addresses associated with the account * @example 12 @@ -5032,9 +5806,9 @@ export interface components { * ] */ mempool_content: { - /** @description Hash of the transaction */ - tx_hash: string; - }[]; + /** @description Hash of the transaction */ + tx_hash: string; + }[]; mempool_tx_content: { tx: { /** @@ -5055,14 +5829,14 @@ export interface components { * ] */ output_amount: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** * @description Fees of the transaction in Lovelaces * @example 182485 @@ -5107,141 +5881,141 @@ export interface components { * @description Count of the delegations within the transaction * @example 0 */ - delegation_count: number; + delegation_count: number; + /** + * @description Count of the stake keys (de)registration within the transaction + * @example 0 + */ + stake_cert_count: number; + /** + * @description Count of the stake pool registration and update certificates within the transaction + * @example 0 + */ + pool_update_count: number; + /** + * @description Count of the stake pool retirement certificates within the transaction + * @example 0 + */ + pool_retire_count: number; + /** + * @description Count of asset mints and burns within the transaction + * @example 0 + */ + asset_mint_or_burn_count: number; + /** + * @description Count of redeemers within the transaction + * @example 0 + */ + redeemer_count: number; + /** + * @description True if contract script passed validation + * @example true + */ + valid_contract: boolean; + }; + inputs: { + /** + * @description Input address + * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv + */ + address?: string; + /** + * @description Hash of the UTXO transaction + * @example 1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157f0 + */ + tx_hash: string; + /** + * @description UTXO index in the transaction + * @example 0 + */ + output_index: number; + /** + * @description Whether the input is a collateral consumed on script validation failure + * @example false + */ + collateral: boolean; + /** + * @description Whether the input is a reference transaction input + * @example false + */ + reference?: boolean; + }[]; + outputs: { + /** + * @description Output address + * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv + */ + address: string; + /** + * @example [ + * { + * "unit": "lovelace", + * "quantity": "42000000" + * }, + * { + * "unit": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e", + * "quantity": "12" + * } + * ] + */ + amount: { + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; + /** + * @description UTXO index in the transaction + * @example 0 + */ + output_index: number; + /** + * @description The hash of the transaction output datum + * @example 9e478573ab81ea7a8e31891ce0648b81229f408d596a3483e6f4f9b92d3cf710 + */ + data_hash: string | null; + /** + * @description CBOR encoded inline datum + * @example 19a6aa + */ + inline_datum: string | null; /** - * @description Count of the stake keys (de)registration within the transaction - * @example 0 + * @description Whether the output is a collateral output + * @example false */ - stake_cert_count: number; + collateral: boolean; /** - * @description Count of the stake pool registration and update certificates within the transaction - * @example 0 + * @description The hash of the reference script of the output + * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 */ - pool_update_count: number; + reference_script_hash: string | null; + }[]; + redeemers?: { /** - * @description Count of the stake pool retirement certificates within the transaction + * @description Index of the redeemer within the transaction * @example 0 */ - pool_retire_count: number; + tx_index: number; /** - * @description Count of asset mints and burns within the transaction - * @example 0 + * @description Validation purpose + * @example spend + * @enum {string} */ - asset_mint_or_burn_count: number; + purpose: "spend" | "mint" | "cert" | "reward"; /** - * @description Count of redeemers within the transaction - * @example 0 + * @description The budget in Memory to run a script + * @example 1700 */ - redeemer_count: number; + unit_mem: string; /** - * @description True if contract script passed validation - * @example true + * @description The budget in CPU steps to run a script + * @example 476468 */ - valid_contract: boolean; - }; - inputs: { - /** - * @description Input address - * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv - */ - address?: string; - /** - * @description Hash of the UTXO transaction - * @example 1a0570af966fb355a7160e4f82d5a80b8681b7955f5d44bec0dce628516157f0 - */ - tx_hash: string; - /** - * @description UTXO index in the transaction - * @example 0 - */ - output_index: number; - /** - * @description Whether the input is a collateral consumed on script validation failure - * @example false - */ - collateral: boolean; - /** - * @description Whether the input is a reference transaction input - * @example false - */ - reference?: boolean; - }[]; - outputs: ({ - /** - * @description Output address - * @example addr1q9ld26v2lv8wvrxxmvg90pn8n8n5k6tdst06q2s856rwmvnueldzuuqmnsye359fqrk8hwvenjnqultn7djtrlft7jnq7dy7wv - */ - address: string; - /** - * @example [ - * { - * "unit": "lovelace", - * "quantity": "42000000" - * }, - * { - * "unit": "b0d07d45fe9514f80213f4020e5a61241458be626841cde717cb38a76e7574636f696e", - * "quantity": "12" - * } - * ] - */ - amount: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; - /** - * @description UTXO index in the transaction - * @example 0 - */ - output_index: number; - /** - * @description The hash of the transaction output datum - * @example 9e478573ab81ea7a8e31891ce0648b81229f408d596a3483e6f4f9b92d3cf710 - */ - data_hash: string | null; - /** - * @description CBOR encoded inline datum - * @example 19a6aa - */ - inline_datum: string | null; - /** - * @description Whether the output is a collateral output - * @example false - */ - collateral: boolean; - /** - * @description The hash of the reference script of the output - * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 - */ - reference_script_hash: string | null; - })[]; - redeemers?: ({ - /** - * @description Index of the redeemer within the transaction - * @example 0 - */ - tx_index: number; - /** - * @description Validation purpose - * @example spend - * @enum {string} - */ - purpose: "spend" | "mint" | "cert" | "reward"; - /** - * @description The budget in Memory to run a script - * @example 1700 - */ - unit_mem: string; - /** - * @description The budget in CPU steps to run a script - * @example 476468 - */ - unit_steps: string; - })[]; + unit_steps: string; + }[]; }; /** * @example [ @@ -5251,9 +6025,9 @@ export interface components { * ] */ mempool_addresses_content: { - /** @description Hash of the transaction */ - tx_hash: string; - }[]; + /** @description Hash of the transaction */ + tx_hash: string; + }[]; /** * @example [ * { @@ -5273,14 +6047,14 @@ export interface components { * } * ] */ - tx_metadata_labels: ({ - /** @description Metadata label */ - label: string; - /** @description CIP10 defined description */ - cip10: string | null; - /** @description The count of metadata entries with a specific label */ - count: string; - })[]; + tx_metadata_labels: { + /** @description Metadata label */ + label: string; + /** @description CIP10 defined description */ + cip10: string | null; + /** @description The count of metadata entries with a specific label */ + count: string; + }[]; /** * @example [ * { @@ -5311,14 +6085,20 @@ export interface components { * } * ] */ - tx_metadata_label_json: ({ - /** @description Transaction hash that contains the specific metadata */ - tx_hash: string; - /** @description Content of the JSON metadata */ - json_metadata: string | { - [key: string]: unknown; - } | unknown[] | number | boolean | null; - })[]; + tx_metadata_label_json: { + /** @description Transaction hash that contains the specific metadata */ + tx_hash: string; + /** @description Content of the JSON metadata */ + json_metadata: + | string + | { + [key: string]: unknown; + } + | unknown[] + | number + | boolean + | null; + }[]; /** * @example [ * { @@ -5338,17 +6118,17 @@ export interface components { * } * ] */ - tx_metadata_label_cbor: ({ - /** @description Transaction hash that contains the specific metadata */ - tx_hash: string; - /** - * @deprecated - * @description Content of the CBOR metadata - */ - cbor_metadata: string | null; - /** @description Content of the CBOR metadata in hex */ - metadata: string | null; - })[]; + tx_metadata_label_cbor: { + /** @description Transaction hash that contains the specific metadata */ + tx_hash: string; + /** + * @deprecated + * @description Content of the CBOR metadata + */ + cbor_metadata: string | null; + /** @description Content of the CBOR metadata in hex */ + metadata: string | null; + }[]; address_content: { /** * @description Bech32 encoded addresses @@ -5368,14 +6148,14 @@ export interface components { * ] */ amount: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** * @description Stake address that controls the key * @example stake1ux3g2c9dx2nhhehyrezyxpkstartcqmu9hk63qgfkccw5rqttygt7 @@ -5415,19 +6195,19 @@ export interface components { * } * ] */ - amount: ({ - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - /** @description Number of decimal places of the asset unit. Primary data source is CIP68 reference NFT with a fallback to off-chain metadata. */ - decimals: number | null; - /** @description True if the latest minting transaction includes metadata (best-effort) */ - has_nft_onchain_metadata: boolean; - })[]; + amount: { + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + /** @description Number of decimal places of the asset unit. Primary data source is CIP68 reference NFT with a fallback to off-chain metadata. */ + decimals: number | null; + /** @description True if the latest minting transaction includes metadata (best-effort) */ + has_nft_onchain_metadata: boolean; + }[]; /** * @description Stake address that controls the key * @example stake1ux3g2c9dx2nhhehyrezyxpkstartcqmu9hk63qgfkccw5rqttygt7 @@ -5464,14 +6244,14 @@ export interface components { * ] */ received_sum: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** * @example [ * { @@ -5485,14 +6265,14 @@ export interface components { * ] */ sent_sum: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; + /** + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value + */ + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; /** * @description Count of all transactions on the address * @example 12 @@ -5552,45 +6332,45 @@ export interface components { * } * ] */ - address_utxo_content: ({ - /** - * @description Bech32 encoded addresses - useful when querying by payment_cred - * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz - */ - address: string; - /** @description Transaction hash of the UTXO */ - tx_hash: string; - /** - * @deprecated - * @description UTXO index in the transaction - */ - tx_index: number; - /** @description UTXO index in the transaction */ - output_index: number; - amount: { - /** - * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name - * @description The unit of the value - */ - unit: string; - /** @description The quantity of the unit */ - quantity: string; - }[]; - /** @description Block hash of the UTXO */ - block: string; - /** @description The hash of the transaction output datum */ - data_hash: string | null; - /** - * @description CBOR encoded inline datum - * @example 19a6aa - */ - inline_datum: string | null; + address_utxo_content: { + /** + * @description Bech32 encoded addresses - useful when querying by payment_cred + * @example addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz + */ + address: string; + /** @description Transaction hash of the UTXO */ + tx_hash: string; + /** + * @deprecated + * @description UTXO index in the transaction + */ + tx_index: number; + /** @description UTXO index in the transaction */ + output_index: number; + amount: { /** - * @description The hash of the reference script of the output - * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 + * Format: Lovelace or concatenation of asset policy_id and hex-encoded asset_name + * @description The unit of the value */ - reference_script_hash: string | null; - })[]; + unit: string; + /** @description The quantity of the unit */ + quantity: string; + }[]; + /** @description Block hash of the UTXO */ + block: string; + /** @description The hash of the transaction output datum */ + data_hash: string | null; + /** + * @description CBOR encoded inline datum + * @example 19a6aa + */ + inline_datum: string | null; + /** + * @description The hash of the reference script of the output + * @example 13a3efd825703a352a8f71f4e2758d08c28c564e8dfcce9f77776ad1 + */ + reference_script_hash: string | null; + }[]; /** * @example [ * "2dd15e0ef6e6a17841cb9541c27724072ce4d4b79b91e58432fbaa32d9572531", @@ -5621,15 +6401,15 @@ export interface components { * ] */ address_transactions_content: { - /** @description Hash of the transaction */ - tx_hash: string; - /** @description Transaction index within the block */ - tx_index: number; - /** @description Block height */ - block_height: number; - /** @description Block creation time in UNIX time */ - block_time: number; - }[]; + /** @description Hash of the transaction */ + tx_hash: string; + /** @description Transaction index within the block */ + tx_index: number; + /** @description Block height */ + block_height: number; + /** @description Block creation time in UNIX time */ + block_time: number; + }[]; /** * @example [ * "pool1pu5jlj4q9w9jlxeu370a3c9myx47md5j5m2str0naunn2q3lkdy", @@ -5661,27 +6441,27 @@ export interface components { * ] */ pool_list_extended: { - /** - * @description Bech32 encoded pool ID - * @example pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt - */ - pool_id: string; - /** - * @description Hexadecimal pool ID. - * @example 0f292fcaa02b8b2f9b3c8f9fd8e0bb21abedb692a6d5058df3ef2735 - */ - hex: string; - /** - * @description Active delegated amount - * @example 4200000000 - */ - active_stake: string; - /** - * @description Currently delegated amount - * @example 6900000000 - */ - live_stake: string; - }[]; + /** + * @description Bech32 encoded pool ID + * @example pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt + */ + pool_id: string; + /** + * @description Hexadecimal pool ID. + * @example 0f292fcaa02b8b2f9b3c8f9fd8e0bb21abedb692a6d5058df3ef2735 + */ + hex: string; + /** + * @description Active delegated amount + * @example 4200000000 + */ + active_stake: string; + /** + * @description Currently delegated amount + * @example 6900000000 + */ + live_stake: string; + }[]; /** * @example [ * { @@ -5699,17 +6479,17 @@ export interface components { * ] */ pool_list_retire: { - /** - * @description Bech32 encoded pool ID - * @example pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt - */ - pool_id: string; - /** - * @description Retirement epoch number - * @example 242 - */ - epoch: number; - }[]; + /** + * @description Bech32 encoded pool ID + * @example pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt + */ + pool_id: string; + /** + * @description Retirement epoch number + * @example 242 + */ + epoch: number; + }[]; pool: { /** * @description Bech32 pool ID @@ -5778,54 +6558,54 @@ export interface components { * "stake1u98nnlkvkk23vtvf9273uq7cph5ww6u2yq2389psuqet90sv4xv9v" * ] */ - owners: string[]; + owners: string[]; + /** + * @example [ + * "9f83e5484f543e05b52e99988272a31da373f3aab4c064c76db96643a355d9dc", + * "7ce3b8c433bf401a190d58c8c483d8e3564dfd29ae8633c8b1b3e6c814403e95", + * "3e6e1200ce92977c3fe5996bd4d7d7e192bcb7e231bc762f9f240c76766535b9" + * ] + */ + registration: string[]; + retirement: string[]; + }; + pool_history: { + /** + * @description Epoch number + * @example 233 + */ + epoch: number; + /** + * @description Number of blocks created by pool + * @example 22 + */ + blocks: number; + /** + * @description Active (Snapshot of live stake 2 epochs ago) stake in Lovelaces + * @example 20485965693569 + */ + active_stake: string; + /** + * @description Pool size (percentage) of overall active stake at that epoch + * @example 1.2345 + */ + active_size: number; + /** + * @description Number of delegators for epoch + * @example 115 + */ + delegators_count: number; /** - * @example [ - * "9f83e5484f543e05b52e99988272a31da373f3aab4c064c76db96643a355d9dc", - * "7ce3b8c433bf401a190d58c8c483d8e3564dfd29ae8633c8b1b3e6c814403e95", - * "3e6e1200ce92977c3fe5996bd4d7d7e192bcb7e231bc762f9f240c76766535b9" - * ] + * @description Total rewards received before distribution to delegators + * @example 206936253674159 */ - registration: string[]; - retirement: string[]; - }; - pool_history: { - /** - * @description Epoch number - * @example 233 - */ - epoch: number; - /** - * @description Number of blocks created by pool - * @example 22 - */ - blocks: number; - /** - * @description Active (Snapshot of live stake 2 epochs ago) stake in Lovelaces - * @example 20485965693569 - */ - active_stake: string; - /** - * @description Pool size (percentage) of overall active stake at that epoch - * @example 1.2345 - */ - active_size: number; - /** - * @description Number of delegators for epoch - * @example 115 - */ - delegators_count: number; - /** - * @description Total rewards received before distribution to delegators - * @example 206936253674159 - */ - rewards: string; - /** - * @description Pool operator rewards - * @example 1290968354 - */ - fees: string; - }[]; + rewards: string; + /** + * @description Pool operator rewards + * @example 1290968354 + */ + fees: string; + }[]; pool_metadata: { /** * @description Bech32 pool ID @@ -5869,33 +6649,33 @@ export interface components { homepage: string | null; }; empty_object: Record