From 60ae3930a0c8a6617a6db1c035854bf34a98884c Mon Sep 17 00:00:00 2001 From: Ola Date: Wed, 31 Jul 2024 19:33:41 +0200 Subject: [PATCH] Add param_proposal data to proposal_list endpoint --- files/grest/rpc/governance/proposal_list.sql | 32 +- specs/results/koiosapi-guild.yaml | 10848 +++++++++-------- specs/results/koiosapi-mainnet.yaml | 10848 +++++++++-------- specs/results/koiosapi-preprod.yaml | 10848 +++++++++-------- specs/results/koiosapi-preview.yaml | 10848 +++++++++-------- specs/templates/4-api-schemas.yaml | 8 +- 6 files changed, 21735 insertions(+), 21697 deletions(-) diff --git a/files/grest/rpc/governance/proposal_list.sql b/files/grest/rpc/governance/proposal_list.sql index 250957c0..5fa25fd6 100644 --- a/files/grest/rpc/governance/proposal_list.sql +++ b/files/grest/rpc/governance/proposal_list.sql @@ -19,7 +19,8 @@ RETURNS TABLE ( meta_comment text, meta_language text, meta_is_valid boolean, - withdrawal jsonb + withdrawal jsonb, + param_proposal jsonb ) LANGUAGE sql STABLE AS $$ @@ -43,22 +44,29 @@ AS $$ ocvd.comment AS meta_comment, ocvd.language AS meta_language, ocvd.is_valid AS meta_is_valid, - CASE WHEN tw.id IS NULL THEN NULL - ELSE - JSONB_BUILD_OBJECT( - 'stake_address', ( - SELECT sa2.view - FROM stake_address AS sa2 - WHERE sa2.id = tw.stake_address_id - ), - 'amount', tw.amount::text - ) - END AS withdrawal + CASE + WHEN tw.id IS NULL THEN NULL + ELSE + JSONB_BUILD_OBJECT( + 'stake_address', ( + SELECT sa2.view + FROM stake_address AS sa2 + WHERE sa2.id = tw.stake_address_id + ), + 'amount', tw.amount::text + ) + END AS withdrawal, + CASE + WHEN pp.id IS NULL THEN NULL + ELSE ( SELECT ROW_TO_JSON(pp.*) ) + END AS param_proposal FROM public.gov_action_proposal AS gap INNER JOIN public.tx ON gap.tx_id = tx.id INNER JOIN public.block AS b ON tx.block_id = b.id INNER JOIN public.stake_address AS sa ON gap.return_address = sa.id LEFT JOIN public.treasury_withdrawal AS tw ON gap.id = tw.gov_action_proposal_id + LEFT JOIN public.param_proposal AS pp ON gap.param_proposal = pp.id + LEFT JOIN public.cost_model AS cm ON cm.id = pp.cost_model_id LEFT JOIN public.voting_anchor AS va ON gap.voting_anchor_id = va.id LEFT JOIN public.off_chain_vote_data AS ocvd ON va.id = ocvd.voting_anchor_id ORDER BY diff --git a/specs/results/koiosapi-guild.yaml b/specs/results/koiosapi-guild.yaml index 1ca5e674..4c77c159 100644 --- a/specs/results/koiosapi-guild.yaml +++ b/specs/results/koiosapi-guild.yaml @@ -1,5421 +1,5427 @@ -openapi: 3.1.0 -info: - title: Koios API - contact: - name: Koios Core Team - url: https://t.me/CardanoKoios - email: general@koios.rest - license: - name: Creative Commons Attribution 4.0 International - url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE - version: v1.2.0a - description: | - Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. - - # API Usage - - The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. - - ## Vertical Filtering - - Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

- - ``` bash - curl "https://api.koios.rest/api/v1/tip" - - # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] - - curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" - - # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] - ``` - - ## Horizontal Filtering - - You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

- ``` bash - curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" - - # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, - # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] - ``` - - Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): - - |Abbreviation|In PostgreSQL|Meaning | - |------------|-------------|-------------------------------------------| - |eq |`=` |equals | - |gt |`>` |greater than | - |gte |`>=` |greater than or equal | - |lt |`<` |less than | - |lte |`<=` |less than or equal | - |neq |`<>` or `!=` |not equal | - |like |`LIKE` |LIKE operator (use * in place of %) | - |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| - |is |`IS` |checking for exact equality (null,true,false,unknown)| - |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | - |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | - |not |`NOT` |negates another operator | - |or |`OR` |logical `OR` operator | - |and |`AND` |logical `AND` operator | - - ## Pagination (offset/limit) - - When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. - - The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. - - Sounds confusing? Let's see this in practice, to hopefully make it easier. - Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range - - # content-range: 0-999/* - - ``` - - As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range - - # content-range: 1000-1499/* - - ``` - - The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. - However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. - - ## Ordering - - You can set a sorting order for returned queries against specific column(s). - Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" - - # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] - ``` - - ## Response Formats - - You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. - Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" - - # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, - # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, - # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] - - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" - - # epoch_no,epoch_slot,block_time - # 318,28491,1643607582 - # 318,28479,1643607570 - # 318,28406,1643607497 - - ``` - - ## Limits - - While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: - - - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. - - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). - - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). - - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. - - Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. - - # Authentication - - While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). - The examples across this API site already [supports authentication](/#auth), for you to use in the queries. - - # Community projects - - A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) - - x-logo: - url: "https://api.koios.rest/images/koios.png" -servers: - - url: https://api.koios.rest/api/v1 - description: Mainnet - - url: https://guild.koios.rest/api/v1 - description: Guildnet - - url: https://preview.koios.rest/api/v1 - description: Preview Network - - url: https://preprod.koios.rest/api/v1 - description: Preprod Network -paths: - - /tip: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tip" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Query Chain Tip - description: Get the tip info about the latest block seen by chain - operationId: tip - /genesis: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/genesis" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get Genesis info - description: Get the Genesis parameters used to start specific era on chain - operationId: genesis - /totals: #RPC - get: - tags: - - Network - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/totals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get historical tokenomic stats - description: >- - Get the circulating utxo, treasury, rewards, supply and reserves in - lovelace for specified epoch, all epochs if empty - operationId: totals - /param_updates: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/param_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Param Update Proposals - description: Get all parameter update proposals submitted to the chain starting Shelley era - operationId: param_updates - /cli_protocol_params: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/cli_protocol_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: CLI Protocol Parameters - description: >- - Get Current Protocol Parameters as published by cardano-cli. Note that - the output schema of this command is unfortunately fluid on cardano-node - and may vary between CLI versions/era. Accordingly, the returned output for - this endpoint is left as raw JSON (single row) and any filtering to output should - be done on client-side - operationId: cli_protocol_params - /reserve_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Reserve Withdrawals - description: List of all withdrawals from reserves against stake accounts - operationId: reserve_withdrawals - /treasury_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Treasury Withdrawals - description: List of all withdrawals from treasury against stake accounts - operationId: treasury_withdrawals - - /epoch_info: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - - $ref: "#/components/parameters/_include_next_epoch" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch Information - description: Get the epoch information, all epochs if no epoch specified - operationId: epoch_info - /epoch_params: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Protocol Parameters - description: >- - Get the protocol parameters for specific epoch, returns information - about all epochs if no epoch specified - operationId: epoch_params - /epoch_block_protocols: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_block_protocols" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Block Protocols - description: >- - Get the information about block protocol distribution in epoch - operationId: epoch_block_protocols - - /blocks: #RPC - get: - tags: - - Block - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block List - description: Get summarised details about all blocks (paginated - latest first) - operationId: blocks - /block_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/block_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Information - description: Get detailed information about a specific block - operationId: block_info - /block_txs: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions - description: Get a list of all transactions included in provided blocks - operationId: block_txs - /block_tx_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions (Detailed Info) - description: Get detailed information about transaction(s) for requested blocks - operationId: block_tx_info - - /utxo_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/utxo_refs_with_extended" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxO Info - description: Get UTxO set for requested UTxO references - operationId: utxo_info - /tx_cbor: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_cbor" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Raw Transaction (CBOR) - description: Get raw transaction(s) in CBOR format - operationId: tx_cbor - /tx_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Information - description: Get detailed information about transaction(s) - operationId: tx_info - /tx_metadata: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata - description: Get metadata information (if any) for given transaction(s) - operationId: tx_metadata - /tx_metalabels: #RPC - get: - tags: - - Transactions - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metalabels" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata Labels - description: Get a list of all transaction metalabels - operationId: tx_metalabels - /submittx: #submit-api - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/txbin" - x-code-samples: - - lang: "Shell" - source: | - # Assuming ${data} is a raw binary serialized transaction on the file-system. - # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. - curl -X POST \ - --header "Content-Type: application/cbor" \ - --data-binary @${data} https://api.koios.rest/api/v1/submittx - responses: - "202": - description: OK - content: - application/json: - schema: - description: The transaction id. - type: string - format: hex - minLength: 64 - maxLength: 64 - example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f - "400": - description: An error occured while submitting transaction. - summary: Submit Transaction - description: Submit an already serialized transaction to the network. - operationId: submittx - /tx_status: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_status" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Status - description: Get the number of block confirmations for a given transaction hash list - operationId: tx_status - /tx_utxos: #RPC - post: - tags: - - Transactions - deprecated: true - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_utxos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction UTxOs - description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. - operationId: tx_utxos - - /address_info: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Information - description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses - operationId: address_info - /address_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address UTXOs - description: Get UTxO set for given addresses - operationId: address_utxos - /credential_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_utxos" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs from payment credentials - description: Get UTxO details for requested payment credentials - operationId: credential_utxos - /address_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/address_txs" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Transactions - description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) - operationId: address_txs - /credential_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_txs" - responses: - "200": - description: Array of transaction hashes for given credential(s) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transactions from payment credentials - description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) - operationId: credential_txs - /address_assets: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Assets - description: Get the list of all the assets (policy, name and quantity) for given addresses - operationId: address_assets - - /account_list: #RPC - get: - tags: - - Stake Account - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account List - description: Get a list of all stake addresses that have atleast 1 transaction - operationId: account_list - /account_info: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information - description: Get the account information for given stake addresses - operationId: account_info - /account_info_cached: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information (Cached) - description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) - operationId: account_info_cached - /account_utxos: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs for stake addresses (accounts) - description: Get a list of all UTxOs for given stake addresses (account)s - operationId: account_utxos - /account_txs: #RPC - get: - tags: - - Stake Account - parameters: - - $ref: "#/components/parameters/_stake_address" - - $ref: "#/components/parameters/_after_block_height" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Txs - description: Get a list of all Txs for a given stake address (account) - operationId: account_txs - /account_rewards: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_rewards" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Rewards - description: >- - Get the full rewards history (including MIR) for given stake addresses - operationId: account_rewards - /account_updates: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Updates - description: >- - Get the account updates (registration, deregistration, delegation and - withdrawals) for given stake addresses - operationId: account_updates - /account_addresses: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Addresses - description: Get all addresses associated with given staking accounts - operationId: account_addresses - /account_assets: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Assets - description: Get the native asset balance for a given stake address - operationId: account_assets - /account_history: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account History - description: Get the staking history of given stake addresses (accounts) - operationId: account_history - - /asset_list: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset List - description: Get the list of all native assets (paginated) - operationId: asset_list - /policy_asset_list: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of brief information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset List - description: Get the list of asset under the given policy (including balances) - operationId: policy_asset_list - /asset_token_registry: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_token_registry" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Token Registry - description: Get a list of assets registered via token registry on github - operationId: asset_token_registry - /asset_info: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list" - responses: - "200": - description: Array of detailed asset information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Information (Bulk) - description: Get the information of a list of assets including first minting & token registry metadata - operationId: asset_info - /asset_utxos: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset UTXOs - description: Get the UTXO information of a list of assets including - operationId: asset_utxos - /asset_history: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset mint/burn history - content: - application/json: - schema: - $ref: "#/components/schemas/asset_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset History - description: Get the mint/burn history of an asset - operationId: asset_history - /asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Addresses - description: Get the list of all addresses holding a given asset

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: asset_addresses - /asset_nft_address: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy_nft" - - $ref: "#/components/parameters/_asset_name_nft" - responses: - "200": - description: Payment addresses currently holding the given NFT - content: - application/json: - schema: - $ref: "#/components/schemas/asset_nft_address" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: NFT Address - description: Get the address where specified NFT currently reside on. - operationId: asset_nft_address - /policy_asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of asset names and payment addresses for the given policy (including balances) - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Address List - description: Get the list of addresses with quantity for each asset on the given policy

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: policy_asset_addresses - /policy_asset_info: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of detailed information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Information - description: Get the information for all assets under the same policy - operationId: policy_asset_info - /policy_asset_mints: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Get a list of mint or burn count details for all assets minted under a policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_mints" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Mints - description: Get a list of mint or burn count details for all assets minted under a policy - operationId: policy_asset_mints - /asset_summary: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset summary information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_summary" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Summary - description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) - operationId: asset_summary - /asset_txs: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - - $ref: "#/components/parameters/_after_block_height" - - $ref: "#/components/parameters/_history" - responses: - "200": - description: An array of Tx hashes that included the given asset (latest first) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Transactions - description: Get the list of current or all asset transaction hashes (newest first) - operationId: asset_txs - - /drep_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps List - description: List of all active delegated representatives (DReps) - operationId: drep_list - /drep_info: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Info - description: Get detailed information about requested delegated representatives (DReps) - operationId: drep_info - /drep_metadata: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Metadata - description: List metadata for requested delegated representatives (DReps) - operationId: drep_metadata - /drep_updates: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Updates - description: List of updates for requested (or all) delegated representatives (DReps) - operationId: drep_updates - /drep_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Votes - description: List of all votes casted by requested delegated representative (DRep) - operationId: drep_votes - /committee_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_committee_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Committee Votes - description: List of all votes casted by given committee member or collective - operationId: committee_votes - /proposal_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/proposal_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposals List - description: List of all governance proposals - operationId: proposal_list - /proposal_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_tx_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposal Votes - description: List of all votes cast on specified governance action - operationId: proposal_votes - - /pool_list: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool List - description: List of brief info for all pools - operationId: pool_list - /pool_info: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Information - description: Current pool statuses and details for a specified list of pool ids - operationId: pool_info - /pool_stake_snapshot: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_snapshot" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake Snapshot - description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation - operationId: pool_stake_snapshot - /pool_delegators: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators List - description: Return information about live delegators for a given pool. - operationId: pool_delegators - /pool_delegators_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators History - description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). - operationId: pool_delegators_history - /pool_blocks: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Blocks - description: >- - Return information about blocks minted by a given pool for all epochs - (or _epoch_no if provided) - operationId: pool_blocks - /pool_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_history_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake, Block and Reward History - description: >- - Return information about pool stake, block and reward history in a given epoch _epoch_no - (or all epochs that pool existed for, in descending order if no _epoch_no was provided) - operationId: pool_history - /pool_updates: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Updates (History) - description: Return all pool updates for all pools or only updates for specific pool if specified - operationId: pool_updates - /pool_registrations: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Registrations - description: Return all pool registrations initiated in the requested epoch - operationId: pool_registrations - /pool_retirements: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Retirements - description: Return all pool retirements initiated in the requested epoch - operationId: pool_retirements - /pool_relays: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_relays" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Relays - description: A list of registered relays for all pools - operationId: pool_relays - /pool_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Votes - description: List of all votes casted by a pool - operationId: pool_votes - /pool_metadata: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Metadata - description: Metadata (on & off-chain) for all pools - operationId: pool_metadata - - /script_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/script_hashes" - responses: - "200": - description: Array of information for scripts requested - content: - application/json: - schema: - $ref: "#/components/schemas/script_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Information - description: List of script information for given script hashes - operationId: script_info - /native_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of native script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Native Script List - description: List of all existing native script hashes along with their creation transaction hashes - operationId: native_script_list - /plutus_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of Plutus script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Plutus Script List - description: List of all existing Plutus script hashes along with their creation transaction hashes - operationId: plutus_script_list - /script_redeemers: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - responses: - "200": - description: Array of all redeemers for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/script_redeemers" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Redeemers - description: List of all redeemers for a given script hash - operationId: script_redeemers - /script_utxos: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - - $ref: "#/components/parameters/_extended" - responses: - "200": - description: List of UTXOs for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script UTXOs - description: List of all UTXOs for a given script hash - operationId: script_utxos - /datum_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/datum_hashes" - responses: - "200": - description: Array of datum information for given datum hashes - content: - application/json: - schema: - $ref: "#/components/schemas/datum_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Datum Information - description: List of datum information for given datum hashes - operationId: datum_info - - /ogmios: #ogmios-api - post: - tags: - - Ogmios - requestBody: - $ref: "#/components/requestBodies/ogmios" - responses: - "200": - description: Current tip of the chain, identified by a slot and a block header hash. - content: - application/json: - schema: - $ref: "#/components/schemas/ogmiostip" - "400": - $ref: "#/components/responses/BadRequest" - summary: Query Example - description: | - Query the current tip of the Network. - -
-
- We do support transparent forwarding for various methods from Ogmios, you can read about those here. -
- operationId: ogmios - -components: - parameters: - _after_block_height: - deprecated: false - name: _after_block_height - description: Block height for specifying time delta - schema: - type: number - example: 50000 - in: query - required: false - allowEmptyValue: true - _epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "6219" - in: query - required: false - allowEmptyValue: true - _stake_address: - deprecated: false - name: _stake_address - description: Cardano staking address (reward account) in bech32 format - schema: - type: string - example: "stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2" - in: query - required: true - allowEmptyValue: false - _tx_hash: - deprecated: false - name: _tx_hash - description: Transaction Hash in hexadecimal format (hex) - example: "bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7" - schema: - type: string - in: query - required: true - allowEmptyValue: false - _asset_policy: - deprecated: false - name: _asset_policy - description: Asset Policy ID in hexadecimal format (hex) - schema: - type: string - example: "313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e" - in: query - required: true - allowEmptyValue: false - _asset_name: - deprecated: false - name: _asset_name - description: Asset Name in hexadecimal format (hex), empty asset name returns royalties - schema: - type: string - example: "41484c636f696e" - in: query - required: false - allowEmptyValue: true - _asset_policy_nft: - deprecated: false - name: _asset_policy - description: NFT Policy ID in hexadecimal format (hex) - schema: - type: string - example: "187abba169e246fdcbebcd12915a8610cb470fda3b3fc21da0c4aed4" - in: query - required: true - allowEmptyValue: false - _asset_name_nft: - deprecated: false - name: _asset_name - description: NFT Name in hexadecimal format (hex) - schema: - type: string - example: "4f504b4559" - in: query - required: false - allowEmptyValue: true - _drep_id: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r" - in: query - required: true - allowEmptyValue: false - _drep_id_optional: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r" - in: query - required: false - allowEmptyValue: true - _committee_hash: - deprecated: false - name: _committee_hash - description: Committee hash in hexadecimal format (hex) - schema: - type: string - example: "65d497b875c56ab213586a4006d4f6658970573ea8e2398893857472" - in: query - required: false - allowEmptyValue: true - _extended: - deprecated: false - name: _extended - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _history: - deprecated: false - name: _history - description: Include all historical transactions, setting to false includes only the non-empty ones - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: false - _include_next_epoch: - deprecated: false - name: _include_next_epoch - description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _pool_bech32: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format - schema: - type: string - example: "pool1xc9eywck4e20tydz4yvh5vfe0ep8whawvwz8wqkc9k046a2ypp4" - in: query - required: true - allowEmptyValue: false - _pool_bech32_optional: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format (optional) - schema: - type: string - example: "pool1xc9eywck4e20tydz4yvh5vfe0ep8whawvwz8wqkc9k046a2ypp4" - in: query - required: false - allowEmptyValue: true - _pool_epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "18852" - in: query - required: false - allowEmptyValue: true - _script_hash: - deprecated: false - name: _script_hash - description: Script hash in hexadecimal format (hex) - schema: - type: string - example: "f6c13b1bd68219ffb6a1e6d77bd23ec5982f3da2d93007aa5956a142" - in: query - required: true - allowEmptyValue: false - requestBodies: - block_hashes: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - example: - _block_hashes: - - af2f6f7dd4e4ea6765103a1e38e023da3edd2b3c7fea2aa367222564dbe01cfd - - bddbbc6df0ad09567a513349bafd56d8ec5c8fcd9ee9db12173624b896350d57 - - 732bf9bbc3780e6cd7ad57a3889dd5904f6e8a27d54eabf43eb0dbc485323f04 - description: Array of block hashes - block_tx_info: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _block_hashes: - - af2f6f7dd4e4ea6765103a1e38e023da3edd2b3c7fea2aa367222564dbe01cfd - - bddbbc6df0ad09567a513349bafd56d8ec5c8fcd9ee9db12173624b896350d57 - - 732bf9bbc3780e6cd7ad57a3889dd5904f6e8a27d54eabf43eb0dbc485323f04 - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of block hashes - payment_addresses: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - example: - _addresses: - - addr_test1qzmtfv43a8ncx6ve92ja6yy25npn9raz9pu5a2tfxsqv9gy9ktf0pu6yu4zjh9r37fzx3h4tsxqdjhu3t4d5ffdsfz9s6ska3z - - addr_test1vq67g5u8ls4vm4wdvs0r8xvsuej66nvaqedyrj2tcz6tuycz275pu - description: Array of Cardano payment address(es) - payment_addresses_with_extended: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _addresses: - - addr_test1qzmtfv43a8ncx6ve92ja6yy25npn9raz9pu5a2tfxsqv9gy9ktf0pu6yu4zjh9r37fzx3h4tsxqdjhu3t4d5ffdsfz9s6ska3z - - addr_test1vq67g5u8ls4vm4wdvs0r8xvsuej66nvaqedyrj2tcz6tuycz275pu - _extended: true - description: Array of Cardano payment address(es) with extended flag to toggle additional fields - address_txs: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _addresses: - - addr_test1qzmtfv43a8ncx6ve92ja6yy25npn9raz9pu5a2tfxsqv9gy9ktf0pu6yu4zjh9r37fzx3h4tsxqdjhu3t4d5ffdsfz9s6ska3z - - addr_test1vq67g5u8ls4vm4wdvs0r8xvsuej66nvaqedyrj2tcz6tuycz275pu - _after_block_height: 120000 - description: Array of Cardano payment address(es) - stake_addresses_with_epoch_no: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _epoch_no: - format: integer - type: number - description: Only fetch information for a specific epoch - example: - _stake_addresses: - - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 - - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd - _epoch_no: 1500 - description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by - stake_addresses_with_first_only_and_empty: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _first_only: - format: boolean - type: boolean - description: Only return the first result - _empty: - format: boolean - type: boolean - description: Include zero quantity entries - example: - _stake_addresses: - - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 - - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd - _first_only: false - _empty: false - description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs - stake_addresses_with_extended: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _stake_addresses: - - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 - - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd - _extended: true - description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns - stake_addresses: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - example: - _stake_addresses: - - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 - - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd - description: Array of Cardano stake credential(s) in bech32 format - credential_txs: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _payment_credentials: - - b6b4b2b1e9e78369992aa5dd108aa4c3328fa228794ea9693400c2a0 - - 35e45387fc2acdd5cd641e339990e665ad4d9d065a41c94bc0b4be13 - _after_block_height: 120000 - description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight - credential_utxos: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _payment_credentials: - - b6b4b2b1e9e78369992aa5dd108aa4c3328fa228794ea9693400c2a0 - - 35e45387fc2acdd5cd641e339990e665ad4d9d065a41c94bc0b4be13 - _extended: true - description: Array of Cardano payment credential(s) in hex format - tx_ids: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - example: - _tx_hashes: - - bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7 - - 63b716064012f858450731cb5f960c100c6cb639ec1ec999b898c604451f116a - description: Array of Cardano Transaction hashes - tx_info: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _tx_hashes: - - bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7 - - 63b716064012f858450731cb5f960c100c6cb639ec1ec999b898c604451f116a - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of Cardano Transaction hashes - txbin: - content: - application/cbor: - schema: - type: string - format: binary - example: bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7 - description: Serialised Cardano Transaction - pool_ids: - content: - application/json: - schema: - required: - - _pool_bech32_ids - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool19st4a2vvu78tjtyywjte2eml3kx6ynersgd2nyw0y4jvyhlfu0u - - pool1uul8pytp2p0xq4ckjn3l294km0m7fuef46teehvh3x5tk46sfx3 - - pool1us9ww725p0vygae5zaydme3apt7wg9se2yemhl8mgwkes3tlrqp - description: Array of Cardano pool IDs (bech32 format) - pool_ids_optional: - content: - application/json: - schema: - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool19st4a2vvu78tjtyywjte2eml3kx6ynersgd2nyw0y4jvyhlfu0u - - pool1uul8pytp2p0xq4ckjn3l294km0m7fuef46teehvh3x5tk46sfx3 - - pool1us9ww725p0vygae5zaydme3apt7wg9se2yemhl8mgwkes3tlrqp - description: Array of Cardano pool IDs (bech32 format) [Optional] - script_hashes: - content: - application/json: - schema: - type: object - properties: - _script_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano script hashes - example: - _script_hashes: - - a08a267e92456ba48e157dd7e77bdd35aba0fc50fe625a10a6a7fc5e - - 1f3a4aa08cfa0e47fff200578f0d4847b6890b7093a765773feb35de - description: Array of Cardano script hashes - datum_hashes: - content: - application/json: - schema: - type: object - properties: - _datum_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano datum hashes - example: - _datum_hashes: - - 964af1ff2a66ce472d34ac39b47f356b6d971d62c794a89ec12825d5de30f3aa - - 17bdb9c96b77c7718d546be50193a80bc9d72081b7375e5e16891db196af14fc - description: Array of Cardano datum hashes - asset_list: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - example: - _asset_list: - - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] - - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] - description: Array of array of policyID and asset names (hex) - asset_list_with_extended: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _asset_list: - - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] - - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] - _extended: true - description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns - drep_id_bulk: - content: - application/json: - schema: - required: - - _drep_ids - type: object - properties: - _drep_ids: - format: text - type: array - descriptions: Array of DRep IDs in bech32 format - items: - type: string - example: - _drep_ids: - - drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r - - drep13p45vxysc2s6vp6ez2ng7lynlsheh64zxexpcennn68cuc05yps - utxo_refs_with_extended: - content: - application/json: - schema: - required: - - _utxo_refs - type: object - properties: - _utxo_refs: - format: text - type: array - items: - type: string - description: Array of Cardano utxo references in the form "hash#index" - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _utxo_refs: - - f82e568d42604fd71424d193c86ec00c97aead2b8f018e81c3139d9e3770c735#0 - - 88ae22495123c7ee37a0bbe865243757185a302ed5359d1eae9347030628290a#0 - _extended: false - description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields - ogmios: - content: - application/json: - schema: - required: - - jsonrpc - - method - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab - enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] - example: "queryNetwork/tip" - params: - type: object - description: Any parameters relevant to the specific method to be called - nullable: true - examples: - blockHeight: - description: Query the network’s highest block number. - value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } - genesisConfiguration: - description: Query the genesis configuration of a given era. - value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } - startTimeTime: - description: Query the network start time. - value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } - tip: - description: Query tip of the Network - value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } - epoch: - description: Query the current epoch of the ledger. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } - eraStart: - description: Query information regarding the beginning of the current ledger era. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } - eraSummaries: - description: Query era bounds and slot parameters details, required for proper sloting arithmetic. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } - liveStakeDistribution: - description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } - protocolParameters: - description: Query the current protocol parameters. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } - proposedProtocolParameters: - description: Query the last update proposal w.r.t. protocol parameters, if any. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } - StakePools: - description: Query the list of all stake pool identifiers currently registered and active. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } - submitTransaction: - description: Submit a signed and serialized transaction to the network. - value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } - evaluateTransaction: - description: Evaluate execution units of scripts in a well-formed transaction. - value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } - description: JSON-RPC 2.0 standard request body - securitySchemes: - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT - description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. - schemas: - tip: - description: Current tip of the chain - type: array - items: - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_no: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - genesis: - description: Array of genesis parameters used to start each era on chain - type: array - items: - properties: - networkmagic: - type: string - example: 764824073 - description: Unique network identifier for chain - networkid: - type: string - example: Mainnet - description: Network ID used at various CLI identification to distinguish between Mainnet and other networks - epochlength: - type: string - example: 432000 - description: Number of slots in an epoch - slotlength: - type: string - example: 1 - description: Duration of a single slot (in seconds) - maxlovelacesupply: - type: string - example: 45000000000000000 - description: Maximum smallest units (lovelaces) supply for the blockchain - systemstart: - type: number - description: UNIX timestamp of the first block (genesis) on chain - example: 1506203091 - activeslotcoeff: - type: string - example: 0.05 - description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" - slotsperkesperiod: - type: string - example: 129600 - description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) - maxkesrevolutions: - type: string - example: 62 - description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised - securityparam: - type: string - example: 2160 - description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) - updatequorum: - type: string - example: 5 - description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal - alonzogenesis: - type: string - example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' - description: A JSON dump of Alonzo Genesis - totals: - description: Array of supply/reserves/utxo/fees/treasury stats - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - circulation: - type: string - description: Circulating UTxOs for given epoch (in lovelaces) - example: 32081169442642320 - treasury: - type: string - description: Funds in treasury for given epoch (in lovelaces) - example: 637024173474141 - reward: - type: string - description: Rewards accumulated as of given epoch (in lovelaces) - example: 506871250479840 - supply: - type: string - description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) - example: 33228495612391330 - reserves: - type: string - description: Total Reserves yet to be unlocked on chain - example: 11771504387608670 - param_updates: - description: Array of unique param update proposals submitted on chain - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - data: - type: string - description: JSON encoded data with details about the parameter update - example: {"decentralisation": 0.9} - cli_protocol_params: - description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format - type: object - example: - { - "collateralPercentage": 150, - "maxBlockBodySize": 90112, - "maxBlockHeaderSize": 1100, - "maxCollateralInputs": 3, - "maxTxSize": 16384, - "maxValueSize": 5000, - "minPoolCost": 170000000, - "minUTxOValue": null, - "monetaryExpansion": 3.0e-3, - "poolPledgeInfluence": 0.3, - "poolRetireMaxEpoch": 18, - "protocolVersion": { - "major": 8, - "minor": 0 - }, - "...": "...", - "stakeAddressDeposit": 2000000, - "stakePoolDeposit": 500000000, - "stakePoolTargetNum": 500, - "treasuryCut": 0.2, - "txFeeFixed": 155381, - "txFeePerByte": 44, - "utxoCostPerByte": 4310 - } - reserve_withdrawals: - description: Array of withdrawals from reserves/treasury against stake accounts - type: array - items: - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - earned_epoch: - description: Epoch where amount is earned - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - spendable_epoch: - description: Epoch where the earned amount can be spent - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - pool_list: - description: Array of pool IDs and tickers - type: array - items: - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - ticker: - type: - - string - - 'null' - description: Pool ticker - example: AHL - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_history_info: - description: Array of pool history information - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch for which the pool history data is shown - example: 312 - active_stake: - type: string - description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) - example: "31235800000" - active_stake_pct: - type: number - description: Active stake for the pool, expressed as a percentage of total active stake on network - example: 13.512182543475783 - saturation_pct: - type: number - description: Saturation percentage of a pool at the time of snapshot (2 decimals) - example: 45.32 - block_cnt: - type: - - number - - 'null' - description: Number of blocks pool created in that epoch - example: 14 - delegator_cnt: - type: number - description: Number of delegators to the pool for that epoch snapshot - example: 1432 - margin: - type: number - description: Margin (decimal format) - example: 0.125 - fixed_cost: - type: string - description: Pool fixed cost per epoch (in lovelaces) - example: "340000000" - pool_fees: - type: string - description: Total amount of fees earned by pool owners in that epoch (in lovelaces) - example: "123327382" - deleg_rewards: - type: string - description: Total amount of rewards earned by delegators in that epoch (in lovelaces) - example: "123456789123" - member_rewards: - type: string - description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) - example: "123456780123" - epoch_ros: - type: number - description: Annualized ROS (return on staking) for delegators for this epoch - example: 3.000340466 - pool_info: - description: Array of pool information - type: array - items: - type: object - properties: - pool_id_bech32: - type: string - description: Pool ID (bech32 format) - example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc - pool_id_hex: - type: string - description: Pool ID (Hex format) - example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - vrf_key_hash: - type: - - string - - 'null' - description: Pool VRF key hash - example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 - margin: - type: - - number - - 'null' - description: Margin (decimal format) - example: 0.1 - fixed_cost: - type: - - string - - 'null' - description: Pool fixed cost per epoch - example: "500000000" - pledge: - type: - - string - - 'null' - description: Pool pledge in lovelace - example: "64000000000000" - deposit: - type: - - string - - 'null' - description: Pool's registration deposit in lovelace - example: "500000000" - reward_addr: - type: - - string - - 'null' - description: Pool reward address - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - owners: - type: - - array - - 'null' - items: - type: string - description: Pool (co)owner address - example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 - relays: - type: array - items: - type: object - properties: - dns: - type: - - string - - 'null' - description: DNS name of the relay (nullable) - example: relays-new.cardano-mainnet.iohk.io - srv: - type: - - string - - 'null' - description: DNS service name of the relay (nullable) - example: biostakingpool3.hopto.org - ipv4: - type: - - string - - 'null' - description: IPv4 address of the relay (nullable) - example: "54.220.20.40" - ipv6: - type: - - string - - 'null' - description: IPv6 address of the relay (nullable) - example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf - port: - type: - - number - - 'null' - description: Port number of the relay (nullable) - example: 6000 - meta_url: - type: - - string - - 'null' - description: Pool metadata URL - example: https://pools.iohk.io/IOGP.json - meta_hash: - type: - - string - - 'null' - description: Pool metadata hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - meta_json: - type: - - object - - 'null' - properties: - name: - type: string - description: Pool name - example: Input Output Global (IOHK) - Private - ticker: - type: string - description: Pool ticker - example: IOGP - homepage: - type: string - description: Pool homepage URL - example: https://iohk.io - description: - type: string - description: Pool description - example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. - pool_status: - type: string - description: Pool status - enum: ["registered", "retiring", "retired"] - example: registered - retiring_epoch: - type: - - number - - 'null' - description: Announced retiring epoch (nullable) - example: 'null' - op_cert: - type: - - string - - 'null' - description: Pool latest operational certificate hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - op_cert_counter: - type: - - number - - 'null' - description: Pool latest operational certificate counter value - example: 8 - active_stake: - type: - - string - - 'null' - description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) - example: "64328627680963" - sigma: - type: - - number - - 'null' - description: Pool relative active stake share - example: 0.0034839235 - block_count: - type: - - number - - 'null' - description: Total pool blocks on chain - example: 4509 - live_pledge: - type: - - string - - 'null' - description: Summary of account balance for all pool owner's - example: "64328594406327" - live_stake: - type: - - string - - 'null' - description: Pool live stake - example: "64328627680963" - live_delegators: - type: number - description: Pool live delegator count - example: 5 - live_saturation: - type: - - number - - 'null' - description: Pool live saturation (decimal format) - example: 94.52 - pool_snapshot: - type: array - items: - description: Array of pool stake information for 3 snapshots - type: object - properties: - snapshot: - type: string - description: Type of snapshot ("Mark", "Set" or "Go") - example: "Mark" - epoch_no: - type: number - description: Epoch number for the snapshot entry - example: 324 - nonce: - $ref: "#/components/schemas/epoch_params/items/properties/nonce" - pool_stake: - type: string - description: Pool's Active Stake for the given epoch - example: "100000000000" - active_stake: - type: string - description: Total Active Stake for the given epoch - example: "103703246364020" - pool_delegators: - description: Array of live pool delegators - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - description: Current delegator live stake (in lovelace) - example: 64328591517480 - active_epoch_no: - type: number - description: Epoch number in which the delegation becomes active - example: 324 - latest_delegation_tx_hash: - type: string - description: Latest transaction hash used for delegation by the account - example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 - pool_registrations: - description: Array of pool registrations/retirements - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - pool_delegators_history: - description: Array of pool delegators (historical) - type: - - array - - 'null' - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - epoch_no: - type: number - description: Epoch number for the delegation history - example: 324 - pool_blocks: - description: Array of blocks created by pool - type: array - items: - type: object - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_updates: - description: Array of historical pool updates - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - type: - - number - - 'null' - description: Epoch number in which the update becomes active - example: 324 - vrf_key_hash: - $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - update_type: - type: string - description: Type of update task - enum: ["registration", "deregistration"] - example: registered - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_relays: - description: Array of pool relay information - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - pool_metadata: - description: Array of pool metadata - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - epoch_info: - description: Array of detailed summary for each epoch - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - out_sum: - type: string - description: Total output value across all transactions in epoch - example: 15432725054364942 - fees: - type: string - description: Total fees incurred by transactions in epoch - example: 74325855210 - tx_count: - type: number - description: Number of transactions submitted in epoch - example: 357919 - blk_count: - type: number - description: Number of blocks created in epoch - example: 17321 - start_time: - type: number - description: UNIX timestamp of the epoch start - example: 1506203091 - end_time: - type: number - description: UNIX timestamp of the epoch end - example: 1506635091 - first_block_time: - type: number - description: UNIX timestamp of the epoch's first block - example: 1506635091 - last_block_time: - type: number - description: UNIX timestamp of the epoch's last block - example: 1506635091 - active_stake: - type: - - string - - 'null' - description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) - example: 23395112387185880 - total_rewards: - type: - - string - - 'null' - description: Total rewards earned in epoch (null for pre-Shelley epochs) - example: 252902897534230 - avg_blk_reward: - type: - - string - - 'null' - description: Average block reward for epoch (null for pre-Shelley epochs) - example: 660233450 - epoch_params: - description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - min_fee_a: - type: - - number - - 'null' - description: The 'a' parameter to calculate the minimum transaction fee - example: 44 - min_fee_b: - type: - - number - - 'null' - description: The 'b' parameter to calculate the minimum transaction fee - example: 155381 - max_block_size: - type: - - number - - 'null' - description: The maximum block size (in bytes) - example: 65536 - max_tx_size: - type: - - number - - 'null' - description: The maximum transaction size (in bytes) - example: 16384 - max_bh_size: - type: - - number - - 'null' - description: The maximum block header size (in bytes) - example: 1100 - key_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake address - example: 2000000 - pool_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake pool - example: 500000000 - max_epoch: - type: - - number - - 'null' - description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for - example: 18 - optimal_pool_count: - type: - - number - - 'null' - description: The optimal number of stake pools - example: 500 - influence: - type: - - number - - 'null' - format: double - description: The pledge influence on pool rewards - example: 0.3 - monetary_expand_rate: - type: - - number - - 'null' - format: double - description: The monetary expansion rate - example: 0.003 - treasury_growth_rate: - type: - - number - - 'null' - format: double - description: The treasury growth rate - example: 0.2 - decentralisation: - type: - - number - - 'null' - format: double - description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) - example: 0.1 - extra_entropy: - type: - - string - - 'null' - description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool - example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa - protocol_major: - type: - - number - - 'null' - description: The protocol major version - example: 5 - protocol_minor: - type: - - number - - 'null' - description: The protocol minor version - example: 0 - min_utxo_value: - type: - - string - - 'null' - description: The minimum value of a UTxO entry - example: 34482 - min_pool_cost: - type: - - string - - 'null' - description: The minimum pool cost - example: 340000000 - nonce: - type: - - string - - 'null' - description: The nonce value for this epoch - example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 - block_hash: - type: string - description: The hash of the first block where these parameters are valid - example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 - cost_models: - type: - - object - - 'null' - description: The per language cost model in JSON - example: 'null' - price_mem: - type: - - number - - 'null' - format: double - description: The per word cost of script memory usage - example: 0.0577 - price_step: - type: - - number - - 'null' - format: double - description: The cost of script execution step usage - example: 7.21e-05 - max_tx_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single transaction - example: 10000000 - max_tx_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single transaction - example: 10000000000 - max_block_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single block - example: 50000000 - max_block_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single block - example: 40000000000 - max_val_size: - type: - - number - - 'null' - description: The maximum Val size - example: 5000 - collateral_percent: - type: - - number - - 'null' - description: The percentage of the tx fee which must be provided as collateral when including non-native scripts - example: 150 - max_collateral_inputs: - type: - - number - - 'null' - description: The maximum number of collateral inputs allowed in a transaction - example: 3 - coins_per_utxo_size: - type: - - string - - 'null' - description: The cost per UTxO size - example: 34482 - pvt_motion_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for motion of no-confidence. - example: 0.6 - pvt_committee_normal: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (normal state). - example: 0.65 - pvt_committee_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (state of no-confidence). - example: 0.65 - pvt_hard_fork_initiation: - type: - - number - - 'null' - description: Pool Voting threshold for hard-fork initiation. - example: 0.51 - dvt_motion_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for motion of no-confidence. - example: 0.67 - dvt_committee_normal: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (normal state). - example: 0.67 - dvt_committee_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (state of no-confidence). - example: 0.65 - dvt_update_to_constitution: - type: - - number - - 'null' - description: DRep Vote threshold for update to the Constitution. - example: 0.75 - dvt_hard_fork_initiation: - type: - - number - - 'null' - description: DRep Vote threshold for hard-fork initiation. - example: 0.6 - dvt_p_p_network_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, network group. - example: 0.67 - dvt_p_p_economic_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, economic group. - example: 0.67 - dvt_p_p_technical_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, technical group. - example: 0.67 - dvt_p_p_gov_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, governance group. - example: 0.75 - dvt_treasury_withdrawal: - type: - - number - - 'null' - description: DRep Vote threshold for treasury withdrawal. - example: 0.67 - committee_min_size: - type: - - number - - 'null' - description: Minimal constitutional committee size. - example: 5 - committee_max_term_length: - type: - - number - - 'null' - description: Constitutional committee term limits. - example: 146 - gov_action_lifetime: - type: - - number - - 'null' - description: Governance action expiration. - example: 14 - gov_action_deposit: - type: - - string - - 'null' - description: Governance action deposit. - example: 100000000000 - drep_deposit: - type: - - string - - 'null' - description: DRep deposit amount. - example: 500000000 - drep_activity: - type: - - number - - 'null' - description: DRep activity period. - example: 20 - pvtpp_security_group: - type: - - number - - 'null' - description: Pool Voting threshold for protocol parameter changes, security group. - example: 0.6 - min_fee_ref_script_cost_per_byte: - type: - - number - - 'null' - description: Minimum Fee for Reference Script cost pre byte - example: 15 - epoch_block_protocols: - description: Array of distinct block protocol versions counts in epoch - type: array - items: - properties: - proto_major: - type: number - description: Protocol major version - example: 6 - proto_minor: - type: number - description: Protocol major version - example: 2 - blocks: - type: number - description: Amount of blocks with specified major and protocol combination - example: 2183 - blocks: - description: Array of block information - type: array - items: - type: object - properties: - hash: - type: string - description: Hash of the block - example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f - epoch_no: - type: number - description: Epoch number of the block - example: 117 - abs_slot: - type: number - description: Absolute slot number of the block - example: 49073930 - epoch_slot: - type: number - description: Slot number of the block in epoch - example: 171530 - block_height: - type: - - number - - 'null' - description: Block height - example: 1794506 - block_size: - type: number - description: Block size in bytes - example: 2433 - block_time: - type: number - description: UNIX timestamp of the block - example: 1704757130 - tx_count: - type: number - description: Number of transactions in the block - example: 2 - vrf_key: - type: string - description: VRF key of the block producer - example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" - pool: - type: - - string - - 'null' - description: Pool ID in bech32 format (null for pre-Shelley blocks) - example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v - op_cert_counter: - type: number - description: Counter value of the operational certificate used to create this block - example: 5 - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - parent_hash: - type: string - description: Previous Hash of the current block - example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 - block_info: - description: Array of detailed block information - type: array - items: - type: object - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_size: - $ref: "#/components/schemas/blocks/items/properties/block_size" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - tx_count: - $ref: "#/components/schemas/blocks/items/properties/tx_count" - vrf_key: - $ref: "#/components/schemas/blocks/items/properties/vrf_key" - op_cert: - type: string - description: Hash of the block producers' operational certificate - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - op_cert_counter: - $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" - pool: - $ref: "#/components/schemas/blocks/items/properties/pool" - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - total_output: - type: - - string - - 'null' - description: Total output of the block (in lovelace) - example: 92384672389 - total_fees: - type: - - string - - 'null' - description: Total fees of the block (in lovelace) - example: 2346834 - num_confirmations: - type: number - description: Number of confirmations for the block - example: 664275 - parent_hash: - type: string - description: Hash of the parent of this block - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - child_hash: - type: string - description: Hash of the child of this block (if present) - example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" - block_txs: - description: Array of transactions hashes - type: array - items: - type: object - properties: - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - block_tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" - tx_block_index: - $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" - tx_size: - $ref: "#/components/schemas/tx_info/items/properties/tx_size" - total_output: - $ref: "#/components/schemas/tx_info/items/properties/total_output" - fee: - $ref: "#/components/schemas/tx_info/items/properties/fee" - treasury_donation: - $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" - deposit: - $ref: "#/components/schemas/tx_info/items/properties/deposit" - invalid_before: - $ref: "#/components/schemas/tx_info/items/properties/invalid_before" - invalid_after: - $ref: "#/components/schemas/tx_info/items/properties/invalid_after" - collateral_inputs: - $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" - collateral_output: - $ref: "#/components/schemas/tx_info/items/properties/collateral_output" - reference_inputs: - $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" - inputs: - description: An array of UTxO inputs spent in the transaction - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - outputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - withdrawals: - $ref: "#/components/schemas/tx_info/items/properties/withdrawals" - assets_minted: - $ref: "#/components/schemas/tx_info/items/properties/assets_minted" - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - $ref: "#/components/schemas/tx_info/items/properties/certificates" - native_scripts: - $ref: "#/components/schemas/tx_info/items/properties/native_scripts" - plutus_contracts: - $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" - address_info: - description: Array of information for address(es) - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - balance: - type: string - description: Sum of all UTxO values beloning to address - example: 10723473983 - stake_address: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/account_history/items/properties/stake_address" - script_address: - type: boolean - description: Signifies whether the address is a script address - example: true - utxo_set: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - address_txs: - description: Array of transaction hashes - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - address_assets: - description: Array of address-owned assets - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - - account_list: - description: Array of account (stake address) IDs - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - stake_address_hex: - type: string - description: Cardano staking address (reward account) in hex format - example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf - script_hash: - type: string - description: Script hash in case the stake address is locked by a script - example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 - account_info: - description: Array of stake account information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - status: - type: string - description: Stake address status - enum: ["registered", "not registered"] - example: registered - delegated_drep: - anyOf: - - type: 'null' - - type: string - description: Account's current delegation status to DRep ID in Bech32 format - example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 - delegated_pool: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - total_balance: - type: string - description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) - example: 207116800428 - utxo: - type: string - description: Total UTxO balance of the account - example: 162764177131 - rewards: - type: string - description: Total rewards earned by the account - example: 56457728047 - withdrawals: - type: string - description: Total rewards withdrawn by the account - example: 12105104750 - rewards_available: - type: string - description: Total rewards available for withdrawal - example: 44352623297 - deposit: - type: string - description: Total deposit available for withdrawal - example: 2000000 - reserves: - type: string - description: Total reserves MIR value of the account - example: "0" - treasury: - type: string - description: Total treasury MIR value of the account - example: "0" - utxo_infos: - description: Array of complete UTxO information - type: array - items: - type: object - properties: - tx_hash: - type: string - description: Hash identifier of the transaction - example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e - tx_index: - type: number - description: Index of UTxO in the transaction - example: 0 - address: - type: string - description: A Cardano payment/base address (bech32 encoded) - example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - payment_cred: - type: - - string - - 'null' - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: - - array - - 'null' - description: An array of assets on the UTxO - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of assets on the UTxO - example: 1 - is_spent: - type: boolean - description: True if the UTXO has been spent - example: true - account_rewards: - description: Array of reward history information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - rewards: - type: array - items: - type: object - properties: - earned_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" - spendable_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" - amount: - type: string - description: Amount of rewards earned (in lovelace) - type: - type: string - description: The source of the rewards - enum: [member, leader, treasury, reserves] - example: member - pool_id: - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - account_updates: - description: Array of account updates information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - updates: - type: array - items: - type: object - properties: - action_type: - type: string - description: Type of certificate submitted - enum: ["registration", "delegation", "withdrawal", "deregistration"] - example: "registration" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - account_addresses: - description: Array of payment addresses - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - addresses: - type: array - items: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - account_assets: - description: Array of assets owned by account - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - account_history: - description: Array of active stake values per epoch - type: array - items: - properties: - stake_address: - type: string - description: Cardano staking address (reward account) in bech32 format - example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz - history: - type: array - items: - type: object - properties: - pool_id: - type: string - description: Bech32 representation of pool ID - example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt - epoch_no: - type: number - description: Epoch number - example: 301 - active_stake: - type: string - description: Active stake amount (in lovelaces) - example: 682334162 - tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - type: number - description: UNIX timestamp of the transaction - example: 1506635091 - tx_block_index: - type: number - description: Index of transaction within block - example: 6 - tx_size: - type: number - description: Size in bytes of transaction - example: 391 - total_output: - type: string - description: Total sum of all transaction outputs (in lovelaces) - example: 157832856 - fee: - type: string - description: Total Transaction fee (in lovelaces) - example: 172761 - treasury_donation: - type: string - description: Total Donation to on-chain treasury (in lovelaces) - example: 0 - deposit: - type: string - description: Total Deposits included in transaction (for example, if it is registering a pool/key) - example: 0 - invalid_before: - type: - - string - - 'null' - description: Slot before which transaction cannot be validated (if supplied, else null) - invalid_after: - type: - - string - - 'null' - description: Slot after which transaction cannot be validated - example: 42332172 - collateral_inputs: - description: An array of collateral inputs needed for smart contracts in case of contract failure - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - collateral_output: - description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) - type: array - items: - properties: - payment_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" - stake_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: array - description: Brief asset description from ledger - reference_inputs: - description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - inputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - #description: An array of UTxO inputs spent in the transaction - outputs: - type: array - description: An array of UTxO outputs created by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - datum_hash: - type: - - string - - 'null' - description: Hash of datum (if any) connected to UTxO - example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 - inline_datum: - type: - - object - - 'null' - description: Allows datums to be attached to UTxO (CIP-32) - properties: - bytes: - type: string - description: Datum bytes (hex) - example: 19029a - value: - type: object - description: Value (json) - example: { "int": 666 } - reference_script: - type: - - object - - 'null' - description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) - properties: - hash: - type: string - description: Hash of referenced script - example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 - size: - type: number - description: Size in bytes - example: 14 - type: - type: string - description: Type of script - example: plutusV1 - bytes: - type: string - description: Script bytes (hex) - example: 4e4d01000033222220051200120011 - value: - type: - - object - - 'null' - description: Value (json) - example: 'null' - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - withdrawals: - type: - - array - - 'null' - description: Array of withdrawals with-in a transaction - items: - type: object - properties: - amount: - type: string - description: Withdrawal amount (in lovelaces) - example: 9845162 - stake_addr: - type: string - description: A Cardano staking address (reward account, bech32 encoded) - example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj - assets_minted: - type: - - array - - 'null' - description: Array of minted assets with-in a transaction - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of minted assets (negative on burn) - example: 1 - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - type: - - array - - 'null' - description: Certificates present with-in a transaction (if any) - items: - properties: - index: - type: - - number - - 'null' - description: Certificate index - example: 0 - type: - type: string - description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) - example: delegation - info: - type: - - object - - 'null' - description: A JSON array containing information from the certificate - example: - { - "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", - "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", - } - native_scripts: - type: - - array - - 'null' - description: Native scripts present in a transaction (if any) - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - script_json: - type: object - description: JSON representation of the timelock script (null for other script types) - example: - { - "type": "all", - "scripts": - [ - { - "type": "sig", - "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", - }, - { - "type": "sig", - "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", - }, - { - "type": "sig", - "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", - }, - ], - } - plutus_contracts: - type: - - array - - 'null' - description: Plutus contracts present in transaction (if any) - items: - properties: - address: - type: - - string - - 'null' - description: Plutus script address - example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 - spends_input: - type: - - object - - 'null' - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - description: Input utxo this contract spends - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - bytecode: - $ref: "#/components/schemas/script_info/items/properties/bytes" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - valid_contract: - type: boolean - description: True if the contract is valid or there is no contract - example: true - input: - type: object - properties: - redeemer: - type: object - properties: - purpose: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" - fee: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" - unit: - type: object - properties: - steps: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" - mem: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - tx_cbor: - description: Raw Transaction(s) in CBOR format - item: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - cbor: - type: string - description: CBOR encoded raw transaction. - tx_utxos: - description: Array of inputs and outputs for given transaction(s) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - inputs: - type: array - description: An array of UTxO inputs used by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - type: string - description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned - example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - outputs: - description: An array of UTxO outputs created by the transaction - allOf: - - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" - tx_metadata: - description: Array of metadata information present in each of the transactions queried - type: - - array - - 'null' - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - metadata: - type: - - object - - 'null' - description: A JSON array containing details about metadata within transaction - example: - { - "721": - { - "version": 1, - "copyright": "...", - "publisher": ["p...o"], - "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": - {}, - }, - } - tx_status: - description: Array of transaction confirmation counts - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - num_confirmations: - type: - - number - - 'null' - description: Number of block confirmations - example: 17 - tx_metalabels: - description: Array of known metadata labels - type: array - items: - properties: - key: - type: string - description: A distinct known metalabel - example: "721" - asset_list: - description: Array of policy IDs and asset names - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - asset_token_registry: - description: An array of token registry information (registered via github) for each asset - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - ticker: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" - description: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" - url: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - logo: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" - asset_addresses: - description: An array of payment addresses holding the given token (including balances) - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - type: string - description: Asset balance on the payment address - example: 23 - asset_nft_address: - description: An array of payment addresses holding the given token - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - asset_summary: - description: Array of asset summary information - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_transactions: - type: number - description: Total number of transactions including the given asset - example: 89416 - staked_wallets: - type: number - description: Total number of registered wallets holding the given asset - example: 548 - unstaked_addresses: - type: number - description: Total number of payment addresses (not belonging to registered wallets) holding the given asset - example: 245 - addresses: - type: number - description: Total number of unique addresses holding the given asset - example: 812 - asset_info: - description: Array of detailed asset information - type: array - items: - properties: - policy_id: - type: string - description: Asset Policy ID (hex) - example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff - asset_name: - type: - - string - - 'null' - description: Asset Name (hex) - example: 444f4e545350414d - asset_name_ascii: - type: string - description: Asset Name (ASCII) - example: DONTSPAM - fingerprint: - type: string - description: The CIP14 fingerprint of the asset - example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 - minting_tx_hash: - type: string - description: Hash of the latest mint transaction (with metadata if found for asset) - example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 - total_supply: - type: string - description: Total supply for the asset - example: "35000" - mint_cnt: - type: number - description: Count of total mint transactions - example: 1 - burn_cnt: - type: number - description: Count of total burn transactions - example: 5 - creation_time: - type: number - description: UNIX timestamp of the first asset mint - example: 1506635091 - minting_tx_metadata: - allOf: - - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - description: Latest minting transaction metadata (aligns with CIP-25) - token_registry_metadata: - type: - - object - - 'null' - description: Asset metadata registered on the Cardano Token Registry - properties: - name: - type: string - example: Rackmob - description: - type: string - example: Metaverse Blockchain Cryptocurrency. - ticker: - type: string - example: MOB - url: - type: string - example: https://www.rackmob.com/ - logo: - type: string - description: A PNG image file as a byte string - example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc - decimals: - type: number - example: 0 - cip68_metadata: - type: - - object - - 'null' - description: CIP 68 metadata if present for asset - example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} - asset_history: - description: Array of asset mint/burn history - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_txs: - type: - - array - - 'null' - description: Array of all mint/burn transactions for an asset - items: - type: object - properties: - tx_hash: - type: string - description: Hash of minting/burning transaction - example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - quantity: - type: string - description: Quantity minted/burned (negative numbers indicate burn transactions) - example: "-10" - metadata: - type: array - description: Array of Transaction Metadata for given transaction - items: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - policy_asset_addresses: - description: Array of asset names and payment addresses for the given policy (including balances) - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - policy_asset_info: - description: Array of detailed information of assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - token_registry_metadata: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" - policy_asset_mints: - description: Array of mint information for assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - policy_asset_list: - description: Array of brief information of assets under the same policy - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - drep_info: - description: Get detailed information about requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - type: string - description: DRep ID in bech32 format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - hex: - type: string - description: DRep ID in hex format - example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 - has_script: - type: boolean - description: Flag which shows if this DRep credentials are a script hash - example: false - registered: - type: boolean - description: Flag to show if the DRep is currently registered - example: false - deposit: - type: - - string - - 'null' - description: DRep's registration deposit in lovelace - example: 500000000 - active: - type: boolean - description: Flag to show if the DRep is (i.e. not expired) - example: true - expires_epoch_no: - type: - - number - - 'null' - description: After which epoch DRep is considered inactive. - example: 410 - amount: - type: string - description: The total amount of voting power this DRep is delegated. - example: 599496769641 - drep_list: - description: List of all active delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - has_script: - $ref: "#/components/schemas/drep_info/items/properties/has_script" - registered: - $ref: "#/components/schemas/drep_info/items/properties/registered" - drep_metadata: - description: List metadata for requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - url: - type: string - description: A URL to a JSON payload of metadata - example: "https://hornan7.github.io/Vote_Context.jsonld" - hash: - type: string - description: A hash of the contents of the metadata URL - example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d - json: - type: object - description: The payload as JSON - example: - {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} - bytes: - type: string - description: The raw bytes of the payload - example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d - warning: - type: string - description: A warning that occured while validating the metadata - language: - type: string - description: The language described in the context of the metadata as per CIP-100 - example: en-us - comment: - type: string - description: Comment attached to the metadata - is_valid: - type: boolean - description: Indicate whether data is invalid - example: true - drep_updates: - description: List of updates for requested (or all) delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - type: string - description: The index of this certificate within the the transaction. - example: 1 - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - action: - type: string - description: Effective action for this DRep Update certificate - enum: ["updated","registered","deregistered"] - example: registered - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - drep_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - vote: - type: string - enum: ["Yes","No","Abstain"] - description: Actual Vote casted - example: "Yes" - pool_votes: - description: List of all votes casted by requested pool - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - committee_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - proposal_list: - description: List of all votes cast on specified governance action - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - proposal_type: - type: string - enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] - description: Proposal Action Type - example: ParameterChange - proposal_description: - type: string - description: Description for Proposal Action - example: '{"tag": "InfoAction"}' - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - return_address: - type: string - description: The StakeAddress index of the reward address to receive the deposit when it is repaid. - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - proposed_epoch: - type: number - description: Shows the epoch at which this governance action was proposed. - example: 660 - ratified_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been ratified at the specfied epoch. - example: 670 - enacted_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been enacted at the specfied epoch. - example: 675 - dropped_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. - example: 680 - expired_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been expired at the specfied epoch. - example: 680 - expiration: - type: - - number - - 'null' - description: Shows the epoch at which this governance action is expected to expire. - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - meta_comment: - $ref: "#/components/schemas/drep_metadata/items/properties/comment" - meta_language: - $ref: "#/components/schemas/drep_metadata/items/properties/language" - meta_is_valid: - $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" - withdrawal: - type: - - object - - 'null' - description: If not null, The amount withdrawn from treasury into stake address by this this proposal - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - example: "31235800000" - proposal_votes: - type: array - description: List of all votes cast on specified governance action - items: - properties: - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - voter_role: - type: string - description: The role of the voter - enum: ["ConstitutionalCommittee", "DRep", "SPO"] - example: DRep - voter: - type: string - description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - voter_hex: - type: string - description: Voter's DRep ID , pool ID or committee hash in hex format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - vote: - $ref: "#/components/schemas/drep_votes/items/properties/vote" - - script_info: - type: array - items: - description: Array of information for scripts - properties: - script_hash: - type: string - description: Hash of a script - example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af - creation_tx_hash: - type: string - description: Hash of the script creation transaction - example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe - type: - type: string - description: Type of the script - enum: ["plutusV1","plutusV2","timelock","multisig"] - example: plutusV1 - value: - type: - - object - - 'null' - description: Data in JSON format - example: 'null' - bytes: - type: - - string - - 'null' - description: Script bytes (cborSeq) - example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 - size: - type: number - description: The size of the CBOR serialised script (in bytes) - example: 2039 - script_list: - description: List of script and creation tx hash pairs - type: array - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - type: - $ref: "#/components/schemas/script_info/items/properties/type" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - script_redeemers: - description: Array of all redeemers for a given script hash - type: array - items: - type: object - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - redeemers: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - unit_mem: - type: - - string - - number - - 'null' - description: The budget in Memory to run a script - example: 520448 - unit_steps: - type: - - string - - number - - 'null' - description: The budget in Cpu steps to run a script - example: 211535239 - fee: - type: string - description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices - example: 45282 - purpose: - type: string - description: What kind of validation this redeemer is used for - enum: ["spend", "mint", "cert", "reward"] - example: spend - datum_hash: - type: - - string - - 'null' - description: The Hash of the Plutus Data - example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 - datum_value: - $ref: "#/components/schemas/script_info/items/properties/value" - datum_info: - description: Array of datum information for given datum hashes - type: array - items: - type: object - properties: - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - value: - $ref: "#/components/schemas/script_info/items/properties/value" - bytes: - $ref: "#/components/schemas/script_info/items/properties/bytes" - ogmiostip: - description: Current tip of the chain, identified by a slot and a block header hash. - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method that was called in the request - example: "queryNetwork/tip" - result: - type: - - object - - 'null' - - string - - array - - number - description: Result of the query - properties: - slot: - type: number - description: Absolute slot number on chain - example: 59886800 - id: - type: string - description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) - example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" - example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} - headers: {} - responses: - NotFound: - description: The server does not recognise the combination of endpoint and parameters provided - Unauthorized: - description: Access token is missing or invalid - BadRequest: - description: The server cannot process the request due to invalid input -tags: - - name: Network - description: Query information about the network - x-tag-expanded: false - - name: Epoch - description: Query epoch-specific details - x-tag-expanded: false - - name: Block - description: Query information about particular block on chain - x-tag-expanded: false - - name: Transactions - description: Query blockchain transaction details - x-tag-expanded: false - - name: Stake Account - description: Query details about specific stake account addresses - x-tag-expanded: false - - name: Address - description: Query information about specific address(es) - x-tag-expanded: false - - name: Asset - description: Query Asset related informations - x-tag-expanded: false - - name: Governance - description: Query information about governance for network - x-tag-expanded: false - - name: Pool - description: Query information about specific pools - x-tag-expanded: false - - name: Script - description: Query information about specific scripts (Smart Contracts) - x-tag-expanded: false - - name: Ogmios - description: | - Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, - but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. - -
-
- Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. - Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: -
- - - ### Network - - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) - - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) - - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) - - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) - ### Ledger-State - - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) - - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) - - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) - - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) - - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) - - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) - - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) - ### Transactions - - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) - - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) - x-tag-expanded: true -security: - - [] - - bearerAuth: [] +openapi: 3.1.0 +info: + title: Koios API + contact: + name: Koios Core Team + url: https://t.me/CardanoKoios + email: general@koios.rest + license: + name: Creative Commons Attribution 4.0 International + url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE + version: v1.2.0a + description: | + Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. + + # API Usage + + The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. + + ## Vertical Filtering + + Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

+ + ``` bash + curl "https://api.koios.rest/api/v1/tip" + + # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] + + curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" + + # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] + ``` + + ## Horizontal Filtering + + You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

+ ``` bash + curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" + + # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, + # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] + ``` + + Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): + + |Abbreviation|In PostgreSQL|Meaning | + |------------|-------------|-------------------------------------------| + |eq |`=` |equals | + |gt |`>` |greater than | + |gte |`>=` |greater than or equal | + |lt |`<` |less than | + |lte |`<=` |less than or equal | + |neq |`<>` or `!=` |not equal | + |like |`LIKE` |LIKE operator (use * in place of %) | + |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| + |is |`IS` |checking for exact equality (null,true,false,unknown)| + |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | + |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | + |not |`NOT` |negates another operator | + |or |`OR` |logical `OR` operator | + |and |`AND` |logical `AND` operator | + + ## Pagination (offset/limit) + + When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. + + The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. + + Sounds confusing? Let's see this in practice, to hopefully make it easier. + Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range + + # content-range: 0-999/* + + ``` + + As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range + + # content-range: 1000-1499/* + + ``` + + The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. + However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. + + ## Ordering + + You can set a sorting order for returned queries against specific column(s). + Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" + + # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] + ``` + + ## Response Formats + + You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. + Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" + + # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, + # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, + # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] + + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" + + # epoch_no,epoch_slot,block_time + # 318,28491,1643607582 + # 318,28479,1643607570 + # 318,28406,1643607497 + + ``` + + ## Limits + + While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: + + - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. + - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). + - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). + - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. + + Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. + + # Community projects + + A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) + + x-logo: + url: "https://api.koios.rest/images/koios.png" +servers: + - url: https://api.koios.rest/api/v1 + description: Mainnet + - url: https://guild.koios.rest/api/v1 + description: Guildnet + - url: https://preview.koios.rest/api/v1 + description: Preview Network + - url: https://preprod.koios.rest/api/v1 + description: Preprod Network +paths: + + /tip: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tip" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Query Chain Tip + description: Get the tip info about the latest block seen by chain + operationId: tip + /genesis: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/genesis" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get Genesis info + description: Get the Genesis parameters used to start specific era on chain + operationId: genesis + /totals: #RPC + get: + tags: + - Network + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/totals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get historical tokenomic stats + description: >- + Get the circulating utxo, treasury, rewards, supply and reserves in + lovelace for specified epoch, all epochs if empty + operationId: totals + /param_updates: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/param_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Param Update Proposals + description: Get all parameter update proposals submitted to the chain starting Shelley era + operationId: param_updates + /cli_protocol_params: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/cli_protocol_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: CLI Protocol Parameters + description: >- + Get Current Protocol Parameters as published by cardano-cli. Note that + the output schema of this command is unfortunately fluid on cardano-node + and may vary between CLI versions/era. Accordingly, the returned output for + this endpoint is left as raw JSON (single row) and any filtering to output should + be done on client-side + operationId: cli_protocol_params + /reserve_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Reserve Withdrawals + description: List of all withdrawals from reserves against stake accounts + operationId: reserve_withdrawals + /treasury_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Treasury Withdrawals + description: List of all withdrawals from treasury against stake accounts + operationId: treasury_withdrawals + + /epoch_info: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + - $ref: "#/components/parameters/_include_next_epoch" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch Information + description: Get the epoch information, all epochs if no epoch specified + operationId: epoch_info + /epoch_params: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Protocol Parameters + description: >- + Get the protocol parameters for specific epoch, returns information + about all epochs if no epoch specified + operationId: epoch_params + /epoch_block_protocols: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_block_protocols" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Block Protocols + description: >- + Get the information about block protocol distribution in epoch + operationId: epoch_block_protocols + + /blocks: #RPC + get: + tags: + - Block + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block List + description: Get summarised details about all blocks (paginated - latest first) + operationId: blocks + /block_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/block_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Information + description: Get detailed information about a specific block + operationId: block_info + /block_txs: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions + description: Get a list of all transactions included in provided blocks + operationId: block_txs + /block_tx_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions (Detailed Info) + description: Get detailed information about transaction(s) for requested blocks + operationId: block_tx_info + + /utxo_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/utxo_refs_with_extended" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxO Info + description: Get UTxO set for requested UTxO references + operationId: utxo_info + /tx_cbor: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_cbor" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Raw Transaction (CBOR) + description: Get raw transaction(s) in CBOR format + operationId: tx_cbor + /tx_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Information + description: Get detailed information about transaction(s) + operationId: tx_info + /tx_metadata: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata + description: Get metadata information (if any) for given transaction(s) + operationId: tx_metadata + /tx_metalabels: #RPC + get: + tags: + - Transactions + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metalabels" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata Labels + description: Get a list of all transaction metalabels + operationId: tx_metalabels + /submittx: #submit-api + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/txbin" + x-code-samples: + - lang: "Shell" + source: | + # Assuming ${data} is a raw binary serialized transaction on the file-system. + # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. + curl -X POST \ + --header "Content-Type: application/cbor" \ + --data-binary @${data} https://api.koios.rest/api/v1/submittx + responses: + "202": + description: OK + content: + application/json: + schema: + description: The transaction id. + type: string + format: hex + minLength: 64 + maxLength: 64 + example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f + "400": + description: An error occured while submitting transaction. + summary: Submit Transaction + description: Submit an already serialized transaction to the network. + operationId: submittx + /tx_status: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_status" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Status + description: Get the number of block confirmations for a given transaction hash list + operationId: tx_status + /tx_utxos: #RPC + post: + tags: + - Transactions + deprecated: true + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_utxos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction UTxOs + description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. + operationId: tx_utxos + + /address_info: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Information + description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses + operationId: address_info + /address_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address UTXOs + description: Get UTxO set for given addresses + operationId: address_utxos + /credential_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_utxos" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs from payment credentials + description: Get UTxO details for requested payment credentials + operationId: credential_utxos + /address_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/address_txs" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Transactions + description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) + operationId: address_txs + /credential_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_txs" + responses: + "200": + description: Array of transaction hashes for given credential(s) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transactions from payment credentials + description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) + operationId: credential_txs + /address_assets: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Assets + description: Get the list of all the assets (policy, name and quantity) for given addresses + operationId: address_assets + + /account_list: #RPC + get: + tags: + - Stake Account + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account List + description: Get a list of all stake addresses that have atleast 1 transaction + operationId: account_list + /account_info: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information + description: Get the account information for given stake addresses + operationId: account_info + /account_info_cached: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information (Cached) + description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) + operationId: account_info_cached + /account_utxos: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs for stake addresses (accounts) + description: Get a list of all UTxOs for given stake addresses (account)s + operationId: account_utxos + /account_txs: #RPC + get: + tags: + - Stake Account + parameters: + - $ref: "#/components/parameters/_stake_address" + - $ref: "#/components/parameters/_after_block_height" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Txs + description: Get a list of all Txs for a given stake address (account) + operationId: account_txs + /account_rewards: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_rewards" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Rewards + description: >- + Get the full rewards history (including MIR) for given stake addresses + operationId: account_rewards + /account_updates: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Updates + description: >- + Get the account updates (registration, deregistration, delegation and + withdrawals) for given stake addresses + operationId: account_updates + /account_addresses: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Addresses + description: Get all addresses associated with given staking accounts + operationId: account_addresses + /account_assets: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Assets + description: Get the native asset balance for a given stake address + operationId: account_assets + /account_history: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account History + description: Get the staking history of given stake addresses (accounts) + operationId: account_history + + /asset_list: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset List + description: Get the list of all native assets (paginated) + operationId: asset_list + /policy_asset_list: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of brief information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset List + description: Get the list of asset under the given policy (including balances) + operationId: policy_asset_list + /asset_token_registry: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_token_registry" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Token Registry + description: Get a list of assets registered via token registry on github + operationId: asset_token_registry + /asset_info: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list" + responses: + "200": + description: Array of detailed asset information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Information (Bulk) + description: Get the information of a list of assets including first minting & token registry metadata + operationId: asset_info + /asset_utxos: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset UTXOs + description: Get the UTXO information of a list of assets including + operationId: asset_utxos + /asset_history: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset mint/burn history + content: + application/json: + schema: + $ref: "#/components/schemas/asset_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset History + description: Get the mint/burn history of an asset + operationId: asset_history + /asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Addresses + description: Get the list of all addresses holding a given asset

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: asset_addresses + /asset_nft_address: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy_nft" + - $ref: "#/components/parameters/_asset_name_nft" + responses: + "200": + description: Payment addresses currently holding the given NFT + content: + application/json: + schema: + $ref: "#/components/schemas/asset_nft_address" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: NFT Address + description: Get the address where specified NFT currently reside on. + operationId: asset_nft_address + /policy_asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of asset names and payment addresses for the given policy (including balances) + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Address List + description: Get the list of addresses with quantity for each asset on the given policy

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: policy_asset_addresses + /policy_asset_info: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of detailed information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Information + description: Get the information for all assets under the same policy + operationId: policy_asset_info + /policy_asset_mints: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Get a list of mint or burn count details for all assets minted under a policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_mints" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Mints + description: Get a list of mint or burn count details for all assets minted under a policy + operationId: policy_asset_mints + /asset_summary: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset summary information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_summary" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Summary + description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) + operationId: asset_summary + /asset_txs: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + - $ref: "#/components/parameters/_after_block_height" + - $ref: "#/components/parameters/_history" + responses: + "200": + description: An array of Tx hashes that included the given asset (latest first) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Transactions + description: Get the list of current or all asset transaction hashes (newest first) + operationId: asset_txs + + /drep_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps List + description: List of all active delegated representatives (DReps) + operationId: drep_list + /drep_info: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Info + description: Get detailed information about requested delegated representatives (DReps) + operationId: drep_info + /drep_metadata: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Metadata + description: List metadata for requested delegated representatives (DReps) + operationId: drep_metadata + /drep_updates: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Updates + description: List of updates for requested (or all) delegated representatives (DReps) + operationId: drep_updates + /drep_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Votes + description: List of all votes casted by requested delegated representative (DRep) + operationId: drep_votes + /committee_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_committee_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Committee Votes + description: List of all votes casted by given committee member or collective + operationId: committee_votes + /proposal_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/proposal_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposals List + description: List of all governance proposals + operationId: proposal_list + /proposal_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_tx_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposal Votes + description: List of all votes cast on specified governance action + operationId: proposal_votes + + /pool_list: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool List + description: List of brief info for all pools + operationId: pool_list + /pool_info: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Information + description: Current pool statuses and details for a specified list of pool ids + operationId: pool_info + /pool_stake_snapshot: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_snapshot" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake Snapshot + description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation + operationId: pool_stake_snapshot + /pool_delegators: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators List + description: Return information about live delegators for a given pool. + operationId: pool_delegators + /pool_delegators_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators History + description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). + operationId: pool_delegators_history + /pool_blocks: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Blocks + description: >- + Return information about blocks minted by a given pool for all epochs + (or _epoch_no if provided) + operationId: pool_blocks + /pool_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_history_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake, Block and Reward History + description: >- + Return information about pool stake, block and reward history in a given epoch _epoch_no + (or all epochs that pool existed for, in descending order if no _epoch_no was provided) + operationId: pool_history + /pool_updates: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Updates (History) + description: Return all pool updates for all pools or only updates for specific pool if specified + operationId: pool_updates + /pool_registrations: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Registrations + description: Return all pool registrations initiated in the requested epoch + operationId: pool_registrations + /pool_retirements: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Retirements + description: Return all pool retirements initiated in the requested epoch + operationId: pool_retirements + /pool_relays: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_relays" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Relays + description: A list of registered relays for all pools + operationId: pool_relays + /pool_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Votes + description: List of all votes casted by a pool + operationId: pool_votes + /pool_metadata: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Metadata + description: Metadata (on & off-chain) for all pools + operationId: pool_metadata + + /script_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/script_hashes" + responses: + "200": + description: Array of information for scripts requested + content: + application/json: + schema: + $ref: "#/components/schemas/script_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Information + description: List of script information for given script hashes + operationId: script_info + /native_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of native script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Native Script List + description: List of all existing native script hashes along with their creation transaction hashes + operationId: native_script_list + /plutus_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of Plutus script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Plutus Script List + description: List of all existing Plutus script hashes along with their creation transaction hashes + operationId: plutus_script_list + /script_redeemers: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + responses: + "200": + description: Array of all redeemers for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/script_redeemers" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Redeemers + description: List of all redeemers for a given script hash + operationId: script_redeemers + /script_utxos: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + - $ref: "#/components/parameters/_extended" + responses: + "200": + description: List of UTXOs for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script UTXOs + description: List of all UTXOs for a given script hash + operationId: script_utxos + /datum_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/datum_hashes" + responses: + "200": + description: Array of datum information for given datum hashes + content: + application/json: + schema: + $ref: "#/components/schemas/datum_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Datum Information + description: List of datum information for given datum hashes + operationId: datum_info + + /ogmios: #ogmios-api + post: + tags: + - Ogmios + requestBody: + $ref: "#/components/requestBodies/ogmios" + responses: + "200": + description: Current tip of the chain, identified by a slot and a block header hash. + content: + application/json: + schema: + $ref: "#/components/schemas/ogmiostip" + "400": + $ref: "#/components/responses/BadRequest" + summary: Query Example + description: | + Query the current tip of the Network. + +
+
+ We do support transparent forwarding for various methods from Ogmios, you can read about those here. +
+ operationId: ogmios + +components: + parameters: + _after_block_height: + deprecated: false + name: _after_block_height + description: Block height for specifying time delta + schema: + type: number + example: 50000 + in: query + required: false + allowEmptyValue: true + _epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "6219" + in: query + required: false + allowEmptyValue: true + _stake_address: + deprecated: false + name: _stake_address + description: Cardano staking address (reward account) in bech32 format + schema: + type: string + example: "stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2" + in: query + required: true + allowEmptyValue: false + _tx_hash: + deprecated: false + name: _tx_hash + description: Transaction Hash in hexadecimal format (hex) + example: "bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7" + schema: + type: string + in: query + required: true + allowEmptyValue: false + _asset_policy: + deprecated: false + name: _asset_policy + description: Asset Policy ID in hexadecimal format (hex) + schema: + type: string + example: "313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e" + in: query + required: true + allowEmptyValue: false + _asset_name: + deprecated: false + name: _asset_name + description: Asset Name in hexadecimal format (hex), empty asset name returns royalties + schema: + type: string + example: "41484c636f696e" + in: query + required: false + allowEmptyValue: true + _asset_policy_nft: + deprecated: false + name: _asset_policy + description: NFT Policy ID in hexadecimal format (hex) + schema: + type: string + example: "187abba169e246fdcbebcd12915a8610cb470fda3b3fc21da0c4aed4" + in: query + required: true + allowEmptyValue: false + _asset_name_nft: + deprecated: false + name: _asset_name + description: NFT Name in hexadecimal format (hex) + schema: + type: string + example: "4f504b4559" + in: query + required: false + allowEmptyValue: true + _drep_id: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r" + in: query + required: true + allowEmptyValue: false + _drep_id_optional: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r" + in: query + required: false + allowEmptyValue: true + _committee_hash: + deprecated: false + name: _committee_hash + description: Committee hash in hexadecimal format (hex) + schema: + type: string + example: "65d497b875c56ab213586a4006d4f6658970573ea8e2398893857472" + in: query + required: false + allowEmptyValue: true + _extended: + deprecated: false + name: _extended + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _history: + deprecated: false + name: _history + description: Include all historical transactions, setting to false includes only the non-empty ones + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: false + _include_next_epoch: + deprecated: false + name: _include_next_epoch + description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _pool_bech32: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format + schema: + type: string + example: "pool1xc9eywck4e20tydz4yvh5vfe0ep8whawvwz8wqkc9k046a2ypp4" + in: query + required: true + allowEmptyValue: false + _pool_bech32_optional: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format (optional) + schema: + type: string + example: "pool1xc9eywck4e20tydz4yvh5vfe0ep8whawvwz8wqkc9k046a2ypp4" + in: query + required: false + allowEmptyValue: true + _pool_epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "18852" + in: query + required: false + allowEmptyValue: true + _script_hash: + deprecated: false + name: _script_hash + description: Script hash in hexadecimal format (hex) + schema: + type: string + example: "f6c13b1bd68219ffb6a1e6d77bd23ec5982f3da2d93007aa5956a142" + in: query + required: true + allowEmptyValue: false + requestBodies: + block_hashes: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + example: + _block_hashes: + - af2f6f7dd4e4ea6765103a1e38e023da3edd2b3c7fea2aa367222564dbe01cfd + - bddbbc6df0ad09567a513349bafd56d8ec5c8fcd9ee9db12173624b896350d57 + - 732bf9bbc3780e6cd7ad57a3889dd5904f6e8a27d54eabf43eb0dbc485323f04 + description: Array of block hashes + block_tx_info: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _block_hashes: + - af2f6f7dd4e4ea6765103a1e38e023da3edd2b3c7fea2aa367222564dbe01cfd + - bddbbc6df0ad09567a513349bafd56d8ec5c8fcd9ee9db12173624b896350d57 + - 732bf9bbc3780e6cd7ad57a3889dd5904f6e8a27d54eabf43eb0dbc485323f04 + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of block hashes + payment_addresses: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + example: + _addresses: + - addr_test1qzmtfv43a8ncx6ve92ja6yy25npn9raz9pu5a2tfxsqv9gy9ktf0pu6yu4zjh9r37fzx3h4tsxqdjhu3t4d5ffdsfz9s6ska3z + - addr_test1vq67g5u8ls4vm4wdvs0r8xvsuej66nvaqedyrj2tcz6tuycz275pu + description: Array of Cardano payment address(es) + payment_addresses_with_extended: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _addresses: + - addr_test1qzmtfv43a8ncx6ve92ja6yy25npn9raz9pu5a2tfxsqv9gy9ktf0pu6yu4zjh9r37fzx3h4tsxqdjhu3t4d5ffdsfz9s6ska3z + - addr_test1vq67g5u8ls4vm4wdvs0r8xvsuej66nvaqedyrj2tcz6tuycz275pu + _extended: true + description: Array of Cardano payment address(es) with extended flag to toggle additional fields + address_txs: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _addresses: + - addr_test1qzmtfv43a8ncx6ve92ja6yy25npn9raz9pu5a2tfxsqv9gy9ktf0pu6yu4zjh9r37fzx3h4tsxqdjhu3t4d5ffdsfz9s6ska3z + - addr_test1vq67g5u8ls4vm4wdvs0r8xvsuej66nvaqedyrj2tcz6tuycz275pu + _after_block_height: 120000 + description: Array of Cardano payment address(es) + stake_addresses_with_epoch_no: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _epoch_no: + format: integer + type: number + description: Only fetch information for a specific epoch + example: + _stake_addresses: + - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 + - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd + _epoch_no: 1500 + description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by + stake_addresses_with_first_only_and_empty: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _first_only: + format: boolean + type: boolean + description: Only return the first result + _empty: + format: boolean + type: boolean + description: Include zero quantity entries + example: + _stake_addresses: + - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 + - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd + _first_only: false + _empty: false + description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs + stake_addresses_with_extended: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _stake_addresses: + - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 + - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd + _extended: true + description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns + stake_addresses: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + example: + _stake_addresses: + - stake_test17zt9x005zkd2usz2vhvktyzqsuwz25gmgnaqdka5hcj9m2qfg2py2 + - stake_test1uzzm95hs7dzw23ftj3cly3rgm64crqxet7g46k6y5kcy3zcs3mpjd + description: Array of Cardano stake credential(s) in bech32 format + credential_txs: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _payment_credentials: + - b6b4b2b1e9e78369992aa5dd108aa4c3328fa228794ea9693400c2a0 + - 35e45387fc2acdd5cd641e339990e665ad4d9d065a41c94bc0b4be13 + _after_block_height: 120000 + description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight + credential_utxos: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _payment_credentials: + - b6b4b2b1e9e78369992aa5dd108aa4c3328fa228794ea9693400c2a0 + - 35e45387fc2acdd5cd641e339990e665ad4d9d065a41c94bc0b4be13 + _extended: true + description: Array of Cardano payment credential(s) in hex format + tx_ids: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + example: + _tx_hashes: + - bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7 + - 63b716064012f858450731cb5f960c100c6cb639ec1ec999b898c604451f116a + description: Array of Cardano Transaction hashes + tx_info: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _tx_hashes: + - bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7 + - 63b716064012f858450731cb5f960c100c6cb639ec1ec999b898c604451f116a + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of Cardano Transaction hashes + txbin: + content: + application/cbor: + schema: + type: string + format: binary + example: bf04578d452dd3acb7c70fbac32dc972cb69f932f804171cfb4268f5af0228e7 + description: Serialised Cardano Transaction + pool_ids: + content: + application/json: + schema: + required: + - _pool_bech32_ids + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool19st4a2vvu78tjtyywjte2eml3kx6ynersgd2nyw0y4jvyhlfu0u + - pool1uul8pytp2p0xq4ckjn3l294km0m7fuef46teehvh3x5tk46sfx3 + - pool1us9ww725p0vygae5zaydme3apt7wg9se2yemhl8mgwkes3tlrqp + description: Array of Cardano pool IDs (bech32 format) + pool_ids_optional: + content: + application/json: + schema: + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool19st4a2vvu78tjtyywjte2eml3kx6ynersgd2nyw0y4jvyhlfu0u + - pool1uul8pytp2p0xq4ckjn3l294km0m7fuef46teehvh3x5tk46sfx3 + - pool1us9ww725p0vygae5zaydme3apt7wg9se2yemhl8mgwkes3tlrqp + description: Array of Cardano pool IDs (bech32 format) [Optional] + script_hashes: + content: + application/json: + schema: + type: object + properties: + _script_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano script hashes + example: + _script_hashes: + - a08a267e92456ba48e157dd7e77bdd35aba0fc50fe625a10a6a7fc5e + - 1f3a4aa08cfa0e47fff200578f0d4847b6890b7093a765773feb35de + description: Array of Cardano script hashes + datum_hashes: + content: + application/json: + schema: + type: object + properties: + _datum_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano datum hashes + example: + _datum_hashes: + - 964af1ff2a66ce472d34ac39b47f356b6d971d62c794a89ec12825d5de30f3aa + - 17bdb9c96b77c7718d546be50193a80bc9d72081b7375e5e16891db196af14fc + description: Array of Cardano datum hashes + asset_list: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + example: + _asset_list: + - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] + - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] + description: Array of array of policyID and asset names (hex) + asset_list_with_extended: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _asset_list: + - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] + - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] + _extended: true + description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns + drep_id_bulk: + content: + application/json: + schema: + required: + - _drep_ids + type: object + properties: + _drep_ids: + format: text + type: array + descriptions: Array of DRep IDs in bech32 format + items: + type: string + example: + _drep_ids: + - drep1s9qaseg7qyum807fcv0hdky9gv0c89tn98t4urjn5ewz57dml0r + - drep13p45vxysc2s6vp6ez2ng7lynlsheh64zxexpcennn68cuc05yps + utxo_refs_with_extended: + content: + application/json: + schema: + required: + - _utxo_refs + type: object + properties: + _utxo_refs: + format: text + type: array + items: + type: string + description: Array of Cardano utxo references in the form "hash#index" + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _utxo_refs: + - f82e568d42604fd71424d193c86ec00c97aead2b8f018e81c3139d9e3770c735#0 + - 88ae22495123c7ee37a0bbe865243757185a302ed5359d1eae9347030628290a#0 + _extended: false + description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields + ogmios: + content: + application/json: + schema: + required: + - jsonrpc + - method + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab + enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] + example: "queryNetwork/tip" + params: + type: object + description: Any parameters relevant to the specific method to be called + nullable: true + examples: + blockHeight: + description: Query the network’s highest block number. + value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } + genesisConfiguration: + description: Query the genesis configuration of a given era. + value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } + startTimeTime: + description: Query the network start time. + value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } + tip: + description: Query tip of the Network + value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } + epoch: + description: Query the current epoch of the ledger. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } + eraStart: + description: Query information regarding the beginning of the current ledger era. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } + eraSummaries: + description: Query era bounds and slot parameters details, required for proper sloting arithmetic. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } + liveStakeDistribution: + description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } + protocolParameters: + description: Query the current protocol parameters. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } + proposedProtocolParameters: + description: Query the last update proposal w.r.t. protocol parameters, if any. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } + StakePools: + description: Query the list of all stake pool identifiers currently registered and active. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } + submitTransaction: + description: Submit a signed and serialized transaction to the network. + value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } + evaluateTransaction: + description: Evaluate execution units of scripts in a well-formed transaction. + value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } + description: JSON-RPC 2.0 standard request body + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT + description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. + schemas: + tip: + description: Current tip of the chain + type: array + items: + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_no: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + genesis: + description: Array of genesis parameters used to start each era on chain + type: array + items: + properties: + networkmagic: + type: string + example: 764824073 + description: Unique network identifier for chain + networkid: + type: string + example: Mainnet + description: Network ID used at various CLI identification to distinguish between Mainnet and other networks + epochlength: + type: string + example: 432000 + description: Number of slots in an epoch + slotlength: + type: string + example: 1 + description: Duration of a single slot (in seconds) + maxlovelacesupply: + type: string + example: 45000000000000000 + description: Maximum smallest units (lovelaces) supply for the blockchain + systemstart: + type: number + description: UNIX timestamp of the first block (genesis) on chain + example: 1506203091 + activeslotcoeff: + type: string + example: 0.05 + description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" + slotsperkesperiod: + type: string + example: 129600 + description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) + maxkesrevolutions: + type: string + example: 62 + description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised + securityparam: + type: string + example: 2160 + description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) + updatequorum: + type: string + example: 5 + description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal + alonzogenesis: + type: string + example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' + description: A JSON dump of Alonzo Genesis + totals: + description: Array of supply/reserves/utxo/fees/treasury stats + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + circulation: + type: string + description: Circulating UTxOs for given epoch (in lovelaces) + example: 32081169442642320 + treasury: + type: string + description: Funds in treasury for given epoch (in lovelaces) + example: 637024173474141 + reward: + type: string + description: Rewards accumulated as of given epoch (in lovelaces) + example: 506871250479840 + supply: + type: string + description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) + example: 33228495612391330 + reserves: + type: string + description: Total Reserves yet to be unlocked on chain + example: 11771504387608670 + param_updates: + description: Array of unique param update proposals submitted on chain + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + data: + type: string + description: JSON encoded data with details about the parameter update + example: {"decentralisation": 0.9} + cli_protocol_params: + description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format + type: object + example: + { + "collateralPercentage": 150, + "maxBlockBodySize": 90112, + "maxBlockHeaderSize": 1100, + "maxCollateralInputs": 3, + "maxTxSize": 16384, + "maxValueSize": 5000, + "minPoolCost": 170000000, + "minUTxOValue": null, + "monetaryExpansion": 3.0e-3, + "poolPledgeInfluence": 0.3, + "poolRetireMaxEpoch": 18, + "protocolVersion": { + "major": 8, + "minor": 0 + }, + "...": "...", + "stakeAddressDeposit": 2000000, + "stakePoolDeposit": 500000000, + "stakePoolTargetNum": 500, + "treasuryCut": 0.2, + "txFeeFixed": 155381, + "txFeePerByte": 44, + "utxoCostPerByte": 4310 + } + reserve_withdrawals: + description: Array of withdrawals from reserves/treasury against stake accounts + type: array + items: + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + earned_epoch: + description: Epoch where amount is earned + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + spendable_epoch: + description: Epoch where the earned amount can be spent + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + pool_list: + description: Array of pool IDs and tickers + type: array + items: + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + ticker: + type: + - string + - 'null' + description: Pool ticker + example: AHL + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_history_info: + description: Array of pool history information + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch for which the pool history data is shown + example: 312 + active_stake: + type: string + description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) + example: "31235800000" + active_stake_pct: + type: number + description: Active stake for the pool, expressed as a percentage of total active stake on network + example: 13.512182543475783 + saturation_pct: + type: number + description: Saturation percentage of a pool at the time of snapshot (2 decimals) + example: 45.32 + block_cnt: + type: + - number + - 'null' + description: Number of blocks pool created in that epoch + example: 14 + delegator_cnt: + type: number + description: Number of delegators to the pool for that epoch snapshot + example: 1432 + margin: + type: number + description: Margin (decimal format) + example: 0.125 + fixed_cost: + type: string + description: Pool fixed cost per epoch (in lovelaces) + example: "340000000" + pool_fees: + type: string + description: Total amount of fees earned by pool owners in that epoch (in lovelaces) + example: "123327382" + deleg_rewards: + type: string + description: Total amount of rewards earned by delegators in that epoch (in lovelaces) + example: "123456789123" + member_rewards: + type: string + description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) + example: "123456780123" + epoch_ros: + type: number + description: Annualized ROS (return on staking) for delegators for this epoch + example: 3.000340466 + pool_info: + description: Array of pool information + type: array + items: + type: object + properties: + pool_id_bech32: + type: string + description: Pool ID (bech32 format) + example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc + pool_id_hex: + type: string + description: Pool ID (Hex format) + example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + vrf_key_hash: + type: + - string + - 'null' + description: Pool VRF key hash + example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 + margin: + type: + - number + - 'null' + description: Margin (decimal format) + example: 0.1 + fixed_cost: + type: + - string + - 'null' + description: Pool fixed cost per epoch + example: "500000000" + pledge: + type: + - string + - 'null' + description: Pool pledge in lovelace + example: "64000000000000" + deposit: + type: + - string + - 'null' + description: Pool's registration deposit in lovelace + example: "500000000" + reward_addr: + type: + - string + - 'null' + description: Pool reward address + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + owners: + type: + - array + - 'null' + items: + type: string + description: Pool (co)owner address + example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 + relays: + type: array + items: + type: object + properties: + dns: + type: + - string + - 'null' + description: DNS name of the relay (nullable) + example: relays-new.cardano-mainnet.iohk.io + srv: + type: + - string + - 'null' + description: DNS service name of the relay (nullable) + example: biostakingpool3.hopto.org + ipv4: + type: + - string + - 'null' + description: IPv4 address of the relay (nullable) + example: "54.220.20.40" + ipv6: + type: + - string + - 'null' + description: IPv6 address of the relay (nullable) + example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf + port: + type: + - number + - 'null' + description: Port number of the relay (nullable) + example: 6000 + meta_url: + type: + - string + - 'null' + description: Pool metadata URL + example: https://pools.iohk.io/IOGP.json + meta_hash: + type: + - string + - 'null' + description: Pool metadata hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + meta_json: + type: + - object + - 'null' + properties: + name: + type: string + description: Pool name + example: Input Output Global (IOHK) - Private + ticker: + type: string + description: Pool ticker + example: IOGP + homepage: + type: string + description: Pool homepage URL + example: https://iohk.io + description: + type: string + description: Pool description + example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. + pool_status: + type: string + description: Pool status + enum: ["registered", "retiring", "retired"] + example: registered + retiring_epoch: + type: + - number + - 'null' + description: Announced retiring epoch (nullable) + example: 'null' + op_cert: + type: + - string + - 'null' + description: Pool latest operational certificate hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + op_cert_counter: + type: + - number + - 'null' + description: Pool latest operational certificate counter value + example: 8 + active_stake: + type: + - string + - 'null' + description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) + example: "64328627680963" + sigma: + type: + - number + - 'null' + description: Pool relative active stake share + example: 0.0034839235 + block_count: + type: + - number + - 'null' + description: Total pool blocks on chain + example: 4509 + live_pledge: + type: + - string + - 'null' + description: Summary of account balance for all pool owner's + example: "64328594406327" + live_stake: + type: + - string + - 'null' + description: Pool live stake + example: "64328627680963" + live_delegators: + type: number + description: Pool live delegator count + example: 5 + live_saturation: + type: + - number + - 'null' + description: Pool live saturation (decimal format) + example: 94.52 + pool_snapshot: + type: array + items: + description: Array of pool stake information for 3 snapshots + type: object + properties: + snapshot: + type: string + description: Type of snapshot ("Mark", "Set" or "Go") + example: "Mark" + epoch_no: + type: number + description: Epoch number for the snapshot entry + example: 324 + nonce: + $ref: "#/components/schemas/epoch_params/items/properties/nonce" + pool_stake: + type: string + description: Pool's Active Stake for the given epoch + example: "100000000000" + active_stake: + type: string + description: Total Active Stake for the given epoch + example: "103703246364020" + pool_delegators: + description: Array of live pool delegators + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + description: Current delegator live stake (in lovelace) + example: 64328591517480 + active_epoch_no: + type: number + description: Epoch number in which the delegation becomes active + example: 324 + latest_delegation_tx_hash: + type: string + description: Latest transaction hash used for delegation by the account + example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 + pool_registrations: + description: Array of pool registrations/retirements + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + pool_delegators_history: + description: Array of pool delegators (historical) + type: + - array + - 'null' + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + epoch_no: + type: number + description: Epoch number for the delegation history + example: 324 + pool_blocks: + description: Array of blocks created by pool + type: array + items: + type: object + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_updates: + description: Array of historical pool updates + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + type: + - number + - 'null' + description: Epoch number in which the update becomes active + example: 324 + vrf_key_hash: + $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + update_type: + type: string + description: Type of update task + enum: ["registration", "deregistration"] + example: registered + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_relays: + description: Array of pool relay information + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + pool_metadata: + description: Array of pool metadata + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + epoch_info: + description: Array of detailed summary for each epoch + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + out_sum: + type: string + description: Total output value across all transactions in epoch + example: 15432725054364942 + fees: + type: string + description: Total fees incurred by transactions in epoch + example: 74325855210 + tx_count: + type: number + description: Number of transactions submitted in epoch + example: 357919 + blk_count: + type: number + description: Number of blocks created in epoch + example: 17321 + start_time: + type: number + description: UNIX timestamp of the epoch start + example: 1506203091 + end_time: + type: number + description: UNIX timestamp of the epoch end + example: 1506635091 + first_block_time: + type: number + description: UNIX timestamp of the epoch's first block + example: 1506635091 + last_block_time: + type: number + description: UNIX timestamp of the epoch's last block + example: 1506635091 + active_stake: + type: + - string + - 'null' + description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) + example: 23395112387185880 + total_rewards: + type: + - string + - 'null' + description: Total rewards earned in epoch (null for pre-Shelley epochs) + example: 252902897534230 + avg_blk_reward: + type: + - string + - 'null' + description: Average block reward for epoch (null for pre-Shelley epochs) + example: 660233450 + epoch_params: + description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + min_fee_a: + type: + - number + - 'null' + description: The 'a' parameter to calculate the minimum transaction fee + example: 44 + min_fee_b: + type: + - number + - 'null' + description: The 'b' parameter to calculate the minimum transaction fee + example: 155381 + max_block_size: + type: + - number + - 'null' + description: The maximum block size (in bytes) + example: 65536 + max_tx_size: + type: + - number + - 'null' + description: The maximum transaction size (in bytes) + example: 16384 + max_bh_size: + type: + - number + - 'null' + description: The maximum block header size (in bytes) + example: 1100 + key_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake address + example: 2000000 + pool_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake pool + example: 500000000 + max_epoch: + type: + - number + - 'null' + description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for + example: 18 + optimal_pool_count: + type: + - number + - 'null' + description: The optimal number of stake pools + example: 500 + influence: + type: + - number + - 'null' + format: double + description: The pledge influence on pool rewards + example: 0.3 + monetary_expand_rate: + type: + - number + - 'null' + format: double + description: The monetary expansion rate + example: 0.003 + treasury_growth_rate: + type: + - number + - 'null' + format: double + description: The treasury growth rate + example: 0.2 + decentralisation: + type: + - number + - 'null' + format: double + description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) + example: 0.1 + extra_entropy: + type: + - string + - 'null' + description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool + example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa + protocol_major: + type: + - number + - 'null' + description: The protocol major version + example: 5 + protocol_minor: + type: + - number + - 'null' + description: The protocol minor version + example: 0 + min_utxo_value: + type: + - string + - 'null' + description: The minimum value of a UTxO entry + example: 34482 + min_pool_cost: + type: + - string + - 'null' + description: The minimum pool cost + example: 340000000 + nonce: + type: + - string + - 'null' + description: The nonce value for this epoch + example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 + block_hash: + type: string + description: The hash of the first block where these parameters are valid + example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 + cost_models: + type: + - object + - 'null' + description: The per language cost model in JSON + example: 'null' + price_mem: + type: + - number + - 'null' + format: double + description: The per word cost of script memory usage + example: 0.0577 + price_step: + type: + - number + - 'null' + format: double + description: The cost of script execution step usage + example: 7.21e-05 + max_tx_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single transaction + example: 10000000 + max_tx_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single transaction + example: 10000000000 + max_block_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single block + example: 50000000 + max_block_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single block + example: 40000000000 + max_val_size: + type: + - number + - 'null' + description: The maximum Val size + example: 5000 + collateral_percent: + type: + - number + - 'null' + description: The percentage of the tx fee which must be provided as collateral when including non-native scripts + example: 150 + max_collateral_inputs: + type: + - number + - 'null' + description: The maximum number of collateral inputs allowed in a transaction + example: 3 + coins_per_utxo_size: + type: + - string + - 'null' + description: The cost per UTxO size + example: 34482 + pvt_motion_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for motion of no-confidence. + example: 0.6 + pvt_committee_normal: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (normal state). + example: 0.65 + pvt_committee_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (state of no-confidence). + example: 0.65 + pvt_hard_fork_initiation: + type: + - number + - 'null' + description: Pool Voting threshold for hard-fork initiation. + example: 0.51 + dvt_motion_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for motion of no-confidence. + example: 0.67 + dvt_committee_normal: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (normal state). + example: 0.67 + dvt_committee_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (state of no-confidence). + example: 0.65 + dvt_update_to_constitution: + type: + - number + - 'null' + description: DRep Vote threshold for update to the Constitution. + example: 0.75 + dvt_hard_fork_initiation: + type: + - number + - 'null' + description: DRep Vote threshold for hard-fork initiation. + example: 0.6 + dvt_p_p_network_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, network group. + example: 0.67 + dvt_p_p_economic_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, economic group. + example: 0.67 + dvt_p_p_technical_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, technical group. + example: 0.67 + dvt_p_p_gov_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, governance group. + example: 0.75 + dvt_treasury_withdrawal: + type: + - number + - 'null' + description: DRep Vote threshold for treasury withdrawal. + example: 0.67 + committee_min_size: + type: + - number + - 'null' + description: Minimal constitutional committee size. + example: 5 + committee_max_term_length: + type: + - number + - 'null' + description: Constitutional committee term limits. + example: 146 + gov_action_lifetime: + type: + - number + - 'null' + description: Governance action expiration. + example: 14 + gov_action_deposit: + type: + - string + - 'null' + description: Governance action deposit. + example: 100000000000 + drep_deposit: + type: + - string + - 'null' + description: DRep deposit amount. + example: 500000000 + drep_activity: + type: + - number + - 'null' + description: DRep activity period. + example: 20 + pvtpp_security_group: + type: + - number + - 'null' + description: Pool Voting threshold for protocol parameter changes, security group. + example: 0.6 + min_fee_ref_script_cost_per_byte: + type: + - number + - 'null' + description: Minimum Fee for Reference Script cost pre byte + example: 15 + epoch_block_protocols: + description: Array of distinct block protocol versions counts in epoch + type: array + items: + properties: + proto_major: + type: number + description: Protocol major version + example: 6 + proto_minor: + type: number + description: Protocol major version + example: 2 + blocks: + type: number + description: Amount of blocks with specified major and protocol combination + example: 2183 + blocks: + description: Array of block information + type: array + items: + type: object + properties: + hash: + type: string + description: Hash of the block + example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f + epoch_no: + type: number + description: Epoch number of the block + example: 117 + abs_slot: + type: number + description: Absolute slot number of the block + example: 49073930 + epoch_slot: + type: number + description: Slot number of the block in epoch + example: 171530 + block_height: + type: + - number + - 'null' + description: Block height + example: 1794506 + block_size: + type: number + description: Block size in bytes + example: 2433 + block_time: + type: number + description: UNIX timestamp of the block + example: 1704757130 + tx_count: + type: number + description: Number of transactions in the block + example: 2 + vrf_key: + type: string + description: VRF key of the block producer + example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" + pool: + type: + - string + - 'null' + description: Pool ID in bech32 format (null for pre-Shelley blocks) + example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v + op_cert_counter: + type: number + description: Counter value of the operational certificate used to create this block + example: 5 + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + parent_hash: + type: string + description: Previous Hash of the current block + example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 + block_info: + description: Array of detailed block information + type: array + items: + type: object + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_size: + $ref: "#/components/schemas/blocks/items/properties/block_size" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + tx_count: + $ref: "#/components/schemas/blocks/items/properties/tx_count" + vrf_key: + $ref: "#/components/schemas/blocks/items/properties/vrf_key" + op_cert: + type: string + description: Hash of the block producers' operational certificate + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + op_cert_counter: + $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" + pool: + $ref: "#/components/schemas/blocks/items/properties/pool" + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + total_output: + type: + - string + - 'null' + description: Total output of the block (in lovelace) + example: 92384672389 + total_fees: + type: + - string + - 'null' + description: Total fees of the block (in lovelace) + example: 2346834 + num_confirmations: + type: number + description: Number of confirmations for the block + example: 664275 + parent_hash: + type: string + description: Hash of the parent of this block + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + child_hash: + type: string + description: Hash of the child of this block (if present) + example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" + block_txs: + description: Array of transactions hashes + type: array + items: + type: object + properties: + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + block_tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" + tx_block_index: + $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" + tx_size: + $ref: "#/components/schemas/tx_info/items/properties/tx_size" + total_output: + $ref: "#/components/schemas/tx_info/items/properties/total_output" + fee: + $ref: "#/components/schemas/tx_info/items/properties/fee" + treasury_donation: + $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" + deposit: + $ref: "#/components/schemas/tx_info/items/properties/deposit" + invalid_before: + $ref: "#/components/schemas/tx_info/items/properties/invalid_before" + invalid_after: + $ref: "#/components/schemas/tx_info/items/properties/invalid_after" + collateral_inputs: + $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" + collateral_output: + $ref: "#/components/schemas/tx_info/items/properties/collateral_output" + reference_inputs: + $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" + inputs: + description: An array of UTxO inputs spent in the transaction + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + outputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + withdrawals: + $ref: "#/components/schemas/tx_info/items/properties/withdrawals" + assets_minted: + $ref: "#/components/schemas/tx_info/items/properties/assets_minted" + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + $ref: "#/components/schemas/tx_info/items/properties/certificates" + native_scripts: + $ref: "#/components/schemas/tx_info/items/properties/native_scripts" + plutus_contracts: + $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" + address_info: + description: Array of information for address(es) + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + balance: + type: string + description: Sum of all UTxO values beloning to address + example: 10723473983 + stake_address: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/account_history/items/properties/stake_address" + script_address: + type: boolean + description: Signifies whether the address is a script address + example: true + utxo_set: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + address_txs: + description: Array of transaction hashes + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + address_assets: + description: Array of address-owned assets + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + + account_list: + description: Array of account (stake address) IDs + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + stake_address_hex: + type: string + description: Cardano staking address (reward account) in hex format + example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf + script_hash: + type: string + description: Script hash in case the stake address is locked by a script + example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 + account_info: + description: Array of stake account information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + status: + type: string + description: Stake address status + enum: ["registered", "not registered"] + example: registered + delegated_drep: + anyOf: + - type: 'null' + - type: string + description: Account's current delegation status to DRep ID in Bech32 format + example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 + delegated_pool: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + total_balance: + type: string + description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) + example: 207116800428 + utxo: + type: string + description: Total UTxO balance of the account + example: 162764177131 + rewards: + type: string + description: Total rewards earned by the account + example: 56457728047 + withdrawals: + type: string + description: Total rewards withdrawn by the account + example: 12105104750 + rewards_available: + type: string + description: Total rewards available for withdrawal + example: 44352623297 + deposit: + type: string + description: Total deposit available for withdrawal + example: 2000000 + reserves: + type: string + description: Total reserves MIR value of the account + example: "0" + treasury: + type: string + description: Total treasury MIR value of the account + example: "0" + utxo_infos: + description: Array of complete UTxO information + type: array + items: + type: object + properties: + tx_hash: + type: string + description: Hash identifier of the transaction + example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e + tx_index: + type: number + description: Index of UTxO in the transaction + example: 0 + address: + type: string + description: A Cardano payment/base address (bech32 encoded) + example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + payment_cred: + type: + - string + - 'null' + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: + - array + - 'null' + description: An array of assets on the UTxO + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of assets on the UTxO + example: 1 + is_spent: + type: boolean + description: True if the UTXO has been spent + example: true + account_rewards: + description: Array of reward history information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + rewards: + type: array + items: + type: object + properties: + earned_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" + spendable_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" + amount: + type: string + description: Amount of rewards earned (in lovelace) + type: + type: string + description: The source of the rewards + enum: [member, leader, treasury, reserves] + example: member + pool_id: + $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + account_updates: + description: Array of account updates information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + updates: + type: array + items: + type: object + properties: + action_type: + type: string + description: Type of certificate submitted + enum: ["registration", "delegation", "withdrawal", "deregistration"] + example: "registration" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + account_addresses: + description: Array of payment addresses + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + addresses: + type: array + items: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + account_assets: + description: Array of assets owned by account + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + account_history: + description: Array of active stake values per epoch + type: array + items: + properties: + stake_address: + type: string + description: Cardano staking address (reward account) in bech32 format + example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz + history: + type: array + items: + type: object + properties: + pool_id: + type: string + description: Bech32 representation of pool ID + example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt + epoch_no: + type: number + description: Epoch number + example: 301 + active_stake: + type: string + description: Active stake amount (in lovelaces) + example: 682334162 + tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + type: number + description: UNIX timestamp of the transaction + example: 1506635091 + tx_block_index: + type: number + description: Index of transaction within block + example: 6 + tx_size: + type: number + description: Size in bytes of transaction + example: 391 + total_output: + type: string + description: Total sum of all transaction outputs (in lovelaces) + example: 157832856 + fee: + type: string + description: Total Transaction fee (in lovelaces) + example: 172761 + treasury_donation: + type: string + description: Total Donation to on-chain treasury (in lovelaces) + example: 0 + deposit: + type: string + description: Total Deposits included in transaction (for example, if it is registering a pool/key) + example: 0 + invalid_before: + type: + - string + - 'null' + description: Slot before which transaction cannot be validated (if supplied, else null) + invalid_after: + type: + - string + - 'null' + description: Slot after which transaction cannot be validated + example: 42332172 + collateral_inputs: + description: An array of collateral inputs needed for smart contracts in case of contract failure + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + collateral_output: + description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) + type: array + items: + properties: + payment_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" + stake_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: array + description: Brief asset description from ledger + reference_inputs: + description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + inputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + #description: An array of UTxO inputs spent in the transaction + outputs: + type: array + description: An array of UTxO outputs created by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + datum_hash: + type: + - string + - 'null' + description: Hash of datum (if any) connected to UTxO + example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 + inline_datum: + type: + - object + - 'null' + description: Allows datums to be attached to UTxO (CIP-32) + properties: + bytes: + type: string + description: Datum bytes (hex) + example: 19029a + value: + type: object + description: Value (json) + example: { "int": 666 } + reference_script: + type: + - object + - 'null' + description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) + properties: + hash: + type: string + description: Hash of referenced script + example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 + size: + type: number + description: Size in bytes + example: 14 + type: + type: string + description: Type of script + example: plutusV1 + bytes: + type: string + description: Script bytes (hex) + example: 4e4d01000033222220051200120011 + value: + type: + - object + - 'null' + description: Value (json) + example: 'null' + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + withdrawals: + type: + - array + - 'null' + description: Array of withdrawals with-in a transaction + items: + type: object + properties: + amount: + type: string + description: Withdrawal amount (in lovelaces) + example: 9845162 + stake_addr: + type: string + description: A Cardano staking address (reward account, bech32 encoded) + example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj + assets_minted: + type: + - array + - 'null' + description: Array of minted assets with-in a transaction + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of minted assets (negative on burn) + example: 1 + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + type: + - array + - 'null' + description: Certificates present with-in a transaction (if any) + items: + properties: + index: + type: + - number + - 'null' + description: Certificate index + example: 0 + type: + type: string + description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) + example: delegation + info: + type: + - object + - 'null' + description: A JSON array containing information from the certificate + example: + { + "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", + "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", + } + native_scripts: + type: + - array + - 'null' + description: Native scripts present in a transaction (if any) + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + script_json: + type: object + description: JSON representation of the timelock script (null for other script types) + example: + { + "type": "all", + "scripts": + [ + { + "type": "sig", + "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", + }, + { + "type": "sig", + "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", + }, + { + "type": "sig", + "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", + }, + ], + } + plutus_contracts: + type: + - array + - 'null' + description: Plutus contracts present in transaction (if any) + items: + properties: + address: + type: + - string + - 'null' + description: Plutus script address + example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 + spends_input: + type: + - object + - 'null' + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + description: Input utxo this contract spends + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + bytecode: + $ref: "#/components/schemas/script_info/items/properties/bytes" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + valid_contract: + type: boolean + description: True if the contract is valid or there is no contract + example: true + input: + type: object + properties: + redeemer: + type: object + properties: + purpose: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" + fee: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" + unit: + type: object + properties: + steps: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" + mem: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + tx_cbor: + description: Raw Transaction(s) in CBOR format + item: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + cbor: + type: string + description: CBOR encoded raw transaction. + tx_utxos: + description: Array of inputs and outputs for given transaction(s) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + inputs: + type: array + description: An array of UTxO inputs used by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + type: string + description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned + example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + outputs: + description: An array of UTxO outputs created by the transaction + allOf: + - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" + tx_metadata: + description: Array of metadata information present in each of the transactions queried + type: + - array + - 'null' + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + metadata: + type: + - object + - 'null' + description: A JSON array containing details about metadata within transaction + example: + { + "721": + { + "version": 1, + "copyright": "...", + "publisher": ["p...o"], + "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": + {}, + }, + } + tx_status: + description: Array of transaction confirmation counts + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + num_confirmations: + type: + - number + - 'null' + description: Number of block confirmations + example: 17 + tx_metalabels: + description: Array of known metadata labels + type: array + items: + properties: + key: + type: string + description: A distinct known metalabel + example: "721" + asset_list: + description: Array of policy IDs and asset names + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + asset_token_registry: + description: An array of token registry information (registered via github) for each asset + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + ticker: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" + description: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" + url: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + logo: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" + asset_addresses: + description: An array of payment addresses holding the given token (including balances) + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + type: string + description: Asset balance on the payment address + example: 23 + asset_nft_address: + description: An array of payment addresses holding the given token + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + asset_summary: + description: Array of asset summary information + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_transactions: + type: number + description: Total number of transactions including the given asset + example: 89416 + staked_wallets: + type: number + description: Total number of registered wallets holding the given asset + example: 548 + unstaked_addresses: + type: number + description: Total number of payment addresses (not belonging to registered wallets) holding the given asset + example: 245 + addresses: + type: number + description: Total number of unique addresses holding the given asset + example: 812 + asset_info: + description: Array of detailed asset information + type: array + items: + properties: + policy_id: + type: string + description: Asset Policy ID (hex) + example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff + asset_name: + type: + - string + - 'null' + description: Asset Name (hex) + example: 444f4e545350414d + asset_name_ascii: + type: string + description: Asset Name (ASCII) + example: DONTSPAM + fingerprint: + type: string + description: The CIP14 fingerprint of the asset + example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 + minting_tx_hash: + type: string + description: Hash of the latest mint transaction (with metadata if found for asset) + example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 + total_supply: + type: string + description: Total supply for the asset + example: "35000" + mint_cnt: + type: number + description: Count of total mint transactions + example: 1 + burn_cnt: + type: number + description: Count of total burn transactions + example: 5 + creation_time: + type: number + description: UNIX timestamp of the first asset mint + example: 1506635091 + minting_tx_metadata: + allOf: + - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + description: Latest minting transaction metadata (aligns with CIP-25) + token_registry_metadata: + type: + - object + - 'null' + description: Asset metadata registered on the Cardano Token Registry + properties: + name: + type: string + example: Rackmob + description: + type: string + example: Metaverse Blockchain Cryptocurrency. + ticker: + type: string + example: MOB + url: + type: string + example: https://www.rackmob.com/ + logo: + type: string + description: A PNG image file as a byte string + example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc + decimals: + type: number + example: 0 + cip68_metadata: + type: + - object + - 'null' + description: CIP 68 metadata if present for asset + example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} + asset_history: + description: Array of asset mint/burn history + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_txs: + type: + - array + - 'null' + description: Array of all mint/burn transactions for an asset + items: + type: object + properties: + tx_hash: + type: string + description: Hash of minting/burning transaction + example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + quantity: + type: string + description: Quantity minted/burned (negative numbers indicate burn transactions) + example: "-10" + metadata: + type: array + description: Array of Transaction Metadata for given transaction + items: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + policy_asset_addresses: + description: Array of asset names and payment addresses for the given policy (including balances) + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + policy_asset_info: + description: Array of detailed information of assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + token_registry_metadata: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" + policy_asset_mints: + description: Array of mint information for assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + policy_asset_list: + description: Array of brief information of assets under the same policy + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + drep_info: + description: Get detailed information about requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + type: string + description: DRep ID in bech32 format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + hex: + type: string + description: DRep ID in hex format + example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 + has_script: + type: boolean + description: Flag which shows if this DRep credentials are a script hash + example: false + registered: + type: boolean + description: Flag to show if the DRep is currently registered + example: false + deposit: + type: + - string + - 'null' + description: DRep's registration deposit in lovelace + example: 500000000 + active: + type: boolean + description: Flag to show if the DRep is (i.e. not expired) + example: true + expires_epoch_no: + type: + - number + - 'null' + description: After which epoch DRep is considered inactive. + example: 410 + amount: + type: string + description: The total amount of voting power this DRep is delegated. + example: 599496769641 + drep_list: + description: List of all active delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + has_script: + $ref: "#/components/schemas/drep_info/items/properties/has_script" + registered: + $ref: "#/components/schemas/drep_info/items/properties/registered" + drep_metadata: + description: List metadata for requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + url: + type: string + description: A URL to a JSON payload of metadata + example: "https://hornan7.github.io/Vote_Context.jsonld" + hash: + type: string + description: A hash of the contents of the metadata URL + example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d + json: + type: object + description: The payload as JSON + example: + {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} + bytes: + type: string + description: The raw bytes of the payload + example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d + warning: + type: string + description: A warning that occured while validating the metadata + language: + type: string + description: The language described in the context of the metadata as per CIP-100 + example: en-us + comment: + type: string + description: Comment attached to the metadata + is_valid: + type: boolean + description: Indicate whether data is invalid + example: true + drep_updates: + description: List of updates for requested (or all) delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + type: string + description: The index of this certificate within the the transaction. + example: 1 + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + action: + type: string + description: Effective action for this DRep Update certificate + enum: ["updated","registered","deregistered"] + example: registered + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + drep_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + vote: + type: string + enum: ["Yes","No","Abstain"] + description: Actual Vote casted + example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + committee_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + proposal_list: + description: List of all votes cast on specified governance action + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + proposal_type: + type: string + enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] + description: Proposal Action Type + example: ParameterChange + proposal_description: + type: string + description: Description for Proposal Action + example: '{"tag": "InfoAction"}' + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + return_address: + type: string + description: The StakeAddress index of the reward address to receive the deposit when it is repaid. + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + proposed_epoch: + type: number + description: Shows the epoch at which this governance action was proposed. + example: 660 + ratified_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been ratified at the specfied epoch. + example: 670 + enacted_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been enacted at the specfied epoch. + example: 675 + dropped_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. + example: 680 + expired_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been expired at the specfied epoch. + example: 680 + expiration: + type: + - number + - 'null' + description: Shows the epoch at which this governance action is expected to expire. + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + meta_comment: + $ref: "#/components/schemas/drep_metadata/items/properties/comment" + meta_language: + $ref: "#/components/schemas/drep_metadata/items/properties/language" + meta_is_valid: + $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" + withdrawal: + type: + - object + - 'null' + description: If not null, the amount withdrawn from treasury into stake address by this this proposal + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + example: "31235800000" + param_proposal: + description: If not null, the proposed new parameter set + type: + - object + - 'null' + example: {"id": 15, "key": null, "entropy": null, "epoch_no": null, "influence": null, "max_epoch": null, "min_fee_a": null, "min_fee_b": null, "price_mem": null, "price_step": null, "key_deposit": 1000000, "max_bh_size": null, "max_tx_size": null, "drep_deposit": null, "max_val_size": null, "pool_deposit": null, "cost_model_id": null, "drep_activity": null, "max_tx_ex_mem": null, "min_pool_cost": null, "max_block_size": null, "min_utxo_value": null, "protocol_major": null, "protocol_minor": null, "max_tx_ex_steps": null, "decentralisation": null, "max_block_ex_mem": null, "registered_tx_id": 12270, "dvt_p_p_gov_group": null, "collateral_percent": null, "committee_min_size": null, "gov_action_deposit": null, "max_block_ex_steps": null, "optimal_pool_count": null, "coins_per_utxo_size": null, "gov_action_lifetime": null, "dvt_committee_normal": null, "monetary_expand_rate": null, "pvt_committee_normal": null, "pvtpp_security_group": null, "treasury_growth_rate": null, "dvt_p_p_network_group": null, "max_collateral_inputs": null, "dvt_p_p_economic_group": null, "dvt_p_p_technical_group": null, "dvt_treasury_withdrawal": null, "dvt_hard_fork_initiation": null, "dvt_motion_no_confidence": null, "pvt_hard_fork_initiation": null, "pvt_motion_no_confidence": null, "committee_max_term_length": null, "dvt_update_to_constitution": null, "dvt_committee_no_confidence": null, "pvt_committee_no_confidence": null, "min_fee_ref_script_cost_per_byte": null} + proposal_votes: + type: array + description: List of all votes cast on specified governance action + items: + properties: + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + voter_role: + type: string + description: The role of the voter + enum: ["ConstitutionalCommittee", "DRep", "SPO"] + example: DRep + voter: + type: string + description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + voter_hex: + type: string + description: Voter's DRep ID , pool ID or committee hash in hex format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + vote: + $ref: "#/components/schemas/drep_votes/items/properties/vote" + + script_info: + type: array + items: + description: Array of information for scripts + properties: + script_hash: + type: string + description: Hash of a script + example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af + creation_tx_hash: + type: string + description: Hash of the script creation transaction + example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe + type: + type: string + description: Type of the script + enum: ["plutusV1","plutusV2","timelock","multisig"] + example: plutusV1 + value: + type: + - object + - 'null' + description: Data in JSON format + example: 'null' + bytes: + type: + - string + - 'null' + description: Script bytes (cborSeq) + example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 + size: + type: number + description: The size of the CBOR serialised script (in bytes) + example: 2039 + script_list: + description: List of script and creation tx hash pairs + type: array + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + type: + $ref: "#/components/schemas/script_info/items/properties/type" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + script_redeemers: + description: Array of all redeemers for a given script hash + type: array + items: + type: object + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + redeemers: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + unit_mem: + type: + - string + - number + - 'null' + description: The budget in Memory to run a script + example: 520448 + unit_steps: + type: + - string + - number + - 'null' + description: The budget in Cpu steps to run a script + example: 211535239 + fee: + type: string + description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices + example: 45282 + purpose: + type: string + description: What kind of validation this redeemer is used for + enum: ["spend", "mint", "cert", "reward"] + example: spend + datum_hash: + type: + - string + - 'null' + description: The Hash of the Plutus Data + example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 + datum_value: + $ref: "#/components/schemas/script_info/items/properties/value" + datum_info: + description: Array of datum information for given datum hashes + type: array + items: + type: object + properties: + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + value: + $ref: "#/components/schemas/script_info/items/properties/value" + bytes: + $ref: "#/components/schemas/script_info/items/properties/bytes" + ogmiostip: + description: Current tip of the chain, identified by a slot and a block header hash. + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method that was called in the request + example: "queryNetwork/tip" + result: + type: + - object + - 'null' + - string + - array + - number + description: Result of the query + properties: + slot: + type: number + description: Absolute slot number on chain + example: 59886800 + id: + type: string + description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) + example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" + example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} + headers: {} + responses: + NotFound: + description: The server does not recognise the combination of endpoint and parameters provided + Unauthorized: + description: Access token is missing or invalid + BadRequest: + description: The server cannot process the request due to invalid input +tags: + - name: Network + description: Query information about the network + x-tag-expanded: false + - name: Epoch + description: Query epoch-specific details + x-tag-expanded: false + - name: Block + description: Query information about particular block on chain + x-tag-expanded: false + - name: Transactions + description: Query blockchain transaction details + x-tag-expanded: false + - name: Stake Account + description: Query details about specific stake account addresses + x-tag-expanded: false + - name: Address + description: Query information about specific address(es) + x-tag-expanded: false + - name: Asset + description: Query Asset related informations + x-tag-expanded: false + - name: Governance + description: Query information about governance for network + x-tag-expanded: false + - name: Pool + description: Query information about specific pools + x-tag-expanded: false + - name: Script + description: Query information about specific scripts (Smart Contracts) + x-tag-expanded: false + - name: Ogmios + description: | + Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, + but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. + +
+
+ Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. + Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: +
+ + + ### Network + - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) + - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) + - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) + - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) + ### Ledger-State + - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) + - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) + - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) + - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) + - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) + - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) + - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) + ### Transactions + - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) + - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) + x-tag-expanded: true +security: + - [] + - bearerAuth: [] diff --git a/specs/results/koiosapi-mainnet.yaml b/specs/results/koiosapi-mainnet.yaml index eb6721a5..18e193a6 100644 --- a/specs/results/koiosapi-mainnet.yaml +++ b/specs/results/koiosapi-mainnet.yaml @@ -1,5421 +1,5427 @@ -openapi: 3.1.0 -info: - title: Koios API - contact: - name: Koios Core Team - url: https://t.me/CardanoKoios - email: general@koios.rest - license: - name: Creative Commons Attribution 4.0 International - url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE - version: v1.2.0a - description: | - Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. - - # API Usage - - The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. - - ## Vertical Filtering - - Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

- - ``` bash - curl "https://api.koios.rest/api/v1/tip" - - # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] - - curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" - - # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] - ``` - - ## Horizontal Filtering - - You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

- ``` bash - curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" - - # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, - # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] - ``` - - Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): - - |Abbreviation|In PostgreSQL|Meaning | - |------------|-------------|-------------------------------------------| - |eq |`=` |equals | - |gt |`>` |greater than | - |gte |`>=` |greater than or equal | - |lt |`<` |less than | - |lte |`<=` |less than or equal | - |neq |`<>` or `!=` |not equal | - |like |`LIKE` |LIKE operator (use * in place of %) | - |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| - |is |`IS` |checking for exact equality (null,true,false,unknown)| - |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | - |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | - |not |`NOT` |negates another operator | - |or |`OR` |logical `OR` operator | - |and |`AND` |logical `AND` operator | - - ## Pagination (offset/limit) - - When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. - - The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. - - Sounds confusing? Let's see this in practice, to hopefully make it easier. - Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range - - # content-range: 0-999/* - - ``` - - As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range - - # content-range: 1000-1499/* - - ``` - - The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. - However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. - - ## Ordering - - You can set a sorting order for returned queries against specific column(s). - Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" - - # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] - ``` - - ## Response Formats - - You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. - Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" - - # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, - # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, - # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] - - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" - - # epoch_no,epoch_slot,block_time - # 318,28491,1643607582 - # 318,28479,1643607570 - # 318,28406,1643607497 - - ``` - - ## Limits - - While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: - - - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. - - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). - - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). - - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. - - Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. - - # Authentication - - While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). - The examples across this API site already [supports authentication](/#auth), for you to use in the queries. - - # Community projects - - A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) - - x-logo: - url: "https://api.koios.rest/images/koios.png" -servers: - - url: https://api.koios.rest/api/v1 - description: Mainnet - - url: https://guild.koios.rest/api/v1 - description: Guildnet - - url: https://preview.koios.rest/api/v1 - description: Preview Network - - url: https://preprod.koios.rest/api/v1 - description: Preprod Network -paths: - - /tip: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tip" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Query Chain Tip - description: Get the tip info about the latest block seen by chain - operationId: tip - /genesis: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/genesis" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get Genesis info - description: Get the Genesis parameters used to start specific era on chain - operationId: genesis - /totals: #RPC - get: - tags: - - Network - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/totals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get historical tokenomic stats - description: >- - Get the circulating utxo, treasury, rewards, supply and reserves in - lovelace for specified epoch, all epochs if empty - operationId: totals - /param_updates: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/param_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Param Update Proposals - description: Get all parameter update proposals submitted to the chain starting Shelley era - operationId: param_updates - /cli_protocol_params: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/cli_protocol_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: CLI Protocol Parameters - description: >- - Get Current Protocol Parameters as published by cardano-cli. Note that - the output schema of this command is unfortunately fluid on cardano-node - and may vary between CLI versions/era. Accordingly, the returned output for - this endpoint is left as raw JSON (single row) and any filtering to output should - be done on client-side - operationId: cli_protocol_params - /reserve_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Reserve Withdrawals - description: List of all withdrawals from reserves against stake accounts - operationId: reserve_withdrawals - /treasury_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Treasury Withdrawals - description: List of all withdrawals from treasury against stake accounts - operationId: treasury_withdrawals - - /epoch_info: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - - $ref: "#/components/parameters/_include_next_epoch" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch Information - description: Get the epoch information, all epochs if no epoch specified - operationId: epoch_info - /epoch_params: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Protocol Parameters - description: >- - Get the protocol parameters for specific epoch, returns information - about all epochs if no epoch specified - operationId: epoch_params - /epoch_block_protocols: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_block_protocols" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Block Protocols - description: >- - Get the information about block protocol distribution in epoch - operationId: epoch_block_protocols - - /blocks: #RPC - get: - tags: - - Block - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block List - description: Get summarised details about all blocks (paginated - latest first) - operationId: blocks - /block_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/block_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Information - description: Get detailed information about a specific block - operationId: block_info - /block_txs: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions - description: Get a list of all transactions included in provided blocks - operationId: block_txs - /block_tx_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions (Detailed Info) - description: Get detailed information about transaction(s) for requested blocks - operationId: block_tx_info - - /utxo_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/utxo_refs_with_extended" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxO Info - description: Get UTxO set for requested UTxO references - operationId: utxo_info - /tx_cbor: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_cbor" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Raw Transaction (CBOR) - description: Get raw transaction(s) in CBOR format - operationId: tx_cbor - /tx_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Information - description: Get detailed information about transaction(s) - operationId: tx_info - /tx_metadata: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata - description: Get metadata information (if any) for given transaction(s) - operationId: tx_metadata - /tx_metalabels: #RPC - get: - tags: - - Transactions - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metalabels" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata Labels - description: Get a list of all transaction metalabels - operationId: tx_metalabels - /submittx: #submit-api - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/txbin" - x-code-samples: - - lang: "Shell" - source: | - # Assuming ${data} is a raw binary serialized transaction on the file-system. - # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. - curl -X POST \ - --header "Content-Type: application/cbor" \ - --data-binary @${data} https://api.koios.rest/api/v1/submittx - responses: - "202": - description: OK - content: - application/json: - schema: - description: The transaction id. - type: string - format: hex - minLength: 64 - maxLength: 64 - example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f - "400": - description: An error occured while submitting transaction. - summary: Submit Transaction - description: Submit an already serialized transaction to the network. - operationId: submittx - /tx_status: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_status" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Status - description: Get the number of block confirmations for a given transaction hash list - operationId: tx_status - /tx_utxos: #RPC - post: - tags: - - Transactions - deprecated: true - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_utxos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction UTxOs - description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. - operationId: tx_utxos - - /address_info: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Information - description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses - operationId: address_info - /address_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address UTXOs - description: Get UTxO set for given addresses - operationId: address_utxos - /credential_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_utxos" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs from payment credentials - description: Get UTxO details for requested payment credentials - operationId: credential_utxos - /address_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/address_txs" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Transactions - description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) - operationId: address_txs - /credential_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_txs" - responses: - "200": - description: Array of transaction hashes for given credential(s) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transactions from payment credentials - description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) - operationId: credential_txs - /address_assets: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Assets - description: Get the list of all the assets (policy, name and quantity) for given addresses - operationId: address_assets - - /account_list: #RPC - get: - tags: - - Stake Account - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account List - description: Get a list of all stake addresses that have atleast 1 transaction - operationId: account_list - /account_info: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information - description: Get the account information for given stake addresses - operationId: account_info - /account_info_cached: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information (Cached) - description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) - operationId: account_info_cached - /account_utxos: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs for stake addresses (accounts) - description: Get a list of all UTxOs for given stake addresses (account)s - operationId: account_utxos - /account_txs: #RPC - get: - tags: - - Stake Account - parameters: - - $ref: "#/components/parameters/_stake_address" - - $ref: "#/components/parameters/_after_block_height" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Txs - description: Get a list of all Txs for a given stake address (account) - operationId: account_txs - /account_rewards: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_rewards" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Rewards - description: >- - Get the full rewards history (including MIR) for given stake addresses - operationId: account_rewards - /account_updates: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Updates - description: >- - Get the account updates (registration, deregistration, delegation and - withdrawals) for given stake addresses - operationId: account_updates - /account_addresses: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Addresses - description: Get all addresses associated with given staking accounts - operationId: account_addresses - /account_assets: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Assets - description: Get the native asset balance for a given stake address - operationId: account_assets - /account_history: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account History - description: Get the staking history of given stake addresses (accounts) - operationId: account_history - - /asset_list: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset List - description: Get the list of all native assets (paginated) - operationId: asset_list - /policy_asset_list: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of brief information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset List - description: Get the list of asset under the given policy (including balances) - operationId: policy_asset_list - /asset_token_registry: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_token_registry" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Token Registry - description: Get a list of assets registered via token registry on github - operationId: asset_token_registry - /asset_info: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list" - responses: - "200": - description: Array of detailed asset information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Information (Bulk) - description: Get the information of a list of assets including first minting & token registry metadata - operationId: asset_info - /asset_utxos: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset UTXOs - description: Get the UTXO information of a list of assets including - operationId: asset_utxos - /asset_history: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset mint/burn history - content: - application/json: - schema: - $ref: "#/components/schemas/asset_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset History - description: Get the mint/burn history of an asset - operationId: asset_history - /asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Addresses - description: Get the list of all addresses holding a given asset

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: asset_addresses - /asset_nft_address: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy_nft" - - $ref: "#/components/parameters/_asset_name_nft" - responses: - "200": - description: Payment addresses currently holding the given NFT - content: - application/json: - schema: - $ref: "#/components/schemas/asset_nft_address" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: NFT Address - description: Get the address where specified NFT currently reside on. - operationId: asset_nft_address - /policy_asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of asset names and payment addresses for the given policy (including balances) - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Address List - description: Get the list of addresses with quantity for each asset on the given policy

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: policy_asset_addresses - /policy_asset_info: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of detailed information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Information - description: Get the information for all assets under the same policy - operationId: policy_asset_info - /policy_asset_mints: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Get a list of mint or burn count details for all assets minted under a policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_mints" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Mints - description: Get a list of mint or burn count details for all assets minted under a policy - operationId: policy_asset_mints - /asset_summary: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset summary information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_summary" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Summary - description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) - operationId: asset_summary - /asset_txs: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - - $ref: "#/components/parameters/_after_block_height" - - $ref: "#/components/parameters/_history" - responses: - "200": - description: An array of Tx hashes that included the given asset (latest first) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Transactions - description: Get the list of current or all asset transaction hashes (newest first) - operationId: asset_txs - - /drep_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps List - description: List of all active delegated representatives (DReps) - operationId: drep_list - /drep_info: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Info - description: Get detailed information about requested delegated representatives (DReps) - operationId: drep_info - /drep_metadata: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Metadata - description: List metadata for requested delegated representatives (DReps) - operationId: drep_metadata - /drep_updates: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Updates - description: List of updates for requested (or all) delegated representatives (DReps) - operationId: drep_updates - /drep_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Votes - description: List of all votes casted by requested delegated representative (DRep) - operationId: drep_votes - /committee_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_committee_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Committee Votes - description: List of all votes casted by given committee member or collective - operationId: committee_votes - /proposal_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/proposal_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposals List - description: List of all governance proposals - operationId: proposal_list - /proposal_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_tx_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposal Votes - description: List of all votes cast on specified governance action - operationId: proposal_votes - - /pool_list: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool List - description: List of brief info for all pools - operationId: pool_list - /pool_info: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Information - description: Current pool statuses and details for a specified list of pool ids - operationId: pool_info - /pool_stake_snapshot: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_snapshot" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake Snapshot - description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation - operationId: pool_stake_snapshot - /pool_delegators: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators List - description: Return information about live delegators for a given pool. - operationId: pool_delegators - /pool_delegators_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators History - description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). - operationId: pool_delegators_history - /pool_blocks: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Blocks - description: >- - Return information about blocks minted by a given pool for all epochs - (or _epoch_no if provided) - operationId: pool_blocks - /pool_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_history_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake, Block and Reward History - description: >- - Return information about pool stake, block and reward history in a given epoch _epoch_no - (or all epochs that pool existed for, in descending order if no _epoch_no was provided) - operationId: pool_history - /pool_updates: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Updates (History) - description: Return all pool updates for all pools or only updates for specific pool if specified - operationId: pool_updates - /pool_registrations: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Registrations - description: Return all pool registrations initiated in the requested epoch - operationId: pool_registrations - /pool_retirements: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Retirements - description: Return all pool retirements initiated in the requested epoch - operationId: pool_retirements - /pool_relays: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_relays" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Relays - description: A list of registered relays for all pools - operationId: pool_relays - /pool_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Votes - description: List of all votes casted by a pool - operationId: pool_votes - /pool_metadata: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Metadata - description: Metadata (on & off-chain) for all pools - operationId: pool_metadata - - /script_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/script_hashes" - responses: - "200": - description: Array of information for scripts requested - content: - application/json: - schema: - $ref: "#/components/schemas/script_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Information - description: List of script information for given script hashes - operationId: script_info - /native_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of native script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Native Script List - description: List of all existing native script hashes along with their creation transaction hashes - operationId: native_script_list - /plutus_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of Plutus script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Plutus Script List - description: List of all existing Plutus script hashes along with their creation transaction hashes - operationId: plutus_script_list - /script_redeemers: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - responses: - "200": - description: Array of all redeemers for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/script_redeemers" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Redeemers - description: List of all redeemers for a given script hash - operationId: script_redeemers - /script_utxos: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - - $ref: "#/components/parameters/_extended" - responses: - "200": - description: List of UTXOs for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script UTXOs - description: List of all UTXOs for a given script hash - operationId: script_utxos - /datum_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/datum_hashes" - responses: - "200": - description: Array of datum information for given datum hashes - content: - application/json: - schema: - $ref: "#/components/schemas/datum_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Datum Information - description: List of datum information for given datum hashes - operationId: datum_info - - /ogmios: #ogmios-api - post: - tags: - - Ogmios - requestBody: - $ref: "#/components/requestBodies/ogmios" - responses: - "200": - description: Current tip of the chain, identified by a slot and a block header hash. - content: - application/json: - schema: - $ref: "#/components/schemas/ogmiostip" - "400": - $ref: "#/components/responses/BadRequest" - summary: Query Example - description: | - Query the current tip of the Network. - -
-
- We do support transparent forwarding for various methods from Ogmios, you can read about those here. -
- operationId: ogmios - -components: - parameters: - _after_block_height: - deprecated: false - name: _after_block_height - description: Block height for specifying time delta - schema: - type: number - example: 50000 - in: query - required: false - allowEmptyValue: true - _epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "320" - in: query - required: false - allowEmptyValue: true - _stake_address: - deprecated: false - name: _stake_address - description: Cardano staking address (reward account) in bech32 format - schema: - type: string - example: "stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz" - in: query - required: true - allowEmptyValue: false - _tx_hash: - deprecated: false - name: _tx_hash - description: Transaction Hash in hexadecimal format (hex) - example: "f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e" - schema: - type: string - in: query - required: true - allowEmptyValue: false - _asset_policy: - deprecated: false - name: _asset_policy - description: Asset Policy ID in hexadecimal format (hex) - schema: - type: string - example: "750900e4999ebe0d58f19b634768ba25e525aaf12403bfe8fe130501" - in: query - required: true - allowEmptyValue: false - _asset_name: - deprecated: false - name: _asset_name - description: Asset Name in hexadecimal format (hex), empty asset name returns royalties - schema: - type: string - example: "424f4f4b" - in: query - required: false - allowEmptyValue: true - _asset_policy_nft: - deprecated: false - name: _asset_policy - description: NFT Policy ID in hexadecimal format (hex) - schema: - type: string - example: "f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a" - in: query - required: true - allowEmptyValue: false - _asset_name_nft: - deprecated: false - name: _asset_name - description: NFT Name in hexadecimal format (hex) - schema: - type: string - example: "68616e646c65" - in: query - required: false - allowEmptyValue: true - _drep_id: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3" - in: query - required: true - allowEmptyValue: false - _drep_id_optional: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3" - in: query - required: false - allowEmptyValue: true - _committee_hash: - deprecated: false - name: _committee_hash - description: Committee hash in hexadecimal format (hex) - schema: - type: string - example: "49fa008218cd619afe6aa8a1a93303f242440722b314f36bda2c2e23" - in: query - required: false - allowEmptyValue: true - _extended: - deprecated: false - name: _extended - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _history: - deprecated: false - name: _history - description: Include all historical transactions, setting to false includes only the non-empty ones - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: false - _include_next_epoch: - deprecated: false - name: _include_next_epoch - description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _pool_bech32: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format - schema: - type: string - example: "pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc" - in: query - required: true - allowEmptyValue: false - _pool_bech32_optional: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format (optional) - schema: - type: string - example: "pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc" - in: query - required: false - allowEmptyValue: true - _pool_epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "320" - in: query - required: false - allowEmptyValue: true - _script_hash: - deprecated: false - name: _script_hash - description: Script hash in hexadecimal format (hex) - schema: - type: string - example: "d8480dc869b94b80e81ec91b0abe307279311fe0e7001a9488f61ff8" - in: query - required: true - allowEmptyValue: false - requestBodies: - block_hashes: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - example: - _block_hashes: - - fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30 - - 60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a - - c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015 - description: Array of block hashes - block_tx_info: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _block_hashes: - - fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30 - - 60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a - - c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015 - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of block hashes - payment_addresses: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - example: - _addresses: - - addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv - - addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y - description: Array of Cardano payment address(es) - payment_addresses_with_extended: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _addresses: - - addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv - - addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y - _extended: true - description: Array of Cardano payment address(es) with extended flag to toggle additional fields - address_txs: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _addresses: - - addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv - - addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y - _after_block_height: 6238675 - description: Array of Cardano payment address(es) - stake_addresses_with_epoch_no: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _epoch_no: - format: integer - type: number - description: Only fetch information for a specific epoch - example: - _stake_addresses: - - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 - - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy - _epoch_no: 409 - description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by - stake_addresses_with_first_only_and_empty: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _first_only: - format: boolean - type: boolean - description: Only return the first result - _empty: - format: boolean - type: boolean - description: Include zero quantity entries - example: - _stake_addresses: - - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 - - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy - _first_only: false - _empty: false - description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs - stake_addresses_with_extended: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _stake_addresses: - - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 - - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy - _extended: true - description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns - stake_addresses: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - example: - _stake_addresses: - - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 - - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy - description: Array of Cardano stake credential(s) in bech32 format - credential_txs: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _payment_credentials: - - 025b0a8f85cb8a46e1dda3fae5d22f07e2d56abb4019a2129c5d6c52 - - 13f6870c5e4f3b242463e4dc1f2f56b02a032d3797d933816f15e555 - _after_block_height: 6238675 - description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight - credential_utxos: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _payment_credentials: - - 025b0a8f85cb8a46e1dda3fae5d22f07e2d56abb4019a2129c5d6c52 - - 13f6870c5e4f3b242463e4dc1f2f56b02a032d3797d933816f15e555 - _extended: true - description: Array of Cardano payment credential(s) in hex format - tx_ids: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - example: - _tx_hashes: - - f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e - - 0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94 - description: Array of Cardano Transaction hashes - tx_info: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _tx_hashes: - - f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e - - 0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94 - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of Cardano Transaction hashes - txbin: - content: - application/cbor: - schema: - type: string - format: binary - example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e - description: Serialised Cardano Transaction - pool_ids: - content: - application/json: - schema: - required: - - _pool_bech32_ids - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool100wj94uzf54vup2hdzk0afng4dhjaqggt7j434mtgm8v2gfvfgp - - pool102s2nqtea2hf5q0s4amj0evysmfnhrn4apyyhd4azcmsclzm96m - - pool102vsulhfx8ua2j9fwl2u7gv57fhhutc3tp6juzaefgrn7ae35wm - description: Array of Cardano pool IDs (bech32 format) - pool_ids_optional: - content: - application/json: - schema: - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool100wj94uzf54vup2hdzk0afng4dhjaqggt7j434mtgm8v2gfvfgp - - pool102s2nqtea2hf5q0s4amj0evysmfnhrn4apyyhd4azcmsclzm96m - - pool102vsulhfx8ua2j9fwl2u7gv57fhhutc3tp6juzaefgrn7ae35wm - description: Array of Cardano pool IDs (bech32 format) [Optional] - script_hashes: - content: - application/json: - schema: - type: object - properties: - _script_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano script hashes - example: - _script_hashes: - - bd2119ee2bfb8c8d7c427e8af3c35d537534281e09e23013bca5b138 - - c0c671fba483641a71bb92d3a8b7c52c90bf1c01e2b83116ad7d4536 - description: Array of Cardano script hashes - datum_hashes: - content: - application/json: - schema: - type: object - properties: - _datum_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano datum hashes - example: - _datum_hashes: - - 818ee3db3bbbd04f9f2ce21778cac3ac605802a4fcb00c8b3a58ee2dafc17d46 - - 45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0 - description: Array of Cardano datum hashes - asset_list: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - example: - _asset_list: - - ['750900e4999ebe0d58f19b634768ba25e525aaf12403bfe8fe130501','424f4f4b'] - - ['f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a','6b6f696f732e72657374'] - description: Array of array of policyID and asset names (hex) - asset_list_with_extended: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _asset_list: - - ['750900e4999ebe0d58f19b634768ba25e525aaf12403bfe8fe130501','424f4f4b'] - - ['f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a','6b6f696f732e72657374'] - _extended: true - description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns - drep_id_bulk: - content: - application/json: - schema: - required: - - _drep_ids - type: object - properties: - _drep_ids: - format: text - type: array - descriptions: Array of DRep IDs in bech32 format - items: - type: string - example: - _drep_ids: - - drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3 - - drep1s9q5uyddsvza4uk2n9wswy90n8wx9d2jmrq4zgcvlyv055007av - utxo_refs_with_extended: - content: - application/json: - schema: - required: - - _utxo_refs - type: object - properties: - _utxo_refs: - format: text - type: array - items: - type: string - description: Array of Cardano utxo references in the form "hash#index" - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _utxo_refs: - - f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e#0 - - 0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94#0 - _extended: false - description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields - ogmios: - content: - application/json: - schema: - required: - - jsonrpc - - method - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab - enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] - example: "queryNetwork/tip" - params: - type: object - description: Any parameters relevant to the specific method to be called - nullable: true - examples: - blockHeight: - description: Query the network’s highest block number. - value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } - genesisConfiguration: - description: Query the genesis configuration of a given era. - value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } - startTimeTime: - description: Query the network start time. - value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } - tip: - description: Query tip of the Network - value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } - epoch: - description: Query the current epoch of the ledger. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } - eraStart: - description: Query information regarding the beginning of the current ledger era. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } - eraSummaries: - description: Query era bounds and slot parameters details, required for proper sloting arithmetic. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } - liveStakeDistribution: - description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } - protocolParameters: - description: Query the current protocol parameters. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } - proposedProtocolParameters: - description: Query the last update proposal w.r.t. protocol parameters, if any. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } - StakePools: - description: Query the list of all stake pool identifiers currently registered and active. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } - submitTransaction: - description: Submit a signed and serialized transaction to the network. - value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } - evaluateTransaction: - description: Evaluate execution units of scripts in a well-formed transaction. - value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } - description: JSON-RPC 2.0 standard request body - securitySchemes: - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT - description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. - schemas: - tip: - description: Current tip of the chain - type: array - items: - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_no: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - genesis: - description: Array of genesis parameters used to start each era on chain - type: array - items: - properties: - networkmagic: - type: string - example: 764824073 - description: Unique network identifier for chain - networkid: - type: string - example: Mainnet - description: Network ID used at various CLI identification to distinguish between Mainnet and other networks - epochlength: - type: string - example: 432000 - description: Number of slots in an epoch - slotlength: - type: string - example: 1 - description: Duration of a single slot (in seconds) - maxlovelacesupply: - type: string - example: 45000000000000000 - description: Maximum smallest units (lovelaces) supply for the blockchain - systemstart: - type: number - description: UNIX timestamp of the first block (genesis) on chain - example: 1506203091 - activeslotcoeff: - type: string - example: 0.05 - description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" - slotsperkesperiod: - type: string - example: 129600 - description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) - maxkesrevolutions: - type: string - example: 62 - description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised - securityparam: - type: string - example: 2160 - description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) - updatequorum: - type: string - example: 5 - description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal - alonzogenesis: - type: string - example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' - description: A JSON dump of Alonzo Genesis - totals: - description: Array of supply/reserves/utxo/fees/treasury stats - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - circulation: - type: string - description: Circulating UTxOs for given epoch (in lovelaces) - example: 32081169442642320 - treasury: - type: string - description: Funds in treasury for given epoch (in lovelaces) - example: 637024173474141 - reward: - type: string - description: Rewards accumulated as of given epoch (in lovelaces) - example: 506871250479840 - supply: - type: string - description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) - example: 33228495612391330 - reserves: - type: string - description: Total Reserves yet to be unlocked on chain - example: 11771504387608670 - param_updates: - description: Array of unique param update proposals submitted on chain - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - data: - type: string - description: JSON encoded data with details about the parameter update - example: {"decentralisation": 0.9} - cli_protocol_params: - description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format - type: object - example: - { - "collateralPercentage": 150, - "maxBlockBodySize": 90112, - "maxBlockHeaderSize": 1100, - "maxCollateralInputs": 3, - "maxTxSize": 16384, - "maxValueSize": 5000, - "minPoolCost": 170000000, - "minUTxOValue": null, - "monetaryExpansion": 3.0e-3, - "poolPledgeInfluence": 0.3, - "poolRetireMaxEpoch": 18, - "protocolVersion": { - "major": 8, - "minor": 0 - }, - "...": "...", - "stakeAddressDeposit": 2000000, - "stakePoolDeposit": 500000000, - "stakePoolTargetNum": 500, - "treasuryCut": 0.2, - "txFeeFixed": 155381, - "txFeePerByte": 44, - "utxoCostPerByte": 4310 - } - reserve_withdrawals: - description: Array of withdrawals from reserves/treasury against stake accounts - type: array - items: - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - earned_epoch: - description: Epoch where amount is earned - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - spendable_epoch: - description: Epoch where the earned amount can be spent - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - pool_list: - description: Array of pool IDs and tickers - type: array - items: - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - ticker: - type: - - string - - 'null' - description: Pool ticker - example: AHL - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_history_info: - description: Array of pool history information - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch for which the pool history data is shown - example: 312 - active_stake: - type: string - description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) - example: "31235800000" - active_stake_pct: - type: number - description: Active stake for the pool, expressed as a percentage of total active stake on network - example: 13.512182543475783 - saturation_pct: - type: number - description: Saturation percentage of a pool at the time of snapshot (2 decimals) - example: 45.32 - block_cnt: - type: - - number - - 'null' - description: Number of blocks pool created in that epoch - example: 14 - delegator_cnt: - type: number - description: Number of delegators to the pool for that epoch snapshot - example: 1432 - margin: - type: number - description: Margin (decimal format) - example: 0.125 - fixed_cost: - type: string - description: Pool fixed cost per epoch (in lovelaces) - example: "340000000" - pool_fees: - type: string - description: Total amount of fees earned by pool owners in that epoch (in lovelaces) - example: "123327382" - deleg_rewards: - type: string - description: Total amount of rewards earned by delegators in that epoch (in lovelaces) - example: "123456789123" - member_rewards: - type: string - description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) - example: "123456780123" - epoch_ros: - type: number - description: Annualized ROS (return on staking) for delegators for this epoch - example: 3.000340466 - pool_info: - description: Array of pool information - type: array - items: - type: object - properties: - pool_id_bech32: - type: string - description: Pool ID (bech32 format) - example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc - pool_id_hex: - type: string - description: Pool ID (Hex format) - example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - vrf_key_hash: - type: - - string - - 'null' - description: Pool VRF key hash - example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 - margin: - type: - - number - - 'null' - description: Margin (decimal format) - example: 0.1 - fixed_cost: - type: - - string - - 'null' - description: Pool fixed cost per epoch - example: "500000000" - pledge: - type: - - string - - 'null' - description: Pool pledge in lovelace - example: "64000000000000" - deposit: - type: - - string - - 'null' - description: Pool's registration deposit in lovelace - example: "500000000" - reward_addr: - type: - - string - - 'null' - description: Pool reward address - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - owners: - type: - - array - - 'null' - items: - type: string - description: Pool (co)owner address - example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 - relays: - type: array - items: - type: object - properties: - dns: - type: - - string - - 'null' - description: DNS name of the relay (nullable) - example: relays-new.cardano-mainnet.iohk.io - srv: - type: - - string - - 'null' - description: DNS service name of the relay (nullable) - example: biostakingpool3.hopto.org - ipv4: - type: - - string - - 'null' - description: IPv4 address of the relay (nullable) - example: "54.220.20.40" - ipv6: - type: - - string - - 'null' - description: IPv6 address of the relay (nullable) - example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf - port: - type: - - number - - 'null' - description: Port number of the relay (nullable) - example: 6000 - meta_url: - type: - - string - - 'null' - description: Pool metadata URL - example: https://pools.iohk.io/IOGP.json - meta_hash: - type: - - string - - 'null' - description: Pool metadata hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - meta_json: - type: - - object - - 'null' - properties: - name: - type: string - description: Pool name - example: Input Output Global (IOHK) - Private - ticker: - type: string - description: Pool ticker - example: IOGP - homepage: - type: string - description: Pool homepage URL - example: https://iohk.io - description: - type: string - description: Pool description - example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. - pool_status: - type: string - description: Pool status - enum: ["registered", "retiring", "retired"] - example: registered - retiring_epoch: - type: - - number - - 'null' - description: Announced retiring epoch (nullable) - example: 'null' - op_cert: - type: - - string - - 'null' - description: Pool latest operational certificate hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - op_cert_counter: - type: - - number - - 'null' - description: Pool latest operational certificate counter value - example: 8 - active_stake: - type: - - string - - 'null' - description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) - example: "64328627680963" - sigma: - type: - - number - - 'null' - description: Pool relative active stake share - example: 0.0034839235 - block_count: - type: - - number - - 'null' - description: Total pool blocks on chain - example: 4509 - live_pledge: - type: - - string - - 'null' - description: Summary of account balance for all pool owner's - example: "64328594406327" - live_stake: - type: - - string - - 'null' - description: Pool live stake - example: "64328627680963" - live_delegators: - type: number - description: Pool live delegator count - example: 5 - live_saturation: - type: - - number - - 'null' - description: Pool live saturation (decimal format) - example: 94.52 - pool_snapshot: - type: array - items: - description: Array of pool stake information for 3 snapshots - type: object - properties: - snapshot: - type: string - description: Type of snapshot ("Mark", "Set" or "Go") - example: "Mark" - epoch_no: - type: number - description: Epoch number for the snapshot entry - example: 324 - nonce: - $ref: "#/components/schemas/epoch_params/items/properties/nonce" - pool_stake: - type: string - description: Pool's Active Stake for the given epoch - example: "100000000000" - active_stake: - type: string - description: Total Active Stake for the given epoch - example: "103703246364020" - pool_delegators: - description: Array of live pool delegators - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - description: Current delegator live stake (in lovelace) - example: 64328591517480 - active_epoch_no: - type: number - description: Epoch number in which the delegation becomes active - example: 324 - latest_delegation_tx_hash: - type: string - description: Latest transaction hash used for delegation by the account - example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 - pool_registrations: - description: Array of pool registrations/retirements - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - pool_delegators_history: - description: Array of pool delegators (historical) - type: - - array - - 'null' - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - epoch_no: - type: number - description: Epoch number for the delegation history - example: 324 - pool_blocks: - description: Array of blocks created by pool - type: array - items: - type: object - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_updates: - description: Array of historical pool updates - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - type: - - number - - 'null' - description: Epoch number in which the update becomes active - example: 324 - vrf_key_hash: - $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - update_type: - type: string - description: Type of update task - enum: ["registration", "deregistration"] - example: registered - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_relays: - description: Array of pool relay information - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - pool_metadata: - description: Array of pool metadata - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - epoch_info: - description: Array of detailed summary for each epoch - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - out_sum: - type: string - description: Total output value across all transactions in epoch - example: 15432725054364942 - fees: - type: string - description: Total fees incurred by transactions in epoch - example: 74325855210 - tx_count: - type: number - description: Number of transactions submitted in epoch - example: 357919 - blk_count: - type: number - description: Number of blocks created in epoch - example: 17321 - start_time: - type: number - description: UNIX timestamp of the epoch start - example: 1506203091 - end_time: - type: number - description: UNIX timestamp of the epoch end - example: 1506635091 - first_block_time: - type: number - description: UNIX timestamp of the epoch's first block - example: 1506635091 - last_block_time: - type: number - description: UNIX timestamp of the epoch's last block - example: 1506635091 - active_stake: - type: - - string - - 'null' - description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) - example: 23395112387185880 - total_rewards: - type: - - string - - 'null' - description: Total rewards earned in epoch (null for pre-Shelley epochs) - example: 252902897534230 - avg_blk_reward: - type: - - string - - 'null' - description: Average block reward for epoch (null for pre-Shelley epochs) - example: 660233450 - epoch_params: - description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - min_fee_a: - type: - - number - - 'null' - description: The 'a' parameter to calculate the minimum transaction fee - example: 44 - min_fee_b: - type: - - number - - 'null' - description: The 'b' parameter to calculate the minimum transaction fee - example: 155381 - max_block_size: - type: - - number - - 'null' - description: The maximum block size (in bytes) - example: 65536 - max_tx_size: - type: - - number - - 'null' - description: The maximum transaction size (in bytes) - example: 16384 - max_bh_size: - type: - - number - - 'null' - description: The maximum block header size (in bytes) - example: 1100 - key_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake address - example: 2000000 - pool_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake pool - example: 500000000 - max_epoch: - type: - - number - - 'null' - description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for - example: 18 - optimal_pool_count: - type: - - number - - 'null' - description: The optimal number of stake pools - example: 500 - influence: - type: - - number - - 'null' - format: double - description: The pledge influence on pool rewards - example: 0.3 - monetary_expand_rate: - type: - - number - - 'null' - format: double - description: The monetary expansion rate - example: 0.003 - treasury_growth_rate: - type: - - number - - 'null' - format: double - description: The treasury growth rate - example: 0.2 - decentralisation: - type: - - number - - 'null' - format: double - description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) - example: 0.1 - extra_entropy: - type: - - string - - 'null' - description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool - example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa - protocol_major: - type: - - number - - 'null' - description: The protocol major version - example: 5 - protocol_minor: - type: - - number - - 'null' - description: The protocol minor version - example: 0 - min_utxo_value: - type: - - string - - 'null' - description: The minimum value of a UTxO entry - example: 34482 - min_pool_cost: - type: - - string - - 'null' - description: The minimum pool cost - example: 340000000 - nonce: - type: - - string - - 'null' - description: The nonce value for this epoch - example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 - block_hash: - type: string - description: The hash of the first block where these parameters are valid - example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 - cost_models: - type: - - object - - 'null' - description: The per language cost model in JSON - example: 'null' - price_mem: - type: - - number - - 'null' - format: double - description: The per word cost of script memory usage - example: 0.0577 - price_step: - type: - - number - - 'null' - format: double - description: The cost of script execution step usage - example: 7.21e-05 - max_tx_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single transaction - example: 10000000 - max_tx_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single transaction - example: 10000000000 - max_block_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single block - example: 50000000 - max_block_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single block - example: 40000000000 - max_val_size: - type: - - number - - 'null' - description: The maximum Val size - example: 5000 - collateral_percent: - type: - - number - - 'null' - description: The percentage of the tx fee which must be provided as collateral when including non-native scripts - example: 150 - max_collateral_inputs: - type: - - number - - 'null' - description: The maximum number of collateral inputs allowed in a transaction - example: 3 - coins_per_utxo_size: - type: - - string - - 'null' - description: The cost per UTxO size - example: 34482 - pvt_motion_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for motion of no-confidence. - example: 0.6 - pvt_committee_normal: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (normal state). - example: 0.65 - pvt_committee_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (state of no-confidence). - example: 0.65 - pvt_hard_fork_initiation: - type: - - number - - 'null' - description: Pool Voting threshold for hard-fork initiation. - example: 0.51 - dvt_motion_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for motion of no-confidence. - example: 0.67 - dvt_committee_normal: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (normal state). - example: 0.67 - dvt_committee_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (state of no-confidence). - example: 0.65 - dvt_update_to_constitution: - type: - - number - - 'null' - description: DRep Vote threshold for update to the Constitution. - example: 0.75 - dvt_hard_fork_initiation: - type: - - number - - 'null' - description: DRep Vote threshold for hard-fork initiation. - example: 0.6 - dvt_p_p_network_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, network group. - example: 0.67 - dvt_p_p_economic_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, economic group. - example: 0.67 - dvt_p_p_technical_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, technical group. - example: 0.67 - dvt_p_p_gov_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, governance group. - example: 0.75 - dvt_treasury_withdrawal: - type: - - number - - 'null' - description: DRep Vote threshold for treasury withdrawal. - example: 0.67 - committee_min_size: - type: - - number - - 'null' - description: Minimal constitutional committee size. - example: 5 - committee_max_term_length: - type: - - number - - 'null' - description: Constitutional committee term limits. - example: 146 - gov_action_lifetime: - type: - - number - - 'null' - description: Governance action expiration. - example: 14 - gov_action_deposit: - type: - - string - - 'null' - description: Governance action deposit. - example: 100000000000 - drep_deposit: - type: - - string - - 'null' - description: DRep deposit amount. - example: 500000000 - drep_activity: - type: - - number - - 'null' - description: DRep activity period. - example: 20 - pvtpp_security_group: - type: - - number - - 'null' - description: Pool Voting threshold for protocol parameter changes, security group. - example: 0.6 - min_fee_ref_script_cost_per_byte: - type: - - number - - 'null' - description: Minimum Fee for Reference Script cost pre byte - example: 15 - epoch_block_protocols: - description: Array of distinct block protocol versions counts in epoch - type: array - items: - properties: - proto_major: - type: number - description: Protocol major version - example: 6 - proto_minor: - type: number - description: Protocol major version - example: 2 - blocks: - type: number - description: Amount of blocks with specified major and protocol combination - example: 2183 - blocks: - description: Array of block information - type: array - items: - type: object - properties: - hash: - type: string - description: Hash of the block - example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f - epoch_no: - type: number - description: Epoch number of the block - example: 117 - abs_slot: - type: number - description: Absolute slot number of the block - example: 49073930 - epoch_slot: - type: number - description: Slot number of the block in epoch - example: 171530 - block_height: - type: - - number - - 'null' - description: Block height - example: 1794506 - block_size: - type: number - description: Block size in bytes - example: 2433 - block_time: - type: number - description: UNIX timestamp of the block - example: 1704757130 - tx_count: - type: number - description: Number of transactions in the block - example: 2 - vrf_key: - type: string - description: VRF key of the block producer - example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" - pool: - type: - - string - - 'null' - description: Pool ID in bech32 format (null for pre-Shelley blocks) - example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v - op_cert_counter: - type: number - description: Counter value of the operational certificate used to create this block - example: 5 - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - parent_hash: - type: string - description: Previous Hash of the current block - example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 - block_info: - description: Array of detailed block information - type: array - items: - type: object - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_size: - $ref: "#/components/schemas/blocks/items/properties/block_size" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - tx_count: - $ref: "#/components/schemas/blocks/items/properties/tx_count" - vrf_key: - $ref: "#/components/schemas/blocks/items/properties/vrf_key" - op_cert: - type: string - description: Hash of the block producers' operational certificate - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - op_cert_counter: - $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" - pool: - $ref: "#/components/schemas/blocks/items/properties/pool" - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - total_output: - type: - - string - - 'null' - description: Total output of the block (in lovelace) - example: 92384672389 - total_fees: - type: - - string - - 'null' - description: Total fees of the block (in lovelace) - example: 2346834 - num_confirmations: - type: number - description: Number of confirmations for the block - example: 664275 - parent_hash: - type: string - description: Hash of the parent of this block - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - child_hash: - type: string - description: Hash of the child of this block (if present) - example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" - block_txs: - description: Array of transactions hashes - type: array - items: - type: object - properties: - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - block_tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" - tx_block_index: - $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" - tx_size: - $ref: "#/components/schemas/tx_info/items/properties/tx_size" - total_output: - $ref: "#/components/schemas/tx_info/items/properties/total_output" - fee: - $ref: "#/components/schemas/tx_info/items/properties/fee" - treasury_donation: - $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" - deposit: - $ref: "#/components/schemas/tx_info/items/properties/deposit" - invalid_before: - $ref: "#/components/schemas/tx_info/items/properties/invalid_before" - invalid_after: - $ref: "#/components/schemas/tx_info/items/properties/invalid_after" - collateral_inputs: - $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" - collateral_output: - $ref: "#/components/schemas/tx_info/items/properties/collateral_output" - reference_inputs: - $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" - inputs: - description: An array of UTxO inputs spent in the transaction - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - outputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - withdrawals: - $ref: "#/components/schemas/tx_info/items/properties/withdrawals" - assets_minted: - $ref: "#/components/schemas/tx_info/items/properties/assets_minted" - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - $ref: "#/components/schemas/tx_info/items/properties/certificates" - native_scripts: - $ref: "#/components/schemas/tx_info/items/properties/native_scripts" - plutus_contracts: - $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" - address_info: - description: Array of information for address(es) - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - balance: - type: string - description: Sum of all UTxO values beloning to address - example: 10723473983 - stake_address: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/account_history/items/properties/stake_address" - script_address: - type: boolean - description: Signifies whether the address is a script address - example: true - utxo_set: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - address_txs: - description: Array of transaction hashes - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - address_assets: - description: Array of address-owned assets - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - - account_list: - description: Array of account (stake address) IDs - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - stake_address_hex: - type: string - description: Cardano staking address (reward account) in hex format - example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf - script_hash: - type: string - description: Script hash in case the stake address is locked by a script - example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 - account_info: - description: Array of stake account information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - status: - type: string - description: Stake address status - enum: ["registered", "not registered"] - example: registered - delegated_drep: - anyOf: - - type: 'null' - - type: string - description: Account's current delegation status to DRep ID in Bech32 format - example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 - delegated_pool: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - total_balance: - type: string - description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) - example: 207116800428 - utxo: - type: string - description: Total UTxO balance of the account - example: 162764177131 - rewards: - type: string - description: Total rewards earned by the account - example: 56457728047 - withdrawals: - type: string - description: Total rewards withdrawn by the account - example: 12105104750 - rewards_available: - type: string - description: Total rewards available for withdrawal - example: 44352623297 - deposit: - type: string - description: Total deposit available for withdrawal - example: 2000000 - reserves: - type: string - description: Total reserves MIR value of the account - example: "0" - treasury: - type: string - description: Total treasury MIR value of the account - example: "0" - utxo_infos: - description: Array of complete UTxO information - type: array - items: - type: object - properties: - tx_hash: - type: string - description: Hash identifier of the transaction - example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e - tx_index: - type: number - description: Index of UTxO in the transaction - example: 0 - address: - type: string - description: A Cardano payment/base address (bech32 encoded) - example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - payment_cred: - type: - - string - - 'null' - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: - - array - - 'null' - description: An array of assets on the UTxO - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of assets on the UTxO - example: 1 - is_spent: - type: boolean - description: True if the UTXO has been spent - example: true - account_rewards: - description: Array of reward history information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - rewards: - type: array - items: - type: object - properties: - earned_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" - spendable_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" - amount: - type: string - description: Amount of rewards earned (in lovelace) - type: - type: string - description: The source of the rewards - enum: [member, leader, treasury, reserves] - example: member - pool_id: - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - account_updates: - description: Array of account updates information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - updates: - type: array - items: - type: object - properties: - action_type: - type: string - description: Type of certificate submitted - enum: ["registration", "delegation", "withdrawal", "deregistration"] - example: "registration" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - account_addresses: - description: Array of payment addresses - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - addresses: - type: array - items: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - account_assets: - description: Array of assets owned by account - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - account_history: - description: Array of active stake values per epoch - type: array - items: - properties: - stake_address: - type: string - description: Cardano staking address (reward account) in bech32 format - example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz - history: - type: array - items: - type: object - properties: - pool_id: - type: string - description: Bech32 representation of pool ID - example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt - epoch_no: - type: number - description: Epoch number - example: 301 - active_stake: - type: string - description: Active stake amount (in lovelaces) - example: 682334162 - tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - type: number - description: UNIX timestamp of the transaction - example: 1506635091 - tx_block_index: - type: number - description: Index of transaction within block - example: 6 - tx_size: - type: number - description: Size in bytes of transaction - example: 391 - total_output: - type: string - description: Total sum of all transaction outputs (in lovelaces) - example: 157832856 - fee: - type: string - description: Total Transaction fee (in lovelaces) - example: 172761 - treasury_donation: - type: string - description: Total Donation to on-chain treasury (in lovelaces) - example: 0 - deposit: - type: string - description: Total Deposits included in transaction (for example, if it is registering a pool/key) - example: 0 - invalid_before: - type: - - string - - 'null' - description: Slot before which transaction cannot be validated (if supplied, else null) - invalid_after: - type: - - string - - 'null' - description: Slot after which transaction cannot be validated - example: 42332172 - collateral_inputs: - description: An array of collateral inputs needed for smart contracts in case of contract failure - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - collateral_output: - description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) - type: array - items: - properties: - payment_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" - stake_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: array - description: Brief asset description from ledger - reference_inputs: - description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - inputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - #description: An array of UTxO inputs spent in the transaction - outputs: - type: array - description: An array of UTxO outputs created by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - datum_hash: - type: - - string - - 'null' - description: Hash of datum (if any) connected to UTxO - example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 - inline_datum: - type: - - object - - 'null' - description: Allows datums to be attached to UTxO (CIP-32) - properties: - bytes: - type: string - description: Datum bytes (hex) - example: 19029a - value: - type: object - description: Value (json) - example: { "int": 666 } - reference_script: - type: - - object - - 'null' - description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) - properties: - hash: - type: string - description: Hash of referenced script - example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 - size: - type: number - description: Size in bytes - example: 14 - type: - type: string - description: Type of script - example: plutusV1 - bytes: - type: string - description: Script bytes (hex) - example: 4e4d01000033222220051200120011 - value: - type: - - object - - 'null' - description: Value (json) - example: 'null' - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - withdrawals: - type: - - array - - 'null' - description: Array of withdrawals with-in a transaction - items: - type: object - properties: - amount: - type: string - description: Withdrawal amount (in lovelaces) - example: 9845162 - stake_addr: - type: string - description: A Cardano staking address (reward account, bech32 encoded) - example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj - assets_minted: - type: - - array - - 'null' - description: Array of minted assets with-in a transaction - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of minted assets (negative on burn) - example: 1 - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - type: - - array - - 'null' - description: Certificates present with-in a transaction (if any) - items: - properties: - index: - type: - - number - - 'null' - description: Certificate index - example: 0 - type: - type: string - description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) - example: delegation - info: - type: - - object - - 'null' - description: A JSON array containing information from the certificate - example: - { - "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", - "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", - } - native_scripts: - type: - - array - - 'null' - description: Native scripts present in a transaction (if any) - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - script_json: - type: object - description: JSON representation of the timelock script (null for other script types) - example: - { - "type": "all", - "scripts": - [ - { - "type": "sig", - "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", - }, - { - "type": "sig", - "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", - }, - { - "type": "sig", - "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", - }, - ], - } - plutus_contracts: - type: - - array - - 'null' - description: Plutus contracts present in transaction (if any) - items: - properties: - address: - type: - - string - - 'null' - description: Plutus script address - example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 - spends_input: - type: - - object - - 'null' - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - description: Input utxo this contract spends - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - bytecode: - $ref: "#/components/schemas/script_info/items/properties/bytes" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - valid_contract: - type: boolean - description: True if the contract is valid or there is no contract - example: true - input: - type: object - properties: - redeemer: - type: object - properties: - purpose: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" - fee: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" - unit: - type: object - properties: - steps: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" - mem: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - tx_cbor: - description: Raw Transaction(s) in CBOR format - item: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - cbor: - type: string - description: CBOR encoded raw transaction. - tx_utxos: - description: Array of inputs and outputs for given transaction(s) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - inputs: - type: array - description: An array of UTxO inputs used by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - type: string - description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned - example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - outputs: - description: An array of UTxO outputs created by the transaction - allOf: - - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" - tx_metadata: - description: Array of metadata information present in each of the transactions queried - type: - - array - - 'null' - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - metadata: - type: - - object - - 'null' - description: A JSON array containing details about metadata within transaction - example: - { - "721": - { - "version": 1, - "copyright": "...", - "publisher": ["p...o"], - "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": - {}, - }, - } - tx_status: - description: Array of transaction confirmation counts - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - num_confirmations: - type: - - number - - 'null' - description: Number of block confirmations - example: 17 - tx_metalabels: - description: Array of known metadata labels - type: array - items: - properties: - key: - type: string - description: A distinct known metalabel - example: "721" - asset_list: - description: Array of policy IDs and asset names - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - asset_token_registry: - description: An array of token registry information (registered via github) for each asset - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - ticker: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" - description: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" - url: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - logo: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" - asset_addresses: - description: An array of payment addresses holding the given token (including balances) - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - type: string - description: Asset balance on the payment address - example: 23 - asset_nft_address: - description: An array of payment addresses holding the given token - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - asset_summary: - description: Array of asset summary information - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_transactions: - type: number - description: Total number of transactions including the given asset - example: 89416 - staked_wallets: - type: number - description: Total number of registered wallets holding the given asset - example: 548 - unstaked_addresses: - type: number - description: Total number of payment addresses (not belonging to registered wallets) holding the given asset - example: 245 - addresses: - type: number - description: Total number of unique addresses holding the given asset - example: 812 - asset_info: - description: Array of detailed asset information - type: array - items: - properties: - policy_id: - type: string - description: Asset Policy ID (hex) - example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff - asset_name: - type: - - string - - 'null' - description: Asset Name (hex) - example: 444f4e545350414d - asset_name_ascii: - type: string - description: Asset Name (ASCII) - example: DONTSPAM - fingerprint: - type: string - description: The CIP14 fingerprint of the asset - example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 - minting_tx_hash: - type: string - description: Hash of the latest mint transaction (with metadata if found for asset) - example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 - total_supply: - type: string - description: Total supply for the asset - example: "35000" - mint_cnt: - type: number - description: Count of total mint transactions - example: 1 - burn_cnt: - type: number - description: Count of total burn transactions - example: 5 - creation_time: - type: number - description: UNIX timestamp of the first asset mint - example: 1506635091 - minting_tx_metadata: - allOf: - - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - description: Latest minting transaction metadata (aligns with CIP-25) - token_registry_metadata: - type: - - object - - 'null' - description: Asset metadata registered on the Cardano Token Registry - properties: - name: - type: string - example: Rackmob - description: - type: string - example: Metaverse Blockchain Cryptocurrency. - ticker: - type: string - example: MOB - url: - type: string - example: https://www.rackmob.com/ - logo: - type: string - description: A PNG image file as a byte string - example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc - decimals: - type: number - example: 0 - cip68_metadata: - type: - - object - - 'null' - description: CIP 68 metadata if present for asset - example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} - asset_history: - description: Array of asset mint/burn history - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_txs: - type: - - array - - 'null' - description: Array of all mint/burn transactions for an asset - items: - type: object - properties: - tx_hash: - type: string - description: Hash of minting/burning transaction - example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - quantity: - type: string - description: Quantity minted/burned (negative numbers indicate burn transactions) - example: "-10" - metadata: - type: array - description: Array of Transaction Metadata for given transaction - items: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - policy_asset_addresses: - description: Array of asset names and payment addresses for the given policy (including balances) - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - policy_asset_info: - description: Array of detailed information of assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - token_registry_metadata: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" - policy_asset_mints: - description: Array of mint information for assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - policy_asset_list: - description: Array of brief information of assets under the same policy - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - drep_info: - description: Get detailed information about requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - type: string - description: DRep ID in bech32 format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - hex: - type: string - description: DRep ID in hex format - example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 - has_script: - type: boolean - description: Flag which shows if this DRep credentials are a script hash - example: false - registered: - type: boolean - description: Flag to show if the DRep is currently registered - example: false - deposit: - type: - - string - - 'null' - description: DRep's registration deposit in lovelace - example: 500000000 - active: - type: boolean - description: Flag to show if the DRep is (i.e. not expired) - example: true - expires_epoch_no: - type: - - number - - 'null' - description: After which epoch DRep is considered inactive. - example: 410 - amount: - type: string - description: The total amount of voting power this DRep is delegated. - example: 599496769641 - drep_list: - description: List of all active delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - has_script: - $ref: "#/components/schemas/drep_info/items/properties/has_script" - registered: - $ref: "#/components/schemas/drep_info/items/properties/registered" - drep_metadata: - description: List metadata for requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - url: - type: string - description: A URL to a JSON payload of metadata - example: "https://hornan7.github.io/Vote_Context.jsonld" - hash: - type: string - description: A hash of the contents of the metadata URL - example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d - json: - type: object - description: The payload as JSON - example: - {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} - bytes: - type: string - description: The raw bytes of the payload - example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d - warning: - type: string - description: A warning that occured while validating the metadata - language: - type: string - description: The language described in the context of the metadata as per CIP-100 - example: en-us - comment: - type: string - description: Comment attached to the metadata - is_valid: - type: boolean - description: Indicate whether data is invalid - example: true - drep_updates: - description: List of updates for requested (or all) delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - type: string - description: The index of this certificate within the the transaction. - example: 1 - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - action: - type: string - description: Effective action for this DRep Update certificate - enum: ["updated","registered","deregistered"] - example: registered - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - drep_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - vote: - type: string - enum: ["Yes","No","Abstain"] - description: Actual Vote casted - example: "Yes" - pool_votes: - description: List of all votes casted by requested pool - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - committee_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - proposal_list: - description: List of all votes cast on specified governance action - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - proposal_type: - type: string - enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] - description: Proposal Action Type - example: ParameterChange - proposal_description: - type: string - description: Description for Proposal Action - example: '{"tag": "InfoAction"}' - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - return_address: - type: string - description: The StakeAddress index of the reward address to receive the deposit when it is repaid. - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - proposed_epoch: - type: number - description: Shows the epoch at which this governance action was proposed. - example: 660 - ratified_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been ratified at the specfied epoch. - example: 670 - enacted_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been enacted at the specfied epoch. - example: 675 - dropped_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. - example: 680 - expired_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been expired at the specfied epoch. - example: 680 - expiration: - type: - - number - - 'null' - description: Shows the epoch at which this governance action is expected to expire. - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - meta_comment: - $ref: "#/components/schemas/drep_metadata/items/properties/comment" - meta_language: - $ref: "#/components/schemas/drep_metadata/items/properties/language" - meta_is_valid: - $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" - withdrawal: - type: - - object - - 'null' - description: If not null, The amount withdrawn from treasury into stake address by this this proposal - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - example: "31235800000" - proposal_votes: - type: array - description: List of all votes cast on specified governance action - items: - properties: - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - voter_role: - type: string - description: The role of the voter - enum: ["ConstitutionalCommittee", "DRep", "SPO"] - example: DRep - voter: - type: string - description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - voter_hex: - type: string - description: Voter's DRep ID , pool ID or committee hash in hex format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - vote: - $ref: "#/components/schemas/drep_votes/items/properties/vote" - - script_info: - type: array - items: - description: Array of information for scripts - properties: - script_hash: - type: string - description: Hash of a script - example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af - creation_tx_hash: - type: string - description: Hash of the script creation transaction - example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe - type: - type: string - description: Type of the script - enum: ["plutusV1","plutusV2","timelock","multisig"] - example: plutusV1 - value: - type: - - object - - 'null' - description: Data in JSON format - example: 'null' - bytes: - type: - - string - - 'null' - description: Script bytes (cborSeq) - example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 - size: - type: number - description: The size of the CBOR serialised script (in bytes) - example: 2039 - script_list: - description: List of script and creation tx hash pairs - type: array - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - type: - $ref: "#/components/schemas/script_info/items/properties/type" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - script_redeemers: - description: Array of all redeemers for a given script hash - type: array - items: - type: object - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - redeemers: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - unit_mem: - type: - - string - - number - - 'null' - description: The budget in Memory to run a script - example: 520448 - unit_steps: - type: - - string - - number - - 'null' - description: The budget in Cpu steps to run a script - example: 211535239 - fee: - type: string - description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices - example: 45282 - purpose: - type: string - description: What kind of validation this redeemer is used for - enum: ["spend", "mint", "cert", "reward"] - example: spend - datum_hash: - type: - - string - - 'null' - description: The Hash of the Plutus Data - example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 - datum_value: - $ref: "#/components/schemas/script_info/items/properties/value" - datum_info: - description: Array of datum information for given datum hashes - type: array - items: - type: object - properties: - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - value: - $ref: "#/components/schemas/script_info/items/properties/value" - bytes: - $ref: "#/components/schemas/script_info/items/properties/bytes" - ogmiostip: - description: Current tip of the chain, identified by a slot and a block header hash. - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method that was called in the request - example: "queryNetwork/tip" - result: - type: - - object - - 'null' - - string - - array - - number - description: Result of the query - properties: - slot: - type: number - description: Absolute slot number on chain - example: 59886800 - id: - type: string - description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) - example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" - example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} - headers: {} - responses: - NotFound: - description: The server does not recognise the combination of endpoint and parameters provided - Unauthorized: - description: Access token is missing or invalid - BadRequest: - description: The server cannot process the request due to invalid input -tags: - - name: Network - description: Query information about the network - x-tag-expanded: false - - name: Epoch - description: Query epoch-specific details - x-tag-expanded: false - - name: Block - description: Query information about particular block on chain - x-tag-expanded: false - - name: Transactions - description: Query blockchain transaction details - x-tag-expanded: false - - name: Stake Account - description: Query details about specific stake account addresses - x-tag-expanded: false - - name: Address - description: Query information about specific address(es) - x-tag-expanded: false - - name: Asset - description: Query Asset related informations - x-tag-expanded: false - - name: Governance - description: Query information about governance for network - x-tag-expanded: false - - name: Pool - description: Query information about specific pools - x-tag-expanded: false - - name: Script - description: Query information about specific scripts (Smart Contracts) - x-tag-expanded: false - - name: Ogmios - description: | - Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, - but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. - -
-
- Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. - Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: -
- - - ### Network - - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) - - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) - - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) - - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) - ### Ledger-State - - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) - - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) - - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) - - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) - - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) - - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) - - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) - ### Transactions - - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) - - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) - x-tag-expanded: true -security: - - [] - - bearerAuth: [] +openapi: 3.1.0 +info: + title: Koios API + contact: + name: Koios Core Team + url: https://t.me/CardanoKoios + email: general@koios.rest + license: + name: Creative Commons Attribution 4.0 International + url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE + version: v1.2.0a + description: | + Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. + + # API Usage + + The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. + + ## Vertical Filtering + + Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

+ + ``` bash + curl "https://api.koios.rest/api/v1/tip" + + # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] + + curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" + + # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] + ``` + + ## Horizontal Filtering + + You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

+ ``` bash + curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" + + # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, + # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] + ``` + + Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): + + |Abbreviation|In PostgreSQL|Meaning | + |------------|-------------|-------------------------------------------| + |eq |`=` |equals | + |gt |`>` |greater than | + |gte |`>=` |greater than or equal | + |lt |`<` |less than | + |lte |`<=` |less than or equal | + |neq |`<>` or `!=` |not equal | + |like |`LIKE` |LIKE operator (use * in place of %) | + |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| + |is |`IS` |checking for exact equality (null,true,false,unknown)| + |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | + |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | + |not |`NOT` |negates another operator | + |or |`OR` |logical `OR` operator | + |and |`AND` |logical `AND` operator | + + ## Pagination (offset/limit) + + When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. + + The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. + + Sounds confusing? Let's see this in practice, to hopefully make it easier. + Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range + + # content-range: 0-999/* + + ``` + + As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range + + # content-range: 1000-1499/* + + ``` + + The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. + However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. + + ## Ordering + + You can set a sorting order for returned queries against specific column(s). + Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" + + # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] + ``` + + ## Response Formats + + You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. + Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" + + # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, + # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, + # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] + + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" + + # epoch_no,epoch_slot,block_time + # 318,28491,1643607582 + # 318,28479,1643607570 + # 318,28406,1643607497 + + ``` + + ## Limits + + While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: + + - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. + - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). + - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). + - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. + + Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. + + # Community projects + + A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) + + x-logo: + url: "https://api.koios.rest/images/koios.png" +servers: + - url: https://api.koios.rest/api/v1 + description: Mainnet + - url: https://guild.koios.rest/api/v1 + description: Guildnet + - url: https://preview.koios.rest/api/v1 + description: Preview Network + - url: https://preprod.koios.rest/api/v1 + description: Preprod Network +paths: + + /tip: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tip" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Query Chain Tip + description: Get the tip info about the latest block seen by chain + operationId: tip + /genesis: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/genesis" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get Genesis info + description: Get the Genesis parameters used to start specific era on chain + operationId: genesis + /totals: #RPC + get: + tags: + - Network + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/totals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get historical tokenomic stats + description: >- + Get the circulating utxo, treasury, rewards, supply and reserves in + lovelace for specified epoch, all epochs if empty + operationId: totals + /param_updates: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/param_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Param Update Proposals + description: Get all parameter update proposals submitted to the chain starting Shelley era + operationId: param_updates + /cli_protocol_params: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/cli_protocol_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: CLI Protocol Parameters + description: >- + Get Current Protocol Parameters as published by cardano-cli. Note that + the output schema of this command is unfortunately fluid on cardano-node + and may vary between CLI versions/era. Accordingly, the returned output for + this endpoint is left as raw JSON (single row) and any filtering to output should + be done on client-side + operationId: cli_protocol_params + /reserve_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Reserve Withdrawals + description: List of all withdrawals from reserves against stake accounts + operationId: reserve_withdrawals + /treasury_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Treasury Withdrawals + description: List of all withdrawals from treasury against stake accounts + operationId: treasury_withdrawals + + /epoch_info: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + - $ref: "#/components/parameters/_include_next_epoch" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch Information + description: Get the epoch information, all epochs if no epoch specified + operationId: epoch_info + /epoch_params: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Protocol Parameters + description: >- + Get the protocol parameters for specific epoch, returns information + about all epochs if no epoch specified + operationId: epoch_params + /epoch_block_protocols: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_block_protocols" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Block Protocols + description: >- + Get the information about block protocol distribution in epoch + operationId: epoch_block_protocols + + /blocks: #RPC + get: + tags: + - Block + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block List + description: Get summarised details about all blocks (paginated - latest first) + operationId: blocks + /block_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/block_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Information + description: Get detailed information about a specific block + operationId: block_info + /block_txs: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions + description: Get a list of all transactions included in provided blocks + operationId: block_txs + /block_tx_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions (Detailed Info) + description: Get detailed information about transaction(s) for requested blocks + operationId: block_tx_info + + /utxo_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/utxo_refs_with_extended" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxO Info + description: Get UTxO set for requested UTxO references + operationId: utxo_info + /tx_cbor: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_cbor" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Raw Transaction (CBOR) + description: Get raw transaction(s) in CBOR format + operationId: tx_cbor + /tx_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Information + description: Get detailed information about transaction(s) + operationId: tx_info + /tx_metadata: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata + description: Get metadata information (if any) for given transaction(s) + operationId: tx_metadata + /tx_metalabels: #RPC + get: + tags: + - Transactions + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metalabels" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata Labels + description: Get a list of all transaction metalabels + operationId: tx_metalabels + /submittx: #submit-api + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/txbin" + x-code-samples: + - lang: "Shell" + source: | + # Assuming ${data} is a raw binary serialized transaction on the file-system. + # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. + curl -X POST \ + --header "Content-Type: application/cbor" \ + --data-binary @${data} https://api.koios.rest/api/v1/submittx + responses: + "202": + description: OK + content: + application/json: + schema: + description: The transaction id. + type: string + format: hex + minLength: 64 + maxLength: 64 + example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f + "400": + description: An error occured while submitting transaction. + summary: Submit Transaction + description: Submit an already serialized transaction to the network. + operationId: submittx + /tx_status: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_status" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Status + description: Get the number of block confirmations for a given transaction hash list + operationId: tx_status + /tx_utxos: #RPC + post: + tags: + - Transactions + deprecated: true + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_utxos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction UTxOs + description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. + operationId: tx_utxos + + /address_info: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Information + description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses + operationId: address_info + /address_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address UTXOs + description: Get UTxO set for given addresses + operationId: address_utxos + /credential_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_utxos" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs from payment credentials + description: Get UTxO details for requested payment credentials + operationId: credential_utxos + /address_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/address_txs" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Transactions + description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) + operationId: address_txs + /credential_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_txs" + responses: + "200": + description: Array of transaction hashes for given credential(s) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transactions from payment credentials + description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) + operationId: credential_txs + /address_assets: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Assets + description: Get the list of all the assets (policy, name and quantity) for given addresses + operationId: address_assets + + /account_list: #RPC + get: + tags: + - Stake Account + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account List + description: Get a list of all stake addresses that have atleast 1 transaction + operationId: account_list + /account_info: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information + description: Get the account information for given stake addresses + operationId: account_info + /account_info_cached: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information (Cached) + description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) + operationId: account_info_cached + /account_utxos: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs for stake addresses (accounts) + description: Get a list of all UTxOs for given stake addresses (account)s + operationId: account_utxos + /account_txs: #RPC + get: + tags: + - Stake Account + parameters: + - $ref: "#/components/parameters/_stake_address" + - $ref: "#/components/parameters/_after_block_height" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Txs + description: Get a list of all Txs for a given stake address (account) + operationId: account_txs + /account_rewards: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_rewards" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Rewards + description: >- + Get the full rewards history (including MIR) for given stake addresses + operationId: account_rewards + /account_updates: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Updates + description: >- + Get the account updates (registration, deregistration, delegation and + withdrawals) for given stake addresses + operationId: account_updates + /account_addresses: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Addresses + description: Get all addresses associated with given staking accounts + operationId: account_addresses + /account_assets: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Assets + description: Get the native asset balance for a given stake address + operationId: account_assets + /account_history: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account History + description: Get the staking history of given stake addresses (accounts) + operationId: account_history + + /asset_list: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset List + description: Get the list of all native assets (paginated) + operationId: asset_list + /policy_asset_list: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of brief information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset List + description: Get the list of asset under the given policy (including balances) + operationId: policy_asset_list + /asset_token_registry: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_token_registry" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Token Registry + description: Get a list of assets registered via token registry on github + operationId: asset_token_registry + /asset_info: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list" + responses: + "200": + description: Array of detailed asset information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Information (Bulk) + description: Get the information of a list of assets including first minting & token registry metadata + operationId: asset_info + /asset_utxos: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset UTXOs + description: Get the UTXO information of a list of assets including + operationId: asset_utxos + /asset_history: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset mint/burn history + content: + application/json: + schema: + $ref: "#/components/schemas/asset_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset History + description: Get the mint/burn history of an asset + operationId: asset_history + /asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Addresses + description: Get the list of all addresses holding a given asset

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: asset_addresses + /asset_nft_address: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy_nft" + - $ref: "#/components/parameters/_asset_name_nft" + responses: + "200": + description: Payment addresses currently holding the given NFT + content: + application/json: + schema: + $ref: "#/components/schemas/asset_nft_address" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: NFT Address + description: Get the address where specified NFT currently reside on. + operationId: asset_nft_address + /policy_asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of asset names and payment addresses for the given policy (including balances) + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Address List + description: Get the list of addresses with quantity for each asset on the given policy

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: policy_asset_addresses + /policy_asset_info: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of detailed information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Information + description: Get the information for all assets under the same policy + operationId: policy_asset_info + /policy_asset_mints: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Get a list of mint or burn count details for all assets minted under a policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_mints" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Mints + description: Get a list of mint or burn count details for all assets minted under a policy + operationId: policy_asset_mints + /asset_summary: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset summary information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_summary" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Summary + description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) + operationId: asset_summary + /asset_txs: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + - $ref: "#/components/parameters/_after_block_height" + - $ref: "#/components/parameters/_history" + responses: + "200": + description: An array of Tx hashes that included the given asset (latest first) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Transactions + description: Get the list of current or all asset transaction hashes (newest first) + operationId: asset_txs + + /drep_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps List + description: List of all active delegated representatives (DReps) + operationId: drep_list + /drep_info: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Info + description: Get detailed information about requested delegated representatives (DReps) + operationId: drep_info + /drep_metadata: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Metadata + description: List metadata for requested delegated representatives (DReps) + operationId: drep_metadata + /drep_updates: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Updates + description: List of updates for requested (or all) delegated representatives (DReps) + operationId: drep_updates + /drep_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Votes + description: List of all votes casted by requested delegated representative (DRep) + operationId: drep_votes + /committee_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_committee_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Committee Votes + description: List of all votes casted by given committee member or collective + operationId: committee_votes + /proposal_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/proposal_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposals List + description: List of all governance proposals + operationId: proposal_list + /proposal_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_tx_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposal Votes + description: List of all votes cast on specified governance action + operationId: proposal_votes + + /pool_list: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool List + description: List of brief info for all pools + operationId: pool_list + /pool_info: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Information + description: Current pool statuses and details for a specified list of pool ids + operationId: pool_info + /pool_stake_snapshot: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_snapshot" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake Snapshot + description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation + operationId: pool_stake_snapshot + /pool_delegators: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators List + description: Return information about live delegators for a given pool. + operationId: pool_delegators + /pool_delegators_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators History + description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). + operationId: pool_delegators_history + /pool_blocks: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Blocks + description: >- + Return information about blocks minted by a given pool for all epochs + (or _epoch_no if provided) + operationId: pool_blocks + /pool_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_history_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake, Block and Reward History + description: >- + Return information about pool stake, block and reward history in a given epoch _epoch_no + (or all epochs that pool existed for, in descending order if no _epoch_no was provided) + operationId: pool_history + /pool_updates: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Updates (History) + description: Return all pool updates for all pools or only updates for specific pool if specified + operationId: pool_updates + /pool_registrations: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Registrations + description: Return all pool registrations initiated in the requested epoch + operationId: pool_registrations + /pool_retirements: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Retirements + description: Return all pool retirements initiated in the requested epoch + operationId: pool_retirements + /pool_relays: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_relays" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Relays + description: A list of registered relays for all pools + operationId: pool_relays + /pool_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Votes + description: List of all votes casted by a pool + operationId: pool_votes + /pool_metadata: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Metadata + description: Metadata (on & off-chain) for all pools + operationId: pool_metadata + + /script_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/script_hashes" + responses: + "200": + description: Array of information for scripts requested + content: + application/json: + schema: + $ref: "#/components/schemas/script_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Information + description: List of script information for given script hashes + operationId: script_info + /native_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of native script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Native Script List + description: List of all existing native script hashes along with their creation transaction hashes + operationId: native_script_list + /plutus_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of Plutus script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Plutus Script List + description: List of all existing Plutus script hashes along with their creation transaction hashes + operationId: plutus_script_list + /script_redeemers: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + responses: + "200": + description: Array of all redeemers for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/script_redeemers" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Redeemers + description: List of all redeemers for a given script hash + operationId: script_redeemers + /script_utxos: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + - $ref: "#/components/parameters/_extended" + responses: + "200": + description: List of UTXOs for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script UTXOs + description: List of all UTXOs for a given script hash + operationId: script_utxos + /datum_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/datum_hashes" + responses: + "200": + description: Array of datum information for given datum hashes + content: + application/json: + schema: + $ref: "#/components/schemas/datum_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Datum Information + description: List of datum information for given datum hashes + operationId: datum_info + + /ogmios: #ogmios-api + post: + tags: + - Ogmios + requestBody: + $ref: "#/components/requestBodies/ogmios" + responses: + "200": + description: Current tip of the chain, identified by a slot and a block header hash. + content: + application/json: + schema: + $ref: "#/components/schemas/ogmiostip" + "400": + $ref: "#/components/responses/BadRequest" + summary: Query Example + description: | + Query the current tip of the Network. + +
+
+ We do support transparent forwarding for various methods from Ogmios, you can read about those here. +
+ operationId: ogmios + +components: + parameters: + _after_block_height: + deprecated: false + name: _after_block_height + description: Block height for specifying time delta + schema: + type: number + example: 50000 + in: query + required: false + allowEmptyValue: true + _epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "320" + in: query + required: false + allowEmptyValue: true + _stake_address: + deprecated: false + name: _stake_address + description: Cardano staking address (reward account) in bech32 format + schema: + type: string + example: "stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz" + in: query + required: true + allowEmptyValue: false + _tx_hash: + deprecated: false + name: _tx_hash + description: Transaction Hash in hexadecimal format (hex) + example: "f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e" + schema: + type: string + in: query + required: true + allowEmptyValue: false + _asset_policy: + deprecated: false + name: _asset_policy + description: Asset Policy ID in hexadecimal format (hex) + schema: + type: string + example: "750900e4999ebe0d58f19b634768ba25e525aaf12403bfe8fe130501" + in: query + required: true + allowEmptyValue: false + _asset_name: + deprecated: false + name: _asset_name + description: Asset Name in hexadecimal format (hex), empty asset name returns royalties + schema: + type: string + example: "424f4f4b" + in: query + required: false + allowEmptyValue: true + _asset_policy_nft: + deprecated: false + name: _asset_policy + description: NFT Policy ID in hexadecimal format (hex) + schema: + type: string + example: "f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a" + in: query + required: true + allowEmptyValue: false + _asset_name_nft: + deprecated: false + name: _asset_name + description: NFT Name in hexadecimal format (hex) + schema: + type: string + example: "68616e646c65" + in: query + required: false + allowEmptyValue: true + _drep_id: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3" + in: query + required: true + allowEmptyValue: false + _drep_id_optional: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3" + in: query + required: false + allowEmptyValue: true + _committee_hash: + deprecated: false + name: _committee_hash + description: Committee hash in hexadecimal format (hex) + schema: + type: string + example: "49fa008218cd619afe6aa8a1a93303f242440722b314f36bda2c2e23" + in: query + required: false + allowEmptyValue: true + _extended: + deprecated: false + name: _extended + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _history: + deprecated: false + name: _history + description: Include all historical transactions, setting to false includes only the non-empty ones + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: false + _include_next_epoch: + deprecated: false + name: _include_next_epoch + description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _pool_bech32: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format + schema: + type: string + example: "pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc" + in: query + required: true + allowEmptyValue: false + _pool_bech32_optional: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format (optional) + schema: + type: string + example: "pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc" + in: query + required: false + allowEmptyValue: true + _pool_epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "320" + in: query + required: false + allowEmptyValue: true + _script_hash: + deprecated: false + name: _script_hash + description: Script hash in hexadecimal format (hex) + schema: + type: string + example: "d8480dc869b94b80e81ec91b0abe307279311fe0e7001a9488f61ff8" + in: query + required: true + allowEmptyValue: false + requestBodies: + block_hashes: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + example: + _block_hashes: + - fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30 + - 60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a + - c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015 + description: Array of block hashes + block_tx_info: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _block_hashes: + - fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30 + - 60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a + - c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015 + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of block hashes + payment_addresses: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + example: + _addresses: + - addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv + - addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y + description: Array of Cardano payment address(es) + payment_addresses_with_extended: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _addresses: + - addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv + - addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y + _extended: true + description: Array of Cardano payment address(es) with extended flag to toggle additional fields + address_txs: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _addresses: + - addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv + - addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y + _after_block_height: 6238675 + description: Array of Cardano payment address(es) + stake_addresses_with_epoch_no: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _epoch_no: + format: integer + type: number + description: Only fetch information for a specific epoch + example: + _stake_addresses: + - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 + - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy + _epoch_no: 409 + description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by + stake_addresses_with_first_only_and_empty: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _first_only: + format: boolean + type: boolean + description: Only return the first result + _empty: + format: boolean + type: boolean + description: Include zero quantity entries + example: + _stake_addresses: + - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 + - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy + _first_only: false + _empty: false + description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs + stake_addresses_with_extended: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _stake_addresses: + - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 + - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy + _extended: true + description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns + stake_addresses: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + example: + _stake_addresses: + - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 + - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy + description: Array of Cardano stake credential(s) in bech32 format + credential_txs: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _payment_credentials: + - 025b0a8f85cb8a46e1dda3fae5d22f07e2d56abb4019a2129c5d6c52 + - 13f6870c5e4f3b242463e4dc1f2f56b02a032d3797d933816f15e555 + _after_block_height: 6238675 + description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight + credential_utxos: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _payment_credentials: + - 025b0a8f85cb8a46e1dda3fae5d22f07e2d56abb4019a2129c5d6c52 + - 13f6870c5e4f3b242463e4dc1f2f56b02a032d3797d933816f15e555 + _extended: true + description: Array of Cardano payment credential(s) in hex format + tx_ids: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + example: + _tx_hashes: + - f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e + - 0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94 + description: Array of Cardano Transaction hashes + tx_info: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _tx_hashes: + - f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e + - 0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94 + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of Cardano Transaction hashes + txbin: + content: + application/cbor: + schema: + type: string + format: binary + example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e + description: Serialised Cardano Transaction + pool_ids: + content: + application/json: + schema: + required: + - _pool_bech32_ids + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool100wj94uzf54vup2hdzk0afng4dhjaqggt7j434mtgm8v2gfvfgp + - pool102s2nqtea2hf5q0s4amj0evysmfnhrn4apyyhd4azcmsclzm96m + - pool102vsulhfx8ua2j9fwl2u7gv57fhhutc3tp6juzaefgrn7ae35wm + description: Array of Cardano pool IDs (bech32 format) + pool_ids_optional: + content: + application/json: + schema: + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool100wj94uzf54vup2hdzk0afng4dhjaqggt7j434mtgm8v2gfvfgp + - pool102s2nqtea2hf5q0s4amj0evysmfnhrn4apyyhd4azcmsclzm96m + - pool102vsulhfx8ua2j9fwl2u7gv57fhhutc3tp6juzaefgrn7ae35wm + description: Array of Cardano pool IDs (bech32 format) [Optional] + script_hashes: + content: + application/json: + schema: + type: object + properties: + _script_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano script hashes + example: + _script_hashes: + - bd2119ee2bfb8c8d7c427e8af3c35d537534281e09e23013bca5b138 + - c0c671fba483641a71bb92d3a8b7c52c90bf1c01e2b83116ad7d4536 + description: Array of Cardano script hashes + datum_hashes: + content: + application/json: + schema: + type: object + properties: + _datum_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano datum hashes + example: + _datum_hashes: + - 818ee3db3bbbd04f9f2ce21778cac3ac605802a4fcb00c8b3a58ee2dafc17d46 + - 45b0cfc220ceec5b7c1c62c4d4193d38e4eba48e8815729ce75f9c0ab0e4c1c0 + description: Array of Cardano datum hashes + asset_list: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + example: + _asset_list: + - ['750900e4999ebe0d58f19b634768ba25e525aaf12403bfe8fe130501','424f4f4b'] + - ['f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a','6b6f696f732e72657374'] + description: Array of array of policyID and asset names (hex) + asset_list_with_extended: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _asset_list: + - ['750900e4999ebe0d58f19b634768ba25e525aaf12403bfe8fe130501','424f4f4b'] + - ['f0ff48bbb7bbe9d59a40f1ce90e9e9d0ff5002ec48f232b49ca0fb9a','6b6f696f732e72657374'] + _extended: true + description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns + drep_id_bulk: + content: + application/json: + schema: + required: + - _drep_ids + type: object + properties: + _drep_ids: + format: text + type: array + descriptions: Array of DRep IDs in bech32 format + items: + type: string + example: + _drep_ids: + - drep17l6sywnwqu9aedd6aumev42w39ln5zfl9nw7j4ak6u8swyrwvz3 + - drep1s9q5uyddsvza4uk2n9wswy90n8wx9d2jmrq4zgcvlyv055007av + utxo_refs_with_extended: + content: + application/json: + schema: + required: + - _utxo_refs + type: object + properties: + _utxo_refs: + format: text + type: array + items: + type: string + description: Array of Cardano utxo references in the form "hash#index" + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _utxo_refs: + - f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e#0 + - 0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94#0 + _extended: false + description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields + ogmios: + content: + application/json: + schema: + required: + - jsonrpc + - method + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab + enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] + example: "queryNetwork/tip" + params: + type: object + description: Any parameters relevant to the specific method to be called + nullable: true + examples: + blockHeight: + description: Query the network’s highest block number. + value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } + genesisConfiguration: + description: Query the genesis configuration of a given era. + value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } + startTimeTime: + description: Query the network start time. + value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } + tip: + description: Query tip of the Network + value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } + epoch: + description: Query the current epoch of the ledger. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } + eraStart: + description: Query information regarding the beginning of the current ledger era. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } + eraSummaries: + description: Query era bounds and slot parameters details, required for proper sloting arithmetic. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } + liveStakeDistribution: + description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } + protocolParameters: + description: Query the current protocol parameters. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } + proposedProtocolParameters: + description: Query the last update proposal w.r.t. protocol parameters, if any. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } + StakePools: + description: Query the list of all stake pool identifiers currently registered and active. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } + submitTransaction: + description: Submit a signed and serialized transaction to the network. + value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } + evaluateTransaction: + description: Evaluate execution units of scripts in a well-formed transaction. + value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } + description: JSON-RPC 2.0 standard request body + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT + description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. + schemas: + tip: + description: Current tip of the chain + type: array + items: + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_no: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + genesis: + description: Array of genesis parameters used to start each era on chain + type: array + items: + properties: + networkmagic: + type: string + example: 764824073 + description: Unique network identifier for chain + networkid: + type: string + example: Mainnet + description: Network ID used at various CLI identification to distinguish between Mainnet and other networks + epochlength: + type: string + example: 432000 + description: Number of slots in an epoch + slotlength: + type: string + example: 1 + description: Duration of a single slot (in seconds) + maxlovelacesupply: + type: string + example: 45000000000000000 + description: Maximum smallest units (lovelaces) supply for the blockchain + systemstart: + type: number + description: UNIX timestamp of the first block (genesis) on chain + example: 1506203091 + activeslotcoeff: + type: string + example: 0.05 + description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" + slotsperkesperiod: + type: string + example: 129600 + description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) + maxkesrevolutions: + type: string + example: 62 + description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised + securityparam: + type: string + example: 2160 + description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) + updatequorum: + type: string + example: 5 + description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal + alonzogenesis: + type: string + example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' + description: A JSON dump of Alonzo Genesis + totals: + description: Array of supply/reserves/utxo/fees/treasury stats + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + circulation: + type: string + description: Circulating UTxOs for given epoch (in lovelaces) + example: 32081169442642320 + treasury: + type: string + description: Funds in treasury for given epoch (in lovelaces) + example: 637024173474141 + reward: + type: string + description: Rewards accumulated as of given epoch (in lovelaces) + example: 506871250479840 + supply: + type: string + description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) + example: 33228495612391330 + reserves: + type: string + description: Total Reserves yet to be unlocked on chain + example: 11771504387608670 + param_updates: + description: Array of unique param update proposals submitted on chain + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + data: + type: string + description: JSON encoded data with details about the parameter update + example: {"decentralisation": 0.9} + cli_protocol_params: + description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format + type: object + example: + { + "collateralPercentage": 150, + "maxBlockBodySize": 90112, + "maxBlockHeaderSize": 1100, + "maxCollateralInputs": 3, + "maxTxSize": 16384, + "maxValueSize": 5000, + "minPoolCost": 170000000, + "minUTxOValue": null, + "monetaryExpansion": 3.0e-3, + "poolPledgeInfluence": 0.3, + "poolRetireMaxEpoch": 18, + "protocolVersion": { + "major": 8, + "minor": 0 + }, + "...": "...", + "stakeAddressDeposit": 2000000, + "stakePoolDeposit": 500000000, + "stakePoolTargetNum": 500, + "treasuryCut": 0.2, + "txFeeFixed": 155381, + "txFeePerByte": 44, + "utxoCostPerByte": 4310 + } + reserve_withdrawals: + description: Array of withdrawals from reserves/treasury against stake accounts + type: array + items: + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + earned_epoch: + description: Epoch where amount is earned + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + spendable_epoch: + description: Epoch where the earned amount can be spent + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + pool_list: + description: Array of pool IDs and tickers + type: array + items: + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + ticker: + type: + - string + - 'null' + description: Pool ticker + example: AHL + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_history_info: + description: Array of pool history information + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch for which the pool history data is shown + example: 312 + active_stake: + type: string + description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) + example: "31235800000" + active_stake_pct: + type: number + description: Active stake for the pool, expressed as a percentage of total active stake on network + example: 13.512182543475783 + saturation_pct: + type: number + description: Saturation percentage of a pool at the time of snapshot (2 decimals) + example: 45.32 + block_cnt: + type: + - number + - 'null' + description: Number of blocks pool created in that epoch + example: 14 + delegator_cnt: + type: number + description: Number of delegators to the pool for that epoch snapshot + example: 1432 + margin: + type: number + description: Margin (decimal format) + example: 0.125 + fixed_cost: + type: string + description: Pool fixed cost per epoch (in lovelaces) + example: "340000000" + pool_fees: + type: string + description: Total amount of fees earned by pool owners in that epoch (in lovelaces) + example: "123327382" + deleg_rewards: + type: string + description: Total amount of rewards earned by delegators in that epoch (in lovelaces) + example: "123456789123" + member_rewards: + type: string + description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) + example: "123456780123" + epoch_ros: + type: number + description: Annualized ROS (return on staking) for delegators for this epoch + example: 3.000340466 + pool_info: + description: Array of pool information + type: array + items: + type: object + properties: + pool_id_bech32: + type: string + description: Pool ID (bech32 format) + example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc + pool_id_hex: + type: string + description: Pool ID (Hex format) + example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + vrf_key_hash: + type: + - string + - 'null' + description: Pool VRF key hash + example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 + margin: + type: + - number + - 'null' + description: Margin (decimal format) + example: 0.1 + fixed_cost: + type: + - string + - 'null' + description: Pool fixed cost per epoch + example: "500000000" + pledge: + type: + - string + - 'null' + description: Pool pledge in lovelace + example: "64000000000000" + deposit: + type: + - string + - 'null' + description: Pool's registration deposit in lovelace + example: "500000000" + reward_addr: + type: + - string + - 'null' + description: Pool reward address + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + owners: + type: + - array + - 'null' + items: + type: string + description: Pool (co)owner address + example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 + relays: + type: array + items: + type: object + properties: + dns: + type: + - string + - 'null' + description: DNS name of the relay (nullable) + example: relays-new.cardano-mainnet.iohk.io + srv: + type: + - string + - 'null' + description: DNS service name of the relay (nullable) + example: biostakingpool3.hopto.org + ipv4: + type: + - string + - 'null' + description: IPv4 address of the relay (nullable) + example: "54.220.20.40" + ipv6: + type: + - string + - 'null' + description: IPv6 address of the relay (nullable) + example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf + port: + type: + - number + - 'null' + description: Port number of the relay (nullable) + example: 6000 + meta_url: + type: + - string + - 'null' + description: Pool metadata URL + example: https://pools.iohk.io/IOGP.json + meta_hash: + type: + - string + - 'null' + description: Pool metadata hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + meta_json: + type: + - object + - 'null' + properties: + name: + type: string + description: Pool name + example: Input Output Global (IOHK) - Private + ticker: + type: string + description: Pool ticker + example: IOGP + homepage: + type: string + description: Pool homepage URL + example: https://iohk.io + description: + type: string + description: Pool description + example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. + pool_status: + type: string + description: Pool status + enum: ["registered", "retiring", "retired"] + example: registered + retiring_epoch: + type: + - number + - 'null' + description: Announced retiring epoch (nullable) + example: 'null' + op_cert: + type: + - string + - 'null' + description: Pool latest operational certificate hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + op_cert_counter: + type: + - number + - 'null' + description: Pool latest operational certificate counter value + example: 8 + active_stake: + type: + - string + - 'null' + description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) + example: "64328627680963" + sigma: + type: + - number + - 'null' + description: Pool relative active stake share + example: 0.0034839235 + block_count: + type: + - number + - 'null' + description: Total pool blocks on chain + example: 4509 + live_pledge: + type: + - string + - 'null' + description: Summary of account balance for all pool owner's + example: "64328594406327" + live_stake: + type: + - string + - 'null' + description: Pool live stake + example: "64328627680963" + live_delegators: + type: number + description: Pool live delegator count + example: 5 + live_saturation: + type: + - number + - 'null' + description: Pool live saturation (decimal format) + example: 94.52 + pool_snapshot: + type: array + items: + description: Array of pool stake information for 3 snapshots + type: object + properties: + snapshot: + type: string + description: Type of snapshot ("Mark", "Set" or "Go") + example: "Mark" + epoch_no: + type: number + description: Epoch number for the snapshot entry + example: 324 + nonce: + $ref: "#/components/schemas/epoch_params/items/properties/nonce" + pool_stake: + type: string + description: Pool's Active Stake for the given epoch + example: "100000000000" + active_stake: + type: string + description: Total Active Stake for the given epoch + example: "103703246364020" + pool_delegators: + description: Array of live pool delegators + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + description: Current delegator live stake (in lovelace) + example: 64328591517480 + active_epoch_no: + type: number + description: Epoch number in which the delegation becomes active + example: 324 + latest_delegation_tx_hash: + type: string + description: Latest transaction hash used for delegation by the account + example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 + pool_registrations: + description: Array of pool registrations/retirements + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + pool_delegators_history: + description: Array of pool delegators (historical) + type: + - array + - 'null' + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + epoch_no: + type: number + description: Epoch number for the delegation history + example: 324 + pool_blocks: + description: Array of blocks created by pool + type: array + items: + type: object + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_updates: + description: Array of historical pool updates + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + type: + - number + - 'null' + description: Epoch number in which the update becomes active + example: 324 + vrf_key_hash: + $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + update_type: + type: string + description: Type of update task + enum: ["registration", "deregistration"] + example: registered + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_relays: + description: Array of pool relay information + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + pool_metadata: + description: Array of pool metadata + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + epoch_info: + description: Array of detailed summary for each epoch + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + out_sum: + type: string + description: Total output value across all transactions in epoch + example: 15432725054364942 + fees: + type: string + description: Total fees incurred by transactions in epoch + example: 74325855210 + tx_count: + type: number + description: Number of transactions submitted in epoch + example: 357919 + blk_count: + type: number + description: Number of blocks created in epoch + example: 17321 + start_time: + type: number + description: UNIX timestamp of the epoch start + example: 1506203091 + end_time: + type: number + description: UNIX timestamp of the epoch end + example: 1506635091 + first_block_time: + type: number + description: UNIX timestamp of the epoch's first block + example: 1506635091 + last_block_time: + type: number + description: UNIX timestamp of the epoch's last block + example: 1506635091 + active_stake: + type: + - string + - 'null' + description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) + example: 23395112387185880 + total_rewards: + type: + - string + - 'null' + description: Total rewards earned in epoch (null for pre-Shelley epochs) + example: 252902897534230 + avg_blk_reward: + type: + - string + - 'null' + description: Average block reward for epoch (null for pre-Shelley epochs) + example: 660233450 + epoch_params: + description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + min_fee_a: + type: + - number + - 'null' + description: The 'a' parameter to calculate the minimum transaction fee + example: 44 + min_fee_b: + type: + - number + - 'null' + description: The 'b' parameter to calculate the minimum transaction fee + example: 155381 + max_block_size: + type: + - number + - 'null' + description: The maximum block size (in bytes) + example: 65536 + max_tx_size: + type: + - number + - 'null' + description: The maximum transaction size (in bytes) + example: 16384 + max_bh_size: + type: + - number + - 'null' + description: The maximum block header size (in bytes) + example: 1100 + key_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake address + example: 2000000 + pool_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake pool + example: 500000000 + max_epoch: + type: + - number + - 'null' + description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for + example: 18 + optimal_pool_count: + type: + - number + - 'null' + description: The optimal number of stake pools + example: 500 + influence: + type: + - number + - 'null' + format: double + description: The pledge influence on pool rewards + example: 0.3 + monetary_expand_rate: + type: + - number + - 'null' + format: double + description: The monetary expansion rate + example: 0.003 + treasury_growth_rate: + type: + - number + - 'null' + format: double + description: The treasury growth rate + example: 0.2 + decentralisation: + type: + - number + - 'null' + format: double + description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) + example: 0.1 + extra_entropy: + type: + - string + - 'null' + description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool + example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa + protocol_major: + type: + - number + - 'null' + description: The protocol major version + example: 5 + protocol_minor: + type: + - number + - 'null' + description: The protocol minor version + example: 0 + min_utxo_value: + type: + - string + - 'null' + description: The minimum value of a UTxO entry + example: 34482 + min_pool_cost: + type: + - string + - 'null' + description: The minimum pool cost + example: 340000000 + nonce: + type: + - string + - 'null' + description: The nonce value for this epoch + example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 + block_hash: + type: string + description: The hash of the first block where these parameters are valid + example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 + cost_models: + type: + - object + - 'null' + description: The per language cost model in JSON + example: 'null' + price_mem: + type: + - number + - 'null' + format: double + description: The per word cost of script memory usage + example: 0.0577 + price_step: + type: + - number + - 'null' + format: double + description: The cost of script execution step usage + example: 7.21e-05 + max_tx_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single transaction + example: 10000000 + max_tx_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single transaction + example: 10000000000 + max_block_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single block + example: 50000000 + max_block_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single block + example: 40000000000 + max_val_size: + type: + - number + - 'null' + description: The maximum Val size + example: 5000 + collateral_percent: + type: + - number + - 'null' + description: The percentage of the tx fee which must be provided as collateral when including non-native scripts + example: 150 + max_collateral_inputs: + type: + - number + - 'null' + description: The maximum number of collateral inputs allowed in a transaction + example: 3 + coins_per_utxo_size: + type: + - string + - 'null' + description: The cost per UTxO size + example: 34482 + pvt_motion_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for motion of no-confidence. + example: 0.6 + pvt_committee_normal: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (normal state). + example: 0.65 + pvt_committee_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (state of no-confidence). + example: 0.65 + pvt_hard_fork_initiation: + type: + - number + - 'null' + description: Pool Voting threshold for hard-fork initiation. + example: 0.51 + dvt_motion_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for motion of no-confidence. + example: 0.67 + dvt_committee_normal: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (normal state). + example: 0.67 + dvt_committee_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (state of no-confidence). + example: 0.65 + dvt_update_to_constitution: + type: + - number + - 'null' + description: DRep Vote threshold for update to the Constitution. + example: 0.75 + dvt_hard_fork_initiation: + type: + - number + - 'null' + description: DRep Vote threshold for hard-fork initiation. + example: 0.6 + dvt_p_p_network_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, network group. + example: 0.67 + dvt_p_p_economic_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, economic group. + example: 0.67 + dvt_p_p_technical_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, technical group. + example: 0.67 + dvt_p_p_gov_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, governance group. + example: 0.75 + dvt_treasury_withdrawal: + type: + - number + - 'null' + description: DRep Vote threshold for treasury withdrawal. + example: 0.67 + committee_min_size: + type: + - number + - 'null' + description: Minimal constitutional committee size. + example: 5 + committee_max_term_length: + type: + - number + - 'null' + description: Constitutional committee term limits. + example: 146 + gov_action_lifetime: + type: + - number + - 'null' + description: Governance action expiration. + example: 14 + gov_action_deposit: + type: + - string + - 'null' + description: Governance action deposit. + example: 100000000000 + drep_deposit: + type: + - string + - 'null' + description: DRep deposit amount. + example: 500000000 + drep_activity: + type: + - number + - 'null' + description: DRep activity period. + example: 20 + pvtpp_security_group: + type: + - number + - 'null' + description: Pool Voting threshold for protocol parameter changes, security group. + example: 0.6 + min_fee_ref_script_cost_per_byte: + type: + - number + - 'null' + description: Minimum Fee for Reference Script cost pre byte + example: 15 + epoch_block_protocols: + description: Array of distinct block protocol versions counts in epoch + type: array + items: + properties: + proto_major: + type: number + description: Protocol major version + example: 6 + proto_minor: + type: number + description: Protocol major version + example: 2 + blocks: + type: number + description: Amount of blocks with specified major and protocol combination + example: 2183 + blocks: + description: Array of block information + type: array + items: + type: object + properties: + hash: + type: string + description: Hash of the block + example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f + epoch_no: + type: number + description: Epoch number of the block + example: 117 + abs_slot: + type: number + description: Absolute slot number of the block + example: 49073930 + epoch_slot: + type: number + description: Slot number of the block in epoch + example: 171530 + block_height: + type: + - number + - 'null' + description: Block height + example: 1794506 + block_size: + type: number + description: Block size in bytes + example: 2433 + block_time: + type: number + description: UNIX timestamp of the block + example: 1704757130 + tx_count: + type: number + description: Number of transactions in the block + example: 2 + vrf_key: + type: string + description: VRF key of the block producer + example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" + pool: + type: + - string + - 'null' + description: Pool ID in bech32 format (null for pre-Shelley blocks) + example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v + op_cert_counter: + type: number + description: Counter value of the operational certificate used to create this block + example: 5 + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + parent_hash: + type: string + description: Previous Hash of the current block + example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 + block_info: + description: Array of detailed block information + type: array + items: + type: object + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_size: + $ref: "#/components/schemas/blocks/items/properties/block_size" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + tx_count: + $ref: "#/components/schemas/blocks/items/properties/tx_count" + vrf_key: + $ref: "#/components/schemas/blocks/items/properties/vrf_key" + op_cert: + type: string + description: Hash of the block producers' operational certificate + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + op_cert_counter: + $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" + pool: + $ref: "#/components/schemas/blocks/items/properties/pool" + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + total_output: + type: + - string + - 'null' + description: Total output of the block (in lovelace) + example: 92384672389 + total_fees: + type: + - string + - 'null' + description: Total fees of the block (in lovelace) + example: 2346834 + num_confirmations: + type: number + description: Number of confirmations for the block + example: 664275 + parent_hash: + type: string + description: Hash of the parent of this block + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + child_hash: + type: string + description: Hash of the child of this block (if present) + example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" + block_txs: + description: Array of transactions hashes + type: array + items: + type: object + properties: + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + block_tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" + tx_block_index: + $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" + tx_size: + $ref: "#/components/schemas/tx_info/items/properties/tx_size" + total_output: + $ref: "#/components/schemas/tx_info/items/properties/total_output" + fee: + $ref: "#/components/schemas/tx_info/items/properties/fee" + treasury_donation: + $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" + deposit: + $ref: "#/components/schemas/tx_info/items/properties/deposit" + invalid_before: + $ref: "#/components/schemas/tx_info/items/properties/invalid_before" + invalid_after: + $ref: "#/components/schemas/tx_info/items/properties/invalid_after" + collateral_inputs: + $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" + collateral_output: + $ref: "#/components/schemas/tx_info/items/properties/collateral_output" + reference_inputs: + $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" + inputs: + description: An array of UTxO inputs spent in the transaction + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + outputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + withdrawals: + $ref: "#/components/schemas/tx_info/items/properties/withdrawals" + assets_minted: + $ref: "#/components/schemas/tx_info/items/properties/assets_minted" + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + $ref: "#/components/schemas/tx_info/items/properties/certificates" + native_scripts: + $ref: "#/components/schemas/tx_info/items/properties/native_scripts" + plutus_contracts: + $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" + address_info: + description: Array of information for address(es) + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + balance: + type: string + description: Sum of all UTxO values beloning to address + example: 10723473983 + stake_address: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/account_history/items/properties/stake_address" + script_address: + type: boolean + description: Signifies whether the address is a script address + example: true + utxo_set: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + address_txs: + description: Array of transaction hashes + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + address_assets: + description: Array of address-owned assets + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + + account_list: + description: Array of account (stake address) IDs + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + stake_address_hex: + type: string + description: Cardano staking address (reward account) in hex format + example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf + script_hash: + type: string + description: Script hash in case the stake address is locked by a script + example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 + account_info: + description: Array of stake account information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + status: + type: string + description: Stake address status + enum: ["registered", "not registered"] + example: registered + delegated_drep: + anyOf: + - type: 'null' + - type: string + description: Account's current delegation status to DRep ID in Bech32 format + example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 + delegated_pool: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + total_balance: + type: string + description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) + example: 207116800428 + utxo: + type: string + description: Total UTxO balance of the account + example: 162764177131 + rewards: + type: string + description: Total rewards earned by the account + example: 56457728047 + withdrawals: + type: string + description: Total rewards withdrawn by the account + example: 12105104750 + rewards_available: + type: string + description: Total rewards available for withdrawal + example: 44352623297 + deposit: + type: string + description: Total deposit available for withdrawal + example: 2000000 + reserves: + type: string + description: Total reserves MIR value of the account + example: "0" + treasury: + type: string + description: Total treasury MIR value of the account + example: "0" + utxo_infos: + description: Array of complete UTxO information + type: array + items: + type: object + properties: + tx_hash: + type: string + description: Hash identifier of the transaction + example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e + tx_index: + type: number + description: Index of UTxO in the transaction + example: 0 + address: + type: string + description: A Cardano payment/base address (bech32 encoded) + example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + payment_cred: + type: + - string + - 'null' + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: + - array + - 'null' + description: An array of assets on the UTxO + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of assets on the UTxO + example: 1 + is_spent: + type: boolean + description: True if the UTXO has been spent + example: true + account_rewards: + description: Array of reward history information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + rewards: + type: array + items: + type: object + properties: + earned_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" + spendable_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" + amount: + type: string + description: Amount of rewards earned (in lovelace) + type: + type: string + description: The source of the rewards + enum: [member, leader, treasury, reserves] + example: member + pool_id: + $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + account_updates: + description: Array of account updates information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + updates: + type: array + items: + type: object + properties: + action_type: + type: string + description: Type of certificate submitted + enum: ["registration", "delegation", "withdrawal", "deregistration"] + example: "registration" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + account_addresses: + description: Array of payment addresses + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + addresses: + type: array + items: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + account_assets: + description: Array of assets owned by account + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + account_history: + description: Array of active stake values per epoch + type: array + items: + properties: + stake_address: + type: string + description: Cardano staking address (reward account) in bech32 format + example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz + history: + type: array + items: + type: object + properties: + pool_id: + type: string + description: Bech32 representation of pool ID + example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt + epoch_no: + type: number + description: Epoch number + example: 301 + active_stake: + type: string + description: Active stake amount (in lovelaces) + example: 682334162 + tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + type: number + description: UNIX timestamp of the transaction + example: 1506635091 + tx_block_index: + type: number + description: Index of transaction within block + example: 6 + tx_size: + type: number + description: Size in bytes of transaction + example: 391 + total_output: + type: string + description: Total sum of all transaction outputs (in lovelaces) + example: 157832856 + fee: + type: string + description: Total Transaction fee (in lovelaces) + example: 172761 + treasury_donation: + type: string + description: Total Donation to on-chain treasury (in lovelaces) + example: 0 + deposit: + type: string + description: Total Deposits included in transaction (for example, if it is registering a pool/key) + example: 0 + invalid_before: + type: + - string + - 'null' + description: Slot before which transaction cannot be validated (if supplied, else null) + invalid_after: + type: + - string + - 'null' + description: Slot after which transaction cannot be validated + example: 42332172 + collateral_inputs: + description: An array of collateral inputs needed for smart contracts in case of contract failure + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + collateral_output: + description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) + type: array + items: + properties: + payment_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" + stake_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: array + description: Brief asset description from ledger + reference_inputs: + description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + inputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + #description: An array of UTxO inputs spent in the transaction + outputs: + type: array + description: An array of UTxO outputs created by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + datum_hash: + type: + - string + - 'null' + description: Hash of datum (if any) connected to UTxO + example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 + inline_datum: + type: + - object + - 'null' + description: Allows datums to be attached to UTxO (CIP-32) + properties: + bytes: + type: string + description: Datum bytes (hex) + example: 19029a + value: + type: object + description: Value (json) + example: { "int": 666 } + reference_script: + type: + - object + - 'null' + description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) + properties: + hash: + type: string + description: Hash of referenced script + example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 + size: + type: number + description: Size in bytes + example: 14 + type: + type: string + description: Type of script + example: plutusV1 + bytes: + type: string + description: Script bytes (hex) + example: 4e4d01000033222220051200120011 + value: + type: + - object + - 'null' + description: Value (json) + example: 'null' + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + withdrawals: + type: + - array + - 'null' + description: Array of withdrawals with-in a transaction + items: + type: object + properties: + amount: + type: string + description: Withdrawal amount (in lovelaces) + example: 9845162 + stake_addr: + type: string + description: A Cardano staking address (reward account, bech32 encoded) + example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj + assets_minted: + type: + - array + - 'null' + description: Array of minted assets with-in a transaction + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of minted assets (negative on burn) + example: 1 + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + type: + - array + - 'null' + description: Certificates present with-in a transaction (if any) + items: + properties: + index: + type: + - number + - 'null' + description: Certificate index + example: 0 + type: + type: string + description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) + example: delegation + info: + type: + - object + - 'null' + description: A JSON array containing information from the certificate + example: + { + "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", + "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", + } + native_scripts: + type: + - array + - 'null' + description: Native scripts present in a transaction (if any) + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + script_json: + type: object + description: JSON representation of the timelock script (null for other script types) + example: + { + "type": "all", + "scripts": + [ + { + "type": "sig", + "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", + }, + { + "type": "sig", + "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", + }, + { + "type": "sig", + "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", + }, + ], + } + plutus_contracts: + type: + - array + - 'null' + description: Plutus contracts present in transaction (if any) + items: + properties: + address: + type: + - string + - 'null' + description: Plutus script address + example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 + spends_input: + type: + - object + - 'null' + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + description: Input utxo this contract spends + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + bytecode: + $ref: "#/components/schemas/script_info/items/properties/bytes" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + valid_contract: + type: boolean + description: True if the contract is valid or there is no contract + example: true + input: + type: object + properties: + redeemer: + type: object + properties: + purpose: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" + fee: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" + unit: + type: object + properties: + steps: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" + mem: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + tx_cbor: + description: Raw Transaction(s) in CBOR format + item: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + cbor: + type: string + description: CBOR encoded raw transaction. + tx_utxos: + description: Array of inputs and outputs for given transaction(s) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + inputs: + type: array + description: An array of UTxO inputs used by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + type: string + description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned + example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + outputs: + description: An array of UTxO outputs created by the transaction + allOf: + - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" + tx_metadata: + description: Array of metadata information present in each of the transactions queried + type: + - array + - 'null' + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + metadata: + type: + - object + - 'null' + description: A JSON array containing details about metadata within transaction + example: + { + "721": + { + "version": 1, + "copyright": "...", + "publisher": ["p...o"], + "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": + {}, + }, + } + tx_status: + description: Array of transaction confirmation counts + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + num_confirmations: + type: + - number + - 'null' + description: Number of block confirmations + example: 17 + tx_metalabels: + description: Array of known metadata labels + type: array + items: + properties: + key: + type: string + description: A distinct known metalabel + example: "721" + asset_list: + description: Array of policy IDs and asset names + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + asset_token_registry: + description: An array of token registry information (registered via github) for each asset + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + ticker: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" + description: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" + url: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + logo: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" + asset_addresses: + description: An array of payment addresses holding the given token (including balances) + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + type: string + description: Asset balance on the payment address + example: 23 + asset_nft_address: + description: An array of payment addresses holding the given token + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + asset_summary: + description: Array of asset summary information + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_transactions: + type: number + description: Total number of transactions including the given asset + example: 89416 + staked_wallets: + type: number + description: Total number of registered wallets holding the given asset + example: 548 + unstaked_addresses: + type: number + description: Total number of payment addresses (not belonging to registered wallets) holding the given asset + example: 245 + addresses: + type: number + description: Total number of unique addresses holding the given asset + example: 812 + asset_info: + description: Array of detailed asset information + type: array + items: + properties: + policy_id: + type: string + description: Asset Policy ID (hex) + example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff + asset_name: + type: + - string + - 'null' + description: Asset Name (hex) + example: 444f4e545350414d + asset_name_ascii: + type: string + description: Asset Name (ASCII) + example: DONTSPAM + fingerprint: + type: string + description: The CIP14 fingerprint of the asset + example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 + minting_tx_hash: + type: string + description: Hash of the latest mint transaction (with metadata if found for asset) + example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 + total_supply: + type: string + description: Total supply for the asset + example: "35000" + mint_cnt: + type: number + description: Count of total mint transactions + example: 1 + burn_cnt: + type: number + description: Count of total burn transactions + example: 5 + creation_time: + type: number + description: UNIX timestamp of the first asset mint + example: 1506635091 + minting_tx_metadata: + allOf: + - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + description: Latest minting transaction metadata (aligns with CIP-25) + token_registry_metadata: + type: + - object + - 'null' + description: Asset metadata registered on the Cardano Token Registry + properties: + name: + type: string + example: Rackmob + description: + type: string + example: Metaverse Blockchain Cryptocurrency. + ticker: + type: string + example: MOB + url: + type: string + example: https://www.rackmob.com/ + logo: + type: string + description: A PNG image file as a byte string + example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc + decimals: + type: number + example: 0 + cip68_metadata: + type: + - object + - 'null' + description: CIP 68 metadata if present for asset + example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} + asset_history: + description: Array of asset mint/burn history + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_txs: + type: + - array + - 'null' + description: Array of all mint/burn transactions for an asset + items: + type: object + properties: + tx_hash: + type: string + description: Hash of minting/burning transaction + example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + quantity: + type: string + description: Quantity minted/burned (negative numbers indicate burn transactions) + example: "-10" + metadata: + type: array + description: Array of Transaction Metadata for given transaction + items: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + policy_asset_addresses: + description: Array of asset names and payment addresses for the given policy (including balances) + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + policy_asset_info: + description: Array of detailed information of assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + token_registry_metadata: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" + policy_asset_mints: + description: Array of mint information for assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + policy_asset_list: + description: Array of brief information of assets under the same policy + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + drep_info: + description: Get detailed information about requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + type: string + description: DRep ID in bech32 format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + hex: + type: string + description: DRep ID in hex format + example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 + has_script: + type: boolean + description: Flag which shows if this DRep credentials are a script hash + example: false + registered: + type: boolean + description: Flag to show if the DRep is currently registered + example: false + deposit: + type: + - string + - 'null' + description: DRep's registration deposit in lovelace + example: 500000000 + active: + type: boolean + description: Flag to show if the DRep is (i.e. not expired) + example: true + expires_epoch_no: + type: + - number + - 'null' + description: After which epoch DRep is considered inactive. + example: 410 + amount: + type: string + description: The total amount of voting power this DRep is delegated. + example: 599496769641 + drep_list: + description: List of all active delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + has_script: + $ref: "#/components/schemas/drep_info/items/properties/has_script" + registered: + $ref: "#/components/schemas/drep_info/items/properties/registered" + drep_metadata: + description: List metadata for requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + url: + type: string + description: A URL to a JSON payload of metadata + example: "https://hornan7.github.io/Vote_Context.jsonld" + hash: + type: string + description: A hash of the contents of the metadata URL + example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d + json: + type: object + description: The payload as JSON + example: + {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} + bytes: + type: string + description: The raw bytes of the payload + example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d + warning: + type: string + description: A warning that occured while validating the metadata + language: + type: string + description: The language described in the context of the metadata as per CIP-100 + example: en-us + comment: + type: string + description: Comment attached to the metadata + is_valid: + type: boolean + description: Indicate whether data is invalid + example: true + drep_updates: + description: List of updates for requested (or all) delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + type: string + description: The index of this certificate within the the transaction. + example: 1 + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + action: + type: string + description: Effective action for this DRep Update certificate + enum: ["updated","registered","deregistered"] + example: registered + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + drep_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + vote: + type: string + enum: ["Yes","No","Abstain"] + description: Actual Vote casted + example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + committee_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + proposal_list: + description: List of all votes cast on specified governance action + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + proposal_type: + type: string + enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] + description: Proposal Action Type + example: ParameterChange + proposal_description: + type: string + description: Description for Proposal Action + example: '{"tag": "InfoAction"}' + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + return_address: + type: string + description: The StakeAddress index of the reward address to receive the deposit when it is repaid. + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + proposed_epoch: + type: number + description: Shows the epoch at which this governance action was proposed. + example: 660 + ratified_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been ratified at the specfied epoch. + example: 670 + enacted_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been enacted at the specfied epoch. + example: 675 + dropped_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. + example: 680 + expired_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been expired at the specfied epoch. + example: 680 + expiration: + type: + - number + - 'null' + description: Shows the epoch at which this governance action is expected to expire. + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + meta_comment: + $ref: "#/components/schemas/drep_metadata/items/properties/comment" + meta_language: + $ref: "#/components/schemas/drep_metadata/items/properties/language" + meta_is_valid: + $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" + withdrawal: + type: + - object + - 'null' + description: If not null, the amount withdrawn from treasury into stake address by this this proposal + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + example: "31235800000" + param_proposal: + description: If not null, the proposed new parameter set + type: + - object + - 'null' + example: {"id": 15, "key": null, "entropy": null, "epoch_no": null, "influence": null, "max_epoch": null, "min_fee_a": null, "min_fee_b": null, "price_mem": null, "price_step": null, "key_deposit": 1000000, "max_bh_size": null, "max_tx_size": null, "drep_deposit": null, "max_val_size": null, "pool_deposit": null, "cost_model_id": null, "drep_activity": null, "max_tx_ex_mem": null, "min_pool_cost": null, "max_block_size": null, "min_utxo_value": null, "protocol_major": null, "protocol_minor": null, "max_tx_ex_steps": null, "decentralisation": null, "max_block_ex_mem": null, "registered_tx_id": 12270, "dvt_p_p_gov_group": null, "collateral_percent": null, "committee_min_size": null, "gov_action_deposit": null, "max_block_ex_steps": null, "optimal_pool_count": null, "coins_per_utxo_size": null, "gov_action_lifetime": null, "dvt_committee_normal": null, "monetary_expand_rate": null, "pvt_committee_normal": null, "pvtpp_security_group": null, "treasury_growth_rate": null, "dvt_p_p_network_group": null, "max_collateral_inputs": null, "dvt_p_p_economic_group": null, "dvt_p_p_technical_group": null, "dvt_treasury_withdrawal": null, "dvt_hard_fork_initiation": null, "dvt_motion_no_confidence": null, "pvt_hard_fork_initiation": null, "pvt_motion_no_confidence": null, "committee_max_term_length": null, "dvt_update_to_constitution": null, "dvt_committee_no_confidence": null, "pvt_committee_no_confidence": null, "min_fee_ref_script_cost_per_byte": null} + proposal_votes: + type: array + description: List of all votes cast on specified governance action + items: + properties: + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + voter_role: + type: string + description: The role of the voter + enum: ["ConstitutionalCommittee", "DRep", "SPO"] + example: DRep + voter: + type: string + description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + voter_hex: + type: string + description: Voter's DRep ID , pool ID or committee hash in hex format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + vote: + $ref: "#/components/schemas/drep_votes/items/properties/vote" + + script_info: + type: array + items: + description: Array of information for scripts + properties: + script_hash: + type: string + description: Hash of a script + example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af + creation_tx_hash: + type: string + description: Hash of the script creation transaction + example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe + type: + type: string + description: Type of the script + enum: ["plutusV1","plutusV2","timelock","multisig"] + example: plutusV1 + value: + type: + - object + - 'null' + description: Data in JSON format + example: 'null' + bytes: + type: + - string + - 'null' + description: Script bytes (cborSeq) + example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 + size: + type: number + description: The size of the CBOR serialised script (in bytes) + example: 2039 + script_list: + description: List of script and creation tx hash pairs + type: array + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + type: + $ref: "#/components/schemas/script_info/items/properties/type" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + script_redeemers: + description: Array of all redeemers for a given script hash + type: array + items: + type: object + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + redeemers: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + unit_mem: + type: + - string + - number + - 'null' + description: The budget in Memory to run a script + example: 520448 + unit_steps: + type: + - string + - number + - 'null' + description: The budget in Cpu steps to run a script + example: 211535239 + fee: + type: string + description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices + example: 45282 + purpose: + type: string + description: What kind of validation this redeemer is used for + enum: ["spend", "mint", "cert", "reward"] + example: spend + datum_hash: + type: + - string + - 'null' + description: The Hash of the Plutus Data + example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 + datum_value: + $ref: "#/components/schemas/script_info/items/properties/value" + datum_info: + description: Array of datum information for given datum hashes + type: array + items: + type: object + properties: + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + value: + $ref: "#/components/schemas/script_info/items/properties/value" + bytes: + $ref: "#/components/schemas/script_info/items/properties/bytes" + ogmiostip: + description: Current tip of the chain, identified by a slot and a block header hash. + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method that was called in the request + example: "queryNetwork/tip" + result: + type: + - object + - 'null' + - string + - array + - number + description: Result of the query + properties: + slot: + type: number + description: Absolute slot number on chain + example: 59886800 + id: + type: string + description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) + example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" + example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} + headers: {} + responses: + NotFound: + description: The server does not recognise the combination of endpoint and parameters provided + Unauthorized: + description: Access token is missing or invalid + BadRequest: + description: The server cannot process the request due to invalid input +tags: + - name: Network + description: Query information about the network + x-tag-expanded: false + - name: Epoch + description: Query epoch-specific details + x-tag-expanded: false + - name: Block + description: Query information about particular block on chain + x-tag-expanded: false + - name: Transactions + description: Query blockchain transaction details + x-tag-expanded: false + - name: Stake Account + description: Query details about specific stake account addresses + x-tag-expanded: false + - name: Address + description: Query information about specific address(es) + x-tag-expanded: false + - name: Asset + description: Query Asset related informations + x-tag-expanded: false + - name: Governance + description: Query information about governance for network + x-tag-expanded: false + - name: Pool + description: Query information about specific pools + x-tag-expanded: false + - name: Script + description: Query information about specific scripts (Smart Contracts) + x-tag-expanded: false + - name: Ogmios + description: | + Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, + but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. + +
+
+ Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. + Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: +
+ + + ### Network + - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) + - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) + - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) + - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) + ### Ledger-State + - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) + - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) + - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) + - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) + - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) + - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) + - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) + ### Transactions + - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) + - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) + x-tag-expanded: true +security: + - [] + - bearerAuth: [] diff --git a/specs/results/koiosapi-preprod.yaml b/specs/results/koiosapi-preprod.yaml index ebfa3d69..f007e817 100644 --- a/specs/results/koiosapi-preprod.yaml +++ b/specs/results/koiosapi-preprod.yaml @@ -1,5421 +1,5427 @@ -openapi: 3.1.0 -info: - title: Koios API - contact: - name: Koios Core Team - url: https://t.me/CardanoKoios - email: general@koios.rest - license: - name: Creative Commons Attribution 4.0 International - url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE - version: v1.2.0a - description: | - Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. - - # API Usage - - The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. - - ## Vertical Filtering - - Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

- - ``` bash - curl "https://api.koios.rest/api/v1/tip" - - # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] - - curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" - - # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] - ``` - - ## Horizontal Filtering - - You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

- ``` bash - curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" - - # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, - # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] - ``` - - Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): - - |Abbreviation|In PostgreSQL|Meaning | - |------------|-------------|-------------------------------------------| - |eq |`=` |equals | - |gt |`>` |greater than | - |gte |`>=` |greater than or equal | - |lt |`<` |less than | - |lte |`<=` |less than or equal | - |neq |`<>` or `!=` |not equal | - |like |`LIKE` |LIKE operator (use * in place of %) | - |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| - |is |`IS` |checking for exact equality (null,true,false,unknown)| - |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | - |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | - |not |`NOT` |negates another operator | - |or |`OR` |logical `OR` operator | - |and |`AND` |logical `AND` operator | - - ## Pagination (offset/limit) - - When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. - - The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. - - Sounds confusing? Let's see this in practice, to hopefully make it easier. - Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range - - # content-range: 0-999/* - - ``` - - As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range - - # content-range: 1000-1499/* - - ``` - - The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. - However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. - - ## Ordering - - You can set a sorting order for returned queries against specific column(s). - Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" - - # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] - ``` - - ## Response Formats - - You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. - Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" - - # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, - # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, - # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] - - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" - - # epoch_no,epoch_slot,block_time - # 318,28491,1643607582 - # 318,28479,1643607570 - # 318,28406,1643607497 - - ``` - - ## Limits - - While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: - - - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. - - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). - - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). - - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. - - Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. - - # Authentication - - While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). - The examples across this API site already [supports authentication](/#auth), for you to use in the queries. - - # Community projects - - A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) - - x-logo: - url: "https://api.koios.rest/images/koios.png" -servers: - - url: https://api.koios.rest/api/v1 - description: Mainnet - - url: https://guild.koios.rest/api/v1 - description: Guildnet - - url: https://preview.koios.rest/api/v1 - description: Preview Network - - url: https://preprod.koios.rest/api/v1 - description: Preprod Network -paths: - - /tip: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tip" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Query Chain Tip - description: Get the tip info about the latest block seen by chain - operationId: tip - /genesis: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/genesis" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get Genesis info - description: Get the Genesis parameters used to start specific era on chain - operationId: genesis - /totals: #RPC - get: - tags: - - Network - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/totals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get historical tokenomic stats - description: >- - Get the circulating utxo, treasury, rewards, supply and reserves in - lovelace for specified epoch, all epochs if empty - operationId: totals - /param_updates: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/param_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Param Update Proposals - description: Get all parameter update proposals submitted to the chain starting Shelley era - operationId: param_updates - /cli_protocol_params: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/cli_protocol_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: CLI Protocol Parameters - description: >- - Get Current Protocol Parameters as published by cardano-cli. Note that - the output schema of this command is unfortunately fluid on cardano-node - and may vary between CLI versions/era. Accordingly, the returned output for - this endpoint is left as raw JSON (single row) and any filtering to output should - be done on client-side - operationId: cli_protocol_params - /reserve_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Reserve Withdrawals - description: List of all withdrawals from reserves against stake accounts - operationId: reserve_withdrawals - /treasury_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Treasury Withdrawals - description: List of all withdrawals from treasury against stake accounts - operationId: treasury_withdrawals - - /epoch_info: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - - $ref: "#/components/parameters/_include_next_epoch" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch Information - description: Get the epoch information, all epochs if no epoch specified - operationId: epoch_info - /epoch_params: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Protocol Parameters - description: >- - Get the protocol parameters for specific epoch, returns information - about all epochs if no epoch specified - operationId: epoch_params - /epoch_block_protocols: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_block_protocols" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Block Protocols - description: >- - Get the information about block protocol distribution in epoch - operationId: epoch_block_protocols - - /blocks: #RPC - get: - tags: - - Block - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block List - description: Get summarised details about all blocks (paginated - latest first) - operationId: blocks - /block_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/block_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Information - description: Get detailed information about a specific block - operationId: block_info - /block_txs: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions - description: Get a list of all transactions included in provided blocks - operationId: block_txs - /block_tx_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions (Detailed Info) - description: Get detailed information about transaction(s) for requested blocks - operationId: block_tx_info - - /utxo_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/utxo_refs_with_extended" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxO Info - description: Get UTxO set for requested UTxO references - operationId: utxo_info - /tx_cbor: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_cbor" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Raw Transaction (CBOR) - description: Get raw transaction(s) in CBOR format - operationId: tx_cbor - /tx_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Information - description: Get detailed information about transaction(s) - operationId: tx_info - /tx_metadata: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata - description: Get metadata information (if any) for given transaction(s) - operationId: tx_metadata - /tx_metalabels: #RPC - get: - tags: - - Transactions - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metalabels" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata Labels - description: Get a list of all transaction metalabels - operationId: tx_metalabels - /submittx: #submit-api - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/txbin" - x-code-samples: - - lang: "Shell" - source: | - # Assuming ${data} is a raw binary serialized transaction on the file-system. - # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. - curl -X POST \ - --header "Content-Type: application/cbor" \ - --data-binary @${data} https://api.koios.rest/api/v1/submittx - responses: - "202": - description: OK - content: - application/json: - schema: - description: The transaction id. - type: string - format: hex - minLength: 64 - maxLength: 64 - example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f - "400": - description: An error occured while submitting transaction. - summary: Submit Transaction - description: Submit an already serialized transaction to the network. - operationId: submittx - /tx_status: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_status" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Status - description: Get the number of block confirmations for a given transaction hash list - operationId: tx_status - /tx_utxos: #RPC - post: - tags: - - Transactions - deprecated: true - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_utxos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction UTxOs - description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. - operationId: tx_utxos - - /address_info: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Information - description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses - operationId: address_info - /address_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address UTXOs - description: Get UTxO set for given addresses - operationId: address_utxos - /credential_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_utxos" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs from payment credentials - description: Get UTxO details for requested payment credentials - operationId: credential_utxos - /address_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/address_txs" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Transactions - description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) - operationId: address_txs - /credential_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_txs" - responses: - "200": - description: Array of transaction hashes for given credential(s) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transactions from payment credentials - description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) - operationId: credential_txs - /address_assets: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Assets - description: Get the list of all the assets (policy, name and quantity) for given addresses - operationId: address_assets - - /account_list: #RPC - get: - tags: - - Stake Account - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account List - description: Get a list of all stake addresses that have atleast 1 transaction - operationId: account_list - /account_info: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information - description: Get the account information for given stake addresses - operationId: account_info - /account_info_cached: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information (Cached) - description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) - operationId: account_info_cached - /account_utxos: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs for stake addresses (accounts) - description: Get a list of all UTxOs for given stake addresses (account)s - operationId: account_utxos - /account_txs: #RPC - get: - tags: - - Stake Account - parameters: - - $ref: "#/components/parameters/_stake_address" - - $ref: "#/components/parameters/_after_block_height" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Txs - description: Get a list of all Txs for a given stake address (account) - operationId: account_txs - /account_rewards: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_rewards" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Rewards - description: >- - Get the full rewards history (including MIR) for given stake addresses - operationId: account_rewards - /account_updates: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Updates - description: >- - Get the account updates (registration, deregistration, delegation and - withdrawals) for given stake addresses - operationId: account_updates - /account_addresses: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Addresses - description: Get all addresses associated with given staking accounts - operationId: account_addresses - /account_assets: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Assets - description: Get the native asset balance for a given stake address - operationId: account_assets - /account_history: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account History - description: Get the staking history of given stake addresses (accounts) - operationId: account_history - - /asset_list: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset List - description: Get the list of all native assets (paginated) - operationId: asset_list - /policy_asset_list: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of brief information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset List - description: Get the list of asset under the given policy (including balances) - operationId: policy_asset_list - /asset_token_registry: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_token_registry" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Token Registry - description: Get a list of assets registered via token registry on github - operationId: asset_token_registry - /asset_info: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list" - responses: - "200": - description: Array of detailed asset information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Information (Bulk) - description: Get the information of a list of assets including first minting & token registry metadata - operationId: asset_info - /asset_utxos: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset UTXOs - description: Get the UTXO information of a list of assets including - operationId: asset_utxos - /asset_history: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset mint/burn history - content: - application/json: - schema: - $ref: "#/components/schemas/asset_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset History - description: Get the mint/burn history of an asset - operationId: asset_history - /asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Addresses - description: Get the list of all addresses holding a given asset

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: asset_addresses - /asset_nft_address: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy_nft" - - $ref: "#/components/parameters/_asset_name_nft" - responses: - "200": - description: Payment addresses currently holding the given NFT - content: - application/json: - schema: - $ref: "#/components/schemas/asset_nft_address" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: NFT Address - description: Get the address where specified NFT currently reside on. - operationId: asset_nft_address - /policy_asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of asset names and payment addresses for the given policy (including balances) - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Address List - description: Get the list of addresses with quantity for each asset on the given policy

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: policy_asset_addresses - /policy_asset_info: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of detailed information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Information - description: Get the information for all assets under the same policy - operationId: policy_asset_info - /policy_asset_mints: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Get a list of mint or burn count details for all assets minted under a policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_mints" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Mints - description: Get a list of mint or burn count details for all assets minted under a policy - operationId: policy_asset_mints - /asset_summary: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset summary information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_summary" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Summary - description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) - operationId: asset_summary - /asset_txs: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - - $ref: "#/components/parameters/_after_block_height" - - $ref: "#/components/parameters/_history" - responses: - "200": - description: An array of Tx hashes that included the given asset (latest first) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Transactions - description: Get the list of current or all asset transaction hashes (newest first) - operationId: asset_txs - - /drep_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps List - description: List of all active delegated representatives (DReps) - operationId: drep_list - /drep_info: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Info - description: Get detailed information about requested delegated representatives (DReps) - operationId: drep_info - /drep_metadata: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Metadata - description: List metadata for requested delegated representatives (DReps) - operationId: drep_metadata - /drep_updates: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Updates - description: List of updates for requested (or all) delegated representatives (DReps) - operationId: drep_updates - /drep_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Votes - description: List of all votes casted by requested delegated representative (DRep) - operationId: drep_votes - /committee_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_committee_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Committee Votes - description: List of all votes casted by given committee member or collective - operationId: committee_votes - /proposal_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/proposal_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposals List - description: List of all governance proposals - operationId: proposal_list - /proposal_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_tx_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposal Votes - description: List of all votes cast on specified governance action - operationId: proposal_votes - - /pool_list: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool List - description: List of brief info for all pools - operationId: pool_list - /pool_info: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Information - description: Current pool statuses and details for a specified list of pool ids - operationId: pool_info - /pool_stake_snapshot: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_snapshot" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake Snapshot - description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation - operationId: pool_stake_snapshot - /pool_delegators: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators List - description: Return information about live delegators for a given pool. - operationId: pool_delegators - /pool_delegators_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators History - description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). - operationId: pool_delegators_history - /pool_blocks: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Blocks - description: >- - Return information about blocks minted by a given pool for all epochs - (or _epoch_no if provided) - operationId: pool_blocks - /pool_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_history_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake, Block and Reward History - description: >- - Return information about pool stake, block and reward history in a given epoch _epoch_no - (or all epochs that pool existed for, in descending order if no _epoch_no was provided) - operationId: pool_history - /pool_updates: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Updates (History) - description: Return all pool updates for all pools or only updates for specific pool if specified - operationId: pool_updates - /pool_registrations: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Registrations - description: Return all pool registrations initiated in the requested epoch - operationId: pool_registrations - /pool_retirements: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Retirements - description: Return all pool retirements initiated in the requested epoch - operationId: pool_retirements - /pool_relays: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_relays" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Relays - description: A list of registered relays for all pools - operationId: pool_relays - /pool_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Votes - description: List of all votes casted by a pool - operationId: pool_votes - /pool_metadata: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Metadata - description: Metadata (on & off-chain) for all pools - operationId: pool_metadata - - /script_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/script_hashes" - responses: - "200": - description: Array of information for scripts requested - content: - application/json: - schema: - $ref: "#/components/schemas/script_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Information - description: List of script information for given script hashes - operationId: script_info - /native_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of native script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Native Script List - description: List of all existing native script hashes along with their creation transaction hashes - operationId: native_script_list - /plutus_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of Plutus script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Plutus Script List - description: List of all existing Plutus script hashes along with their creation transaction hashes - operationId: plutus_script_list - /script_redeemers: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - responses: - "200": - description: Array of all redeemers for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/script_redeemers" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Redeemers - description: List of all redeemers for a given script hash - operationId: script_redeemers - /script_utxos: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - - $ref: "#/components/parameters/_extended" - responses: - "200": - description: List of UTXOs for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script UTXOs - description: List of all UTXOs for a given script hash - operationId: script_utxos - /datum_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/datum_hashes" - responses: - "200": - description: Array of datum information for given datum hashes - content: - application/json: - schema: - $ref: "#/components/schemas/datum_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Datum Information - description: List of datum information for given datum hashes - operationId: datum_info - - /ogmios: #ogmios-api - post: - tags: - - Ogmios - requestBody: - $ref: "#/components/requestBodies/ogmios" - responses: - "200": - description: Current tip of the chain, identified by a slot and a block header hash. - content: - application/json: - schema: - $ref: "#/components/schemas/ogmiostip" - "400": - $ref: "#/components/responses/BadRequest" - summary: Query Example - description: | - Query the current tip of the Network. - -
-
- We do support transparent forwarding for various methods from Ogmios, you can read about those here. -
- operationId: ogmios - -components: - parameters: - _after_block_height: - deprecated: false - name: _after_block_height - description: Block height for specifying time delta - schema: - type: number - example: 50000 - in: query - required: false - allowEmptyValue: true - _epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "31" - in: query - required: false - allowEmptyValue: true - _stake_address: - deprecated: false - name: _stake_address - description: Cardano staking address (reward account) in bech32 format - schema: - type: string - example: "stake_test1urkzeud48zxwnjc54emzmmc3gkg2r6d6tm2sd799jxjnqxqlfzmvk" - in: query - required: true - allowEmptyValue: false - _tx_hash: - deprecated: false - name: _tx_hash - description: Transaction Hash in hexadecimal format (hex) - example: "d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530" - schema: - type: string - in: query - required: true - allowEmptyValue: false - _asset_policy: - deprecated: false - name: _asset_policy - description: Asset Policy ID in hexadecimal format (hex) - schema: - type: string - example: "c6e65ba7878b2f8ea0ad39287d3e2fd256dc5c4160fc19bdf4c4d87e" - in: query - required: true - allowEmptyValue: false - _asset_name: - deprecated: false - name: _asset_name - description: Asset Name in hexadecimal format (hex), empty asset name returns royalties - schema: - type: string - example: "7447454e53" - in: query - required: false - allowEmptyValue: true - _asset_policy_nft: - deprecated: false - name: _asset_policy - description: NFT Policy ID in hexadecimal format (hex) - schema: - type: string - example: "002126e5e7cb2f5b6ac52ef2cdb9308ff58bf6e3b62e29df447cec72" - in: query - required: true - allowEmptyValue: false - _asset_name_nft: - deprecated: false - name: _asset_name - description: NFT Name in hexadecimal format (hex) - schema: - type: string - example: "74657374" - in: query - required: false - allowEmptyValue: true - _drep_id: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd" - in: query - required: true - allowEmptyValue: false - _drep_id_optional: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd" - in: query - required: false - allowEmptyValue: true - _committee_hash: - deprecated: false - name: _committee_hash - description: Committee hash in hexadecimal format (hex) - schema: - type: string - example: "f8f56120e1ec00feb088ece39ef14f07339afeb37b4e949ff12b89ff" - in: query - required: false - allowEmptyValue: true - _extended: - deprecated: false - name: _extended - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _history: - deprecated: false - name: _history - description: Include all historical transactions, setting to false includes only the non-empty ones - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: false - _include_next_epoch: - deprecated: false - name: _include_next_epoch - description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _pool_bech32: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format - schema: - type: string - example: "pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9" - in: query - required: true - allowEmptyValue: false - _pool_bech32_optional: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format (optional) - schema: - type: string - example: "pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9" - in: query - required: false - allowEmptyValue: true - _pool_epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "31" - in: query - required: false - allowEmptyValue: true - _script_hash: - deprecated: false - name: _script_hash - description: Script hash in hexadecimal format (hex) - schema: - type: string - example: "14abafb323de75b7266fd0eab29b6ef562305e8a0dfbb64b07ef32c7" - in: query - required: true - allowEmptyValue: false - requestBodies: - block_hashes: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - example: - _block_hashes: - - 2abeb8d1c1227139763be30ddb7a2fd79abd7d44195fca87a7c836a510b2802d - - 4e790b758c495953bb33c4aad4a4b4c1b98f7c2ec135ebd3db21f32059481718 - - 389da613316d2aec61edc34d51f1b3d004891ab38c9419771e5e0a3b12de3ef6 - description: Array of block hashes - block_tx_info: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _block_hashes: - - 2abeb8d1c1227139763be30ddb7a2fd79abd7d44195fca87a7c836a510b2802d - - 4e790b758c495953bb33c4aad4a4b4c1b98f7c2ec135ebd3db21f32059481718 - - 389da613316d2aec61edc34d51f1b3d004891ab38c9419771e5e0a3b12de3ef6 - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of block hashes - payment_addresses: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - example: - _addresses: - - addr_test1vzpwq95z3xyum8vqndgdd9mdnmafh3djcxnc6jemlgdmswcve6tkw - - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc - description: Array of Cardano payment address(es) - payment_addresses_with_extended: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _addresses: - - addr_test1vzpwq95z3xyum8vqndgdd9mdnmafh3djcxnc6jemlgdmswcve6tkw - - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc - _extended: true - description: Array of Cardano payment address(es) with extended flag to toggle additional fields - address_txs: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _addresses: - - addr_test1vzpwq95z3xyum8vqndgdd9mdnmafh3djcxnc6jemlgdmswcve6tkw - - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc - _after_block_height: 9417 - description: Array of Cardano payment address(es) - stake_addresses_with_epoch_no: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _epoch_no: - format: integer - type: number - description: Only fetch information for a specific epoch - example: - _stake_addresses: - - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l - - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx - _epoch_no: 30 - description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by - stake_addresses_with_first_only_and_empty: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _first_only: - format: boolean - type: boolean - description: Only return the first result - _empty: - format: boolean - type: boolean - description: Include zero quantity entries - example: - _stake_addresses: - - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l - - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx - _first_only: false - _empty: false - description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs - stake_addresses_with_extended: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _stake_addresses: - - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l - - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx - _extended: true - description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns - stake_addresses: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - example: - _stake_addresses: - - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l - - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx - description: Array of Cardano stake credential(s) in bech32 format - credential_txs: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _payment_credentials: - - b429738bd6cc58b5c7932d001aa2bd05cfea47020a556c8c753d4436 - - 82e016828989cd9d809b50d6976d9efa9bc5b2c1a78d4b3bfa1bb83b - _after_block_height: 9417 - description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight - credential_utxos: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _payment_credentials: - - b429738bd6cc58b5c7932d001aa2bd05cfea47020a556c8c753d4436 - - 82e016828989cd9d809b50d6976d9efa9bc5b2c1a78d4b3bfa1bb83b - _extended: true - description: Array of Cardano payment credential(s) in hex format - tx_ids: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - example: - _tx_hashes: - - d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530 - - 145688d3619e7524510ea64c0ec6363b77a9b8da179ef9bb0273a0940d57d576 - description: Array of Cardano Transaction hashes - tx_info: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _tx_hashes: - - d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530 - - 145688d3619e7524510ea64c0ec6363b77a9b8da179ef9bb0273a0940d57d576 - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of Cardano Transaction hashes - txbin: - content: - application/cbor: - schema: - type: string - format: binary - example: d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530 - description: Serialised Cardano Transaction - pool_ids: - content: - application/json: - schema: - required: - - _pool_bech32_ids - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool1ext7qrwjzaxcdfhdnkq5mth59ukuu2atcg6tgqpmevpt7ratkta - - pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9 - - pool1ws42l6rawqjv58crs5l32v0eem3qnngpnjfd7epwd4lmjccc5cg - description: Array of Cardano pool IDs (bech32 format) - pool_ids_optional: - content: - application/json: - schema: - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool1ext7qrwjzaxcdfhdnkq5mth59ukuu2atcg6tgqpmevpt7ratkta - - pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9 - - pool1ws42l6rawqjv58crs5l32v0eem3qnngpnjfd7epwd4lmjccc5cg - description: Array of Cardano pool IDs (bech32 format) [Optional] - script_hashes: - content: - application/json: - schema: - type: object - properties: - _script_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano script hashes - example: - _script_hashes: - - a8e9f8f34fd631b1d5b9f41a90f4abc0d3935cea7baba0bb34c96f59 - - b4fd6dfe4a643aeec5d75dbb1f27198fc2aabf30bf92ed5470253792 - description: Array of Cardano script hashes - datum_hashes: - content: - application/json: - schema: - type: object - properties: - _datum_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano datum hashes - example: - _datum_hashes: - - 5571e2c3549f15934a38382d1318707a86751fb70827f4cbd29b104480f1be9b - - 5f7212f546d7e7308ce99b925f05538db19981f4ea3084559c0b28a363245826 - description: Array of Cardano datum hashes - asset_list: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - example: - _asset_list: - - ['c6e65ba7878b2f8ea0ad39287d3e2fd256dc5c4160fc19bdf4c4d87e','7447454e53'] - - ['777e6b4903dab74963ae581d39875c5dac16c09bb1f511c0af1ddda8','6141414441'] - description: Array of array of policyID and asset names (hex) - asset_list_with_extended: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _asset_list: - - ['c6e65ba7878b2f8ea0ad39287d3e2fd256dc5c4160fc19bdf4c4d87e','7447454e53'] - - ['777e6b4903dab74963ae581d39875c5dac16c09bb1f511c0af1ddda8','6141414441'] - _extended: true - description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns - drep_id_bulk: - content: - application/json: - schema: - required: - - _drep_ids - type: object - properties: - _drep_ids: - format: text - type: array - descriptions: Array of DRep IDs in bech32 format - items: - type: string - example: - _drep_ids: - - drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd - - drep14x62vyme8l8dkhvxg6rauc6vpcd2va9fquz8k3jstsqczwlvqqh - utxo_refs_with_extended: - content: - application/json: - schema: - required: - - _utxo_refs - type: object - properties: - _utxo_refs: - format: text - type: array - items: - type: string - description: Array of Cardano utxo references in the form "hash#index" - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _utxo_refs: - - d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530#0 - - 145688d3619e7524510ea64c0ec6363b77a9b8da179ef9bb0273a0940d57d576#0 - _extended: false - description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields - ogmios: - content: - application/json: - schema: - required: - - jsonrpc - - method - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab - enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] - example: "queryNetwork/tip" - params: - type: object - description: Any parameters relevant to the specific method to be called - nullable: true - examples: - blockHeight: - description: Query the network’s highest block number. - value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } - genesisConfiguration: - description: Query the genesis configuration of a given era. - value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } - startTimeTime: - description: Query the network start time. - value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } - tip: - description: Query tip of the Network - value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } - epoch: - description: Query the current epoch of the ledger. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } - eraStart: - description: Query information regarding the beginning of the current ledger era. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } - eraSummaries: - description: Query era bounds and slot parameters details, required for proper sloting arithmetic. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } - liveStakeDistribution: - description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } - protocolParameters: - description: Query the current protocol parameters. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } - proposedProtocolParameters: - description: Query the last update proposal w.r.t. protocol parameters, if any. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } - StakePools: - description: Query the list of all stake pool identifiers currently registered and active. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } - submitTransaction: - description: Submit a signed and serialized transaction to the network. - value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } - evaluateTransaction: - description: Evaluate execution units of scripts in a well-formed transaction. - value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } - description: JSON-RPC 2.0 standard request body - securitySchemes: - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT - description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. - schemas: - tip: - description: Current tip of the chain - type: array - items: - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_no: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - genesis: - description: Array of genesis parameters used to start each era on chain - type: array - items: - properties: - networkmagic: - type: string - example: 764824073 - description: Unique network identifier for chain - networkid: - type: string - example: Mainnet - description: Network ID used at various CLI identification to distinguish between Mainnet and other networks - epochlength: - type: string - example: 432000 - description: Number of slots in an epoch - slotlength: - type: string - example: 1 - description: Duration of a single slot (in seconds) - maxlovelacesupply: - type: string - example: 45000000000000000 - description: Maximum smallest units (lovelaces) supply for the blockchain - systemstart: - type: number - description: UNIX timestamp of the first block (genesis) on chain - example: 1506203091 - activeslotcoeff: - type: string - example: 0.05 - description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" - slotsperkesperiod: - type: string - example: 129600 - description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) - maxkesrevolutions: - type: string - example: 62 - description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised - securityparam: - type: string - example: 2160 - description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) - updatequorum: - type: string - example: 5 - description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal - alonzogenesis: - type: string - example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' - description: A JSON dump of Alonzo Genesis - totals: - description: Array of supply/reserves/utxo/fees/treasury stats - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - circulation: - type: string - description: Circulating UTxOs for given epoch (in lovelaces) - example: 32081169442642320 - treasury: - type: string - description: Funds in treasury for given epoch (in lovelaces) - example: 637024173474141 - reward: - type: string - description: Rewards accumulated as of given epoch (in lovelaces) - example: 506871250479840 - supply: - type: string - description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) - example: 33228495612391330 - reserves: - type: string - description: Total Reserves yet to be unlocked on chain - example: 11771504387608670 - param_updates: - description: Array of unique param update proposals submitted on chain - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - data: - type: string - description: JSON encoded data with details about the parameter update - example: {"decentralisation": 0.9} - cli_protocol_params: - description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format - type: object - example: - { - "collateralPercentage": 150, - "maxBlockBodySize": 90112, - "maxBlockHeaderSize": 1100, - "maxCollateralInputs": 3, - "maxTxSize": 16384, - "maxValueSize": 5000, - "minPoolCost": 170000000, - "minUTxOValue": null, - "monetaryExpansion": 3.0e-3, - "poolPledgeInfluence": 0.3, - "poolRetireMaxEpoch": 18, - "protocolVersion": { - "major": 8, - "minor": 0 - }, - "...": "...", - "stakeAddressDeposit": 2000000, - "stakePoolDeposit": 500000000, - "stakePoolTargetNum": 500, - "treasuryCut": 0.2, - "txFeeFixed": 155381, - "txFeePerByte": 44, - "utxoCostPerByte": 4310 - } - reserve_withdrawals: - description: Array of withdrawals from reserves/treasury against stake accounts - type: array - items: - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - earned_epoch: - description: Epoch where amount is earned - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - spendable_epoch: - description: Epoch where the earned amount can be spent - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - pool_list: - description: Array of pool IDs and tickers - type: array - items: - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - ticker: - type: - - string - - 'null' - description: Pool ticker - example: AHL - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_history_info: - description: Array of pool history information - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch for which the pool history data is shown - example: 312 - active_stake: - type: string - description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) - example: "31235800000" - active_stake_pct: - type: number - description: Active stake for the pool, expressed as a percentage of total active stake on network - example: 13.512182543475783 - saturation_pct: - type: number - description: Saturation percentage of a pool at the time of snapshot (2 decimals) - example: 45.32 - block_cnt: - type: - - number - - 'null' - description: Number of blocks pool created in that epoch - example: 14 - delegator_cnt: - type: number - description: Number of delegators to the pool for that epoch snapshot - example: 1432 - margin: - type: number - description: Margin (decimal format) - example: 0.125 - fixed_cost: - type: string - description: Pool fixed cost per epoch (in lovelaces) - example: "340000000" - pool_fees: - type: string - description: Total amount of fees earned by pool owners in that epoch (in lovelaces) - example: "123327382" - deleg_rewards: - type: string - description: Total amount of rewards earned by delegators in that epoch (in lovelaces) - example: "123456789123" - member_rewards: - type: string - description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) - example: "123456780123" - epoch_ros: - type: number - description: Annualized ROS (return on staking) for delegators for this epoch - example: 3.000340466 - pool_info: - description: Array of pool information - type: array - items: - type: object - properties: - pool_id_bech32: - type: string - description: Pool ID (bech32 format) - example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc - pool_id_hex: - type: string - description: Pool ID (Hex format) - example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - vrf_key_hash: - type: - - string - - 'null' - description: Pool VRF key hash - example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 - margin: - type: - - number - - 'null' - description: Margin (decimal format) - example: 0.1 - fixed_cost: - type: - - string - - 'null' - description: Pool fixed cost per epoch - example: "500000000" - pledge: - type: - - string - - 'null' - description: Pool pledge in lovelace - example: "64000000000000" - deposit: - type: - - string - - 'null' - description: Pool's registration deposit in lovelace - example: "500000000" - reward_addr: - type: - - string - - 'null' - description: Pool reward address - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - owners: - type: - - array - - 'null' - items: - type: string - description: Pool (co)owner address - example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 - relays: - type: array - items: - type: object - properties: - dns: - type: - - string - - 'null' - description: DNS name of the relay (nullable) - example: relays-new.cardano-mainnet.iohk.io - srv: - type: - - string - - 'null' - description: DNS service name of the relay (nullable) - example: biostakingpool3.hopto.org - ipv4: - type: - - string - - 'null' - description: IPv4 address of the relay (nullable) - example: "54.220.20.40" - ipv6: - type: - - string - - 'null' - description: IPv6 address of the relay (nullable) - example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf - port: - type: - - number - - 'null' - description: Port number of the relay (nullable) - example: 6000 - meta_url: - type: - - string - - 'null' - description: Pool metadata URL - example: https://pools.iohk.io/IOGP.json - meta_hash: - type: - - string - - 'null' - description: Pool metadata hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - meta_json: - type: - - object - - 'null' - properties: - name: - type: string - description: Pool name - example: Input Output Global (IOHK) - Private - ticker: - type: string - description: Pool ticker - example: IOGP - homepage: - type: string - description: Pool homepage URL - example: https://iohk.io - description: - type: string - description: Pool description - example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. - pool_status: - type: string - description: Pool status - enum: ["registered", "retiring", "retired"] - example: registered - retiring_epoch: - type: - - number - - 'null' - description: Announced retiring epoch (nullable) - example: 'null' - op_cert: - type: - - string - - 'null' - description: Pool latest operational certificate hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - op_cert_counter: - type: - - number - - 'null' - description: Pool latest operational certificate counter value - example: 8 - active_stake: - type: - - string - - 'null' - description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) - example: "64328627680963" - sigma: - type: - - number - - 'null' - description: Pool relative active stake share - example: 0.0034839235 - block_count: - type: - - number - - 'null' - description: Total pool blocks on chain - example: 4509 - live_pledge: - type: - - string - - 'null' - description: Summary of account balance for all pool owner's - example: "64328594406327" - live_stake: - type: - - string - - 'null' - description: Pool live stake - example: "64328627680963" - live_delegators: - type: number - description: Pool live delegator count - example: 5 - live_saturation: - type: - - number - - 'null' - description: Pool live saturation (decimal format) - example: 94.52 - pool_snapshot: - type: array - items: - description: Array of pool stake information for 3 snapshots - type: object - properties: - snapshot: - type: string - description: Type of snapshot ("Mark", "Set" or "Go") - example: "Mark" - epoch_no: - type: number - description: Epoch number for the snapshot entry - example: 324 - nonce: - $ref: "#/components/schemas/epoch_params/items/properties/nonce" - pool_stake: - type: string - description: Pool's Active Stake for the given epoch - example: "100000000000" - active_stake: - type: string - description: Total Active Stake for the given epoch - example: "103703246364020" - pool_delegators: - description: Array of live pool delegators - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - description: Current delegator live stake (in lovelace) - example: 64328591517480 - active_epoch_no: - type: number - description: Epoch number in which the delegation becomes active - example: 324 - latest_delegation_tx_hash: - type: string - description: Latest transaction hash used for delegation by the account - example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 - pool_registrations: - description: Array of pool registrations/retirements - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - pool_delegators_history: - description: Array of pool delegators (historical) - type: - - array - - 'null' - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - epoch_no: - type: number - description: Epoch number for the delegation history - example: 324 - pool_blocks: - description: Array of blocks created by pool - type: array - items: - type: object - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_updates: - description: Array of historical pool updates - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - type: - - number - - 'null' - description: Epoch number in which the update becomes active - example: 324 - vrf_key_hash: - $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - update_type: - type: string - description: Type of update task - enum: ["registration", "deregistration"] - example: registered - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_relays: - description: Array of pool relay information - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - pool_metadata: - description: Array of pool metadata - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - epoch_info: - description: Array of detailed summary for each epoch - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - out_sum: - type: string - description: Total output value across all transactions in epoch - example: 15432725054364942 - fees: - type: string - description: Total fees incurred by transactions in epoch - example: 74325855210 - tx_count: - type: number - description: Number of transactions submitted in epoch - example: 357919 - blk_count: - type: number - description: Number of blocks created in epoch - example: 17321 - start_time: - type: number - description: UNIX timestamp of the epoch start - example: 1506203091 - end_time: - type: number - description: UNIX timestamp of the epoch end - example: 1506635091 - first_block_time: - type: number - description: UNIX timestamp of the epoch's first block - example: 1506635091 - last_block_time: - type: number - description: UNIX timestamp of the epoch's last block - example: 1506635091 - active_stake: - type: - - string - - 'null' - description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) - example: 23395112387185880 - total_rewards: - type: - - string - - 'null' - description: Total rewards earned in epoch (null for pre-Shelley epochs) - example: 252902897534230 - avg_blk_reward: - type: - - string - - 'null' - description: Average block reward for epoch (null for pre-Shelley epochs) - example: 660233450 - epoch_params: - description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - min_fee_a: - type: - - number - - 'null' - description: The 'a' parameter to calculate the minimum transaction fee - example: 44 - min_fee_b: - type: - - number - - 'null' - description: The 'b' parameter to calculate the minimum transaction fee - example: 155381 - max_block_size: - type: - - number - - 'null' - description: The maximum block size (in bytes) - example: 65536 - max_tx_size: - type: - - number - - 'null' - description: The maximum transaction size (in bytes) - example: 16384 - max_bh_size: - type: - - number - - 'null' - description: The maximum block header size (in bytes) - example: 1100 - key_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake address - example: 2000000 - pool_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake pool - example: 500000000 - max_epoch: - type: - - number - - 'null' - description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for - example: 18 - optimal_pool_count: - type: - - number - - 'null' - description: The optimal number of stake pools - example: 500 - influence: - type: - - number - - 'null' - format: double - description: The pledge influence on pool rewards - example: 0.3 - monetary_expand_rate: - type: - - number - - 'null' - format: double - description: The monetary expansion rate - example: 0.003 - treasury_growth_rate: - type: - - number - - 'null' - format: double - description: The treasury growth rate - example: 0.2 - decentralisation: - type: - - number - - 'null' - format: double - description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) - example: 0.1 - extra_entropy: - type: - - string - - 'null' - description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool - example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa - protocol_major: - type: - - number - - 'null' - description: The protocol major version - example: 5 - protocol_minor: - type: - - number - - 'null' - description: The protocol minor version - example: 0 - min_utxo_value: - type: - - string - - 'null' - description: The minimum value of a UTxO entry - example: 34482 - min_pool_cost: - type: - - string - - 'null' - description: The minimum pool cost - example: 340000000 - nonce: - type: - - string - - 'null' - description: The nonce value for this epoch - example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 - block_hash: - type: string - description: The hash of the first block where these parameters are valid - example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 - cost_models: - type: - - object - - 'null' - description: The per language cost model in JSON - example: 'null' - price_mem: - type: - - number - - 'null' - format: double - description: The per word cost of script memory usage - example: 0.0577 - price_step: - type: - - number - - 'null' - format: double - description: The cost of script execution step usage - example: 7.21e-05 - max_tx_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single transaction - example: 10000000 - max_tx_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single transaction - example: 10000000000 - max_block_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single block - example: 50000000 - max_block_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single block - example: 40000000000 - max_val_size: - type: - - number - - 'null' - description: The maximum Val size - example: 5000 - collateral_percent: - type: - - number - - 'null' - description: The percentage of the tx fee which must be provided as collateral when including non-native scripts - example: 150 - max_collateral_inputs: - type: - - number - - 'null' - description: The maximum number of collateral inputs allowed in a transaction - example: 3 - coins_per_utxo_size: - type: - - string - - 'null' - description: The cost per UTxO size - example: 34482 - pvt_motion_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for motion of no-confidence. - example: 0.6 - pvt_committee_normal: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (normal state). - example: 0.65 - pvt_committee_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (state of no-confidence). - example: 0.65 - pvt_hard_fork_initiation: - type: - - number - - 'null' - description: Pool Voting threshold for hard-fork initiation. - example: 0.51 - dvt_motion_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for motion of no-confidence. - example: 0.67 - dvt_committee_normal: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (normal state). - example: 0.67 - dvt_committee_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (state of no-confidence). - example: 0.65 - dvt_update_to_constitution: - type: - - number - - 'null' - description: DRep Vote threshold for update to the Constitution. - example: 0.75 - dvt_hard_fork_initiation: - type: - - number - - 'null' - description: DRep Vote threshold for hard-fork initiation. - example: 0.6 - dvt_p_p_network_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, network group. - example: 0.67 - dvt_p_p_economic_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, economic group. - example: 0.67 - dvt_p_p_technical_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, technical group. - example: 0.67 - dvt_p_p_gov_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, governance group. - example: 0.75 - dvt_treasury_withdrawal: - type: - - number - - 'null' - description: DRep Vote threshold for treasury withdrawal. - example: 0.67 - committee_min_size: - type: - - number - - 'null' - description: Minimal constitutional committee size. - example: 5 - committee_max_term_length: - type: - - number - - 'null' - description: Constitutional committee term limits. - example: 146 - gov_action_lifetime: - type: - - number - - 'null' - description: Governance action expiration. - example: 14 - gov_action_deposit: - type: - - string - - 'null' - description: Governance action deposit. - example: 100000000000 - drep_deposit: - type: - - string - - 'null' - description: DRep deposit amount. - example: 500000000 - drep_activity: - type: - - number - - 'null' - description: DRep activity period. - example: 20 - pvtpp_security_group: - type: - - number - - 'null' - description: Pool Voting threshold for protocol parameter changes, security group. - example: 0.6 - min_fee_ref_script_cost_per_byte: - type: - - number - - 'null' - description: Minimum Fee for Reference Script cost pre byte - example: 15 - epoch_block_protocols: - description: Array of distinct block protocol versions counts in epoch - type: array - items: - properties: - proto_major: - type: number - description: Protocol major version - example: 6 - proto_minor: - type: number - description: Protocol major version - example: 2 - blocks: - type: number - description: Amount of blocks with specified major and protocol combination - example: 2183 - blocks: - description: Array of block information - type: array - items: - type: object - properties: - hash: - type: string - description: Hash of the block - example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f - epoch_no: - type: number - description: Epoch number of the block - example: 117 - abs_slot: - type: number - description: Absolute slot number of the block - example: 49073930 - epoch_slot: - type: number - description: Slot number of the block in epoch - example: 171530 - block_height: - type: - - number - - 'null' - description: Block height - example: 1794506 - block_size: - type: number - description: Block size in bytes - example: 2433 - block_time: - type: number - description: UNIX timestamp of the block - example: 1704757130 - tx_count: - type: number - description: Number of transactions in the block - example: 2 - vrf_key: - type: string - description: VRF key of the block producer - example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" - pool: - type: - - string - - 'null' - description: Pool ID in bech32 format (null for pre-Shelley blocks) - example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v - op_cert_counter: - type: number - description: Counter value of the operational certificate used to create this block - example: 5 - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - parent_hash: - type: string - description: Previous Hash of the current block - example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 - block_info: - description: Array of detailed block information - type: array - items: - type: object - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_size: - $ref: "#/components/schemas/blocks/items/properties/block_size" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - tx_count: - $ref: "#/components/schemas/blocks/items/properties/tx_count" - vrf_key: - $ref: "#/components/schemas/blocks/items/properties/vrf_key" - op_cert: - type: string - description: Hash of the block producers' operational certificate - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - op_cert_counter: - $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" - pool: - $ref: "#/components/schemas/blocks/items/properties/pool" - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - total_output: - type: - - string - - 'null' - description: Total output of the block (in lovelace) - example: 92384672389 - total_fees: - type: - - string - - 'null' - description: Total fees of the block (in lovelace) - example: 2346834 - num_confirmations: - type: number - description: Number of confirmations for the block - example: 664275 - parent_hash: - type: string - description: Hash of the parent of this block - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - child_hash: - type: string - description: Hash of the child of this block (if present) - example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" - block_txs: - description: Array of transactions hashes - type: array - items: - type: object - properties: - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - block_tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" - tx_block_index: - $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" - tx_size: - $ref: "#/components/schemas/tx_info/items/properties/tx_size" - total_output: - $ref: "#/components/schemas/tx_info/items/properties/total_output" - fee: - $ref: "#/components/schemas/tx_info/items/properties/fee" - treasury_donation: - $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" - deposit: - $ref: "#/components/schemas/tx_info/items/properties/deposit" - invalid_before: - $ref: "#/components/schemas/tx_info/items/properties/invalid_before" - invalid_after: - $ref: "#/components/schemas/tx_info/items/properties/invalid_after" - collateral_inputs: - $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" - collateral_output: - $ref: "#/components/schemas/tx_info/items/properties/collateral_output" - reference_inputs: - $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" - inputs: - description: An array of UTxO inputs spent in the transaction - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - outputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - withdrawals: - $ref: "#/components/schemas/tx_info/items/properties/withdrawals" - assets_minted: - $ref: "#/components/schemas/tx_info/items/properties/assets_minted" - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - $ref: "#/components/schemas/tx_info/items/properties/certificates" - native_scripts: - $ref: "#/components/schemas/tx_info/items/properties/native_scripts" - plutus_contracts: - $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" - address_info: - description: Array of information for address(es) - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - balance: - type: string - description: Sum of all UTxO values beloning to address - example: 10723473983 - stake_address: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/account_history/items/properties/stake_address" - script_address: - type: boolean - description: Signifies whether the address is a script address - example: true - utxo_set: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - address_txs: - description: Array of transaction hashes - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - address_assets: - description: Array of address-owned assets - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - - account_list: - description: Array of account (stake address) IDs - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - stake_address_hex: - type: string - description: Cardano staking address (reward account) in hex format - example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf - script_hash: - type: string - description: Script hash in case the stake address is locked by a script - example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 - account_info: - description: Array of stake account information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - status: - type: string - description: Stake address status - enum: ["registered", "not registered"] - example: registered - delegated_drep: - anyOf: - - type: 'null' - - type: string - description: Account's current delegation status to DRep ID in Bech32 format - example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 - delegated_pool: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - total_balance: - type: string - description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) - example: 207116800428 - utxo: - type: string - description: Total UTxO balance of the account - example: 162764177131 - rewards: - type: string - description: Total rewards earned by the account - example: 56457728047 - withdrawals: - type: string - description: Total rewards withdrawn by the account - example: 12105104750 - rewards_available: - type: string - description: Total rewards available for withdrawal - example: 44352623297 - deposit: - type: string - description: Total deposit available for withdrawal - example: 2000000 - reserves: - type: string - description: Total reserves MIR value of the account - example: "0" - treasury: - type: string - description: Total treasury MIR value of the account - example: "0" - utxo_infos: - description: Array of complete UTxO information - type: array - items: - type: object - properties: - tx_hash: - type: string - description: Hash identifier of the transaction - example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e - tx_index: - type: number - description: Index of UTxO in the transaction - example: 0 - address: - type: string - description: A Cardano payment/base address (bech32 encoded) - example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - payment_cred: - type: - - string - - 'null' - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: - - array - - 'null' - description: An array of assets on the UTxO - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of assets on the UTxO - example: 1 - is_spent: - type: boolean - description: True if the UTXO has been spent - example: true - account_rewards: - description: Array of reward history information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - rewards: - type: array - items: - type: object - properties: - earned_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" - spendable_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" - amount: - type: string - description: Amount of rewards earned (in lovelace) - type: - type: string - description: The source of the rewards - enum: [member, leader, treasury, reserves] - example: member - pool_id: - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - account_updates: - description: Array of account updates information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - updates: - type: array - items: - type: object - properties: - action_type: - type: string - description: Type of certificate submitted - enum: ["registration", "delegation", "withdrawal", "deregistration"] - example: "registration" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - account_addresses: - description: Array of payment addresses - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - addresses: - type: array - items: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - account_assets: - description: Array of assets owned by account - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - account_history: - description: Array of active stake values per epoch - type: array - items: - properties: - stake_address: - type: string - description: Cardano staking address (reward account) in bech32 format - example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz - history: - type: array - items: - type: object - properties: - pool_id: - type: string - description: Bech32 representation of pool ID - example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt - epoch_no: - type: number - description: Epoch number - example: 301 - active_stake: - type: string - description: Active stake amount (in lovelaces) - example: 682334162 - tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - type: number - description: UNIX timestamp of the transaction - example: 1506635091 - tx_block_index: - type: number - description: Index of transaction within block - example: 6 - tx_size: - type: number - description: Size in bytes of transaction - example: 391 - total_output: - type: string - description: Total sum of all transaction outputs (in lovelaces) - example: 157832856 - fee: - type: string - description: Total Transaction fee (in lovelaces) - example: 172761 - treasury_donation: - type: string - description: Total Donation to on-chain treasury (in lovelaces) - example: 0 - deposit: - type: string - description: Total Deposits included in transaction (for example, if it is registering a pool/key) - example: 0 - invalid_before: - type: - - string - - 'null' - description: Slot before which transaction cannot be validated (if supplied, else null) - invalid_after: - type: - - string - - 'null' - description: Slot after which transaction cannot be validated - example: 42332172 - collateral_inputs: - description: An array of collateral inputs needed for smart contracts in case of contract failure - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - collateral_output: - description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) - type: array - items: - properties: - payment_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" - stake_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: array - description: Brief asset description from ledger - reference_inputs: - description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - inputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - #description: An array of UTxO inputs spent in the transaction - outputs: - type: array - description: An array of UTxO outputs created by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - datum_hash: - type: - - string - - 'null' - description: Hash of datum (if any) connected to UTxO - example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 - inline_datum: - type: - - object - - 'null' - description: Allows datums to be attached to UTxO (CIP-32) - properties: - bytes: - type: string - description: Datum bytes (hex) - example: 19029a - value: - type: object - description: Value (json) - example: { "int": 666 } - reference_script: - type: - - object - - 'null' - description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) - properties: - hash: - type: string - description: Hash of referenced script - example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 - size: - type: number - description: Size in bytes - example: 14 - type: - type: string - description: Type of script - example: plutusV1 - bytes: - type: string - description: Script bytes (hex) - example: 4e4d01000033222220051200120011 - value: - type: - - object - - 'null' - description: Value (json) - example: 'null' - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - withdrawals: - type: - - array - - 'null' - description: Array of withdrawals with-in a transaction - items: - type: object - properties: - amount: - type: string - description: Withdrawal amount (in lovelaces) - example: 9845162 - stake_addr: - type: string - description: A Cardano staking address (reward account, bech32 encoded) - example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj - assets_minted: - type: - - array - - 'null' - description: Array of minted assets with-in a transaction - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of minted assets (negative on burn) - example: 1 - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - type: - - array - - 'null' - description: Certificates present with-in a transaction (if any) - items: - properties: - index: - type: - - number - - 'null' - description: Certificate index - example: 0 - type: - type: string - description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) - example: delegation - info: - type: - - object - - 'null' - description: A JSON array containing information from the certificate - example: - { - "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", - "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", - } - native_scripts: - type: - - array - - 'null' - description: Native scripts present in a transaction (if any) - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - script_json: - type: object - description: JSON representation of the timelock script (null for other script types) - example: - { - "type": "all", - "scripts": - [ - { - "type": "sig", - "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", - }, - { - "type": "sig", - "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", - }, - { - "type": "sig", - "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", - }, - ], - } - plutus_contracts: - type: - - array - - 'null' - description: Plutus contracts present in transaction (if any) - items: - properties: - address: - type: - - string - - 'null' - description: Plutus script address - example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 - spends_input: - type: - - object - - 'null' - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - description: Input utxo this contract spends - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - bytecode: - $ref: "#/components/schemas/script_info/items/properties/bytes" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - valid_contract: - type: boolean - description: True if the contract is valid or there is no contract - example: true - input: - type: object - properties: - redeemer: - type: object - properties: - purpose: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" - fee: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" - unit: - type: object - properties: - steps: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" - mem: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - tx_cbor: - description: Raw Transaction(s) in CBOR format - item: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - cbor: - type: string - description: CBOR encoded raw transaction. - tx_utxos: - description: Array of inputs and outputs for given transaction(s) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - inputs: - type: array - description: An array of UTxO inputs used by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - type: string - description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned - example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - outputs: - description: An array of UTxO outputs created by the transaction - allOf: - - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" - tx_metadata: - description: Array of metadata information present in each of the transactions queried - type: - - array - - 'null' - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - metadata: - type: - - object - - 'null' - description: A JSON array containing details about metadata within transaction - example: - { - "721": - { - "version": 1, - "copyright": "...", - "publisher": ["p...o"], - "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": - {}, - }, - } - tx_status: - description: Array of transaction confirmation counts - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - num_confirmations: - type: - - number - - 'null' - description: Number of block confirmations - example: 17 - tx_metalabels: - description: Array of known metadata labels - type: array - items: - properties: - key: - type: string - description: A distinct known metalabel - example: "721" - asset_list: - description: Array of policy IDs and asset names - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - asset_token_registry: - description: An array of token registry information (registered via github) for each asset - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - ticker: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" - description: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" - url: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - logo: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" - asset_addresses: - description: An array of payment addresses holding the given token (including balances) - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - type: string - description: Asset balance on the payment address - example: 23 - asset_nft_address: - description: An array of payment addresses holding the given token - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - asset_summary: - description: Array of asset summary information - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_transactions: - type: number - description: Total number of transactions including the given asset - example: 89416 - staked_wallets: - type: number - description: Total number of registered wallets holding the given asset - example: 548 - unstaked_addresses: - type: number - description: Total number of payment addresses (not belonging to registered wallets) holding the given asset - example: 245 - addresses: - type: number - description: Total number of unique addresses holding the given asset - example: 812 - asset_info: - description: Array of detailed asset information - type: array - items: - properties: - policy_id: - type: string - description: Asset Policy ID (hex) - example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff - asset_name: - type: - - string - - 'null' - description: Asset Name (hex) - example: 444f4e545350414d - asset_name_ascii: - type: string - description: Asset Name (ASCII) - example: DONTSPAM - fingerprint: - type: string - description: The CIP14 fingerprint of the asset - example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 - minting_tx_hash: - type: string - description: Hash of the latest mint transaction (with metadata if found for asset) - example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 - total_supply: - type: string - description: Total supply for the asset - example: "35000" - mint_cnt: - type: number - description: Count of total mint transactions - example: 1 - burn_cnt: - type: number - description: Count of total burn transactions - example: 5 - creation_time: - type: number - description: UNIX timestamp of the first asset mint - example: 1506635091 - minting_tx_metadata: - allOf: - - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - description: Latest minting transaction metadata (aligns with CIP-25) - token_registry_metadata: - type: - - object - - 'null' - description: Asset metadata registered on the Cardano Token Registry - properties: - name: - type: string - example: Rackmob - description: - type: string - example: Metaverse Blockchain Cryptocurrency. - ticker: - type: string - example: MOB - url: - type: string - example: https://www.rackmob.com/ - logo: - type: string - description: A PNG image file as a byte string - example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc - decimals: - type: number - example: 0 - cip68_metadata: - type: - - object - - 'null' - description: CIP 68 metadata if present for asset - example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} - asset_history: - description: Array of asset mint/burn history - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_txs: - type: - - array - - 'null' - description: Array of all mint/burn transactions for an asset - items: - type: object - properties: - tx_hash: - type: string - description: Hash of minting/burning transaction - example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - quantity: - type: string - description: Quantity minted/burned (negative numbers indicate burn transactions) - example: "-10" - metadata: - type: array - description: Array of Transaction Metadata for given transaction - items: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - policy_asset_addresses: - description: Array of asset names and payment addresses for the given policy (including balances) - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - policy_asset_info: - description: Array of detailed information of assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - token_registry_metadata: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" - policy_asset_mints: - description: Array of mint information for assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - policy_asset_list: - description: Array of brief information of assets under the same policy - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - drep_info: - description: Get detailed information about requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - type: string - description: DRep ID in bech32 format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - hex: - type: string - description: DRep ID in hex format - example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 - has_script: - type: boolean - description: Flag which shows if this DRep credentials are a script hash - example: false - registered: - type: boolean - description: Flag to show if the DRep is currently registered - example: false - deposit: - type: - - string - - 'null' - description: DRep's registration deposit in lovelace - example: 500000000 - active: - type: boolean - description: Flag to show if the DRep is (i.e. not expired) - example: true - expires_epoch_no: - type: - - number - - 'null' - description: After which epoch DRep is considered inactive. - example: 410 - amount: - type: string - description: The total amount of voting power this DRep is delegated. - example: 599496769641 - drep_list: - description: List of all active delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - has_script: - $ref: "#/components/schemas/drep_info/items/properties/has_script" - registered: - $ref: "#/components/schemas/drep_info/items/properties/registered" - drep_metadata: - description: List metadata for requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - url: - type: string - description: A URL to a JSON payload of metadata - example: "https://hornan7.github.io/Vote_Context.jsonld" - hash: - type: string - description: A hash of the contents of the metadata URL - example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d - json: - type: object - description: The payload as JSON - example: - {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} - bytes: - type: string - description: The raw bytes of the payload - example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d - warning: - type: string - description: A warning that occured while validating the metadata - language: - type: string - description: The language described in the context of the metadata as per CIP-100 - example: en-us - comment: - type: string - description: Comment attached to the metadata - is_valid: - type: boolean - description: Indicate whether data is invalid - example: true - drep_updates: - description: List of updates for requested (or all) delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - type: string - description: The index of this certificate within the the transaction. - example: 1 - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - action: - type: string - description: Effective action for this DRep Update certificate - enum: ["updated","registered","deregistered"] - example: registered - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - drep_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - vote: - type: string - enum: ["Yes","No","Abstain"] - description: Actual Vote casted - example: "Yes" - pool_votes: - description: List of all votes casted by requested pool - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - committee_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - proposal_list: - description: List of all votes cast on specified governance action - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - proposal_type: - type: string - enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] - description: Proposal Action Type - example: ParameterChange - proposal_description: - type: string - description: Description for Proposal Action - example: '{"tag": "InfoAction"}' - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - return_address: - type: string - description: The StakeAddress index of the reward address to receive the deposit when it is repaid. - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - proposed_epoch: - type: number - description: Shows the epoch at which this governance action was proposed. - example: 660 - ratified_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been ratified at the specfied epoch. - example: 670 - enacted_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been enacted at the specfied epoch. - example: 675 - dropped_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. - example: 680 - expired_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been expired at the specfied epoch. - example: 680 - expiration: - type: - - number - - 'null' - description: Shows the epoch at which this governance action is expected to expire. - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - meta_comment: - $ref: "#/components/schemas/drep_metadata/items/properties/comment" - meta_language: - $ref: "#/components/schemas/drep_metadata/items/properties/language" - meta_is_valid: - $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" - withdrawal: - type: - - object - - 'null' - description: If not null, The amount withdrawn from treasury into stake address by this this proposal - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - example: "31235800000" - proposal_votes: - type: array - description: List of all votes cast on specified governance action - items: - properties: - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - voter_role: - type: string - description: The role of the voter - enum: ["ConstitutionalCommittee", "DRep", "SPO"] - example: DRep - voter: - type: string - description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - voter_hex: - type: string - description: Voter's DRep ID , pool ID or committee hash in hex format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - vote: - $ref: "#/components/schemas/drep_votes/items/properties/vote" - - script_info: - type: array - items: - description: Array of information for scripts - properties: - script_hash: - type: string - description: Hash of a script - example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af - creation_tx_hash: - type: string - description: Hash of the script creation transaction - example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe - type: - type: string - description: Type of the script - enum: ["plutusV1","plutusV2","timelock","multisig"] - example: plutusV1 - value: - type: - - object - - 'null' - description: Data in JSON format - example: 'null' - bytes: - type: - - string - - 'null' - description: Script bytes (cborSeq) - example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 - size: - type: number - description: The size of the CBOR serialised script (in bytes) - example: 2039 - script_list: - description: List of script and creation tx hash pairs - type: array - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - type: - $ref: "#/components/schemas/script_info/items/properties/type" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - script_redeemers: - description: Array of all redeemers for a given script hash - type: array - items: - type: object - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - redeemers: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - unit_mem: - type: - - string - - number - - 'null' - description: The budget in Memory to run a script - example: 520448 - unit_steps: - type: - - string - - number - - 'null' - description: The budget in Cpu steps to run a script - example: 211535239 - fee: - type: string - description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices - example: 45282 - purpose: - type: string - description: What kind of validation this redeemer is used for - enum: ["spend", "mint", "cert", "reward"] - example: spend - datum_hash: - type: - - string - - 'null' - description: The Hash of the Plutus Data - example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 - datum_value: - $ref: "#/components/schemas/script_info/items/properties/value" - datum_info: - description: Array of datum information for given datum hashes - type: array - items: - type: object - properties: - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - value: - $ref: "#/components/schemas/script_info/items/properties/value" - bytes: - $ref: "#/components/schemas/script_info/items/properties/bytes" - ogmiostip: - description: Current tip of the chain, identified by a slot and a block header hash. - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method that was called in the request - example: "queryNetwork/tip" - result: - type: - - object - - 'null' - - string - - array - - number - description: Result of the query - properties: - slot: - type: number - description: Absolute slot number on chain - example: 59886800 - id: - type: string - description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) - example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" - example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} - headers: {} - responses: - NotFound: - description: The server does not recognise the combination of endpoint and parameters provided - Unauthorized: - description: Access token is missing or invalid - BadRequest: - description: The server cannot process the request due to invalid input -tags: - - name: Network - description: Query information about the network - x-tag-expanded: false - - name: Epoch - description: Query epoch-specific details - x-tag-expanded: false - - name: Block - description: Query information about particular block on chain - x-tag-expanded: false - - name: Transactions - description: Query blockchain transaction details - x-tag-expanded: false - - name: Stake Account - description: Query details about specific stake account addresses - x-tag-expanded: false - - name: Address - description: Query information about specific address(es) - x-tag-expanded: false - - name: Asset - description: Query Asset related informations - x-tag-expanded: false - - name: Governance - description: Query information about governance for network - x-tag-expanded: false - - name: Pool - description: Query information about specific pools - x-tag-expanded: false - - name: Script - description: Query information about specific scripts (Smart Contracts) - x-tag-expanded: false - - name: Ogmios - description: | - Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, - but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. - -
-
- Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. - Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: -
- - - ### Network - - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) - - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) - - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) - - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) - ### Ledger-State - - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) - - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) - - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) - - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) - - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) - - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) - - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) - ### Transactions - - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) - - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) - x-tag-expanded: true -security: - - [] - - bearerAuth: [] +openapi: 3.1.0 +info: + title: Koios API + contact: + name: Koios Core Team + url: https://t.me/CardanoKoios + email: general@koios.rest + license: + name: Creative Commons Attribution 4.0 International + url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE + version: v1.2.0a + description: | + Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. + + # API Usage + + The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. + + ## Vertical Filtering + + Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

+ + ``` bash + curl "https://api.koios.rest/api/v1/tip" + + # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] + + curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" + + # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] + ``` + + ## Horizontal Filtering + + You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

+ ``` bash + curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" + + # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, + # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] + ``` + + Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): + + |Abbreviation|In PostgreSQL|Meaning | + |------------|-------------|-------------------------------------------| + |eq |`=` |equals | + |gt |`>` |greater than | + |gte |`>=` |greater than or equal | + |lt |`<` |less than | + |lte |`<=` |less than or equal | + |neq |`<>` or `!=` |not equal | + |like |`LIKE` |LIKE operator (use * in place of %) | + |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| + |is |`IS` |checking for exact equality (null,true,false,unknown)| + |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | + |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | + |not |`NOT` |negates another operator | + |or |`OR` |logical `OR` operator | + |and |`AND` |logical `AND` operator | + + ## Pagination (offset/limit) + + When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. + + The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. + + Sounds confusing? Let's see this in practice, to hopefully make it easier. + Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range + + # content-range: 0-999/* + + ``` + + As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range + + # content-range: 1000-1499/* + + ``` + + The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. + However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. + + ## Ordering + + You can set a sorting order for returned queries against specific column(s). + Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" + + # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] + ``` + + ## Response Formats + + You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. + Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" + + # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, + # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, + # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] + + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" + + # epoch_no,epoch_slot,block_time + # 318,28491,1643607582 + # 318,28479,1643607570 + # 318,28406,1643607497 + + ``` + + ## Limits + + While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: + + - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. + - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). + - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). + - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. + + Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. + + # Community projects + + A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) + + x-logo: + url: "https://api.koios.rest/images/koios.png" +servers: + - url: https://api.koios.rest/api/v1 + description: Mainnet + - url: https://guild.koios.rest/api/v1 + description: Guildnet + - url: https://preview.koios.rest/api/v1 + description: Preview Network + - url: https://preprod.koios.rest/api/v1 + description: Preprod Network +paths: + + /tip: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tip" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Query Chain Tip + description: Get the tip info about the latest block seen by chain + operationId: tip + /genesis: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/genesis" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get Genesis info + description: Get the Genesis parameters used to start specific era on chain + operationId: genesis + /totals: #RPC + get: + tags: + - Network + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/totals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get historical tokenomic stats + description: >- + Get the circulating utxo, treasury, rewards, supply and reserves in + lovelace for specified epoch, all epochs if empty + operationId: totals + /param_updates: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/param_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Param Update Proposals + description: Get all parameter update proposals submitted to the chain starting Shelley era + operationId: param_updates + /cli_protocol_params: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/cli_protocol_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: CLI Protocol Parameters + description: >- + Get Current Protocol Parameters as published by cardano-cli. Note that + the output schema of this command is unfortunately fluid on cardano-node + and may vary between CLI versions/era. Accordingly, the returned output for + this endpoint is left as raw JSON (single row) and any filtering to output should + be done on client-side + operationId: cli_protocol_params + /reserve_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Reserve Withdrawals + description: List of all withdrawals from reserves against stake accounts + operationId: reserve_withdrawals + /treasury_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Treasury Withdrawals + description: List of all withdrawals from treasury against stake accounts + operationId: treasury_withdrawals + + /epoch_info: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + - $ref: "#/components/parameters/_include_next_epoch" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch Information + description: Get the epoch information, all epochs if no epoch specified + operationId: epoch_info + /epoch_params: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Protocol Parameters + description: >- + Get the protocol parameters for specific epoch, returns information + about all epochs if no epoch specified + operationId: epoch_params + /epoch_block_protocols: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_block_protocols" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Block Protocols + description: >- + Get the information about block protocol distribution in epoch + operationId: epoch_block_protocols + + /blocks: #RPC + get: + tags: + - Block + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block List + description: Get summarised details about all blocks (paginated - latest first) + operationId: blocks + /block_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/block_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Information + description: Get detailed information about a specific block + operationId: block_info + /block_txs: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions + description: Get a list of all transactions included in provided blocks + operationId: block_txs + /block_tx_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions (Detailed Info) + description: Get detailed information about transaction(s) for requested blocks + operationId: block_tx_info + + /utxo_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/utxo_refs_with_extended" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxO Info + description: Get UTxO set for requested UTxO references + operationId: utxo_info + /tx_cbor: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_cbor" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Raw Transaction (CBOR) + description: Get raw transaction(s) in CBOR format + operationId: tx_cbor + /tx_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Information + description: Get detailed information about transaction(s) + operationId: tx_info + /tx_metadata: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata + description: Get metadata information (if any) for given transaction(s) + operationId: tx_metadata + /tx_metalabels: #RPC + get: + tags: + - Transactions + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metalabels" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata Labels + description: Get a list of all transaction metalabels + operationId: tx_metalabels + /submittx: #submit-api + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/txbin" + x-code-samples: + - lang: "Shell" + source: | + # Assuming ${data} is a raw binary serialized transaction on the file-system. + # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. + curl -X POST \ + --header "Content-Type: application/cbor" \ + --data-binary @${data} https://api.koios.rest/api/v1/submittx + responses: + "202": + description: OK + content: + application/json: + schema: + description: The transaction id. + type: string + format: hex + minLength: 64 + maxLength: 64 + example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f + "400": + description: An error occured while submitting transaction. + summary: Submit Transaction + description: Submit an already serialized transaction to the network. + operationId: submittx + /tx_status: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_status" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Status + description: Get the number of block confirmations for a given transaction hash list + operationId: tx_status + /tx_utxos: #RPC + post: + tags: + - Transactions + deprecated: true + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_utxos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction UTxOs + description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. + operationId: tx_utxos + + /address_info: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Information + description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses + operationId: address_info + /address_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address UTXOs + description: Get UTxO set for given addresses + operationId: address_utxos + /credential_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_utxos" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs from payment credentials + description: Get UTxO details for requested payment credentials + operationId: credential_utxos + /address_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/address_txs" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Transactions + description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) + operationId: address_txs + /credential_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_txs" + responses: + "200": + description: Array of transaction hashes for given credential(s) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transactions from payment credentials + description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) + operationId: credential_txs + /address_assets: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Assets + description: Get the list of all the assets (policy, name and quantity) for given addresses + operationId: address_assets + + /account_list: #RPC + get: + tags: + - Stake Account + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account List + description: Get a list of all stake addresses that have atleast 1 transaction + operationId: account_list + /account_info: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information + description: Get the account information for given stake addresses + operationId: account_info + /account_info_cached: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information (Cached) + description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) + operationId: account_info_cached + /account_utxos: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs for stake addresses (accounts) + description: Get a list of all UTxOs for given stake addresses (account)s + operationId: account_utxos + /account_txs: #RPC + get: + tags: + - Stake Account + parameters: + - $ref: "#/components/parameters/_stake_address" + - $ref: "#/components/parameters/_after_block_height" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Txs + description: Get a list of all Txs for a given stake address (account) + operationId: account_txs + /account_rewards: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_rewards" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Rewards + description: >- + Get the full rewards history (including MIR) for given stake addresses + operationId: account_rewards + /account_updates: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Updates + description: >- + Get the account updates (registration, deregistration, delegation and + withdrawals) for given stake addresses + operationId: account_updates + /account_addresses: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Addresses + description: Get all addresses associated with given staking accounts + operationId: account_addresses + /account_assets: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Assets + description: Get the native asset balance for a given stake address + operationId: account_assets + /account_history: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account History + description: Get the staking history of given stake addresses (accounts) + operationId: account_history + + /asset_list: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset List + description: Get the list of all native assets (paginated) + operationId: asset_list + /policy_asset_list: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of brief information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset List + description: Get the list of asset under the given policy (including balances) + operationId: policy_asset_list + /asset_token_registry: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_token_registry" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Token Registry + description: Get a list of assets registered via token registry on github + operationId: asset_token_registry + /asset_info: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list" + responses: + "200": + description: Array of detailed asset information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Information (Bulk) + description: Get the information of a list of assets including first minting & token registry metadata + operationId: asset_info + /asset_utxos: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset UTXOs + description: Get the UTXO information of a list of assets including + operationId: asset_utxos + /asset_history: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset mint/burn history + content: + application/json: + schema: + $ref: "#/components/schemas/asset_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset History + description: Get the mint/burn history of an asset + operationId: asset_history + /asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Addresses + description: Get the list of all addresses holding a given asset

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: asset_addresses + /asset_nft_address: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy_nft" + - $ref: "#/components/parameters/_asset_name_nft" + responses: + "200": + description: Payment addresses currently holding the given NFT + content: + application/json: + schema: + $ref: "#/components/schemas/asset_nft_address" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: NFT Address + description: Get the address where specified NFT currently reside on. + operationId: asset_nft_address + /policy_asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of asset names and payment addresses for the given policy (including balances) + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Address List + description: Get the list of addresses with quantity for each asset on the given policy

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: policy_asset_addresses + /policy_asset_info: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of detailed information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Information + description: Get the information for all assets under the same policy + operationId: policy_asset_info + /policy_asset_mints: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Get a list of mint or burn count details for all assets minted under a policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_mints" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Mints + description: Get a list of mint or burn count details for all assets minted under a policy + operationId: policy_asset_mints + /asset_summary: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset summary information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_summary" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Summary + description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) + operationId: asset_summary + /asset_txs: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + - $ref: "#/components/parameters/_after_block_height" + - $ref: "#/components/parameters/_history" + responses: + "200": + description: An array of Tx hashes that included the given asset (latest first) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Transactions + description: Get the list of current or all asset transaction hashes (newest first) + operationId: asset_txs + + /drep_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps List + description: List of all active delegated representatives (DReps) + operationId: drep_list + /drep_info: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Info + description: Get detailed information about requested delegated representatives (DReps) + operationId: drep_info + /drep_metadata: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Metadata + description: List metadata for requested delegated representatives (DReps) + operationId: drep_metadata + /drep_updates: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Updates + description: List of updates for requested (or all) delegated representatives (DReps) + operationId: drep_updates + /drep_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Votes + description: List of all votes casted by requested delegated representative (DRep) + operationId: drep_votes + /committee_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_committee_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Committee Votes + description: List of all votes casted by given committee member or collective + operationId: committee_votes + /proposal_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/proposal_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposals List + description: List of all governance proposals + operationId: proposal_list + /proposal_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_tx_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposal Votes + description: List of all votes cast on specified governance action + operationId: proposal_votes + + /pool_list: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool List + description: List of brief info for all pools + operationId: pool_list + /pool_info: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Information + description: Current pool statuses and details for a specified list of pool ids + operationId: pool_info + /pool_stake_snapshot: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_snapshot" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake Snapshot + description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation + operationId: pool_stake_snapshot + /pool_delegators: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators List + description: Return information about live delegators for a given pool. + operationId: pool_delegators + /pool_delegators_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators History + description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). + operationId: pool_delegators_history + /pool_blocks: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Blocks + description: >- + Return information about blocks minted by a given pool for all epochs + (or _epoch_no if provided) + operationId: pool_blocks + /pool_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_history_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake, Block and Reward History + description: >- + Return information about pool stake, block and reward history in a given epoch _epoch_no + (or all epochs that pool existed for, in descending order if no _epoch_no was provided) + operationId: pool_history + /pool_updates: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Updates (History) + description: Return all pool updates for all pools or only updates for specific pool if specified + operationId: pool_updates + /pool_registrations: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Registrations + description: Return all pool registrations initiated in the requested epoch + operationId: pool_registrations + /pool_retirements: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Retirements + description: Return all pool retirements initiated in the requested epoch + operationId: pool_retirements + /pool_relays: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_relays" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Relays + description: A list of registered relays for all pools + operationId: pool_relays + /pool_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Votes + description: List of all votes casted by a pool + operationId: pool_votes + /pool_metadata: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Metadata + description: Metadata (on & off-chain) for all pools + operationId: pool_metadata + + /script_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/script_hashes" + responses: + "200": + description: Array of information for scripts requested + content: + application/json: + schema: + $ref: "#/components/schemas/script_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Information + description: List of script information for given script hashes + operationId: script_info + /native_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of native script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Native Script List + description: List of all existing native script hashes along with their creation transaction hashes + operationId: native_script_list + /plutus_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of Plutus script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Plutus Script List + description: List of all existing Plutus script hashes along with their creation transaction hashes + operationId: plutus_script_list + /script_redeemers: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + responses: + "200": + description: Array of all redeemers for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/script_redeemers" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Redeemers + description: List of all redeemers for a given script hash + operationId: script_redeemers + /script_utxos: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + - $ref: "#/components/parameters/_extended" + responses: + "200": + description: List of UTXOs for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script UTXOs + description: List of all UTXOs for a given script hash + operationId: script_utxos + /datum_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/datum_hashes" + responses: + "200": + description: Array of datum information for given datum hashes + content: + application/json: + schema: + $ref: "#/components/schemas/datum_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Datum Information + description: List of datum information for given datum hashes + operationId: datum_info + + /ogmios: #ogmios-api + post: + tags: + - Ogmios + requestBody: + $ref: "#/components/requestBodies/ogmios" + responses: + "200": + description: Current tip of the chain, identified by a slot and a block header hash. + content: + application/json: + schema: + $ref: "#/components/schemas/ogmiostip" + "400": + $ref: "#/components/responses/BadRequest" + summary: Query Example + description: | + Query the current tip of the Network. + +
+
+ We do support transparent forwarding for various methods from Ogmios, you can read about those here. +
+ operationId: ogmios + +components: + parameters: + _after_block_height: + deprecated: false + name: _after_block_height + description: Block height for specifying time delta + schema: + type: number + example: 50000 + in: query + required: false + allowEmptyValue: true + _epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "31" + in: query + required: false + allowEmptyValue: true + _stake_address: + deprecated: false + name: _stake_address + description: Cardano staking address (reward account) in bech32 format + schema: + type: string + example: "stake_test1urkzeud48zxwnjc54emzmmc3gkg2r6d6tm2sd799jxjnqxqlfzmvk" + in: query + required: true + allowEmptyValue: false + _tx_hash: + deprecated: false + name: _tx_hash + description: Transaction Hash in hexadecimal format (hex) + example: "d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530" + schema: + type: string + in: query + required: true + allowEmptyValue: false + _asset_policy: + deprecated: false + name: _asset_policy + description: Asset Policy ID in hexadecimal format (hex) + schema: + type: string + example: "c6e65ba7878b2f8ea0ad39287d3e2fd256dc5c4160fc19bdf4c4d87e" + in: query + required: true + allowEmptyValue: false + _asset_name: + deprecated: false + name: _asset_name + description: Asset Name in hexadecimal format (hex), empty asset name returns royalties + schema: + type: string + example: "7447454e53" + in: query + required: false + allowEmptyValue: true + _asset_policy_nft: + deprecated: false + name: _asset_policy + description: NFT Policy ID in hexadecimal format (hex) + schema: + type: string + example: "002126e5e7cb2f5b6ac52ef2cdb9308ff58bf6e3b62e29df447cec72" + in: query + required: true + allowEmptyValue: false + _asset_name_nft: + deprecated: false + name: _asset_name + description: NFT Name in hexadecimal format (hex) + schema: + type: string + example: "74657374" + in: query + required: false + allowEmptyValue: true + _drep_id: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd" + in: query + required: true + allowEmptyValue: false + _drep_id_optional: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd" + in: query + required: false + allowEmptyValue: true + _committee_hash: + deprecated: false + name: _committee_hash + description: Committee hash in hexadecimal format (hex) + schema: + type: string + example: "f8f56120e1ec00feb088ece39ef14f07339afeb37b4e949ff12b89ff" + in: query + required: false + allowEmptyValue: true + _extended: + deprecated: false + name: _extended + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _history: + deprecated: false + name: _history + description: Include all historical transactions, setting to false includes only the non-empty ones + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: false + _include_next_epoch: + deprecated: false + name: _include_next_epoch + description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _pool_bech32: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format + schema: + type: string + example: "pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9" + in: query + required: true + allowEmptyValue: false + _pool_bech32_optional: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format (optional) + schema: + type: string + example: "pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9" + in: query + required: false + allowEmptyValue: true + _pool_epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "31" + in: query + required: false + allowEmptyValue: true + _script_hash: + deprecated: false + name: _script_hash + description: Script hash in hexadecimal format (hex) + schema: + type: string + example: "14abafb323de75b7266fd0eab29b6ef562305e8a0dfbb64b07ef32c7" + in: query + required: true + allowEmptyValue: false + requestBodies: + block_hashes: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + example: + _block_hashes: + - 2abeb8d1c1227139763be30ddb7a2fd79abd7d44195fca87a7c836a510b2802d + - 4e790b758c495953bb33c4aad4a4b4c1b98f7c2ec135ebd3db21f32059481718 + - 389da613316d2aec61edc34d51f1b3d004891ab38c9419771e5e0a3b12de3ef6 + description: Array of block hashes + block_tx_info: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _block_hashes: + - 2abeb8d1c1227139763be30ddb7a2fd79abd7d44195fca87a7c836a510b2802d + - 4e790b758c495953bb33c4aad4a4b4c1b98f7c2ec135ebd3db21f32059481718 + - 389da613316d2aec61edc34d51f1b3d004891ab38c9419771e5e0a3b12de3ef6 + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of block hashes + payment_addresses: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + example: + _addresses: + - addr_test1vzpwq95z3xyum8vqndgdd9mdnmafh3djcxnc6jemlgdmswcve6tkw + - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc + description: Array of Cardano payment address(es) + payment_addresses_with_extended: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _addresses: + - addr_test1vzpwq95z3xyum8vqndgdd9mdnmafh3djcxnc6jemlgdmswcve6tkw + - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc + _extended: true + description: Array of Cardano payment address(es) with extended flag to toggle additional fields + address_txs: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _addresses: + - addr_test1vzpwq95z3xyum8vqndgdd9mdnmafh3djcxnc6jemlgdmswcve6tkw + - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc + _after_block_height: 9417 + description: Array of Cardano payment address(es) + stake_addresses_with_epoch_no: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _epoch_no: + format: integer + type: number + description: Only fetch information for a specific epoch + example: + _stake_addresses: + - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l + - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx + _epoch_no: 30 + description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by + stake_addresses_with_first_only_and_empty: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _first_only: + format: boolean + type: boolean + description: Only return the first result + _empty: + format: boolean + type: boolean + description: Include zero quantity entries + example: + _stake_addresses: + - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l + - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx + _first_only: false + _empty: false + description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs + stake_addresses_with_extended: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _stake_addresses: + - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l + - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx + _extended: true + description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns + stake_addresses: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + example: + _stake_addresses: + - stake_test1urq4rcynzj4uxqc74c852zky7wa6epgmn9r6k3j3gv7502q8jks0l + - stake_test1ur4t5nhceyn2amfuj7z74uxmmj8jf9fmgd2egqw8c98ve3cp2g4wx + description: Array of Cardano stake credential(s) in bech32 format + credential_txs: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _payment_credentials: + - b429738bd6cc58b5c7932d001aa2bd05cfea47020a556c8c753d4436 + - 82e016828989cd9d809b50d6976d9efa9bc5b2c1a78d4b3bfa1bb83b + _after_block_height: 9417 + description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight + credential_utxos: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _payment_credentials: + - b429738bd6cc58b5c7932d001aa2bd05cfea47020a556c8c753d4436 + - 82e016828989cd9d809b50d6976d9efa9bc5b2c1a78d4b3bfa1bb83b + _extended: true + description: Array of Cardano payment credential(s) in hex format + tx_ids: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + example: + _tx_hashes: + - d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530 + - 145688d3619e7524510ea64c0ec6363b77a9b8da179ef9bb0273a0940d57d576 + description: Array of Cardano Transaction hashes + tx_info: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _tx_hashes: + - d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530 + - 145688d3619e7524510ea64c0ec6363b77a9b8da179ef9bb0273a0940d57d576 + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of Cardano Transaction hashes + txbin: + content: + application/cbor: + schema: + type: string + format: binary + example: d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530 + description: Serialised Cardano Transaction + pool_ids: + content: + application/json: + schema: + required: + - _pool_bech32_ids + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool1ext7qrwjzaxcdfhdnkq5mth59ukuu2atcg6tgqpmevpt7ratkta + - pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9 + - pool1ws42l6rawqjv58crs5l32v0eem3qnngpnjfd7epwd4lmjccc5cg + description: Array of Cardano pool IDs (bech32 format) + pool_ids_optional: + content: + application/json: + schema: + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool1ext7qrwjzaxcdfhdnkq5mth59ukuu2atcg6tgqpmevpt7ratkta + - pool1x4p3cwemsm356vpxnjwuud7w76jz64hyss729zp7xa6wuey6yr9 + - pool1ws42l6rawqjv58crs5l32v0eem3qnngpnjfd7epwd4lmjccc5cg + description: Array of Cardano pool IDs (bech32 format) [Optional] + script_hashes: + content: + application/json: + schema: + type: object + properties: + _script_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano script hashes + example: + _script_hashes: + - a8e9f8f34fd631b1d5b9f41a90f4abc0d3935cea7baba0bb34c96f59 + - b4fd6dfe4a643aeec5d75dbb1f27198fc2aabf30bf92ed5470253792 + description: Array of Cardano script hashes + datum_hashes: + content: + application/json: + schema: + type: object + properties: + _datum_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano datum hashes + example: + _datum_hashes: + - 5571e2c3549f15934a38382d1318707a86751fb70827f4cbd29b104480f1be9b + - 5f7212f546d7e7308ce99b925f05538db19981f4ea3084559c0b28a363245826 + description: Array of Cardano datum hashes + asset_list: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + example: + _asset_list: + - ['c6e65ba7878b2f8ea0ad39287d3e2fd256dc5c4160fc19bdf4c4d87e','7447454e53'] + - ['777e6b4903dab74963ae581d39875c5dac16c09bb1f511c0af1ddda8','6141414441'] + description: Array of array of policyID and asset names (hex) + asset_list_with_extended: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _asset_list: + - ['c6e65ba7878b2f8ea0ad39287d3e2fd256dc5c4160fc19bdf4c4d87e','7447454e53'] + - ['777e6b4903dab74963ae581d39875c5dac16c09bb1f511c0af1ddda8','6141414441'] + _extended: true + description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns + drep_id_bulk: + content: + application/json: + schema: + required: + - _drep_ids + type: object + properties: + _drep_ids: + format: text + type: array + descriptions: Array of DRep IDs in bech32 format + items: + type: string + example: + _drep_ids: + - drep1kxtwaqtayj6vklc57u93xayjvkwgvefh8drscqp5a5y6jz7m6rd + - drep14x62vyme8l8dkhvxg6rauc6vpcd2va9fquz8k3jstsqczwlvqqh + utxo_refs_with_extended: + content: + application/json: + schema: + required: + - _utxo_refs + type: object + properties: + _utxo_refs: + format: text + type: array + items: + type: string + description: Array of Cardano utxo references in the form "hash#index" + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _utxo_refs: + - d10133964da9e443b303917fd0b7644ae3d01c133deff85b4f59416c2d00f530#0 + - 145688d3619e7524510ea64c0ec6363b77a9b8da179ef9bb0273a0940d57d576#0 + _extended: false + description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields + ogmios: + content: + application/json: + schema: + required: + - jsonrpc + - method + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab + enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] + example: "queryNetwork/tip" + params: + type: object + description: Any parameters relevant to the specific method to be called + nullable: true + examples: + blockHeight: + description: Query the network’s highest block number. + value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } + genesisConfiguration: + description: Query the genesis configuration of a given era. + value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } + startTimeTime: + description: Query the network start time. + value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } + tip: + description: Query tip of the Network + value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } + epoch: + description: Query the current epoch of the ledger. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } + eraStart: + description: Query information regarding the beginning of the current ledger era. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } + eraSummaries: + description: Query era bounds and slot parameters details, required for proper sloting arithmetic. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } + liveStakeDistribution: + description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } + protocolParameters: + description: Query the current protocol parameters. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } + proposedProtocolParameters: + description: Query the last update proposal w.r.t. protocol parameters, if any. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } + StakePools: + description: Query the list of all stake pool identifiers currently registered and active. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } + submitTransaction: + description: Submit a signed and serialized transaction to the network. + value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } + evaluateTransaction: + description: Evaluate execution units of scripts in a well-formed transaction. + value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } + description: JSON-RPC 2.0 standard request body + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT + description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. + schemas: + tip: + description: Current tip of the chain + type: array + items: + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_no: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + genesis: + description: Array of genesis parameters used to start each era on chain + type: array + items: + properties: + networkmagic: + type: string + example: 764824073 + description: Unique network identifier for chain + networkid: + type: string + example: Mainnet + description: Network ID used at various CLI identification to distinguish between Mainnet and other networks + epochlength: + type: string + example: 432000 + description: Number of slots in an epoch + slotlength: + type: string + example: 1 + description: Duration of a single slot (in seconds) + maxlovelacesupply: + type: string + example: 45000000000000000 + description: Maximum smallest units (lovelaces) supply for the blockchain + systemstart: + type: number + description: UNIX timestamp of the first block (genesis) on chain + example: 1506203091 + activeslotcoeff: + type: string + example: 0.05 + description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" + slotsperkesperiod: + type: string + example: 129600 + description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) + maxkesrevolutions: + type: string + example: 62 + description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised + securityparam: + type: string + example: 2160 + description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) + updatequorum: + type: string + example: 5 + description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal + alonzogenesis: + type: string + example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' + description: A JSON dump of Alonzo Genesis + totals: + description: Array of supply/reserves/utxo/fees/treasury stats + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + circulation: + type: string + description: Circulating UTxOs for given epoch (in lovelaces) + example: 32081169442642320 + treasury: + type: string + description: Funds in treasury for given epoch (in lovelaces) + example: 637024173474141 + reward: + type: string + description: Rewards accumulated as of given epoch (in lovelaces) + example: 506871250479840 + supply: + type: string + description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) + example: 33228495612391330 + reserves: + type: string + description: Total Reserves yet to be unlocked on chain + example: 11771504387608670 + param_updates: + description: Array of unique param update proposals submitted on chain + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + data: + type: string + description: JSON encoded data with details about the parameter update + example: {"decentralisation": 0.9} + cli_protocol_params: + description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format + type: object + example: + { + "collateralPercentage": 150, + "maxBlockBodySize": 90112, + "maxBlockHeaderSize": 1100, + "maxCollateralInputs": 3, + "maxTxSize": 16384, + "maxValueSize": 5000, + "minPoolCost": 170000000, + "minUTxOValue": null, + "monetaryExpansion": 3.0e-3, + "poolPledgeInfluence": 0.3, + "poolRetireMaxEpoch": 18, + "protocolVersion": { + "major": 8, + "minor": 0 + }, + "...": "...", + "stakeAddressDeposit": 2000000, + "stakePoolDeposit": 500000000, + "stakePoolTargetNum": 500, + "treasuryCut": 0.2, + "txFeeFixed": 155381, + "txFeePerByte": 44, + "utxoCostPerByte": 4310 + } + reserve_withdrawals: + description: Array of withdrawals from reserves/treasury against stake accounts + type: array + items: + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + earned_epoch: + description: Epoch where amount is earned + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + spendable_epoch: + description: Epoch where the earned amount can be spent + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + pool_list: + description: Array of pool IDs and tickers + type: array + items: + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + ticker: + type: + - string + - 'null' + description: Pool ticker + example: AHL + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_history_info: + description: Array of pool history information + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch for which the pool history data is shown + example: 312 + active_stake: + type: string + description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) + example: "31235800000" + active_stake_pct: + type: number + description: Active stake for the pool, expressed as a percentage of total active stake on network + example: 13.512182543475783 + saturation_pct: + type: number + description: Saturation percentage of a pool at the time of snapshot (2 decimals) + example: 45.32 + block_cnt: + type: + - number + - 'null' + description: Number of blocks pool created in that epoch + example: 14 + delegator_cnt: + type: number + description: Number of delegators to the pool for that epoch snapshot + example: 1432 + margin: + type: number + description: Margin (decimal format) + example: 0.125 + fixed_cost: + type: string + description: Pool fixed cost per epoch (in lovelaces) + example: "340000000" + pool_fees: + type: string + description: Total amount of fees earned by pool owners in that epoch (in lovelaces) + example: "123327382" + deleg_rewards: + type: string + description: Total amount of rewards earned by delegators in that epoch (in lovelaces) + example: "123456789123" + member_rewards: + type: string + description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) + example: "123456780123" + epoch_ros: + type: number + description: Annualized ROS (return on staking) for delegators for this epoch + example: 3.000340466 + pool_info: + description: Array of pool information + type: array + items: + type: object + properties: + pool_id_bech32: + type: string + description: Pool ID (bech32 format) + example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc + pool_id_hex: + type: string + description: Pool ID (Hex format) + example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + vrf_key_hash: + type: + - string + - 'null' + description: Pool VRF key hash + example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 + margin: + type: + - number + - 'null' + description: Margin (decimal format) + example: 0.1 + fixed_cost: + type: + - string + - 'null' + description: Pool fixed cost per epoch + example: "500000000" + pledge: + type: + - string + - 'null' + description: Pool pledge in lovelace + example: "64000000000000" + deposit: + type: + - string + - 'null' + description: Pool's registration deposit in lovelace + example: "500000000" + reward_addr: + type: + - string + - 'null' + description: Pool reward address + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + owners: + type: + - array + - 'null' + items: + type: string + description: Pool (co)owner address + example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 + relays: + type: array + items: + type: object + properties: + dns: + type: + - string + - 'null' + description: DNS name of the relay (nullable) + example: relays-new.cardano-mainnet.iohk.io + srv: + type: + - string + - 'null' + description: DNS service name of the relay (nullable) + example: biostakingpool3.hopto.org + ipv4: + type: + - string + - 'null' + description: IPv4 address of the relay (nullable) + example: "54.220.20.40" + ipv6: + type: + - string + - 'null' + description: IPv6 address of the relay (nullable) + example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf + port: + type: + - number + - 'null' + description: Port number of the relay (nullable) + example: 6000 + meta_url: + type: + - string + - 'null' + description: Pool metadata URL + example: https://pools.iohk.io/IOGP.json + meta_hash: + type: + - string + - 'null' + description: Pool metadata hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + meta_json: + type: + - object + - 'null' + properties: + name: + type: string + description: Pool name + example: Input Output Global (IOHK) - Private + ticker: + type: string + description: Pool ticker + example: IOGP + homepage: + type: string + description: Pool homepage URL + example: https://iohk.io + description: + type: string + description: Pool description + example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. + pool_status: + type: string + description: Pool status + enum: ["registered", "retiring", "retired"] + example: registered + retiring_epoch: + type: + - number + - 'null' + description: Announced retiring epoch (nullable) + example: 'null' + op_cert: + type: + - string + - 'null' + description: Pool latest operational certificate hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + op_cert_counter: + type: + - number + - 'null' + description: Pool latest operational certificate counter value + example: 8 + active_stake: + type: + - string + - 'null' + description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) + example: "64328627680963" + sigma: + type: + - number + - 'null' + description: Pool relative active stake share + example: 0.0034839235 + block_count: + type: + - number + - 'null' + description: Total pool blocks on chain + example: 4509 + live_pledge: + type: + - string + - 'null' + description: Summary of account balance for all pool owner's + example: "64328594406327" + live_stake: + type: + - string + - 'null' + description: Pool live stake + example: "64328627680963" + live_delegators: + type: number + description: Pool live delegator count + example: 5 + live_saturation: + type: + - number + - 'null' + description: Pool live saturation (decimal format) + example: 94.52 + pool_snapshot: + type: array + items: + description: Array of pool stake information for 3 snapshots + type: object + properties: + snapshot: + type: string + description: Type of snapshot ("Mark", "Set" or "Go") + example: "Mark" + epoch_no: + type: number + description: Epoch number for the snapshot entry + example: 324 + nonce: + $ref: "#/components/schemas/epoch_params/items/properties/nonce" + pool_stake: + type: string + description: Pool's Active Stake for the given epoch + example: "100000000000" + active_stake: + type: string + description: Total Active Stake for the given epoch + example: "103703246364020" + pool_delegators: + description: Array of live pool delegators + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + description: Current delegator live stake (in lovelace) + example: 64328591517480 + active_epoch_no: + type: number + description: Epoch number in which the delegation becomes active + example: 324 + latest_delegation_tx_hash: + type: string + description: Latest transaction hash used for delegation by the account + example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 + pool_registrations: + description: Array of pool registrations/retirements + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + pool_delegators_history: + description: Array of pool delegators (historical) + type: + - array + - 'null' + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + epoch_no: + type: number + description: Epoch number for the delegation history + example: 324 + pool_blocks: + description: Array of blocks created by pool + type: array + items: + type: object + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_updates: + description: Array of historical pool updates + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + type: + - number + - 'null' + description: Epoch number in which the update becomes active + example: 324 + vrf_key_hash: + $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + update_type: + type: string + description: Type of update task + enum: ["registration", "deregistration"] + example: registered + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_relays: + description: Array of pool relay information + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + pool_metadata: + description: Array of pool metadata + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + epoch_info: + description: Array of detailed summary for each epoch + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + out_sum: + type: string + description: Total output value across all transactions in epoch + example: 15432725054364942 + fees: + type: string + description: Total fees incurred by transactions in epoch + example: 74325855210 + tx_count: + type: number + description: Number of transactions submitted in epoch + example: 357919 + blk_count: + type: number + description: Number of blocks created in epoch + example: 17321 + start_time: + type: number + description: UNIX timestamp of the epoch start + example: 1506203091 + end_time: + type: number + description: UNIX timestamp of the epoch end + example: 1506635091 + first_block_time: + type: number + description: UNIX timestamp of the epoch's first block + example: 1506635091 + last_block_time: + type: number + description: UNIX timestamp of the epoch's last block + example: 1506635091 + active_stake: + type: + - string + - 'null' + description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) + example: 23395112387185880 + total_rewards: + type: + - string + - 'null' + description: Total rewards earned in epoch (null for pre-Shelley epochs) + example: 252902897534230 + avg_blk_reward: + type: + - string + - 'null' + description: Average block reward for epoch (null for pre-Shelley epochs) + example: 660233450 + epoch_params: + description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + min_fee_a: + type: + - number + - 'null' + description: The 'a' parameter to calculate the minimum transaction fee + example: 44 + min_fee_b: + type: + - number + - 'null' + description: The 'b' parameter to calculate the minimum transaction fee + example: 155381 + max_block_size: + type: + - number + - 'null' + description: The maximum block size (in bytes) + example: 65536 + max_tx_size: + type: + - number + - 'null' + description: The maximum transaction size (in bytes) + example: 16384 + max_bh_size: + type: + - number + - 'null' + description: The maximum block header size (in bytes) + example: 1100 + key_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake address + example: 2000000 + pool_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake pool + example: 500000000 + max_epoch: + type: + - number + - 'null' + description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for + example: 18 + optimal_pool_count: + type: + - number + - 'null' + description: The optimal number of stake pools + example: 500 + influence: + type: + - number + - 'null' + format: double + description: The pledge influence on pool rewards + example: 0.3 + monetary_expand_rate: + type: + - number + - 'null' + format: double + description: The monetary expansion rate + example: 0.003 + treasury_growth_rate: + type: + - number + - 'null' + format: double + description: The treasury growth rate + example: 0.2 + decentralisation: + type: + - number + - 'null' + format: double + description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) + example: 0.1 + extra_entropy: + type: + - string + - 'null' + description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool + example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa + protocol_major: + type: + - number + - 'null' + description: The protocol major version + example: 5 + protocol_minor: + type: + - number + - 'null' + description: The protocol minor version + example: 0 + min_utxo_value: + type: + - string + - 'null' + description: The minimum value of a UTxO entry + example: 34482 + min_pool_cost: + type: + - string + - 'null' + description: The minimum pool cost + example: 340000000 + nonce: + type: + - string + - 'null' + description: The nonce value for this epoch + example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 + block_hash: + type: string + description: The hash of the first block where these parameters are valid + example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 + cost_models: + type: + - object + - 'null' + description: The per language cost model in JSON + example: 'null' + price_mem: + type: + - number + - 'null' + format: double + description: The per word cost of script memory usage + example: 0.0577 + price_step: + type: + - number + - 'null' + format: double + description: The cost of script execution step usage + example: 7.21e-05 + max_tx_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single transaction + example: 10000000 + max_tx_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single transaction + example: 10000000000 + max_block_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single block + example: 50000000 + max_block_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single block + example: 40000000000 + max_val_size: + type: + - number + - 'null' + description: The maximum Val size + example: 5000 + collateral_percent: + type: + - number + - 'null' + description: The percentage of the tx fee which must be provided as collateral when including non-native scripts + example: 150 + max_collateral_inputs: + type: + - number + - 'null' + description: The maximum number of collateral inputs allowed in a transaction + example: 3 + coins_per_utxo_size: + type: + - string + - 'null' + description: The cost per UTxO size + example: 34482 + pvt_motion_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for motion of no-confidence. + example: 0.6 + pvt_committee_normal: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (normal state). + example: 0.65 + pvt_committee_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (state of no-confidence). + example: 0.65 + pvt_hard_fork_initiation: + type: + - number + - 'null' + description: Pool Voting threshold for hard-fork initiation. + example: 0.51 + dvt_motion_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for motion of no-confidence. + example: 0.67 + dvt_committee_normal: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (normal state). + example: 0.67 + dvt_committee_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (state of no-confidence). + example: 0.65 + dvt_update_to_constitution: + type: + - number + - 'null' + description: DRep Vote threshold for update to the Constitution. + example: 0.75 + dvt_hard_fork_initiation: + type: + - number + - 'null' + description: DRep Vote threshold for hard-fork initiation. + example: 0.6 + dvt_p_p_network_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, network group. + example: 0.67 + dvt_p_p_economic_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, economic group. + example: 0.67 + dvt_p_p_technical_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, technical group. + example: 0.67 + dvt_p_p_gov_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, governance group. + example: 0.75 + dvt_treasury_withdrawal: + type: + - number + - 'null' + description: DRep Vote threshold for treasury withdrawal. + example: 0.67 + committee_min_size: + type: + - number + - 'null' + description: Minimal constitutional committee size. + example: 5 + committee_max_term_length: + type: + - number + - 'null' + description: Constitutional committee term limits. + example: 146 + gov_action_lifetime: + type: + - number + - 'null' + description: Governance action expiration. + example: 14 + gov_action_deposit: + type: + - string + - 'null' + description: Governance action deposit. + example: 100000000000 + drep_deposit: + type: + - string + - 'null' + description: DRep deposit amount. + example: 500000000 + drep_activity: + type: + - number + - 'null' + description: DRep activity period. + example: 20 + pvtpp_security_group: + type: + - number + - 'null' + description: Pool Voting threshold for protocol parameter changes, security group. + example: 0.6 + min_fee_ref_script_cost_per_byte: + type: + - number + - 'null' + description: Minimum Fee for Reference Script cost pre byte + example: 15 + epoch_block_protocols: + description: Array of distinct block protocol versions counts in epoch + type: array + items: + properties: + proto_major: + type: number + description: Protocol major version + example: 6 + proto_minor: + type: number + description: Protocol major version + example: 2 + blocks: + type: number + description: Amount of blocks with specified major and protocol combination + example: 2183 + blocks: + description: Array of block information + type: array + items: + type: object + properties: + hash: + type: string + description: Hash of the block + example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f + epoch_no: + type: number + description: Epoch number of the block + example: 117 + abs_slot: + type: number + description: Absolute slot number of the block + example: 49073930 + epoch_slot: + type: number + description: Slot number of the block in epoch + example: 171530 + block_height: + type: + - number + - 'null' + description: Block height + example: 1794506 + block_size: + type: number + description: Block size in bytes + example: 2433 + block_time: + type: number + description: UNIX timestamp of the block + example: 1704757130 + tx_count: + type: number + description: Number of transactions in the block + example: 2 + vrf_key: + type: string + description: VRF key of the block producer + example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" + pool: + type: + - string + - 'null' + description: Pool ID in bech32 format (null for pre-Shelley blocks) + example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v + op_cert_counter: + type: number + description: Counter value of the operational certificate used to create this block + example: 5 + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + parent_hash: + type: string + description: Previous Hash of the current block + example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 + block_info: + description: Array of detailed block information + type: array + items: + type: object + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_size: + $ref: "#/components/schemas/blocks/items/properties/block_size" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + tx_count: + $ref: "#/components/schemas/blocks/items/properties/tx_count" + vrf_key: + $ref: "#/components/schemas/blocks/items/properties/vrf_key" + op_cert: + type: string + description: Hash of the block producers' operational certificate + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + op_cert_counter: + $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" + pool: + $ref: "#/components/schemas/blocks/items/properties/pool" + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + total_output: + type: + - string + - 'null' + description: Total output of the block (in lovelace) + example: 92384672389 + total_fees: + type: + - string + - 'null' + description: Total fees of the block (in lovelace) + example: 2346834 + num_confirmations: + type: number + description: Number of confirmations for the block + example: 664275 + parent_hash: + type: string + description: Hash of the parent of this block + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + child_hash: + type: string + description: Hash of the child of this block (if present) + example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" + block_txs: + description: Array of transactions hashes + type: array + items: + type: object + properties: + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + block_tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" + tx_block_index: + $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" + tx_size: + $ref: "#/components/schemas/tx_info/items/properties/tx_size" + total_output: + $ref: "#/components/schemas/tx_info/items/properties/total_output" + fee: + $ref: "#/components/schemas/tx_info/items/properties/fee" + treasury_donation: + $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" + deposit: + $ref: "#/components/schemas/tx_info/items/properties/deposit" + invalid_before: + $ref: "#/components/schemas/tx_info/items/properties/invalid_before" + invalid_after: + $ref: "#/components/schemas/tx_info/items/properties/invalid_after" + collateral_inputs: + $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" + collateral_output: + $ref: "#/components/schemas/tx_info/items/properties/collateral_output" + reference_inputs: + $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" + inputs: + description: An array of UTxO inputs spent in the transaction + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + outputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + withdrawals: + $ref: "#/components/schemas/tx_info/items/properties/withdrawals" + assets_minted: + $ref: "#/components/schemas/tx_info/items/properties/assets_minted" + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + $ref: "#/components/schemas/tx_info/items/properties/certificates" + native_scripts: + $ref: "#/components/schemas/tx_info/items/properties/native_scripts" + plutus_contracts: + $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" + address_info: + description: Array of information for address(es) + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + balance: + type: string + description: Sum of all UTxO values beloning to address + example: 10723473983 + stake_address: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/account_history/items/properties/stake_address" + script_address: + type: boolean + description: Signifies whether the address is a script address + example: true + utxo_set: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + address_txs: + description: Array of transaction hashes + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + address_assets: + description: Array of address-owned assets + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + + account_list: + description: Array of account (stake address) IDs + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + stake_address_hex: + type: string + description: Cardano staking address (reward account) in hex format + example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf + script_hash: + type: string + description: Script hash in case the stake address is locked by a script + example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 + account_info: + description: Array of stake account information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + status: + type: string + description: Stake address status + enum: ["registered", "not registered"] + example: registered + delegated_drep: + anyOf: + - type: 'null' + - type: string + description: Account's current delegation status to DRep ID in Bech32 format + example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 + delegated_pool: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + total_balance: + type: string + description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) + example: 207116800428 + utxo: + type: string + description: Total UTxO balance of the account + example: 162764177131 + rewards: + type: string + description: Total rewards earned by the account + example: 56457728047 + withdrawals: + type: string + description: Total rewards withdrawn by the account + example: 12105104750 + rewards_available: + type: string + description: Total rewards available for withdrawal + example: 44352623297 + deposit: + type: string + description: Total deposit available for withdrawal + example: 2000000 + reserves: + type: string + description: Total reserves MIR value of the account + example: "0" + treasury: + type: string + description: Total treasury MIR value of the account + example: "0" + utxo_infos: + description: Array of complete UTxO information + type: array + items: + type: object + properties: + tx_hash: + type: string + description: Hash identifier of the transaction + example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e + tx_index: + type: number + description: Index of UTxO in the transaction + example: 0 + address: + type: string + description: A Cardano payment/base address (bech32 encoded) + example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + payment_cred: + type: + - string + - 'null' + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: + - array + - 'null' + description: An array of assets on the UTxO + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of assets on the UTxO + example: 1 + is_spent: + type: boolean + description: True if the UTXO has been spent + example: true + account_rewards: + description: Array of reward history information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + rewards: + type: array + items: + type: object + properties: + earned_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" + spendable_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" + amount: + type: string + description: Amount of rewards earned (in lovelace) + type: + type: string + description: The source of the rewards + enum: [member, leader, treasury, reserves] + example: member + pool_id: + $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + account_updates: + description: Array of account updates information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + updates: + type: array + items: + type: object + properties: + action_type: + type: string + description: Type of certificate submitted + enum: ["registration", "delegation", "withdrawal", "deregistration"] + example: "registration" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + account_addresses: + description: Array of payment addresses + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + addresses: + type: array + items: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + account_assets: + description: Array of assets owned by account + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + account_history: + description: Array of active stake values per epoch + type: array + items: + properties: + stake_address: + type: string + description: Cardano staking address (reward account) in bech32 format + example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz + history: + type: array + items: + type: object + properties: + pool_id: + type: string + description: Bech32 representation of pool ID + example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt + epoch_no: + type: number + description: Epoch number + example: 301 + active_stake: + type: string + description: Active stake amount (in lovelaces) + example: 682334162 + tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + type: number + description: UNIX timestamp of the transaction + example: 1506635091 + tx_block_index: + type: number + description: Index of transaction within block + example: 6 + tx_size: + type: number + description: Size in bytes of transaction + example: 391 + total_output: + type: string + description: Total sum of all transaction outputs (in lovelaces) + example: 157832856 + fee: + type: string + description: Total Transaction fee (in lovelaces) + example: 172761 + treasury_donation: + type: string + description: Total Donation to on-chain treasury (in lovelaces) + example: 0 + deposit: + type: string + description: Total Deposits included in transaction (for example, if it is registering a pool/key) + example: 0 + invalid_before: + type: + - string + - 'null' + description: Slot before which transaction cannot be validated (if supplied, else null) + invalid_after: + type: + - string + - 'null' + description: Slot after which transaction cannot be validated + example: 42332172 + collateral_inputs: + description: An array of collateral inputs needed for smart contracts in case of contract failure + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + collateral_output: + description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) + type: array + items: + properties: + payment_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" + stake_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: array + description: Brief asset description from ledger + reference_inputs: + description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + inputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + #description: An array of UTxO inputs spent in the transaction + outputs: + type: array + description: An array of UTxO outputs created by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + datum_hash: + type: + - string + - 'null' + description: Hash of datum (if any) connected to UTxO + example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 + inline_datum: + type: + - object + - 'null' + description: Allows datums to be attached to UTxO (CIP-32) + properties: + bytes: + type: string + description: Datum bytes (hex) + example: 19029a + value: + type: object + description: Value (json) + example: { "int": 666 } + reference_script: + type: + - object + - 'null' + description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) + properties: + hash: + type: string + description: Hash of referenced script + example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 + size: + type: number + description: Size in bytes + example: 14 + type: + type: string + description: Type of script + example: plutusV1 + bytes: + type: string + description: Script bytes (hex) + example: 4e4d01000033222220051200120011 + value: + type: + - object + - 'null' + description: Value (json) + example: 'null' + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + withdrawals: + type: + - array + - 'null' + description: Array of withdrawals with-in a transaction + items: + type: object + properties: + amount: + type: string + description: Withdrawal amount (in lovelaces) + example: 9845162 + stake_addr: + type: string + description: A Cardano staking address (reward account, bech32 encoded) + example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj + assets_minted: + type: + - array + - 'null' + description: Array of minted assets with-in a transaction + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of minted assets (negative on burn) + example: 1 + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + type: + - array + - 'null' + description: Certificates present with-in a transaction (if any) + items: + properties: + index: + type: + - number + - 'null' + description: Certificate index + example: 0 + type: + type: string + description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) + example: delegation + info: + type: + - object + - 'null' + description: A JSON array containing information from the certificate + example: + { + "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", + "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", + } + native_scripts: + type: + - array + - 'null' + description: Native scripts present in a transaction (if any) + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + script_json: + type: object + description: JSON representation of the timelock script (null for other script types) + example: + { + "type": "all", + "scripts": + [ + { + "type": "sig", + "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", + }, + { + "type": "sig", + "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", + }, + { + "type": "sig", + "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", + }, + ], + } + plutus_contracts: + type: + - array + - 'null' + description: Plutus contracts present in transaction (if any) + items: + properties: + address: + type: + - string + - 'null' + description: Plutus script address + example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 + spends_input: + type: + - object + - 'null' + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + description: Input utxo this contract spends + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + bytecode: + $ref: "#/components/schemas/script_info/items/properties/bytes" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + valid_contract: + type: boolean + description: True if the contract is valid or there is no contract + example: true + input: + type: object + properties: + redeemer: + type: object + properties: + purpose: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" + fee: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" + unit: + type: object + properties: + steps: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" + mem: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + tx_cbor: + description: Raw Transaction(s) in CBOR format + item: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + cbor: + type: string + description: CBOR encoded raw transaction. + tx_utxos: + description: Array of inputs and outputs for given transaction(s) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + inputs: + type: array + description: An array of UTxO inputs used by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + type: string + description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned + example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + outputs: + description: An array of UTxO outputs created by the transaction + allOf: + - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" + tx_metadata: + description: Array of metadata information present in each of the transactions queried + type: + - array + - 'null' + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + metadata: + type: + - object + - 'null' + description: A JSON array containing details about metadata within transaction + example: + { + "721": + { + "version": 1, + "copyright": "...", + "publisher": ["p...o"], + "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": + {}, + }, + } + tx_status: + description: Array of transaction confirmation counts + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + num_confirmations: + type: + - number + - 'null' + description: Number of block confirmations + example: 17 + tx_metalabels: + description: Array of known metadata labels + type: array + items: + properties: + key: + type: string + description: A distinct known metalabel + example: "721" + asset_list: + description: Array of policy IDs and asset names + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + asset_token_registry: + description: An array of token registry information (registered via github) for each asset + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + ticker: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" + description: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" + url: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + logo: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" + asset_addresses: + description: An array of payment addresses holding the given token (including balances) + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + type: string + description: Asset balance on the payment address + example: 23 + asset_nft_address: + description: An array of payment addresses holding the given token + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + asset_summary: + description: Array of asset summary information + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_transactions: + type: number + description: Total number of transactions including the given asset + example: 89416 + staked_wallets: + type: number + description: Total number of registered wallets holding the given asset + example: 548 + unstaked_addresses: + type: number + description: Total number of payment addresses (not belonging to registered wallets) holding the given asset + example: 245 + addresses: + type: number + description: Total number of unique addresses holding the given asset + example: 812 + asset_info: + description: Array of detailed asset information + type: array + items: + properties: + policy_id: + type: string + description: Asset Policy ID (hex) + example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff + asset_name: + type: + - string + - 'null' + description: Asset Name (hex) + example: 444f4e545350414d + asset_name_ascii: + type: string + description: Asset Name (ASCII) + example: DONTSPAM + fingerprint: + type: string + description: The CIP14 fingerprint of the asset + example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 + minting_tx_hash: + type: string + description: Hash of the latest mint transaction (with metadata if found for asset) + example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 + total_supply: + type: string + description: Total supply for the asset + example: "35000" + mint_cnt: + type: number + description: Count of total mint transactions + example: 1 + burn_cnt: + type: number + description: Count of total burn transactions + example: 5 + creation_time: + type: number + description: UNIX timestamp of the first asset mint + example: 1506635091 + minting_tx_metadata: + allOf: + - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + description: Latest minting transaction metadata (aligns with CIP-25) + token_registry_metadata: + type: + - object + - 'null' + description: Asset metadata registered on the Cardano Token Registry + properties: + name: + type: string + example: Rackmob + description: + type: string + example: Metaverse Blockchain Cryptocurrency. + ticker: + type: string + example: MOB + url: + type: string + example: https://www.rackmob.com/ + logo: + type: string + description: A PNG image file as a byte string + example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc + decimals: + type: number + example: 0 + cip68_metadata: + type: + - object + - 'null' + description: CIP 68 metadata if present for asset + example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} + asset_history: + description: Array of asset mint/burn history + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_txs: + type: + - array + - 'null' + description: Array of all mint/burn transactions for an asset + items: + type: object + properties: + tx_hash: + type: string + description: Hash of minting/burning transaction + example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + quantity: + type: string + description: Quantity minted/burned (negative numbers indicate burn transactions) + example: "-10" + metadata: + type: array + description: Array of Transaction Metadata for given transaction + items: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + policy_asset_addresses: + description: Array of asset names and payment addresses for the given policy (including balances) + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + policy_asset_info: + description: Array of detailed information of assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + token_registry_metadata: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" + policy_asset_mints: + description: Array of mint information for assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + policy_asset_list: + description: Array of brief information of assets under the same policy + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + drep_info: + description: Get detailed information about requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + type: string + description: DRep ID in bech32 format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + hex: + type: string + description: DRep ID in hex format + example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 + has_script: + type: boolean + description: Flag which shows if this DRep credentials are a script hash + example: false + registered: + type: boolean + description: Flag to show if the DRep is currently registered + example: false + deposit: + type: + - string + - 'null' + description: DRep's registration deposit in lovelace + example: 500000000 + active: + type: boolean + description: Flag to show if the DRep is (i.e. not expired) + example: true + expires_epoch_no: + type: + - number + - 'null' + description: After which epoch DRep is considered inactive. + example: 410 + amount: + type: string + description: The total amount of voting power this DRep is delegated. + example: 599496769641 + drep_list: + description: List of all active delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + has_script: + $ref: "#/components/schemas/drep_info/items/properties/has_script" + registered: + $ref: "#/components/schemas/drep_info/items/properties/registered" + drep_metadata: + description: List metadata for requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + url: + type: string + description: A URL to a JSON payload of metadata + example: "https://hornan7.github.io/Vote_Context.jsonld" + hash: + type: string + description: A hash of the contents of the metadata URL + example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d + json: + type: object + description: The payload as JSON + example: + {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} + bytes: + type: string + description: The raw bytes of the payload + example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d + warning: + type: string + description: A warning that occured while validating the metadata + language: + type: string + description: The language described in the context of the metadata as per CIP-100 + example: en-us + comment: + type: string + description: Comment attached to the metadata + is_valid: + type: boolean + description: Indicate whether data is invalid + example: true + drep_updates: + description: List of updates for requested (or all) delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + type: string + description: The index of this certificate within the the transaction. + example: 1 + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + action: + type: string + description: Effective action for this DRep Update certificate + enum: ["updated","registered","deregistered"] + example: registered + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + drep_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + vote: + type: string + enum: ["Yes","No","Abstain"] + description: Actual Vote casted + example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + committee_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + proposal_list: + description: List of all votes cast on specified governance action + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + proposal_type: + type: string + enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] + description: Proposal Action Type + example: ParameterChange + proposal_description: + type: string + description: Description for Proposal Action + example: '{"tag": "InfoAction"}' + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + return_address: + type: string + description: The StakeAddress index of the reward address to receive the deposit when it is repaid. + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + proposed_epoch: + type: number + description: Shows the epoch at which this governance action was proposed. + example: 660 + ratified_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been ratified at the specfied epoch. + example: 670 + enacted_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been enacted at the specfied epoch. + example: 675 + dropped_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. + example: 680 + expired_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been expired at the specfied epoch. + example: 680 + expiration: + type: + - number + - 'null' + description: Shows the epoch at which this governance action is expected to expire. + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + meta_comment: + $ref: "#/components/schemas/drep_metadata/items/properties/comment" + meta_language: + $ref: "#/components/schemas/drep_metadata/items/properties/language" + meta_is_valid: + $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" + withdrawal: + type: + - object + - 'null' + description: If not null, the amount withdrawn from treasury into stake address by this this proposal + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + example: "31235800000" + param_proposal: + description: If not null, the proposed new parameter set + type: + - object + - 'null' + example: {"id": 15, "key": null, "entropy": null, "epoch_no": null, "influence": null, "max_epoch": null, "min_fee_a": null, "min_fee_b": null, "price_mem": null, "price_step": null, "key_deposit": 1000000, "max_bh_size": null, "max_tx_size": null, "drep_deposit": null, "max_val_size": null, "pool_deposit": null, "cost_model_id": null, "drep_activity": null, "max_tx_ex_mem": null, "min_pool_cost": null, "max_block_size": null, "min_utxo_value": null, "protocol_major": null, "protocol_minor": null, "max_tx_ex_steps": null, "decentralisation": null, "max_block_ex_mem": null, "registered_tx_id": 12270, "dvt_p_p_gov_group": null, "collateral_percent": null, "committee_min_size": null, "gov_action_deposit": null, "max_block_ex_steps": null, "optimal_pool_count": null, "coins_per_utxo_size": null, "gov_action_lifetime": null, "dvt_committee_normal": null, "monetary_expand_rate": null, "pvt_committee_normal": null, "pvtpp_security_group": null, "treasury_growth_rate": null, "dvt_p_p_network_group": null, "max_collateral_inputs": null, "dvt_p_p_economic_group": null, "dvt_p_p_technical_group": null, "dvt_treasury_withdrawal": null, "dvt_hard_fork_initiation": null, "dvt_motion_no_confidence": null, "pvt_hard_fork_initiation": null, "pvt_motion_no_confidence": null, "committee_max_term_length": null, "dvt_update_to_constitution": null, "dvt_committee_no_confidence": null, "pvt_committee_no_confidence": null, "min_fee_ref_script_cost_per_byte": null} + proposal_votes: + type: array + description: List of all votes cast on specified governance action + items: + properties: + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + voter_role: + type: string + description: The role of the voter + enum: ["ConstitutionalCommittee", "DRep", "SPO"] + example: DRep + voter: + type: string + description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + voter_hex: + type: string + description: Voter's DRep ID , pool ID or committee hash in hex format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + vote: + $ref: "#/components/schemas/drep_votes/items/properties/vote" + + script_info: + type: array + items: + description: Array of information for scripts + properties: + script_hash: + type: string + description: Hash of a script + example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af + creation_tx_hash: + type: string + description: Hash of the script creation transaction + example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe + type: + type: string + description: Type of the script + enum: ["plutusV1","plutusV2","timelock","multisig"] + example: plutusV1 + value: + type: + - object + - 'null' + description: Data in JSON format + example: 'null' + bytes: + type: + - string + - 'null' + description: Script bytes (cborSeq) + example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 + size: + type: number + description: The size of the CBOR serialised script (in bytes) + example: 2039 + script_list: + description: List of script and creation tx hash pairs + type: array + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + type: + $ref: "#/components/schemas/script_info/items/properties/type" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + script_redeemers: + description: Array of all redeemers for a given script hash + type: array + items: + type: object + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + redeemers: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + unit_mem: + type: + - string + - number + - 'null' + description: The budget in Memory to run a script + example: 520448 + unit_steps: + type: + - string + - number + - 'null' + description: The budget in Cpu steps to run a script + example: 211535239 + fee: + type: string + description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices + example: 45282 + purpose: + type: string + description: What kind of validation this redeemer is used for + enum: ["spend", "mint", "cert", "reward"] + example: spend + datum_hash: + type: + - string + - 'null' + description: The Hash of the Plutus Data + example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 + datum_value: + $ref: "#/components/schemas/script_info/items/properties/value" + datum_info: + description: Array of datum information for given datum hashes + type: array + items: + type: object + properties: + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + value: + $ref: "#/components/schemas/script_info/items/properties/value" + bytes: + $ref: "#/components/schemas/script_info/items/properties/bytes" + ogmiostip: + description: Current tip of the chain, identified by a slot and a block header hash. + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method that was called in the request + example: "queryNetwork/tip" + result: + type: + - object + - 'null' + - string + - array + - number + description: Result of the query + properties: + slot: + type: number + description: Absolute slot number on chain + example: 59886800 + id: + type: string + description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) + example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" + example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} + headers: {} + responses: + NotFound: + description: The server does not recognise the combination of endpoint and parameters provided + Unauthorized: + description: Access token is missing or invalid + BadRequest: + description: The server cannot process the request due to invalid input +tags: + - name: Network + description: Query information about the network + x-tag-expanded: false + - name: Epoch + description: Query epoch-specific details + x-tag-expanded: false + - name: Block + description: Query information about particular block on chain + x-tag-expanded: false + - name: Transactions + description: Query blockchain transaction details + x-tag-expanded: false + - name: Stake Account + description: Query details about specific stake account addresses + x-tag-expanded: false + - name: Address + description: Query information about specific address(es) + x-tag-expanded: false + - name: Asset + description: Query Asset related informations + x-tag-expanded: false + - name: Governance + description: Query information about governance for network + x-tag-expanded: false + - name: Pool + description: Query information about specific pools + x-tag-expanded: false + - name: Script + description: Query information about specific scripts (Smart Contracts) + x-tag-expanded: false + - name: Ogmios + description: | + Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, + but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. + +
+
+ Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. + Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: +
+ + + ### Network + - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) + - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) + - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) + - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) + ### Ledger-State + - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) + - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) + - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) + - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) + - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) + - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) + - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) + ### Transactions + - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) + - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) + x-tag-expanded: true +security: + - [] + - bearerAuth: [] diff --git a/specs/results/koiosapi-preview.yaml b/specs/results/koiosapi-preview.yaml index 1b7949e2..a8dfb2e3 100644 --- a/specs/results/koiosapi-preview.yaml +++ b/specs/results/koiosapi-preview.yaml @@ -1,5421 +1,5427 @@ -openapi: 3.1.0 -info: - title: Koios API - contact: - name: Koios Core Team - url: https://t.me/CardanoKoios - email: general@koios.rest - license: - name: Creative Commons Attribution 4.0 International - url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE - version: v1.2.0a - description: | - Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. - - # API Usage - - The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. - - ## Vertical Filtering - - Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

- - ``` bash - curl "https://api.koios.rest/api/v1/tip" - - # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] - - curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" - - # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] - ``` - - ## Horizontal Filtering - - You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

- ``` bash - curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" - - # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, - # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] - ``` - - Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): - - |Abbreviation|In PostgreSQL|Meaning | - |------------|-------------|-------------------------------------------| - |eq |`=` |equals | - |gt |`>` |greater than | - |gte |`>=` |greater than or equal | - |lt |`<` |less than | - |lte |`<=` |less than or equal | - |neq |`<>` or `!=` |not equal | - |like |`LIKE` |LIKE operator (use * in place of %) | - |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| - |is |`IS` |checking for exact equality (null,true,false,unknown)| - |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | - |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | - |not |`NOT` |negates another operator | - |or |`OR` |logical `OR` operator | - |and |`AND` |logical `AND` operator | - - ## Pagination (offset/limit) - - When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. - - The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. - - Sounds confusing? Let's see this in practice, to hopefully make it easier. - Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range - - # content-range: 0-999/* - - ``` - - As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range - - # content-range: 1000-1499/* - - ``` - - The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. - However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. - - ## Ordering - - You can set a sorting order for returned queries against specific column(s). - Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" - - # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, - # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] - ``` - - ## Response Formats - - You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. - Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

- - ``` bash - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" - - # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, - # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, - # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] - - curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" - - # epoch_no,epoch_slot,block_time - # 318,28491,1643607582 - # 318,28479,1643607570 - # 318,28406,1643607497 - - ``` - - ## Limits - - While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: - - - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. - - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). - - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). - - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. - - Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. - - # Authentication - - While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). - The examples across this API site already [supports authentication](/#auth), for you to use in the queries. - - # Community projects - - A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) - - x-logo: - url: "https://api.koios.rest/images/koios.png" -servers: - - url: https://api.koios.rest/api/v1 - description: Mainnet - - url: https://guild.koios.rest/api/v1 - description: Guildnet - - url: https://preview.koios.rest/api/v1 - description: Preview Network - - url: https://preprod.koios.rest/api/v1 - description: Preprod Network -paths: - - /tip: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tip" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Query Chain Tip - description: Get the tip info about the latest block seen by chain - operationId: tip - /genesis: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/genesis" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get Genesis info - description: Get the Genesis parameters used to start specific era on chain - operationId: genesis - /totals: #RPC - get: - tags: - - Network - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/totals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Get historical tokenomic stats - description: >- - Get the circulating utxo, treasury, rewards, supply and reserves in - lovelace for specified epoch, all epochs if empty - operationId: totals - /param_updates: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/param_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Param Update Proposals - description: Get all parameter update proposals submitted to the chain starting Shelley era - operationId: param_updates - /cli_protocol_params: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/cli_protocol_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: CLI Protocol Parameters - description: >- - Get Current Protocol Parameters as published by cardano-cli. Note that - the output schema of this command is unfortunately fluid on cardano-node - and may vary between CLI versions/era. Accordingly, the returned output for - this endpoint is left as raw JSON (single row) and any filtering to output should - be done on client-side - operationId: cli_protocol_params - /reserve_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Reserve Withdrawals - description: List of all withdrawals from reserves against stake accounts - operationId: reserve_withdrawals - /treasury_withdrawals: #RPC - get: - tags: - - Network - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/reserve_withdrawals" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Treasury Withdrawals - description: List of all withdrawals from treasury against stake accounts - operationId: treasury_withdrawals - - /epoch_info: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - - $ref: "#/components/parameters/_include_next_epoch" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch Information - description: Get the epoch information, all epochs if no epoch specified - operationId: epoch_info - /epoch_params: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_params" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Protocol Parameters - description: >- - Get the protocol parameters for specific epoch, returns information - about all epochs if no epoch specified - operationId: epoch_params - /epoch_block_protocols: #RPC - get: - tags: - - Epoch - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/epoch_block_protocols" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Epoch's Block Protocols - description: >- - Get the information about block protocol distribution in epoch - operationId: epoch_block_protocols - - /blocks: #RPC - get: - tags: - - Block - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block List - description: Get summarised details about all blocks (paginated - latest first) - operationId: blocks - /block_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success - content: - application/json: - schema: - $ref: "#/components/schemas/block_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Information - description: Get detailed information about a specific block - operationId: block_info - /block_txs: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_hashes" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions - description: Get a list of all transactions included in provided blocks - operationId: block_txs - /block_tx_info: #RPC - post: - tags: - - Block - requestBody: - $ref: "#/components/requestBodies/block_tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/block_tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Block Transactions (Detailed Info) - description: Get detailed information about transaction(s) for requested blocks - operationId: block_tx_info - - /utxo_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/utxo_refs_with_extended" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxO Info - description: Get UTxO set for requested UTxO references - operationId: utxo_info - /tx_cbor: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_cbor" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Raw Transaction (CBOR) - description: Get raw transaction(s) in CBOR format - operationId: tx_cbor - /tx_info: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_info" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Information - description: Get detailed information about transaction(s) - operationId: tx_info - /tx_metadata: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata - description: Get metadata information (if any) for given transaction(s) - operationId: tx_metadata - /tx_metalabels: #RPC - get: - tags: - - Transactions - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_metalabels" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Metadata Labels - description: Get a list of all transaction metalabels - operationId: tx_metalabels - /submittx: #submit-api - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/txbin" - x-code-samples: - - lang: "Shell" - source: | - # Assuming ${data} is a raw binary serialized transaction on the file-system. - # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. - curl -X POST \ - --header "Content-Type: application/cbor" \ - --data-binary @${data} https://api.koios.rest/api/v1/submittx - responses: - "202": - description: OK - content: - application/json: - schema: - description: The transaction id. - type: string - format: hex - minLength: 64 - maxLength: 64 - example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f - "400": - description: An error occured while submitting transaction. - summary: Submit Transaction - description: Submit an already serialized transaction to the network. - operationId: submittx - /tx_status: #RPC - post: - tags: - - Transactions - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_status" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction Status - description: Get the number of block confirmations for a given transaction hash list - operationId: tx_status - /tx_utxos: #RPC - post: - tags: - - Transactions - deprecated: true - requestBody: - $ref: "#/components/requestBodies/tx_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/tx_utxos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transaction UTxOs - description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. - operationId: tx_utxos - - /address_info: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Information - description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses - operationId: address_info - /address_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address UTXOs - description: Get UTxO set for given addresses - operationId: address_utxos - /credential_utxos: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_utxos" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs from payment credentials - description: Get UTxO details for requested payment credentials - operationId: credential_utxos - /address_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/address_txs" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Transactions - description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) - operationId: address_txs - /credential_txs: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/credential_txs" - responses: - "200": - description: Array of transaction hashes for given credential(s) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Transactions from payment credentials - description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) - operationId: credential_txs - /address_assets: #RPC - post: - tags: - - Address - requestBody: - $ref: "#/components/requestBodies/payment_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Address Assets - description: Get the list of all the assets (policy, name and quantity) for given addresses - operationId: address_assets - - /account_list: #RPC - get: - tags: - - Stake Account - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account List - description: Get a list of all stake addresses that have atleast 1 transaction - operationId: account_list - /account_info: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information - description: Get the account information for given stake addresses - operationId: account_info - /account_info_cached: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Information (Cached) - description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) - operationId: account_info_cached - /account_utxos: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: UTxOs for stake addresses (accounts) - description: Get a list of all UTxOs for given stake addresses (account)s - operationId: account_utxos - /account_txs: #RPC - get: - tags: - - Stake Account - parameters: - - $ref: "#/components/parameters/_stake_address" - - $ref: "#/components/parameters/_after_block_height" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Txs - description: Get a list of all Txs for a given stake address (account) - operationId: account_txs - /account_rewards: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_rewards" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Rewards - description: >- - Get the full rewards history (including MIR) for given stake addresses - operationId: account_rewards - /account_updates: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Updates - description: >- - Get the account updates (registration, deregistration, delegation and - withdrawals) for given stake addresses - operationId: account_updates - /account_addresses: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Addresses - description: Get all addresses associated with given staking accounts - operationId: account_addresses - /account_assets: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_assets" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account Assets - description: Get the native asset balance for a given stake address - operationId: account_assets - /account_history: #RPC - post: - tags: - - Stake Account - requestBody: - $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/account_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Account History - description: Get the staking history of given stake addresses (accounts) - operationId: account_history - - /asset_list: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset List - description: Get the list of all native assets (paginated) - operationId: asset_list - /policy_asset_list: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of brief information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset List - description: Get the list of asset under the given policy (including balances) - operationId: policy_asset_list - /asset_token_registry: #RPC - get: - tags: - - Asset - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_token_registry" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Token Registry - description: Get a list of assets registered via token registry on github - operationId: asset_token_registry - /asset_info: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list" - responses: - "200": - description: Array of detailed asset information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Information (Bulk) - description: Get the information of a list of assets including first minting & token registry metadata - operationId: asset_info - /asset_utxos: #RPC - post: - tags: - - Asset - requestBody: - $ref: "#/components/requestBodies/asset_list_with_extended" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset UTXOs - description: Get the UTXO information of a list of assets including - operationId: asset_utxos - /asset_history: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset mint/burn history - content: - application/json: - schema: - $ref: "#/components/schemas/asset_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset History - description: Get the mint/burn history of an asset - operationId: asset_history - /asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Success! - content: - application/json: - schema: - $ref: "#/components/schemas/asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Addresses - description: Get the list of all addresses holding a given asset

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: asset_addresses - /asset_nft_address: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy_nft" - - $ref: "#/components/parameters/_asset_name_nft" - responses: - "200": - description: Payment addresses currently holding the given NFT - content: - application/json: - schema: - $ref: "#/components/schemas/asset_nft_address" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: NFT Address - description: Get the address where specified NFT currently reside on. - operationId: asset_nft_address - /policy_asset_addresses: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of asset names and payment addresses for the given policy (including balances) - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_addresses" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Address List - description: Get the list of addresses with quantity for each asset on the given policy

- `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects - with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to - query layers to have a dedicated cache table for themselves served via Koios.` - operationId: policy_asset_addresses - /policy_asset_info: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Array of detailed information of assets under the same policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Information - description: Get the information for all assets under the same policy - operationId: policy_asset_info - /policy_asset_mints: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - responses: - "200": - description: Get a list of mint or burn count details for all assets minted under a policy - content: - application/json: - schema: - $ref: "#/components/schemas/policy_asset_mints" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Policy Asset Mints - description: Get a list of mint or burn count details for all assets minted under a policy - operationId: policy_asset_mints - /asset_summary: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - responses: - "200": - description: Array of asset summary information - content: - application/json: - schema: - $ref: "#/components/schemas/asset_summary" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Summary - description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) - operationId: asset_summary - /asset_txs: #RPC - get: - tags: - - Asset - parameters: - - $ref: "#/components/parameters/_asset_policy" - - $ref: "#/components/parameters/_asset_name" - - $ref: "#/components/parameters/_after_block_height" - - $ref: "#/components/parameters/_history" - responses: - "200": - description: An array of Tx hashes that included the given asset (latest first) - content: - application/json: - schema: - $ref: "#/components/schemas/address_txs" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Asset Transactions - description: Get the list of current or all asset transaction hashes (newest first) - operationId: asset_txs - - /drep_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps List - description: List of all active delegated representatives (DReps) - operationId: drep_list - /drep_info: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Info - description: Get detailed information about requested delegated representatives (DReps) - operationId: drep_info - /drep_metadata: #RPC - post: - tags: - - Governance - requestBody: - $ref: "#/components/requestBodies/drep_id_bulk" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Metadata - description: List metadata for requested delegated representatives (DReps) - operationId: drep_metadata - /drep_updates: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Updates - description: List of updates for requested (or all) delegated representatives (DReps) - operationId: drep_updates - /drep_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_drep_id" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/drep_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: DReps Votes - description: List of all votes casted by requested delegated representative (DRep) - operationId: drep_votes - /committee_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_committee_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Committee Votes - description: List of all votes casted by given committee member or collective - operationId: committee_votes - /proposal_list: #RPC - get: - tags: - - Governance - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/proposal_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposals List - description: List of all governance proposals - operationId: proposal_list - /proposal_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_tx_hash" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/committee_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Proposal Votes - description: List of all votes cast on specified governance action - operationId: proposal_votes - - /pool_list: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool List - description: List of brief info for all pools - operationId: pool_list - /pool_info: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Information - description: Current pool statuses and details for a specified list of pool ids - operationId: pool_info - /pool_stake_snapshot: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_snapshot" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake Snapshot - description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation - operationId: pool_stake_snapshot - /pool_delegators: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators List - description: Return information about live delegators for a given pool. - operationId: pool_delegators - /pool_delegators_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_delegators_history" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Delegators History - description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). - operationId: pool_delegators_history - /pool_blocks: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_blocks" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Blocks - description: >- - Return information about blocks minted by a given pool for all epochs - (or _epoch_no if provided) - operationId: pool_blocks - /pool_history: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32" - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_history_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Stake, Block and Reward History - description: >- - Return information about pool stake, block and reward history in a given epoch _epoch_no - (or all epochs that pool existed for, in descending order if no _epoch_no was provided) - operationId: pool_history - /pool_updates: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_bech32_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_updates" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Updates (History) - description: Return all pool updates for all pools or only updates for specific pool if specified - operationId: pool_updates - /pool_registrations: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_pool_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Registrations - description: Return all pool registrations initiated in the requested epoch - operationId: pool_registrations - /pool_retirements: #RPC - get: - tags: - - Pool - parameters: - - $ref: "#/components/parameters/_epoch_no" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_registrations" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Retirements - description: Return all pool retirements initiated in the requested epoch - operationId: pool_retirements - /pool_relays: #RPC - get: - tags: - - Pool - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_relays" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Relays - description: A list of registered relays for all pools - operationId: pool_relays - /pool_votes: #RPC - get: - tags: - - Governance - parameters: - - $ref: "#/components/parameters/_pool_bech32" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_votes" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Votes - description: List of all votes casted by a pool - operationId: pool_votes - /pool_metadata: #RPC - post: - tags: - - Pool - requestBody: - $ref: "#/components/requestBodies/pool_ids_optional" - responses: - "200": - description: Success!! - content: - application/json: - schema: - $ref: "#/components/schemas/pool_metadata" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Pool Metadata - description: Metadata (on & off-chain) for all pools - operationId: pool_metadata - - /script_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/script_hashes" - responses: - "200": - description: Array of information for scripts requested - content: - application/json: - schema: - $ref: "#/components/schemas/script_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Information - description: List of script information for given script hashes - operationId: script_info - /native_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of native script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Native Script List - description: List of all existing native script hashes along with their creation transaction hashes - operationId: native_script_list - /plutus_script_list: #RPC - get: - tags: - - Script - responses: - "200": - description: List of Plutus script and creation tx hash pairs - content: - application/json: - schema: - $ref: "#/components/schemas/script_list" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Plutus Script List - description: List of all existing Plutus script hashes along with their creation transaction hashes - operationId: plutus_script_list - /script_redeemers: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - responses: - "200": - description: Array of all redeemers for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/script_redeemers" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script Redeemers - description: List of all redeemers for a given script hash - operationId: script_redeemers - /script_utxos: #RPC - get: - tags: - - Script - parameters: - - $ref: "#/components/parameters/_script_hash" - - $ref: "#/components/parameters/_extended" - responses: - "200": - description: List of UTXOs for a given script hash - content: - application/json: - schema: - $ref: "#/components/schemas/utxo_infos" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Script UTXOs - description: List of all UTXOs for a given script hash - operationId: script_utxos - /datum_info: #RPC - post: - tags: - - Script - requestBody: - $ref: "#/components/requestBodies/datum_hashes" - responses: - "200": - description: Array of datum information for given datum hashes - content: - application/json: - schema: - $ref: "#/components/schemas/datum_info" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "404": - $ref: "#/components/responses/NotFound" - summary: Datum Information - description: List of datum information for given datum hashes - operationId: datum_info - - /ogmios: #ogmios-api - post: - tags: - - Ogmios - requestBody: - $ref: "#/components/requestBodies/ogmios" - responses: - "200": - description: Current tip of the chain, identified by a slot and a block header hash. - content: - application/json: - schema: - $ref: "#/components/schemas/ogmiostip" - "400": - $ref: "#/components/responses/BadRequest" - summary: Query Example - description: | - Query the current tip of the Network. - -
-
- We do support transparent forwarding for various methods from Ogmios, you can read about those here. -
- operationId: ogmios - -components: - parameters: - _after_block_height: - deprecated: false - name: _after_block_height - description: Block height for specifying time delta - schema: - type: number - example: 50000 - in: query - required: false - allowEmptyValue: true - _epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "12" - in: query - required: false - allowEmptyValue: true - _stake_address: - deprecated: false - name: _stake_address - description: Cardano staking address (reward account) in bech32 format - schema: - type: string - example: "stake_test1uzs5rxys8qy5jnr9g0mkj860ms5n92nrykmrgyumpf2ytmsejj4m6" - in: query - required: true - allowEmptyValue: false - _tx_hash: - deprecated: false - name: _tx_hash - description: Transaction Hash in hexadecimal format (hex) - example: "f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c" - schema: - type: string - in: query - required: true - allowEmptyValue: false - _asset_policy: - deprecated: false - name: _asset_policy - description: Asset Policy ID in hexadecimal format (hex) - schema: - type: string - example: "065270479316f1d92e00f7f9f095ebeaac9d009c878dc35ce36d3404" - in: query - required: true - allowEmptyValue: false - _asset_name: - deprecated: false - name: _asset_name - description: Asset Name in hexadecimal format (hex), empty asset name returns royalties - schema: - type: string - example: "433374" - in: query - required: false - allowEmptyValue: true - _asset_policy_nft: - deprecated: false - name: _asset_policy - description: NFT Policy ID in hexadecimal format (hex) - schema: - type: string - example: "005b8ca355aec6125531ebea89bf9ef8df90121ea5717f0c55027e35" - in: query - required: true - allowEmptyValue: false - _asset_name_nft: - deprecated: false - name: _asset_name - description: NFT Name in hexadecimal format (hex) - schema: - type: string - example: "4d43" - in: query - required: false - allowEmptyValue: true - _drep_id: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck" - in: query - required: true - allowEmptyValue: false - _drep_id_optional: - deprecated: false - name: _drep_id - description: DRep ID in bech32 format - schema: - type: string - example: "drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck" - in: query - required: false - allowEmptyValue: true - _committee_hash: - deprecated: false - name: _committee_hash - description: Committee hash in hexadecimal format (hex) - schema: - type: string - example: "7ceede7d6a89e006408e6b7c6acb3dd094b3f6817e43b4a36d01535b" - in: query - required: false - allowEmptyValue: true - _extended: - deprecated: false - name: _extended - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _history: - deprecated: false - name: _history - description: Include all historical transactions, setting to false includes only the non-empty ones - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: false - _include_next_epoch: - deprecated: false - name: _include_next_epoch - description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available - schema: - type: boolean - example: false - in: query - required: false - allowEmptyValue: true - _pool_bech32: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format - schema: - type: string - example: "pool1leml52hm4fcp3hhe4zye08qz27llhj7d339p3gs0tl85cstx59q" - in: query - required: true - allowEmptyValue: false - _pool_bech32_optional: - deprecated: false - name: _pool_bech32 - description: Pool ID in bech32 format (optional) - schema: - type: string - example: "pool1leml52hm4fcp3hhe4zye08qz27llhj7d339p3gs0tl85cstx59q" - in: query - required: false - allowEmptyValue: true - _pool_epoch_no: - deprecated: false - name: _epoch_no - description: Epoch Number to fetch details for - schema: - type: string - example: "12" - in: query - required: false - allowEmptyValue: true - _script_hash: - deprecated: false - name: _script_hash - description: Script hash in hexadecimal format (hex) - schema: - type: string - example: "f758cf422ca0cbed7d9d6fad1eb5a3c70537d62e661ad450dd2a3810" - in: query - required: true - allowEmptyValue: false - requestBodies: - block_hashes: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - example: - _block_hashes: - - a4504e2495ed03b48be36676f430c54dca0769d29f72ebf18d493abf42d2167b - - 8e7a6206d2b21ae4f26e7e09353fadae17f838a63d095c2be51acbd16e9b7716 - - 1baaf7812ed48e663adb9eeaa68fe25034e5e30b4f8e56cc8600cac5e9d42ce7 - description: Array of block hashes - block_tx_info: - content: - application/json: - schema: - required: - - _block_hashes - type: object - properties: - _block_hashes: - format: text - type: array - items: - $ref: "#/components/schemas/blocks/items/properties/hash" - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _block_hashes: - - a4504e2495ed03b48be36676f430c54dca0769d29f72ebf18d493abf42d2167b - - 8e7a6206d2b21ae4f26e7e09353fadae17f838a63d095c2be51acbd16e9b7716 - - 1baaf7812ed48e663adb9eeaa68fe25034e5e30b4f8e56cc8600cac5e9d42ce7 - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of block hashes - payment_addresses: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - example: - _addresses: - - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc - - addr_test1vqneq3v0dqh3x3muv6ee3lt8e5729xymnxuavx6tndcjc2cv24ef9 - description: Array of Cardano payment address(es) - payment_addresses_with_extended: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _addresses: - - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc - - addr_test1vqneq3v0dqh3x3muv6ee3lt8e5729xymnxuavx6tndcjc2cv24ef9 - _extended: true - description: Array of Cardano payment address(es) with extended flag to toggle additional fields - address_txs: - content: - application/json: - schema: - required: - - _addresses - type: object - properties: - _addresses: - format: text - type: array - items: - type: string - description: Array of Cardano payment address(es) in bech32 format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _addresses: - - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc - - addr_test1vqneq3v0dqh3x3muv6ee3lt8e5729xymnxuavx6tndcjc2cv24ef9 - _after_block_height: 40356 - description: Array of Cardano payment address(es) - stake_addresses_with_epoch_no: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _epoch_no: - format: integer - type: number - description: Only fetch information for a specific epoch - example: - _stake_addresses: - - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p - - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl - _epoch_no: 11 - description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by - stake_addresses_with_first_only_and_empty: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _first_only: - format: boolean - type: boolean - description: Only return the first result - _empty: - format: boolean - type: boolean - description: Include zero quantity entries - example: - _stake_addresses: - - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p - - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl - _first_only: false - _empty: false - description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs - stake_addresses_with_extended: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _stake_addresses: - - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p - - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl - _extended: true - description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns - stake_addresses: - content: - application/json: - schema: - required: - - _stake_addresses - type: object - properties: - _stake_addresses: - format: text - type: array - items: - type: string - description: Array of Cardano stake address(es) in bech32 format - example: - _stake_addresses: - - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p - - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl - description: Array of Cardano stake credential(s) in bech32 format - credential_txs: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _after_block_height: - format: integer - type: number - description: Only fetch information after specific block height - example: - _payment_credentials: - - 33c378cee41b2e15ac848f7f6f1d2f78155ab12d93b713de898d855f - - 52e63f22c5107ed776b70f7b92248b02552fd08f3e747bc745099441 - _after_block_height: 40356 - description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight - credential_utxos: - content: - application/json: - schema: - required: - - _payment_credentials - type: object - properties: - _payment_credentials: - format: text - type: array - items: - type: string - description: Array of Cardano payment credential(s) in hex format - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _payment_credentials: - - 33c378cee41b2e15ac848f7f6f1d2f78155ab12d93b713de898d855f - - 52e63f22c5107ed776b70f7b92248b02552fd08f3e747bc745099441 - _extended: true - description: Array of Cardano payment credential(s) in hex format - tx_ids: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - example: - _tx_hashes: - - f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c - - 206f6da5b0b0de45605a95f5ce7e172be9674550f7dde3838c45cbf24bab8b00 - description: Array of Cardano Transaction hashes - tx_info: - content: - application/json: - schema: - required: - - _tx_hashes - type: object - properties: - _tx_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano Transaction hashes - _inputs: - format: boolean - type: boolean - description: Controls whether to include transaction inputs in the result - _metadata: - format: boolean - type: boolean - description: Controls whether to include transaction metadata in the result - _assets: - format: boolean - type: boolean - description: Controls whether to include assets involved within transaction the result - _withdrawals: - format: boolean - type: boolean - description: Controls whether to include any stake account reward withdrawals in the result - _certs: - format: boolean - type: boolean - description: Controls whether to include transaction certificates in the result - _scripts: - format: boolean - type: boolean - description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result - _bytecode: - format: boolean - type: boolean - description: Controls whether to include bytecode for associated reference/plutus scripts - example: - _tx_hashes: - - f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c - - 206f6da5b0b0de45605a95f5ce7e172be9674550f7dde3838c45cbf24bab8b00 - _inputs: false - _metadata: false - _assets: false - _withdrawals: false - _certs: false - _scripts: false - _bytecode: false - description: Array of Cardano Transaction hashes - txbin: - content: - application/cbor: - schema: - type: string - format: binary - example: f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c - description: Serialised Cardano Transaction - pool_ids: - content: - application/json: - schema: - required: - - _pool_bech32_ids - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool1p90428kec03mjdya3k4gv5d20w7lmed7ca0snknef5j977l3y8l - - pool1wwh3k3ldzujdvgxllfwlnnkxyheafkacqlufnvpr77n5q72f9hw - - pool1p835jxsj8py5n34lrgk6fvpgpxxvh585qm8dzvp7ups37vdet5a - description: Array of Cardano pool IDs (bech32 format) - pool_ids_optional: - content: - application/json: - schema: - type: object - properties: - _pool_bech32_ids: - format: text - type: array - items: - type: string - description: Array of Cardano pool IDs (bech32 format) - example: - _pool_bech32_ids: - - pool1p90428kec03mjdya3k4gv5d20w7lmed7ca0snknef5j977l3y8l - - pool1wwh3k3ldzujdvgxllfwlnnkxyheafkacqlufnvpr77n5q72f9hw - - pool1p835jxsj8py5n34lrgk6fvpgpxxvh585qm8dzvp7ups37vdet5a - description: Array of Cardano pool IDs (bech32 format) [Optional] - script_hashes: - content: - application/json: - schema: - type: object - properties: - _script_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano script hashes - example: - _script_hashes: - - c6d963e8892916ab8753d3c342037cd122123c4dd783a07af21f8dac - - c0c671fba483641a71bb92d3a8b7c52c90bf1c01e2b83116ad7d4536 - description: Array of Cardano script hashes - datum_hashes: - content: - application/json: - schema: - type: object - properties: - _datum_hashes: - format: text - type: array - items: - type: string - description: Array of Cardano datum hashes - example: - _datum_hashes: - - 6181b3dc623cd8812caf027a3507e9b3095388a7cf3db65983e1fddd3a84c88c - - f8ae55ff89e1f5366f23e16bcaf2073252337b96031a02d79e41d653b5f0a978 - description: Array of Cardano datum hashes - asset_list: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - example: - _asset_list: - - ['065270479316f1d92e00f7f9f095ebeaac9d009c878dc35ce36d3404','433374'] - - ['189e2c53985411addb8df0f3e09f70e343da69f06746c408aba672a8','15fc257714a51769e192761d674db2ee2e80137428e522f9b914debb5f785301'] - description: Array of array of policyID and asset names (hex) - asset_list_with_extended: - content: - application/json: - schema: - required: - - _asset_list - type: object - properties: - _asset_list: - format: text - type: array - description: Array of array of policy ID and asset names (hex) - items: - type: array - items: - type: string - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _asset_list: - - ['065270479316f1d92e00f7f9f095ebeaac9d009c878dc35ce36d3404','433374'] - - ['189e2c53985411addb8df0f3e09f70e343da69f06746c408aba672a8','15fc257714a51769e192761d674db2ee2e80137428e522f9b914debb5f785301'] - _extended: true - description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns - drep_id_bulk: - content: - application/json: - schema: - required: - - _drep_ids - type: object - properties: - _drep_ids: - format: text - type: array - descriptions: Array of DRep IDs in bech32 format - items: - type: string - example: - _drep_ids: - - drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - - drep1p6m6eg3ljyuthfx49d9dlq4rewnumuupr5hrtay0gaa0zq7qwze - utxo_refs_with_extended: - content: - application/json: - schema: - required: - - _utxo_refs - type: object - properties: - _utxo_refs: - format: text - type: array - items: - type: string - description: Array of Cardano utxo references in the form "hash#index" - _extended: - format: boolean - type: boolean - description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call - example: - _utxo_refs: - - 206f6da5b0b0de45605a95f5ce7e172be9674550f7dde3838c45cbf24bab8b00#0 - - f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c#0 - _extended: false - description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields - ogmios: - content: - application/json: - schema: - required: - - jsonrpc - - method - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab - enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] - example: "queryNetwork/tip" - params: - type: object - description: Any parameters relevant to the specific method to be called - nullable: true - examples: - blockHeight: - description: Query the network’s highest block number. - value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } - genesisConfiguration: - description: Query the genesis configuration of a given era. - value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } - startTimeTime: - description: Query the network start time. - value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } - tip: - description: Query tip of the Network - value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } - epoch: - description: Query the current epoch of the ledger. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } - eraStart: - description: Query information regarding the beginning of the current ledger era. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } - eraSummaries: - description: Query era bounds and slot parameters details, required for proper sloting arithmetic. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } - liveStakeDistribution: - description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } - protocolParameters: - description: Query the current protocol parameters. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } - proposedProtocolParameters: - description: Query the last update proposal w.r.t. protocol parameters, if any. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } - StakePools: - description: Query the list of all stake pool identifiers currently registered and active. - value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } - submitTransaction: - description: Submit a signed and serialized transaction to the network. - value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } - evaluateTransaction: - description: Evaluate execution units of scripts in a well-formed transaction. - value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } - description: JSON-RPC 2.0 standard request body - securitySchemes: - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT - description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. - schemas: - tip: - description: Current tip of the chain - type: array - items: - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_no: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - genesis: - description: Array of genesis parameters used to start each era on chain - type: array - items: - properties: - networkmagic: - type: string - example: 764824073 - description: Unique network identifier for chain - networkid: - type: string - example: Mainnet - description: Network ID used at various CLI identification to distinguish between Mainnet and other networks - epochlength: - type: string - example: 432000 - description: Number of slots in an epoch - slotlength: - type: string - example: 1 - description: Duration of a single slot (in seconds) - maxlovelacesupply: - type: string - example: 45000000000000000 - description: Maximum smallest units (lovelaces) supply for the blockchain - systemstart: - type: number - description: UNIX timestamp of the first block (genesis) on chain - example: 1506203091 - activeslotcoeff: - type: string - example: 0.05 - description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" - slotsperkesperiod: - type: string - example: 129600 - description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) - maxkesrevolutions: - type: string - example: 62 - description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised - securityparam: - type: string - example: 2160 - description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) - updatequorum: - type: string - example: 5 - description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal - alonzogenesis: - type: string - example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' - description: A JSON dump of Alonzo Genesis - totals: - description: Array of supply/reserves/utxo/fees/treasury stats - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - circulation: - type: string - description: Circulating UTxOs for given epoch (in lovelaces) - example: 32081169442642320 - treasury: - type: string - description: Funds in treasury for given epoch (in lovelaces) - example: 637024173474141 - reward: - type: string - description: Rewards accumulated as of given epoch (in lovelaces) - example: 506871250479840 - supply: - type: string - description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) - example: 33228495612391330 - reserves: - type: string - description: Total Reserves yet to be unlocked on chain - example: 11771504387608670 - param_updates: - description: Array of unique param update proposals submitted on chain - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - data: - type: string - description: JSON encoded data with details about the parameter update - example: {"decentralisation": 0.9} - cli_protocol_params: - description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format - type: object - example: - { - "collateralPercentage": 150, - "maxBlockBodySize": 90112, - "maxBlockHeaderSize": 1100, - "maxCollateralInputs": 3, - "maxTxSize": 16384, - "maxValueSize": 5000, - "minPoolCost": 170000000, - "minUTxOValue": null, - "monetaryExpansion": 3.0e-3, - "poolPledgeInfluence": 0.3, - "poolRetireMaxEpoch": 18, - "protocolVersion": { - "major": 8, - "minor": 0 - }, - "...": "...", - "stakeAddressDeposit": 2000000, - "stakePoolDeposit": 500000000, - "stakePoolTargetNum": 500, - "treasuryCut": 0.2, - "txFeeFixed": 155381, - "txFeePerByte": 44, - "utxoCostPerByte": 4310 - } - reserve_withdrawals: - description: Array of withdrawals from reserves/treasury against stake accounts - type: array - items: - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - earned_epoch: - description: Epoch where amount is earned - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - spendable_epoch: - description: Epoch where the earned amount can be spent - allOf: - - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - pool_list: - description: Array of pool IDs and tickers - type: array - items: - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - ticker: - type: - - string - - 'null' - description: Pool ticker - example: AHL - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_history_info: - description: Array of pool history information - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch for which the pool history data is shown - example: 312 - active_stake: - type: string - description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) - example: "31235800000" - active_stake_pct: - type: number - description: Active stake for the pool, expressed as a percentage of total active stake on network - example: 13.512182543475783 - saturation_pct: - type: number - description: Saturation percentage of a pool at the time of snapshot (2 decimals) - example: 45.32 - block_cnt: - type: - - number - - 'null' - description: Number of blocks pool created in that epoch - example: 14 - delegator_cnt: - type: number - description: Number of delegators to the pool for that epoch snapshot - example: 1432 - margin: - type: number - description: Margin (decimal format) - example: 0.125 - fixed_cost: - type: string - description: Pool fixed cost per epoch (in lovelaces) - example: "340000000" - pool_fees: - type: string - description: Total amount of fees earned by pool owners in that epoch (in lovelaces) - example: "123327382" - deleg_rewards: - type: string - description: Total amount of rewards earned by delegators in that epoch (in lovelaces) - example: "123456789123" - member_rewards: - type: string - description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) - example: "123456780123" - epoch_ros: - type: number - description: Annualized ROS (return on staking) for delegators for this epoch - example: 3.000340466 - pool_info: - description: Array of pool information - type: array - items: - type: object - properties: - pool_id_bech32: - type: string - description: Pool ID (bech32 format) - example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc - pool_id_hex: - type: string - description: Pool ID (Hex format) - example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - vrf_key_hash: - type: - - string - - 'null' - description: Pool VRF key hash - example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 - margin: - type: - - number - - 'null' - description: Margin (decimal format) - example: 0.1 - fixed_cost: - type: - - string - - 'null' - description: Pool fixed cost per epoch - example: "500000000" - pledge: - type: - - string - - 'null' - description: Pool pledge in lovelace - example: "64000000000000" - deposit: - type: - - string - - 'null' - description: Pool's registration deposit in lovelace - example: "500000000" - reward_addr: - type: - - string - - 'null' - description: Pool reward address - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - owners: - type: - - array - - 'null' - items: - type: string - description: Pool (co)owner address - example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 - relays: - type: array - items: - type: object - properties: - dns: - type: - - string - - 'null' - description: DNS name of the relay (nullable) - example: relays-new.cardano-mainnet.iohk.io - srv: - type: - - string - - 'null' - description: DNS service name of the relay (nullable) - example: biostakingpool3.hopto.org - ipv4: - type: - - string - - 'null' - description: IPv4 address of the relay (nullable) - example: "54.220.20.40" - ipv6: - type: - - string - - 'null' - description: IPv6 address of the relay (nullable) - example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf - port: - type: - - number - - 'null' - description: Port number of the relay (nullable) - example: 6000 - meta_url: - type: - - string - - 'null' - description: Pool metadata URL - example: https://pools.iohk.io/IOGP.json - meta_hash: - type: - - string - - 'null' - description: Pool metadata hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - meta_json: - type: - - object - - 'null' - properties: - name: - type: string - description: Pool name - example: Input Output Global (IOHK) - Private - ticker: - type: string - description: Pool ticker - example: IOGP - homepage: - type: string - description: Pool homepage URL - example: https://iohk.io - description: - type: string - description: Pool description - example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. - pool_status: - type: string - description: Pool status - enum: ["registered", "retiring", "retired"] - example: registered - retiring_epoch: - type: - - number - - 'null' - description: Announced retiring epoch (nullable) - example: 'null' - op_cert: - type: - - string - - 'null' - description: Pool latest operational certificate hash - example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 - op_cert_counter: - type: - - number - - 'null' - description: Pool latest operational certificate counter value - example: 8 - active_stake: - type: - - string - - 'null' - description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) - example: "64328627680963" - sigma: - type: - - number - - 'null' - description: Pool relative active stake share - example: 0.0034839235 - block_count: - type: - - number - - 'null' - description: Total pool blocks on chain - example: 4509 - live_pledge: - type: - - string - - 'null' - description: Summary of account balance for all pool owner's - example: "64328594406327" - live_stake: - type: - - string - - 'null' - description: Pool live stake - example: "64328627680963" - live_delegators: - type: number - description: Pool live delegator count - example: 5 - live_saturation: - type: - - number - - 'null' - description: Pool live saturation (decimal format) - example: 94.52 - pool_snapshot: - type: array - items: - description: Array of pool stake information for 3 snapshots - type: object - properties: - snapshot: - type: string - description: Type of snapshot ("Mark", "Set" or "Go") - example: "Mark" - epoch_no: - type: number - description: Epoch number for the snapshot entry - example: 324 - nonce: - $ref: "#/components/schemas/epoch_params/items/properties/nonce" - pool_stake: - type: string - description: Pool's Active Stake for the given epoch - example: "100000000000" - active_stake: - type: string - description: Total Active Stake for the given epoch - example: "103703246364020" - pool_delegators: - description: Array of live pool delegators - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - description: Current delegator live stake (in lovelace) - example: 64328591517480 - active_epoch_no: - type: number - description: Epoch number in which the delegation becomes active - example: 324 - latest_delegation_tx_hash: - type: string - description: Latest transaction hash used for delegation by the account - example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 - pool_registrations: - description: Array of pool registrations/retirements - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - active_epoch_no: - $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" - pool_delegators_history: - description: Array of pool delegators (historical) - type: - - array - - 'null' - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - $ref: "#/components/schemas/pool_delegators/items/properties/amount" - epoch_no: - type: number - description: Epoch number for the delegation history - example: 324 - pool_blocks: - description: Array of blocks created by pool - type: array - items: - type: object - properties: - epoch_no: - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_updates: - description: Array of historical pool updates - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - pool_id_hex: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" - active_epoch_no: - type: - - number - - 'null' - description: Epoch number in which the update becomes active - example: 324 - vrf_key_hash: - $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" - margin: - $ref: "#/components/schemas/pool_info/items/properties/margin" - fixed_cost: - $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" - pledge: - $ref: "#/components/schemas/pool_info/items/properties/pledge" - reward_addr: - $ref: "#/components/schemas/pool_info/items/properties/reward_addr" - owners: - $ref: "#/components/schemas/pool_info/items/properties/owners" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - update_type: - type: string - description: Type of update task - enum: ["registration", "deregistration"] - example: registered - retiring_epoch: - $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" - pool_relays: - description: Array of pool relay information - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - relays: - $ref: "#/components/schemas/pool_info/items/properties/relays" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - pool_metadata: - description: Array of pool metadata - type: array - items: - type: object - properties: - pool_id_bech32: - $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" - meta_url: - $ref: "#/components/schemas/pool_info/items/properties/meta_url" - meta_hash: - $ref: "#/components/schemas/pool_info/items/properties/meta_hash" - meta_json: - $ref: "#/components/schemas/pool_info/items/properties/meta_json" - pool_status: - $ref: "#/components/schemas/pool_info/items/properties/pool_status" - epoch_info: - description: Array of detailed summary for each epoch - type: array - items: - type: object - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - out_sum: - type: string - description: Total output value across all transactions in epoch - example: 15432725054364942 - fees: - type: string - description: Total fees incurred by transactions in epoch - example: 74325855210 - tx_count: - type: number - description: Number of transactions submitted in epoch - example: 357919 - blk_count: - type: number - description: Number of blocks created in epoch - example: 17321 - start_time: - type: number - description: UNIX timestamp of the epoch start - example: 1506203091 - end_time: - type: number - description: UNIX timestamp of the epoch end - example: 1506635091 - first_block_time: - type: number - description: UNIX timestamp of the epoch's first block - example: 1506635091 - last_block_time: - type: number - description: UNIX timestamp of the epoch's last block - example: 1506635091 - active_stake: - type: - - string - - 'null' - description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) - example: 23395112387185880 - total_rewards: - type: - - string - - 'null' - description: Total rewards earned in epoch (null for pre-Shelley epochs) - example: 252902897534230 - avg_blk_reward: - type: - - string - - 'null' - description: Average block reward for epoch (null for pre-Shelley epochs) - example: 660233450 - epoch_params: - description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) - type: array - items: - properties: - epoch_no: - type: number - description: Epoch number - example: 294 - min_fee_a: - type: - - number - - 'null' - description: The 'a' parameter to calculate the minimum transaction fee - example: 44 - min_fee_b: - type: - - number - - 'null' - description: The 'b' parameter to calculate the minimum transaction fee - example: 155381 - max_block_size: - type: - - number - - 'null' - description: The maximum block size (in bytes) - example: 65536 - max_tx_size: - type: - - number - - 'null' - description: The maximum transaction size (in bytes) - example: 16384 - max_bh_size: - type: - - number - - 'null' - description: The maximum block header size (in bytes) - example: 1100 - key_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake address - example: 2000000 - pool_deposit: - type: - - string - - 'null' - description: The amount (in lovelace) required for a deposit to register a stake pool - example: 500000000 - max_epoch: - type: - - number - - 'null' - description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for - example: 18 - optimal_pool_count: - type: - - number - - 'null' - description: The optimal number of stake pools - example: 500 - influence: - type: - - number - - 'null' - format: double - description: The pledge influence on pool rewards - example: 0.3 - monetary_expand_rate: - type: - - number - - 'null' - format: double - description: The monetary expansion rate - example: 0.003 - treasury_growth_rate: - type: - - number - - 'null' - format: double - description: The treasury growth rate - example: 0.2 - decentralisation: - type: - - number - - 'null' - format: double - description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) - example: 0.1 - extra_entropy: - type: - - string - - 'null' - description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool - example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa - protocol_major: - type: - - number - - 'null' - description: The protocol major version - example: 5 - protocol_minor: - type: - - number - - 'null' - description: The protocol minor version - example: 0 - min_utxo_value: - type: - - string - - 'null' - description: The minimum value of a UTxO entry - example: 34482 - min_pool_cost: - type: - - string - - 'null' - description: The minimum pool cost - example: 340000000 - nonce: - type: - - string - - 'null' - description: The nonce value for this epoch - example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 - block_hash: - type: string - description: The hash of the first block where these parameters are valid - example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 - cost_models: - type: - - object - - 'null' - description: The per language cost model in JSON - example: 'null' - price_mem: - type: - - number - - 'null' - format: double - description: The per word cost of script memory usage - example: 0.0577 - price_step: - type: - - number - - 'null' - format: double - description: The cost of script execution step usage - example: 7.21e-05 - max_tx_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single transaction - example: 10000000 - max_tx_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single transaction - example: 10000000000 - max_block_ex_mem: - type: - - number - - 'null' - description: The maximum number of execution memory allowed to be used in a single block - example: 50000000 - max_block_ex_steps: - type: - - number - - 'null' - description: The maximum number of execution steps allowed to be used in a single block - example: 40000000000 - max_val_size: - type: - - number - - 'null' - description: The maximum Val size - example: 5000 - collateral_percent: - type: - - number - - 'null' - description: The percentage of the tx fee which must be provided as collateral when including non-native scripts - example: 150 - max_collateral_inputs: - type: - - number - - 'null' - description: The maximum number of collateral inputs allowed in a transaction - example: 3 - coins_per_utxo_size: - type: - - string - - 'null' - description: The cost per UTxO size - example: 34482 - pvt_motion_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for motion of no-confidence. - example: 0.6 - pvt_committee_normal: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (normal state). - example: 0.65 - pvt_committee_no_confidence: - type: - - number - - 'null' - description: Pool Voting threshold for new committee/threshold (state of no-confidence). - example: 0.65 - pvt_hard_fork_initiation: - type: - - number - - 'null' - description: Pool Voting threshold for hard-fork initiation. - example: 0.51 - dvt_motion_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for motion of no-confidence. - example: 0.67 - dvt_committee_normal: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (normal state). - example: 0.67 - dvt_committee_no_confidence: - type: - - number - - 'null' - description: DRep Vote threshold for new committee/threshold (state of no-confidence). - example: 0.65 - dvt_update_to_constitution: - type: - - number - - 'null' - description: DRep Vote threshold for update to the Constitution. - example: 0.75 - dvt_hard_fork_initiation: - type: - - number - - 'null' - description: DRep Vote threshold for hard-fork initiation. - example: 0.6 - dvt_p_p_network_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, network group. - example: 0.67 - dvt_p_p_economic_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, economic group. - example: 0.67 - dvt_p_p_technical_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, technical group. - example: 0.67 - dvt_p_p_gov_group: - type: - - number - - 'null' - description: DRep Vote threshold for protocol parameter changes, governance group. - example: 0.75 - dvt_treasury_withdrawal: - type: - - number - - 'null' - description: DRep Vote threshold for treasury withdrawal. - example: 0.67 - committee_min_size: - type: - - number - - 'null' - description: Minimal constitutional committee size. - example: 5 - committee_max_term_length: - type: - - number - - 'null' - description: Constitutional committee term limits. - example: 146 - gov_action_lifetime: - type: - - number - - 'null' - description: Governance action expiration. - example: 14 - gov_action_deposit: - type: - - string - - 'null' - description: Governance action deposit. - example: 100000000000 - drep_deposit: - type: - - string - - 'null' - description: DRep deposit amount. - example: 500000000 - drep_activity: - type: - - number - - 'null' - description: DRep activity period. - example: 20 - pvtpp_security_group: - type: - - number - - 'null' - description: Pool Voting threshold for protocol parameter changes, security group. - example: 0.6 - min_fee_ref_script_cost_per_byte: - type: - - number - - 'null' - description: Minimum Fee for Reference Script cost pre byte - example: 15 - epoch_block_protocols: - description: Array of distinct block protocol versions counts in epoch - type: array - items: - properties: - proto_major: - type: number - description: Protocol major version - example: 6 - proto_minor: - type: number - description: Protocol major version - example: 2 - blocks: - type: number - description: Amount of blocks with specified major and protocol combination - example: 2183 - blocks: - description: Array of block information - type: array - items: - type: object - properties: - hash: - type: string - description: Hash of the block - example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f - epoch_no: - type: number - description: Epoch number of the block - example: 117 - abs_slot: - type: number - description: Absolute slot number of the block - example: 49073930 - epoch_slot: - type: number - description: Slot number of the block in epoch - example: 171530 - block_height: - type: - - number - - 'null' - description: Block height - example: 1794506 - block_size: - type: number - description: Block size in bytes - example: 2433 - block_time: - type: number - description: UNIX timestamp of the block - example: 1704757130 - tx_count: - type: number - description: Number of transactions in the block - example: 2 - vrf_key: - type: string - description: VRF key of the block producer - example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" - pool: - type: - - string - - 'null' - description: Pool ID in bech32 format (null for pre-Shelley blocks) - example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v - op_cert_counter: - type: number - description: Counter value of the operational certificate used to create this block - example: 5 - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - parent_hash: - type: string - description: Previous Hash of the current block - example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 - block_info: - description: Array of detailed block information - type: array - items: - type: object - properties: - hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - abs_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_size: - $ref: "#/components/schemas/blocks/items/properties/block_size" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - tx_count: - $ref: "#/components/schemas/blocks/items/properties/tx_count" - vrf_key: - $ref: "#/components/schemas/blocks/items/properties/vrf_key" - op_cert: - type: string - description: Hash of the block producers' operational certificate - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - op_cert_counter: - $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" - pool: - $ref: "#/components/schemas/blocks/items/properties/pool" - proto_major: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" - proto_minor: - $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" - total_output: - type: - - string - - 'null' - description: Total output of the block (in lovelace) - example: 92384672389 - total_fees: - type: - - string - - 'null' - description: Total fees of the block (in lovelace) - example: 2346834 - num_confirmations: - type: number - description: Number of confirmations for the block - example: 664275 - parent_hash: - type: string - description: Hash of the parent of this block - example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" - child_hash: - type: string - description: Hash of the child of this block (if present) - example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" - block_txs: - description: Array of transactions hashes - type: array - items: - type: object - properties: - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - block_tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" - tx_block_index: - $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" - tx_size: - $ref: "#/components/schemas/tx_info/items/properties/tx_size" - total_output: - $ref: "#/components/schemas/tx_info/items/properties/total_output" - fee: - $ref: "#/components/schemas/tx_info/items/properties/fee" - treasury_donation: - $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" - deposit: - $ref: "#/components/schemas/tx_info/items/properties/deposit" - invalid_before: - $ref: "#/components/schemas/tx_info/items/properties/invalid_before" - invalid_after: - $ref: "#/components/schemas/tx_info/items/properties/invalid_after" - collateral_inputs: - $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" - collateral_output: - $ref: "#/components/schemas/tx_info/items/properties/collateral_output" - reference_inputs: - $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" - inputs: - description: An array of UTxO inputs spent in the transaction - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - outputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - withdrawals: - $ref: "#/components/schemas/tx_info/items/properties/withdrawals" - assets_minted: - $ref: "#/components/schemas/tx_info/items/properties/assets_minted" - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - $ref: "#/components/schemas/tx_info/items/properties/certificates" - native_scripts: - $ref: "#/components/schemas/tx_info/items/properties/native_scripts" - plutus_contracts: - $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" - address_info: - description: Array of information for address(es) - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - balance: - type: string - description: Sum of all UTxO values beloning to address - example: 10723473983 - stake_address: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/account_history/items/properties/stake_address" - script_address: - type: boolean - description: Signifies whether the address is a script address - example: true - utxo_set: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - address_txs: - description: Array of transaction hashes - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - address_assets: - description: Array of address-owned assets - type: array - items: - type: object - properties: - address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - - account_list: - description: Array of account (stake address) IDs - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - stake_address_hex: - type: string - description: Cardano staking address (reward account) in hex format - example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf - script_hash: - type: string - description: Script hash in case the stake address is locked by a script - example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 - account_info: - description: Array of stake account information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - status: - type: string - description: Stake address status - enum: ["registered", "not registered"] - example: registered - delegated_drep: - anyOf: - - type: 'null' - - type: string - description: Account's current delegation status to DRep ID in Bech32 format - example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 - delegated_pool: - anyOf: - - type: 'null' - - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - total_balance: - type: string - description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) - example: 207116800428 - utxo: - type: string - description: Total UTxO balance of the account - example: 162764177131 - rewards: - type: string - description: Total rewards earned by the account - example: 56457728047 - withdrawals: - type: string - description: Total rewards withdrawn by the account - example: 12105104750 - rewards_available: - type: string - description: Total rewards available for withdrawal - example: 44352623297 - deposit: - type: string - description: Total deposit available for withdrawal - example: 2000000 - reserves: - type: string - description: Total reserves MIR value of the account - example: "0" - treasury: - type: string - description: Total treasury MIR value of the account - example: "0" - utxo_infos: - description: Array of complete UTxO information - type: array - items: - type: object - properties: - tx_hash: - type: string - description: Hash identifier of the transaction - example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e - tx_index: - type: number - description: Index of UTxO in the transaction - example: 0 - address: - type: string - description: A Cardano payment/base address (bech32 encoded) - example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - payment_cred: - type: - - string - - 'null' - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: - - array - - 'null' - description: An array of assets on the UTxO - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of assets on the UTxO - example: 1 - is_spent: - type: boolean - description: True if the UTXO has been spent - example: true - account_rewards: - description: Array of reward history information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - rewards: - type: array - items: - type: object - properties: - earned_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" - spendable_epoch: - $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" - amount: - type: string - description: Amount of rewards earned (in lovelace) - type: - type: string - description: The source of the rewards - enum: [member, leader, treasury, reserves] - example: member - pool_id: - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" - account_updates: - description: Array of account updates information - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - updates: - type: array - items: - type: object - properties: - action_type: - type: string - description: Type of certificate submitted - enum: ["registration", "delegation", "withdrawal", "deregistration"] - example: "registration" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - account_addresses: - description: Array of payment addresses - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - addresses: - type: array - items: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - account_assets: - description: Array of assets owned by account - type: array - items: - type: object - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - account_history: - description: Array of active stake values per epoch - type: array - items: - properties: - stake_address: - type: string - description: Cardano staking address (reward account) in bech32 format - example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz - history: - type: array - items: - type: object - properties: - pool_id: - type: string - description: Bech32 representation of pool ID - example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt - epoch_no: - type: number - description: Epoch number - example: 301 - active_stake: - type: string - description: Active stake amount (in lovelaces) - example: 682334162 - tx_info: - description: Array of detailed information about transaction(s) - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - block_hash: - $ref: "#/components/schemas/blocks/items/properties/hash" - block_height: - $ref: "#/components/schemas/blocks/items/properties/block_height" - epoch_no: - $ref: "#/components/schemas/blocks/items/properties/epoch_no" - epoch_slot: - $ref: "#/components/schemas/blocks/items/properties/epoch_slot" - absolute_slot: - $ref: "#/components/schemas/blocks/items/properties/abs_slot" - tx_timestamp: - type: number - description: UNIX timestamp of the transaction - example: 1506635091 - tx_block_index: - type: number - description: Index of transaction within block - example: 6 - tx_size: - type: number - description: Size in bytes of transaction - example: 391 - total_output: - type: string - description: Total sum of all transaction outputs (in lovelaces) - example: 157832856 - fee: - type: string - description: Total Transaction fee (in lovelaces) - example: 172761 - treasury_donation: - type: string - description: Total Donation to on-chain treasury (in lovelaces) - example: 0 - deposit: - type: string - description: Total Deposits included in transaction (for example, if it is registering a pool/key) - example: 0 - invalid_before: - type: - - string - - 'null' - description: Slot before which transaction cannot be validated (if supplied, else null) - invalid_after: - type: - - string - - 'null' - description: Slot after which transaction cannot be validated - example: 42332172 - collateral_inputs: - description: An array of collateral inputs needed for smart contracts in case of contract failure - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - collateral_output: - description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) - type: array - items: - properties: - payment_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" - stake_addr: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" - value: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" - datum_hash: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" - inline_datum: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" - reference_script: - $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" - asset_list: - type: array - description: Brief asset description from ledger - reference_inputs: - description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) - anyOf: - - type: 'null' - - $ref: "#/components/schemas/tx_info/items/properties/outputs" - inputs: - $ref: "#/components/schemas/tx_info/items/properties/outputs" - #description: An array of UTxO inputs spent in the transaction - outputs: - type: array - description: An array of UTxO outputs created by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - datum_hash: - type: - - string - - 'null' - description: Hash of datum (if any) connected to UTxO - example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 - inline_datum: - type: - - object - - 'null' - description: Allows datums to be attached to UTxO (CIP-32) - properties: - bytes: - type: string - description: Datum bytes (hex) - example: 19029a - value: - type: object - description: Value (json) - example: { "int": 666 } - reference_script: - type: - - object - - 'null' - description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) - properties: - hash: - type: string - description: Hash of referenced script - example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 - size: - type: number - description: Size in bytes - example: 14 - type: - type: string - description: Type of script - example: plutusV1 - bytes: - type: string - description: Script bytes (hex) - example: 4e4d01000033222220051200120011 - value: - type: - - object - - 'null' - description: Value (json) - example: 'null' - asset_list: - $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" - withdrawals: - type: - - array - - 'null' - description: Array of withdrawals with-in a transaction - items: - type: object - properties: - amount: - type: string - description: Withdrawal amount (in lovelaces) - example: 9845162 - stake_addr: - type: string - description: A Cardano staking address (reward account, bech32 encoded) - example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj - assets_minted: - type: - - array - - 'null' - description: Array of minted assets with-in a transaction - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - quantity: - type: string - description: Quantity of minted assets (negative on burn) - example: 1 - metadata: - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - certificates: - type: - - array - - 'null' - description: Certificates present with-in a transaction (if any) - items: - properties: - index: - type: - - number - - 'null' - description: Certificate index - example: 0 - type: - type: string - description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) - example: delegation - info: - type: - - object - - 'null' - description: A JSON array containing information from the certificate - example: - { - "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", - "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", - } - native_scripts: - type: - - array - - 'null' - description: Native scripts present in a transaction (if any) - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - script_json: - type: object - description: JSON representation of the timelock script (null for other script types) - example: - { - "type": "all", - "scripts": - [ - { - "type": "sig", - "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", - }, - { - "type": "sig", - "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", - }, - { - "type": "sig", - "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", - }, - ], - } - plutus_contracts: - type: - - array - - 'null' - description: Plutus contracts present in transaction (if any) - items: - properties: - address: - type: - - string - - 'null' - description: Plutus script address - example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 - spends_input: - type: - - object - - 'null' - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - description: Input utxo this contract spends - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - bytecode: - $ref: "#/components/schemas/script_info/items/properties/bytes" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - valid_contract: - type: boolean - description: True if the contract is valid or there is no contract - example: true - input: - type: object - properties: - redeemer: - type: object - properties: - purpose: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" - fee: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" - unit: - type: object - properties: - steps: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" - mem: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - datum: - type: object - properties: - hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - value: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" - tx_cbor: - description: Raw Transaction(s) in CBOR format - item: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - cbor: - type: string - description: CBOR encoded raw transaction. - tx_utxos: - description: Array of inputs and outputs for given transaction(s) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/tx_info/items/properties/tx_hash" - inputs: - type: array - description: An array of UTxO inputs used by the transaction - items: - type: object - properties: - payment_addr: - type: object - properties: - bech32: - type: string - description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned - example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw - cred: - type: string - description: Payment credential - example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 - stake_addr: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - value: - type: string - description: Total sum of ADA on the UTxO - example: 157832856 - outputs: - description: An array of UTxO outputs created by the transaction - allOf: - - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" - tx_metadata: - description: Array of metadata information present in each of the transactions queried - type: - - array - - 'null' - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - metadata: - type: - - object - - 'null' - description: A JSON array containing details about metadata within transaction - example: - { - "721": - { - "version": 1, - "copyright": "...", - "publisher": ["p...o"], - "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": - {}, - }, - } - tx_status: - description: Array of transaction confirmation counts - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - num_confirmations: - type: - - number - - 'null' - description: Number of block confirmations - example: 17 - tx_metalabels: - description: Array of known metadata labels - type: array - items: - properties: - key: - type: string - description: A distinct known metalabel - example: "721" - asset_list: - description: Array of policy IDs and asset names - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - asset_token_registry: - description: An array of token registry information (registered via github) for each asset - type: array - items: - type: object - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - ticker: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" - description: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" - url: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - logo: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" - asset_addresses: - description: An array of payment addresses holding the given token (including balances) - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - type: string - description: Asset balance on the payment address - example: 23 - asset_nft_address: - description: An array of payment addresses holding the given token - type: array - items: - properties: - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - asset_summary: - description: Array of asset summary information - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_transactions: - type: number - description: Total number of transactions including the given asset - example: 89416 - staked_wallets: - type: number - description: Total number of registered wallets holding the given asset - example: 548 - unstaked_addresses: - type: number - description: Total number of payment addresses (not belonging to registered wallets) holding the given asset - example: 245 - addresses: - type: number - description: Total number of unique addresses holding the given asset - example: 812 - asset_info: - description: Array of detailed asset information - type: array - items: - properties: - policy_id: - type: string - description: Asset Policy ID (hex) - example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff - asset_name: - type: - - string - - 'null' - description: Asset Name (hex) - example: 444f4e545350414d - asset_name_ascii: - type: string - description: Asset Name (ASCII) - example: DONTSPAM - fingerprint: - type: string - description: The CIP14 fingerprint of the asset - example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 - minting_tx_hash: - type: string - description: Hash of the latest mint transaction (with metadata if found for asset) - example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 - total_supply: - type: string - description: Total supply for the asset - example: "35000" - mint_cnt: - type: number - description: Count of total mint transactions - example: 1 - burn_cnt: - type: number - description: Count of total burn transactions - example: 5 - creation_time: - type: number - description: UNIX timestamp of the first asset mint - example: 1506635091 - minting_tx_metadata: - allOf: - - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" - description: Latest minting transaction metadata (aligns with CIP-25) - token_registry_metadata: - type: - - object - - 'null' - description: Asset metadata registered on the Cardano Token Registry - properties: - name: - type: string - example: Rackmob - description: - type: string - example: Metaverse Blockchain Cryptocurrency. - ticker: - type: string - example: MOB - url: - type: string - example: https://www.rackmob.com/ - logo: - type: string - description: A PNG image file as a byte string - example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc - decimals: - type: number - example: 0 - cip68_metadata: - type: - - object - - 'null' - description: CIP 68 metadata if present for asset - example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} - asset_history: - description: Array of asset mint/burn history - type: array - items: - properties: - policy_id: - $ref: "#/components/schemas/asset_info/items/properties/policy_id" - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_txs: - type: - - array - - 'null' - description: Array of all mint/burn transactions for an asset - items: - type: object - properties: - tx_hash: - type: string - description: Hash of minting/burning transaction - example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - quantity: - type: string - description: Quantity minted/burned (negative numbers indicate burn transactions) - example: "-10" - metadata: - type: array - description: Array of Transaction Metadata for given transaction - items: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - policy_asset_addresses: - description: Array of asset names and payment addresses for the given policy (including balances) - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - payment_address: - $ref: "#/components/schemas/utxo_infos/items/properties/address" - stake_address: - $ref: "#/components/schemas/address_info/items/properties/stake_address" - quantity: - $ref: "#/components/schemas/asset_addresses/items/properties/quantity" - policy_asset_info: - description: Array of detailed information of assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - token_registry_metadata: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" - policy_asset_mints: - description: Array of mint information for assets under requested policies - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - asset_name_ascii: - $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - minting_tx_hash: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - mint_cnt: - $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" - burn_cnt: - $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" - creation_time: - $ref: "#/components/schemas/asset_info/items/properties/creation_time" - minting_tx_metadata: - $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - policy_asset_list: - description: Array of brief information of assets under the same policy - type: array - items: - properties: - asset_name: - $ref: "#/components/schemas/asset_info/items/properties/asset_name" - fingerprint: - $ref: "#/components/schemas/asset_info/items/properties/fingerprint" - total_supply: - $ref: "#/components/schemas/asset_info/items/properties/total_supply" - decimals: - $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" - drep_info: - description: Get detailed information about requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - type: string - description: DRep ID in bech32 format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - hex: - type: string - description: DRep ID in hex format - example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 - has_script: - type: boolean - description: Flag which shows if this DRep credentials are a script hash - example: false - registered: - type: boolean - description: Flag to show if the DRep is currently registered - example: false - deposit: - type: - - string - - 'null' - description: DRep's registration deposit in lovelace - example: 500000000 - active: - type: boolean - description: Flag to show if the DRep is (i.e. not expired) - example: true - expires_epoch_no: - type: - - number - - 'null' - description: After which epoch DRep is considered inactive. - example: 410 - amount: - type: string - description: The total amount of voting power this DRep is delegated. - example: 599496769641 - drep_list: - description: List of all active delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - has_script: - $ref: "#/components/schemas/drep_info/items/properties/has_script" - registered: - $ref: "#/components/schemas/drep_info/items/properties/registered" - drep_metadata: - description: List metadata for requested delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - url: - type: string - description: A URL to a JSON payload of metadata - example: "https://hornan7.github.io/Vote_Context.jsonld" - hash: - type: string - description: A hash of the contents of the metadata URL - example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d - json: - type: object - description: The payload as JSON - example: - {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} - bytes: - type: string - description: The raw bytes of the payload - example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d - warning: - type: string - description: A warning that occured while validating the metadata - language: - type: string - description: The language described in the context of the metadata as per CIP-100 - example: en-us - comment: - type: string - description: Comment attached to the metadata - is_valid: - type: boolean - description: Indicate whether data is invalid - example: true - drep_updates: - description: List of updates for requested (or all) delegated representatives (DReps) - type: array - items: - properties: - drep_id: - $ref: "#/components/schemas/drep_info/items/properties/drep_id" - hex: - $ref: "#/components/schemas/drep_info/items/properties/hex" - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - type: string - description: The index of this certificate within the the transaction. - example: 1 - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - action: - type: string - description: Effective action for this DRep Update certificate - enum: ["updated","registered","deregistered"] - example: registered - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - drep_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - vote: - type: string - enum: ["Yes","No","Abstain"] - description: Actual Vote casted - example: "Yes" - pool_votes: - description: List of all votes casted by requested pool - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - committee_votes: - description: List of all votes casted by requested delegated representative (DRep) - type: array - items: - $ref: "#/components/schemas/drep_votes/items" - proposal_list: - description: List of all votes cast on specified governance action - type: array - items: - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - cert_index: - $ref: "#/components/schemas/drep_updates/items/properties/cert_index" - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - proposal_type: - type: string - enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] - description: Proposal Action Type - example: ParameterChange - proposal_description: - type: string - description: Description for Proposal Action - example: '{"tag": "InfoAction"}' - deposit: - $ref: "#/components/schemas/drep_info/items/properties/deposit" - return_address: - type: string - description: The StakeAddress index of the reward address to receive the deposit when it is repaid. - example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 - proposed_epoch: - type: number - description: Shows the epoch at which this governance action was proposed. - example: 660 - ratified_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been ratified at the specfied epoch. - example: 670 - enacted_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been enacted at the specfied epoch. - example: 675 - dropped_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. - example: 680 - expired_epoch: - type: - - number - - 'null' - description: If not null, then this proposal has been expired at the specfied epoch. - example: 680 - expiration: - type: - - number - - 'null' - description: Shows the epoch at which this governance action is expected to expire. - meta_url: - $ref: "#/components/schemas/drep_metadata/items/properties/url" - meta_hash: - $ref: "#/components/schemas/drep_metadata/items/properties/hash" - meta_json: - $ref: "#/components/schemas/drep_metadata/items/properties/json" - meta_comment: - $ref: "#/components/schemas/drep_metadata/items/properties/comment" - meta_language: - $ref: "#/components/schemas/drep_metadata/items/properties/language" - meta_is_valid: - $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" - withdrawal: - type: - - object - - 'null' - description: If not null, The amount withdrawn from treasury into stake address by this this proposal - properties: - stake_address: - $ref: "#/components/schemas/account_history/items/properties/stake_address" - amount: - type: string - example: "31235800000" - proposal_votes: - type: array - description: List of all votes cast on specified governance action - items: - properties: - block_time: - $ref: "#/components/schemas/blocks/items/properties/block_time" - voter_role: - type: string - description: The role of the voter - enum: ["ConstitutionalCommittee", "DRep", "SPO"] - example: DRep - voter: - type: string - description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - voter_hex: - type: string - description: Voter's DRep ID , pool ID or committee hash in hex format - example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck - vote: - $ref: "#/components/schemas/drep_votes/items/properties/vote" - - script_info: - type: array - items: - description: Array of information for scripts - properties: - script_hash: - type: string - description: Hash of a script - example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af - creation_tx_hash: - type: string - description: Hash of the script creation transaction - example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe - type: - type: string - description: Type of the script - enum: ["plutusV1","plutusV2","timelock","multisig"] - example: plutusV1 - value: - type: - - object - - 'null' - description: Data in JSON format - example: 'null' - bytes: - type: - - string - - 'null' - description: Script bytes (cborSeq) - example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 - size: - type: number - description: The size of the CBOR serialised script (in bytes) - example: 2039 - script_list: - description: List of script and creation tx hash pairs - type: array - items: - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - type: - $ref: "#/components/schemas/script_info/items/properties/type" - size: - $ref: "#/components/schemas/script_info/items/properties/size" - script_redeemers: - description: Array of all redeemers for a given script hash - type: array - items: - type: object - properties: - script_hash: - $ref: "#/components/schemas/script_info/items/properties/script_hash" - redeemers: - type: array - items: - type: object - properties: - tx_hash: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" - tx_index: - $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" - unit_mem: - type: - - string - - number - - 'null' - description: The budget in Memory to run a script - example: 520448 - unit_steps: - type: - - string - - number - - 'null' - description: The budget in Cpu steps to run a script - example: 211535239 - fee: - type: string - description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices - example: 45282 - purpose: - type: string - description: What kind of validation this redeemer is used for - enum: ["spend", "mint", "cert", "reward"] - example: spend - datum_hash: - type: - - string - - 'null' - description: The Hash of the Plutus Data - example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 - datum_value: - $ref: "#/components/schemas/script_info/items/properties/value" - datum_info: - description: Array of datum information for given datum hashes - type: array - items: - type: object - properties: - datum_hash: - $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" - creation_tx_hash: - $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" - value: - $ref: "#/components/schemas/script_info/items/properties/value" - bytes: - $ref: "#/components/schemas/script_info/items/properties/bytes" - ogmiostip: - description: Current tip of the chain, identified by a slot and a block header hash. - type: object - properties: - jsonrpc: - format: text - type: string - description: Identifier for JSON-RPC 2.0 standard - example: "2.0" - method: - format: text - type: string - description: The Ogmios method that was called in the request - example: "queryNetwork/tip" - result: - type: - - object - - 'null' - - string - - array - - number - description: Result of the query - properties: - slot: - type: number - description: Absolute slot number on chain - example: 59886800 - id: - type: string - description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) - example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" - example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} - headers: {} - responses: - NotFound: - description: The server does not recognise the combination of endpoint and parameters provided - Unauthorized: - description: Access token is missing or invalid - BadRequest: - description: The server cannot process the request due to invalid input -tags: - - name: Network - description: Query information about the network - x-tag-expanded: false - - name: Epoch - description: Query epoch-specific details - x-tag-expanded: false - - name: Block - description: Query information about particular block on chain - x-tag-expanded: false - - name: Transactions - description: Query blockchain transaction details - x-tag-expanded: false - - name: Stake Account - description: Query details about specific stake account addresses - x-tag-expanded: false - - name: Address - description: Query information about specific address(es) - x-tag-expanded: false - - name: Asset - description: Query Asset related informations - x-tag-expanded: false - - name: Governance - description: Query information about governance for network - x-tag-expanded: false - - name: Pool - description: Query information about specific pools - x-tag-expanded: false - - name: Script - description: Query information about specific scripts (Smart Contracts) - x-tag-expanded: false - - name: Ogmios - description: | - Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, - but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. - -
-
- Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. - Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: -
- - - ### Network - - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) - - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) - - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) - - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) - ### Ledger-State - - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) - - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) - - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) - - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) - - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) - - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) - - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) - ### Transactions - - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) - - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) - x-tag-expanded: true -security: - - [] - - bearerAuth: [] +openapi: 3.1.0 +info: + title: Koios API + contact: + name: Koios Core Team + url: https://t.me/CardanoKoios + email: general@koios.rest + license: + name: Creative Commons Attribution 4.0 International + url: https://github.com/cardano-community/koios-artifacts/blob/main/LICENSE + version: v1.2.0a + description: | + Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc. This page not only provides an OpenAPI Spec for live implementation, but also ability to execute live demo from client browser against each endpoint with pre-filled examples. + + # API Usage + + The endpoints served by Koios can be browsed from the left side bar of this site. You will find that almost each endpoint has an example that you can `Try` and will help you get an example in shell using cURL. For public queries, you do not need to register yourself - you can simply use them as per the examples provided on individual endpoints. But in addition, the [PostgREST API](https://postgrest.org/en/stable/api.html) used underneath provides a handful of features that can be quite handy for you to improve your queries to directly grab very specific information pertinent to your calls, reducing data you download and process. + + ## Vertical Filtering + + Instead of returning entire row, you can elect which rows you would like to fetch from the endpoint by using the `select` parameter with corresponding columns separated by commas. See example below (first is complete information for tip, while second command gives us 3 columns we are interested in):

+ + ``` bash + curl "https://api.koios.rest/api/v1/tip" + + # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch_no":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] + + curl "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_height" + + # [{"epoch_no":317,"epoch_slot":120071,"block_height":6806994}] + ``` + + ## Horizontal Filtering + + You can filter the returned output based on specific conditions using operators against a column within returned result. Consider an example where you would want to query blocks minted in first 3 minutes of epoch 250 (i.e. epoch_slot was less than 180). To do so your query would look like below:

+ ``` bash + curl "https://api.koios.rest/api/v1/blocks?epoch_no=eq.250&epoch_slot=lt.180" + + # [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch_no":250,"abs_slot":22636942,"epoch_slot":142,"block_height":5385757,"block_time":1614203233,"tx_count":65,"vrf_key":"vrf_vk14y9pjprzlsjvjt66mv5u7w7292sxp3kn4ewhss45ayjga5vurgaqhqknuu","pool":null,"op_cert_counter":2}, + # {"hash":"9d33b02badaedc0dedd0d59f3e0411e5fb4ac94217fb5ee86719e8463c570e16","epoch_no":250,"abs_slot":22636800,"epoch_slot":0,"block_height":5385756,"block_time":1614203091,"tx_count":10,"vrf_key":"vrf_vk1dkfsejw3h2k7tnguwrauqfwnxa7wj3nkp3yw2yw3400c4nlkluwqzwvka6","pool":null,"op_cert_counter":2}] + ``` + + Here, we made use of `eq.` operator to denote a filter of "value equal to" against `epoch_no` column. Similarly, we added a filter using `lt.` operator to denote a filter of "values lower than" against `epoch_slot` column. You can find a complete list of operators supported in PostgREST documentation (commonly used ones extracted below): + + |Abbreviation|In PostgreSQL|Meaning | + |------------|-------------|-------------------------------------------| + |eq |`=` |equals | + |gt |`>` |greater than | + |gte |`>=` |greater than or equal | + |lt |`<` |less than | + |lte |`<=` |less than or equal | + |neq |`<>` or `!=` |not equal | + |like |`LIKE` |LIKE operator (use * in place of %) | + |in |`IN` |one of a list of values, e.g. `?a=in.("hi,there","yes,you")`| + |is |`IS` |checking for exact equality (null,true,false,unknown)| + |cs |`@>` |contains e.g. `?tags=cs.{example, new}` | + |cd |`<@` |contained in e.g. `?values=cd.{1,2,3}` | + |not |`NOT` |negates another operator | + |or |`OR` |logical `OR` operator | + |and |`AND` |logical `AND` operator | + + ## Pagination (offset/limit) + + When you query any endpoint in PostgREST, the number of observations returned will be limited to a maximum of 1000 rows (set via `max-rows` config option in the `grest.conf` file. This - however - is a result of a paginated call, wherein the [ up to ] 1000 records you see without any parameters is the first page. If you want to see the next 1000 results, you can always append `offset=1000` to view the next set of results. But what if 1000 is too high for your use-case and you want smaller page? Well, you can specify a smaller limit using parameter `limit`, which will see shortly in an example below. The obvious question at this point that would cross your mind is - how do I know if I need to offset and what range I am querying? This is where headers come in to your aid. + + The default headers returned by PostgREST will include a `Content-Range` field giving a range of observations returned. For large tables, this range could include a wildcard `*` as it is expensive to query exact count of observations from endpoint. But if you would like to get an estimate count without overloading servers, PostgREST can utilise Postgres's own maintenance thread results (which maintain stats for each table) to provide you a count, by specifying a header `"Preferred: count=estimated"`. + + Sounds confusing? Let's see this in practice, to hopefully make it easier. + Consider a simple case where I want query `blocks` endpoint for `block_height` column and focus on `content-range` header to monitor the rows we discussed above.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -I | grep -i content-range + + # content-range: 0-999/* + + ``` + + As we can see above, the number of observations returned was 1000 (range being 0-999), but the total size was not queried to avoid wait times. Now, let's modify this default behaviour to query rows beyond the first 999, but this time - also add another clause to limit results by 500. We can do this using `offset=1000` and `limit=500` as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range + + # content-range: 1000-1499/* + + ``` + + The above methods for pagination are very useful to keep some of the queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. + However, note that due to the complex nature of some queries that require pre-processing before being subjected to paginations, these may not always be helpful to avoid server timeouts. + + ## Ordering + + You can set a sorting order for returned queries against specific column(s). + Consider example where you want to check `epoch_no` and `epoch_slot` for the first 5 blocks created by a particular pool, i.e. you can set order to ascending based on block_height column and add horizontal filter for that pool ID as below:

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" + + # [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch_no":236,"abs_slot":16594295,"epoch_slot":5495,"block_height":5086774,"block_time":1608160586,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"d93d1db5275329ab695d30c06a35124038d8d9af64fc2b0aa082b8aa43da4164","epoch_no":236,"abs_slot":16597729,"epoch_slot":8929,"block_height":5086944,"block_time":1608164020,"tx_count":7,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"dc9496eae64294b46f07eb20499ae6dae4d81fdc67c63c354397db91bda1ee55","epoch_no":236,"abs_slot":16598058,"epoch_slot":9258,"block_height":5086962,"block_time":1608164349,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"6ebc7b734c513bc19290d96ca573a09cac9503c5a349dd9892b9ab43f917f9bd","epoch_no":236,"abs_slot":16601491,"epoch_slot":12691,"block_height":5087097,"block_time":1608167782,"tx_count":0,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}, + # {"hash":"2eac97548829fc312858bc56a40f7ce3bf9b0ca27ee8530283ccebb3963de1c0","epoch_no":236,"abs_slot":16602308,"epoch_slot":13508,"block_height":5087136,"block_time":1608168599,"tx_count":1,"vrf_key":"vrf_vk18x0e7dx8j37gdxftnn8ru6jcxs7n6acdazc4ykeda2ygjwg9a7ls7ns699","pool":"pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc","op_cert_counter":1}] + ``` + + ## Response Formats + + You can get the results from the PostgREST endpoints in CSV or JSON formats. The default response format will always be JSON, but if you'd like to switch, you can do so by specifying header `'Accept: text/csv'` or `'Accept: application/json'`. + Below is an example of JSON/CSV output making use of above to print first in JSON (default), and then override response format to CSV.

+ + ``` bash + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" + + # [{"epoch_no":318,"epoch_slot":27867,"block_time":1643606958}, + # {"epoch_no":318,"epoch_slot":27841,"block_time":1643606932}, + # {"epoch_no":318,"epoch_slot":27839,"block_time":1643606930}] + + curl -s "https://api.koios.rest/api/v1/blocks?select=epoch_no,epoch_slot,block_time&limit=3" -H "Accept: text/csv" + + # epoch_no,epoch_slot,block_time + # 318,28491,1643607582 + # 318,28479,1643607570 + # 318,28406,1643607497 + + ``` + + ## Limits + + While use of Koios is completely free and there are no registration requirements to the usage, the monitoring layer will only restrict spam requests that can potentially cause high amount of load to backends. The emphasis is on using list of objects first, and then [bulk where available] query specific objects to drill down where possible - which forms higher performance results to consumer as well as instance provider. Some basic protection against patterns that could cause unexpected resource spikes are protected as per below: + + - Burst Limit: A single IP can query an endpoint up to 100 times within 10 seconds (that's about 8.64 million requests within a day). The sleep time if a limit is crossed is minimal (60 seconds) for that IP - during which, the monitoring layer will return HTTP Status `429 - Too many requests`. + - Pagination/Limits: Any query results fetched will be paginated by 1000 records (you can reduce limit and or control pagination offsets on URL itself, see API > Pagination section for more details). + - Query timeout: If a query from server takes more than 30 seconds, it will return a HTTP Status of `504 - Gateway timeout`. This is because we would want to ensure you're using the queries optimally, and more often than not - it would indicate that particular endpoint is not optimised (or the network connectivity is not optimal between servers). + - Payload size limit: Koios supports sending bulk objects to reduce networking costs as well as number of calls users spent. However, this can also become an easy attack surface. Thus, we've had to add a strict limit for request body size to be limited to 1kb for public and 5kb for registered tiers. + + Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. + + # Community projects + + A big thank you to the following projects who are already starting to use Koios from early days. A list of tools, libraries and projects utilising Koios (atleast those who'd like to be named) can be found [here](https://www.koios.rest/community.html) + + x-logo: + url: "https://api.koios.rest/images/koios.png" +servers: + - url: https://api.koios.rest/api/v1 + description: Mainnet + - url: https://guild.koios.rest/api/v1 + description: Guildnet + - url: https://preview.koios.rest/api/v1 + description: Preview Network + - url: https://preprod.koios.rest/api/v1 + description: Preprod Network +paths: + + /tip: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tip" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Query Chain Tip + description: Get the tip info about the latest block seen by chain + operationId: tip + /genesis: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/genesis" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get Genesis info + description: Get the Genesis parameters used to start specific era on chain + operationId: genesis + /totals: #RPC + get: + tags: + - Network + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/totals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Get historical tokenomic stats + description: >- + Get the circulating utxo, treasury, rewards, supply and reserves in + lovelace for specified epoch, all epochs if empty + operationId: totals + /param_updates: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/param_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Param Update Proposals + description: Get all parameter update proposals submitted to the chain starting Shelley era + operationId: param_updates + /cli_protocol_params: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/cli_protocol_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: CLI Protocol Parameters + description: >- + Get Current Protocol Parameters as published by cardano-cli. Note that + the output schema of this command is unfortunately fluid on cardano-node + and may vary between CLI versions/era. Accordingly, the returned output for + this endpoint is left as raw JSON (single row) and any filtering to output should + be done on client-side + operationId: cli_protocol_params + /reserve_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Reserve Withdrawals + description: List of all withdrawals from reserves against stake accounts + operationId: reserve_withdrawals + /treasury_withdrawals: #RPC + get: + tags: + - Network + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/reserve_withdrawals" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Treasury Withdrawals + description: List of all withdrawals from treasury against stake accounts + operationId: treasury_withdrawals + + /epoch_info: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + - $ref: "#/components/parameters/_include_next_epoch" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch Information + description: Get the epoch information, all epochs if no epoch specified + operationId: epoch_info + /epoch_params: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_params" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Protocol Parameters + description: >- + Get the protocol parameters for specific epoch, returns information + about all epochs if no epoch specified + operationId: epoch_params + /epoch_block_protocols: #RPC + get: + tags: + - Epoch + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/epoch_block_protocols" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Epoch's Block Protocols + description: >- + Get the information about block protocol distribution in epoch + operationId: epoch_block_protocols + + /blocks: #RPC + get: + tags: + - Block + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block List + description: Get summarised details about all blocks (paginated - latest first) + operationId: blocks + /block_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: "#/components/schemas/block_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Information + description: Get detailed information about a specific block + operationId: block_info + /block_txs: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_hashes" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions + description: Get a list of all transactions included in provided blocks + operationId: block_txs + /block_tx_info: #RPC + post: + tags: + - Block + requestBody: + $ref: "#/components/requestBodies/block_tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/block_tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Block Transactions (Detailed Info) + description: Get detailed information about transaction(s) for requested blocks + operationId: block_tx_info + + /utxo_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/utxo_refs_with_extended" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxO Info + description: Get UTxO set for requested UTxO references + operationId: utxo_info + /tx_cbor: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_cbor" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Raw Transaction (CBOR) + description: Get raw transaction(s) in CBOR format + operationId: tx_cbor + /tx_info: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_info" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Information + description: Get detailed information about transaction(s) + operationId: tx_info + /tx_metadata: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata + description: Get metadata information (if any) for given transaction(s) + operationId: tx_metadata + /tx_metalabels: #RPC + get: + tags: + - Transactions + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_metalabels" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Metadata Labels + description: Get a list of all transaction metalabels + operationId: tx_metalabels + /submittx: #submit-api + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/txbin" + x-code-samples: + - lang: "Shell" + source: | + # Assuming ${data} is a raw binary serialized transaction on the file-system. + # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting. + curl -X POST \ + --header "Content-Type: application/cbor" \ + --data-binary @${data} https://api.koios.rest/api/v1/submittx + responses: + "202": + description: OK + content: + application/json: + schema: + description: The transaction id. + type: string + format: hex + minLength: 64 + maxLength: 64 + example: 92bcd06b25dfbd89b578d536b4d3b7dd269b7c2aa206ed518012cffe0444d67f + "400": + description: An error occured while submitting transaction. + summary: Submit Transaction + description: Submit an already serialized transaction to the network. + operationId: submittx + /tx_status: #RPC + post: + tags: + - Transactions + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_status" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction Status + description: Get the number of block confirmations for a given transaction hash list + operationId: tx_status + /tx_utxos: #RPC + post: + tags: + - Transactions + deprecated: true + requestBody: + $ref: "#/components/requestBodies/tx_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/tx_utxos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transaction UTxOs + description: Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead]. + operationId: tx_utxos + + /address_info: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Information + description: Get address info - balance, associated stake address (if any) and UTxO set for given addresses + operationId: address_info + /address_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address UTXOs + description: Get UTxO set for given addresses + operationId: address_utxos + /credential_utxos: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_utxos" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs from payment credentials + description: Get UTxO details for requested payment credentials + operationId: credential_utxos + /address_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/address_txs" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Transactions + description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive) + operationId: address_txs + /credential_txs: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/credential_txs" + responses: + "200": + description: Array of transaction hashes for given credential(s) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Transactions from payment credentials + description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive) + operationId: credential_txs + /address_assets: #RPC + post: + tags: + - Address + requestBody: + $ref: "#/components/requestBodies/payment_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Address Assets + description: Get the list of all the assets (policy, name and quantity) for given addresses + operationId: address_assets + + /account_list: #RPC + get: + tags: + - Stake Account + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account List + description: Get a list of all stake addresses that have atleast 1 transaction + operationId: account_list + /account_info: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information + description: Get the account information for given stake addresses + operationId: account_info + /account_info_cached: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Information (Cached) + description: Get the cached account information for given stake addresses (effective for performance query against registered accounts) + operationId: account_info_cached + /account_utxos: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: UTxOs for stake addresses (accounts) + description: Get a list of all UTxOs for given stake addresses (account)s + operationId: account_utxos + /account_txs: #RPC + get: + tags: + - Stake Account + parameters: + - $ref: "#/components/parameters/_stake_address" + - $ref: "#/components/parameters/_after_block_height" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Txs + description: Get a list of all Txs for a given stake address (account) + operationId: account_txs + /account_rewards: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_rewards" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Rewards + description: >- + Get the full rewards history (including MIR) for given stake addresses + operationId: account_rewards + /account_updates: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Updates + description: >- + Get the account updates (registration, deregistration, delegation and + withdrawals) for given stake addresses + operationId: account_updates + /account_addresses: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_first_only_and_empty" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Addresses + description: Get all addresses associated with given staking accounts + operationId: account_addresses + /account_assets: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_assets" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account Assets + description: Get the native asset balance for a given stake address + operationId: account_assets + /account_history: #RPC + post: + tags: + - Stake Account + requestBody: + $ref: "#/components/requestBodies/stake_addresses_with_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/account_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Account History + description: Get the staking history of given stake addresses (accounts) + operationId: account_history + + /asset_list: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset List + description: Get the list of all native assets (paginated) + operationId: asset_list + /policy_asset_list: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of brief information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset List + description: Get the list of asset under the given policy (including balances) + operationId: policy_asset_list + /asset_token_registry: #RPC + get: + tags: + - Asset + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_token_registry" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Token Registry + description: Get a list of assets registered via token registry on github + operationId: asset_token_registry + /asset_info: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list" + responses: + "200": + description: Array of detailed asset information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Information (Bulk) + description: Get the information of a list of assets including first minting & token registry metadata + operationId: asset_info + /asset_utxos: #RPC + post: + tags: + - Asset + requestBody: + $ref: "#/components/requestBodies/asset_list_with_extended" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset UTXOs + description: Get the UTXO information of a list of assets including + operationId: asset_utxos + /asset_history: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset mint/burn history + content: + application/json: + schema: + $ref: "#/components/schemas/asset_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset History + description: Get the mint/burn history of an asset + operationId: asset_history + /asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Success! + content: + application/json: + schema: + $ref: "#/components/schemas/asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Addresses + description: Get the list of all addresses holding a given asset

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: asset_addresses + /asset_nft_address: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy_nft" + - $ref: "#/components/parameters/_asset_name_nft" + responses: + "200": + description: Payment addresses currently holding the given NFT + content: + application/json: + schema: + $ref: "#/components/schemas/asset_nft_address" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: NFT Address + description: Get the address where specified NFT currently reside on. + operationId: asset_nft_address + /policy_asset_addresses: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of asset names and payment addresses for the given policy (including balances) + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_addresses" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Address List + description: Get the list of addresses with quantity for each asset on the given policy

+ `Note - Due to cardano's UTxO design and usage from projects, asset to addresses map can be infinite. Thus, for a small subset of active projects + with millions of transactions, these might end up with timeouts (HTTP code 504) on free layer. Such large-scale projects are free to subscribe to + query layers to have a dedicated cache table for themselves served via Koios.` + operationId: policy_asset_addresses + /policy_asset_info: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Array of detailed information of assets under the same policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Information + description: Get the information for all assets under the same policy + operationId: policy_asset_info + /policy_asset_mints: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + responses: + "200": + description: Get a list of mint or burn count details for all assets minted under a policy + content: + application/json: + schema: + $ref: "#/components/schemas/policy_asset_mints" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Policy Asset Mints + description: Get a list of mint or burn count details for all assets minted under a policy + operationId: policy_asset_mints + /asset_summary: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + responses: + "200": + description: Array of asset summary information + content: + application/json: + schema: + $ref: "#/components/schemas/asset_summary" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Summary + description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance) + operationId: asset_summary + /asset_txs: #RPC + get: + tags: + - Asset + parameters: + - $ref: "#/components/parameters/_asset_policy" + - $ref: "#/components/parameters/_asset_name" + - $ref: "#/components/parameters/_after_block_height" + - $ref: "#/components/parameters/_history" + responses: + "200": + description: An array of Tx hashes that included the given asset (latest first) + content: + application/json: + schema: + $ref: "#/components/schemas/address_txs" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Asset Transactions + description: Get the list of current or all asset transaction hashes (newest first) + operationId: asset_txs + + /drep_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps List + description: List of all active delegated representatives (DReps) + operationId: drep_list + /drep_info: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Info + description: Get detailed information about requested delegated representatives (DReps) + operationId: drep_info + /drep_metadata: #RPC + post: + tags: + - Governance + requestBody: + $ref: "#/components/requestBodies/drep_id_bulk" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Metadata + description: List metadata for requested delegated representatives (DReps) + operationId: drep_metadata + /drep_updates: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Updates + description: List of updates for requested (or all) delegated representatives (DReps) + operationId: drep_updates + /drep_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_drep_id" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/drep_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: DReps Votes + description: List of all votes casted by requested delegated representative (DRep) + operationId: drep_votes + /committee_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_committee_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Committee Votes + description: List of all votes casted by given committee member or collective + operationId: committee_votes + /proposal_list: #RPC + get: + tags: + - Governance + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/proposal_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposals List + description: List of all governance proposals + operationId: proposal_list + /proposal_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_tx_hash" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/committee_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Proposal Votes + description: List of all votes cast on specified governance action + operationId: proposal_votes + + /pool_list: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool List + description: List of brief info for all pools + operationId: pool_list + /pool_info: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Information + description: Current pool statuses and details for a specified list of pool ids + operationId: pool_info + /pool_stake_snapshot: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_snapshot" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake Snapshot + description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation + operationId: pool_stake_snapshot + /pool_delegators: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators List + description: Return information about live delegators for a given pool. + operationId: pool_delegators + /pool_delegators_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_delegators_history" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Delegators History + description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified). + operationId: pool_delegators_history + /pool_blocks: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_blocks" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Blocks + description: >- + Return information about blocks minted by a given pool for all epochs + (or _epoch_no if provided) + operationId: pool_blocks + /pool_history: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32" + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_history_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Stake, Block and Reward History + description: >- + Return information about pool stake, block and reward history in a given epoch _epoch_no + (or all epochs that pool existed for, in descending order if no _epoch_no was provided) + operationId: pool_history + /pool_updates: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_bech32_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_updates" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Updates (History) + description: Return all pool updates for all pools or only updates for specific pool if specified + operationId: pool_updates + /pool_registrations: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_pool_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Registrations + description: Return all pool registrations initiated in the requested epoch + operationId: pool_registrations + /pool_retirements: #RPC + get: + tags: + - Pool + parameters: + - $ref: "#/components/parameters/_epoch_no" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_registrations" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Retirements + description: Return all pool retirements initiated in the requested epoch + operationId: pool_retirements + /pool_relays: #RPC + get: + tags: + - Pool + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_relays" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Relays + description: A list of registered relays for all pools + operationId: pool_relays + /pool_votes: #RPC + get: + tags: + - Governance + parameters: + - $ref: "#/components/parameters/_pool_bech32" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_votes" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Votes + description: List of all votes casted by a pool + operationId: pool_votes + /pool_metadata: #RPC + post: + tags: + - Pool + requestBody: + $ref: "#/components/requestBodies/pool_ids_optional" + responses: + "200": + description: Success!! + content: + application/json: + schema: + $ref: "#/components/schemas/pool_metadata" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Pool Metadata + description: Metadata (on & off-chain) for all pools + operationId: pool_metadata + + /script_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/script_hashes" + responses: + "200": + description: Array of information for scripts requested + content: + application/json: + schema: + $ref: "#/components/schemas/script_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Information + description: List of script information for given script hashes + operationId: script_info + /native_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of native script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Native Script List + description: List of all existing native script hashes along with their creation transaction hashes + operationId: native_script_list + /plutus_script_list: #RPC + get: + tags: + - Script + responses: + "200": + description: List of Plutus script and creation tx hash pairs + content: + application/json: + schema: + $ref: "#/components/schemas/script_list" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Plutus Script List + description: List of all existing Plutus script hashes along with their creation transaction hashes + operationId: plutus_script_list + /script_redeemers: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + responses: + "200": + description: Array of all redeemers for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/script_redeemers" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script Redeemers + description: List of all redeemers for a given script hash + operationId: script_redeemers + /script_utxos: #RPC + get: + tags: + - Script + parameters: + - $ref: "#/components/parameters/_script_hash" + - $ref: "#/components/parameters/_extended" + responses: + "200": + description: List of UTXOs for a given script hash + content: + application/json: + schema: + $ref: "#/components/schemas/utxo_infos" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Script UTXOs + description: List of all UTXOs for a given script hash + operationId: script_utxos + /datum_info: #RPC + post: + tags: + - Script + requestBody: + $ref: "#/components/requestBodies/datum_hashes" + responses: + "200": + description: Array of datum information for given datum hashes + content: + application/json: + schema: + $ref: "#/components/schemas/datum_info" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "404": + $ref: "#/components/responses/NotFound" + summary: Datum Information + description: List of datum information for given datum hashes + operationId: datum_info + + /ogmios: #ogmios-api + post: + tags: + - Ogmios + requestBody: + $ref: "#/components/requestBodies/ogmios" + responses: + "200": + description: Current tip of the chain, identified by a slot and a block header hash. + content: + application/json: + schema: + $ref: "#/components/schemas/ogmiostip" + "400": + $ref: "#/components/responses/BadRequest" + summary: Query Example + description: | + Query the current tip of the Network. + +
+
+ We do support transparent forwarding for various methods from Ogmios, you can read about those here. +
+ operationId: ogmios + +components: + parameters: + _after_block_height: + deprecated: false + name: _after_block_height + description: Block height for specifying time delta + schema: + type: number + example: 50000 + in: query + required: false + allowEmptyValue: true + _epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "12" + in: query + required: false + allowEmptyValue: true + _stake_address: + deprecated: false + name: _stake_address + description: Cardano staking address (reward account) in bech32 format + schema: + type: string + example: "stake_test1uzs5rxys8qy5jnr9g0mkj860ms5n92nrykmrgyumpf2ytmsejj4m6" + in: query + required: true + allowEmptyValue: false + _tx_hash: + deprecated: false + name: _tx_hash + description: Transaction Hash in hexadecimal format (hex) + example: "f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c" + schema: + type: string + in: query + required: true + allowEmptyValue: false + _asset_policy: + deprecated: false + name: _asset_policy + description: Asset Policy ID in hexadecimal format (hex) + schema: + type: string + example: "065270479316f1d92e00f7f9f095ebeaac9d009c878dc35ce36d3404" + in: query + required: true + allowEmptyValue: false + _asset_name: + deprecated: false + name: _asset_name + description: Asset Name in hexadecimal format (hex), empty asset name returns royalties + schema: + type: string + example: "433374" + in: query + required: false + allowEmptyValue: true + _asset_policy_nft: + deprecated: false + name: _asset_policy + description: NFT Policy ID in hexadecimal format (hex) + schema: + type: string + example: "005b8ca355aec6125531ebea89bf9ef8df90121ea5717f0c55027e35" + in: query + required: true + allowEmptyValue: false + _asset_name_nft: + deprecated: false + name: _asset_name + description: NFT Name in hexadecimal format (hex) + schema: + type: string + example: "4d43" + in: query + required: false + allowEmptyValue: true + _drep_id: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck" + in: query + required: true + allowEmptyValue: false + _drep_id_optional: + deprecated: false + name: _drep_id + description: DRep ID in bech32 format + schema: + type: string + example: "drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck" + in: query + required: false + allowEmptyValue: true + _committee_hash: + deprecated: false + name: _committee_hash + description: Committee hash in hexadecimal format (hex) + schema: + type: string + example: "7ceede7d6a89e006408e6b7c6acb3dd094b3f6817e43b4a36d01535b" + in: query + required: false + allowEmptyValue: true + _extended: + deprecated: false + name: _extended + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _history: + deprecated: false + name: _history + description: Include all historical transactions, setting to false includes only the non-empty ones + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: false + _include_next_epoch: + deprecated: false + name: _include_next_epoch + description: Include information about nearing but not yet started epoch, to get access to active stake snapshot information if available + schema: + type: boolean + example: false + in: query + required: false + allowEmptyValue: true + _pool_bech32: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format + schema: + type: string + example: "pool1leml52hm4fcp3hhe4zye08qz27llhj7d339p3gs0tl85cstx59q" + in: query + required: true + allowEmptyValue: false + _pool_bech32_optional: + deprecated: false + name: _pool_bech32 + description: Pool ID in bech32 format (optional) + schema: + type: string + example: "pool1leml52hm4fcp3hhe4zye08qz27llhj7d339p3gs0tl85cstx59q" + in: query + required: false + allowEmptyValue: true + _pool_epoch_no: + deprecated: false + name: _epoch_no + description: Epoch Number to fetch details for + schema: + type: string + example: "12" + in: query + required: false + allowEmptyValue: true + _script_hash: + deprecated: false + name: _script_hash + description: Script hash in hexadecimal format (hex) + schema: + type: string + example: "f758cf422ca0cbed7d9d6fad1eb5a3c70537d62e661ad450dd2a3810" + in: query + required: true + allowEmptyValue: false + requestBodies: + block_hashes: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + example: + _block_hashes: + - a4504e2495ed03b48be36676f430c54dca0769d29f72ebf18d493abf42d2167b + - 8e7a6206d2b21ae4f26e7e09353fadae17f838a63d095c2be51acbd16e9b7716 + - 1baaf7812ed48e663adb9eeaa68fe25034e5e30b4f8e56cc8600cac5e9d42ce7 + description: Array of block hashes + block_tx_info: + content: + application/json: + schema: + required: + - _block_hashes + type: object + properties: + _block_hashes: + format: text + type: array + items: + $ref: "#/components/schemas/blocks/items/properties/hash" + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _block_hashes: + - a4504e2495ed03b48be36676f430c54dca0769d29f72ebf18d493abf42d2167b + - 8e7a6206d2b21ae4f26e7e09353fadae17f838a63d095c2be51acbd16e9b7716 + - 1baaf7812ed48e663adb9eeaa68fe25034e5e30b4f8e56cc8600cac5e9d42ce7 + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of block hashes + payment_addresses: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + example: + _addresses: + - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc + - addr_test1vqneq3v0dqh3x3muv6ee3lt8e5729xymnxuavx6tndcjc2cv24ef9 + description: Array of Cardano payment address(es) + payment_addresses_with_extended: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _addresses: + - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc + - addr_test1vqneq3v0dqh3x3muv6ee3lt8e5729xymnxuavx6tndcjc2cv24ef9 + _extended: true + description: Array of Cardano payment address(es) with extended flag to toggle additional fields + address_txs: + content: + application/json: + schema: + required: + - _addresses + type: object + properties: + _addresses: + format: text + type: array + items: + type: string + description: Array of Cardano payment address(es) in bech32 format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _addresses: + - addr_test1vpfwv0ezc5g8a4mkku8hhy3y3vp92t7s3ul8g778g5yegsgalc6gc + - addr_test1vqneq3v0dqh3x3muv6ee3lt8e5729xymnxuavx6tndcjc2cv24ef9 + _after_block_height: 40356 + description: Array of Cardano payment address(es) + stake_addresses_with_epoch_no: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _epoch_no: + format: integer + type: number + description: Only fetch information for a specific epoch + example: + _stake_addresses: + - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p + - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl + _epoch_no: 11 + description: Array of Cardano stake address(es) in bech32 format with optional epoch no to filter by + stake_addresses_with_first_only_and_empty: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _first_only: + format: boolean + type: boolean + description: Only return the first result + _empty: + format: boolean + type: boolean + description: Include zero quantity entries + example: + _stake_addresses: + - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p + - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl + _first_only: false + _empty: false + description: Array of Cardano stake credential(s) in bech32 format alongwith flag to return first only or used UTxOs + stake_addresses_with_extended: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _stake_addresses: + - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p + - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl + _extended: true + description: Array of Cardano stake credential(s) in bech32 format alongwith extended flag to return additional columns + stake_addresses: + content: + application/json: + schema: + required: + - _stake_addresses + type: object + properties: + _stake_addresses: + format: text + type: array + items: + type: string + description: Array of Cardano stake address(es) in bech32 format + example: + _stake_addresses: + - stake_test1urqntq4wexjylnrdnp97qq79qkxxvrsa9lcnwr7ckjd6w0cr04y4p + - stake_test1up6wqzrw2h9vvjy5zfkjn0dwtymy5r29zyhf8fyhm6fat9c2am5hl + description: Array of Cardano stake credential(s) in bech32 format + credential_txs: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _after_block_height: + format: integer + type: number + description: Only fetch information after specific block height + example: + _payment_credentials: + - 33c378cee41b2e15ac848f7f6f1d2f78155ab12d93b713de898d855f + - 52e63f22c5107ed776b70f7b92248b02552fd08f3e747bc745099441 + _after_block_height: 40356 + description: Array of Cardano payment credential(s) in hex format alongwith filtering based on blockheight + credential_utxos: + content: + application/json: + schema: + required: + - _payment_credentials + type: object + properties: + _payment_credentials: + format: text + type: array + items: + type: string + description: Array of Cardano payment credential(s) in hex format + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _payment_credentials: + - 33c378cee41b2e15ac848f7f6f1d2f78155ab12d93b713de898d855f + - 52e63f22c5107ed776b70f7b92248b02552fd08f3e747bc745099441 + _extended: true + description: Array of Cardano payment credential(s) in hex format + tx_ids: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + example: + _tx_hashes: + - f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c + - 206f6da5b0b0de45605a95f5ce7e172be9674550f7dde3838c45cbf24bab8b00 + description: Array of Cardano Transaction hashes + tx_info: + content: + application/json: + schema: + required: + - _tx_hashes + type: object + properties: + _tx_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano Transaction hashes + _inputs: + format: boolean + type: boolean + description: Controls whether to include transaction inputs in the result + _metadata: + format: boolean + type: boolean + description: Controls whether to include transaction metadata in the result + _assets: + format: boolean + type: boolean + description: Controls whether to include assets involved within transaction the result + _withdrawals: + format: boolean + type: boolean + description: Controls whether to include any stake account reward withdrawals in the result + _certs: + format: boolean + type: boolean + description: Controls whether to include transaction certificates in the result + _scripts: + format: boolean + type: boolean + description: Controls whether to include any details regarding collateral/reference/datum/script objects in the result + _bytecode: + format: boolean + type: boolean + description: Controls whether to include bytecode for associated reference/plutus scripts + example: + _tx_hashes: + - f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c + - 206f6da5b0b0de45605a95f5ce7e172be9674550f7dde3838c45cbf24bab8b00 + _inputs: false + _metadata: false + _assets: false + _withdrawals: false + _certs: false + _scripts: false + _bytecode: false + description: Array of Cardano Transaction hashes + txbin: + content: + application/cbor: + schema: + type: string + format: binary + example: f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c + description: Serialised Cardano Transaction + pool_ids: + content: + application/json: + schema: + required: + - _pool_bech32_ids + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool1p90428kec03mjdya3k4gv5d20w7lmed7ca0snknef5j977l3y8l + - pool1wwh3k3ldzujdvgxllfwlnnkxyheafkacqlufnvpr77n5q72f9hw + - pool1p835jxsj8py5n34lrgk6fvpgpxxvh585qm8dzvp7ups37vdet5a + description: Array of Cardano pool IDs (bech32 format) + pool_ids_optional: + content: + application/json: + schema: + type: object + properties: + _pool_bech32_ids: + format: text + type: array + items: + type: string + description: Array of Cardano pool IDs (bech32 format) + example: + _pool_bech32_ids: + - pool1p90428kec03mjdya3k4gv5d20w7lmed7ca0snknef5j977l3y8l + - pool1wwh3k3ldzujdvgxllfwlnnkxyheafkacqlufnvpr77n5q72f9hw + - pool1p835jxsj8py5n34lrgk6fvpgpxxvh585qm8dzvp7ups37vdet5a + description: Array of Cardano pool IDs (bech32 format) [Optional] + script_hashes: + content: + application/json: + schema: + type: object + properties: + _script_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano script hashes + example: + _script_hashes: + - c6d963e8892916ab8753d3c342037cd122123c4dd783a07af21f8dac + - c0c671fba483641a71bb92d3a8b7c52c90bf1c01e2b83116ad7d4536 + description: Array of Cardano script hashes + datum_hashes: + content: + application/json: + schema: + type: object + properties: + _datum_hashes: + format: text + type: array + items: + type: string + description: Array of Cardano datum hashes + example: + _datum_hashes: + - 6181b3dc623cd8812caf027a3507e9b3095388a7cf3db65983e1fddd3a84c88c + - f8ae55ff89e1f5366f23e16bcaf2073252337b96031a02d79e41d653b5f0a978 + description: Array of Cardano datum hashes + asset_list: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + example: + _asset_list: + - ['065270479316f1d92e00f7f9f095ebeaac9d009c878dc35ce36d3404','433374'] + - ['189e2c53985411addb8df0f3e09f70e343da69f06746c408aba672a8','15fc257714a51769e192761d674db2ee2e80137428e522f9b914debb5f785301'] + description: Array of array of policyID and asset names (hex) + asset_list_with_extended: + content: + application/json: + schema: + required: + - _asset_list + type: object + properties: + _asset_list: + format: text + type: array + description: Array of array of policy ID and asset names (hex) + items: + type: array + items: + type: string + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _asset_list: + - ['065270479316f1d92e00f7f9f095ebeaac9d009c878dc35ce36d3404','433374'] + - ['189e2c53985411addb8df0f3e09f70e343da69f06746c408aba672a8','15fc257714a51769e192761d674db2ee2e80137428e522f9b914debb5f785301'] + _extended: true + description: Array of array of policyID and asset names (hex) alongwith extended flag to return additional columns + drep_id_bulk: + content: + application/json: + schema: + required: + - _drep_ids + type: object + properties: + _drep_ids: + format: text + type: array + descriptions: Array of DRep IDs in bech32 format + items: + type: string + example: + _drep_ids: + - drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + - drep1p6m6eg3ljyuthfx49d9dlq4rewnumuupr5hrtay0gaa0zq7qwze + utxo_refs_with_extended: + content: + application/json: + schema: + required: + - _utxo_refs + type: object + properties: + _utxo_refs: + format: text + type: array + items: + type: string + description: Array of Cardano utxo references in the form "hash#index" + _extended: + format: boolean + type: boolean + description: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call + example: + _utxo_refs: + - 206f6da5b0b0de45605a95f5ce7e172be9674550f7dde3838c45cbf24bab8b00#0 + - f1592b29b79ae85d753913dd25644c60925a4a0683979faa33832fead4b4bd9c#0 + _extended: false + description: Array of Cardano UTxO references in the form "hash#index" with extended flag to toggle additional fields + ogmios: + content: + application/json: + schema: + required: + - jsonrpc + - method + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method to be called (see more details [here](#tag--Ogmios)) or browse examples tab + enum: ["queryNetwork/blockHeight","queryNetwork/genesisConfiguration","queryNetwork/startTime","queryNetwork/tip","queryLedgerState/epoch","queryLedgerState/eraStart","queryLedgerState/eraSummaries","queryLedgerState/liveStakeDistribution","queryLedgerState/protocolParameters","queryLedgerState/proposedProtocolParameters","queryLedgerState/stakePools","submitTransaction","evaluateTransaction"] + example: "queryNetwork/tip" + params: + type: object + description: Any parameters relevant to the specific method to be called + nullable: true + examples: + blockHeight: + description: Query the network’s highest block number. + value: { "jsonrpc": "2.0", "method": "queryNetwork/blockHeight" } + genesisConfiguration: + description: Query the genesis configuration of a given era. + value: { "jsonrpc": "2.0", "method": "queryNetwork/genesisConfiguration", "params": { "era": "shelley" } } + startTimeTime: + description: Query the network start time. + value: { "jsonrpc": "2.0", "method": "queryNetwork/startTime" } + tip: + description: Query tip of the Network + value: { "jsonrpc": "2.0", "method": "queryNetwork/tip" } + epoch: + description: Query the current epoch of the ledger. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/epoch" } + eraStart: + description: Query information regarding the beginning of the current ledger era. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraStart" } + eraSummaries: + description: Query era bounds and slot parameters details, required for proper sloting arithmetic. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/eraSummaries" } + liveStakeDistribution: + description: Query distribution of the stake across all known stake pools, relative to the total stake in the network. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/liveStakeDistribution" } + protocolParameters: + description: Query the current protocol parameters. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/protocolParameters" } + proposedProtocolParameters: + description: Query the last update proposal w.r.t. protocol parameters, if any. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/proposedProtocolParameters" } + StakePools: + description: Query the list of all stake pool identifiers currently registered and active. + value: { "jsonrpc": "2.0", "method": "queryLedgerState/stakePools" } + submitTransaction: + description: Submit a signed and serialized transaction to the network. + value: { "jsonrpc": "2.0", "method": "submitTransaction", "params": { "transaction": { "cbor": "" } } } + evaluateTransaction: + description: Evaluate execution units of scripts in a well-formed transaction. + value: { "jsonrpc": "2.0", "method": "evaluateTransaction", "params": { "transaction": { "cbor": "" }, "additionalUtxo": [ { ... } ] } } + description: JSON-RPC 2.0 standard request body + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT + description: JWT Bearer Auth token generated via https://koios.rest Profile page. Using this token value allows consumers to use higher limits than public unauthenticated requests. + schemas: + tip: + description: Current tip of the chain + type: array + items: + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_no: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + genesis: + description: Array of genesis parameters used to start each era on chain + type: array + items: + properties: + networkmagic: + type: string + example: 764824073 + description: Unique network identifier for chain + networkid: + type: string + example: Mainnet + description: Network ID used at various CLI identification to distinguish between Mainnet and other networks + epochlength: + type: string + example: 432000 + description: Number of slots in an epoch + slotlength: + type: string + example: 1 + description: Duration of a single slot (in seconds) + maxlovelacesupply: + type: string + example: 45000000000000000 + description: Maximum smallest units (lovelaces) supply for the blockchain + systemstart: + type: number + description: UNIX timestamp of the first block (genesis) on chain + example: 1506203091 + activeslotcoeff: + type: string + example: 0.05 + description: "Active Slot Co-Efficient (f) - determines the _probability_ of number of slots in epoch that are expected to have blocks (so mainnet, this would be: 432000 * 0.05 = 21600 estimated blocks)" + slotsperkesperiod: + type: string + example: 129600 + description: Number of slots that represent a single KES period (a unit used for validation of KES key evolutions) + maxkesrevolutions: + type: string + example: 62 + description: Number of KES key evolutions that will automatically occur before a KES (hot) key is expired. This parameter is for security of a pool, in case an operator had access to his hot(online) machine compromised + securityparam: + type: string + example: 2160 + description: A unit (k) used to divide epochs to determine stability window (used in security checks like ensuring atleast 1 block was created in 3*k/f period, or to finalize next epoch's nonce at 4*k/f slots before end of epoch) + updatequorum: + type: string + example: 5 + description: Number of BFT members that need to approve (via vote) a Protocol Update Proposal + alonzogenesis: + type: string + example: '{\"lovelacePerUTxOWord\":34482,\"executionPrices\":{\"prSteps\":{\"numerator\":721,\"denominator\":10000000},...' + description: A JSON dump of Alonzo Genesis + totals: + description: Array of supply/reserves/utxo/fees/treasury stats + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + circulation: + type: string + description: Circulating UTxOs for given epoch (in lovelaces) + example: 32081169442642320 + treasury: + type: string + description: Funds in treasury for given epoch (in lovelaces) + example: 637024173474141 + reward: + type: string + description: Rewards accumulated as of given epoch (in lovelaces) + example: 506871250479840 + supply: + type: string + description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces) + example: 33228495612391330 + reserves: + type: string + description: Total Reserves yet to be unlocked on chain + example: 11771504387608670 + param_updates: + description: Array of unique param update proposals submitted on chain + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + data: + type: string + description: JSON encoded data with details about the parameter update + example: {"decentralisation": 0.9} + cli_protocol_params: + description: Get Current Protocol Parameters from node as published by cardano-cli in JSON format + type: object + example: + { + "collateralPercentage": 150, + "maxBlockBodySize": 90112, + "maxBlockHeaderSize": 1100, + "maxCollateralInputs": 3, + "maxTxSize": 16384, + "maxValueSize": 5000, + "minPoolCost": 170000000, + "minUTxOValue": null, + "monetaryExpansion": 3.0e-3, + "poolPledgeInfluence": 0.3, + "poolRetireMaxEpoch": 18, + "protocolVersion": { + "major": 8, + "minor": 0 + }, + "...": "...", + "stakeAddressDeposit": 2000000, + "stakePoolDeposit": 500000000, + "stakePoolTargetNum": 500, + "treasuryCut": 0.2, + "txFeeFixed": 155381, + "txFeePerByte": 44, + "utxoCostPerByte": 4310 + } + reserve_withdrawals: + description: Array of withdrawals from reserves/treasury against stake accounts + type: array + items: + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + earned_epoch: + description: Epoch where amount is earned + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + spendable_epoch: + description: Epoch where the earned amount can be spent + allOf: + - $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + pool_list: + description: Array of pool IDs and tickers + type: array + items: + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + $ref: "#/components/schemas/pool_info/items/properties/active_epoch_no" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + ticker: + type: + - string + - 'null' + description: Pool ticker + example: AHL + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_history_info: + description: Array of pool history information + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch for which the pool history data is shown + example: 312 + active_stake: + type: string + description: Amount of delegated stake to this pool at the time of epoch snapshot (in lovelaces) + example: "31235800000" + active_stake_pct: + type: number + description: Active stake for the pool, expressed as a percentage of total active stake on network + example: 13.512182543475783 + saturation_pct: + type: number + description: Saturation percentage of a pool at the time of snapshot (2 decimals) + example: 45.32 + block_cnt: + type: + - number + - 'null' + description: Number of blocks pool created in that epoch + example: 14 + delegator_cnt: + type: number + description: Number of delegators to the pool for that epoch snapshot + example: 1432 + margin: + type: number + description: Margin (decimal format) + example: 0.125 + fixed_cost: + type: string + description: Pool fixed cost per epoch (in lovelaces) + example: "340000000" + pool_fees: + type: string + description: Total amount of fees earned by pool owners in that epoch (in lovelaces) + example: "123327382" + deleg_rewards: + type: string + description: Total amount of rewards earned by delegators in that epoch (in lovelaces) + example: "123456789123" + member_rewards: + type: string + description: Total amount of rewards earned by members (delegator - owner) in that epoch (in lovelaces) + example: "123456780123" + epoch_ros: + type: number + description: Annualized ROS (return on staking) for delegators for this epoch + example: 3.000340466 + pool_info: + description: Array of pool information + type: array + items: + type: object + properties: + pool_id_bech32: + type: string + description: Pool ID (bech32 format) + example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc + pool_id_hex: + type: string + description: Pool ID (Hex format) + example: a532904ca60e13e88437b58e7c6ff66b8d5e7ec8d3f4b9e4be7820ec + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + vrf_key_hash: + type: + - string + - 'null' + description: Pool VRF key hash + example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3 + margin: + type: + - number + - 'null' + description: Margin (decimal format) + example: 0.1 + fixed_cost: + type: + - string + - 'null' + description: Pool fixed cost per epoch + example: "500000000" + pledge: + type: + - string + - 'null' + description: Pool pledge in lovelace + example: "64000000000000" + deposit: + type: + - string + - 'null' + description: Pool's registration deposit in lovelace + example: "500000000" + reward_addr: + type: + - string + - 'null' + description: Pool reward address + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + owners: + type: + - array + - 'null' + items: + type: string + description: Pool (co)owner address + example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3 + relays: + type: array + items: + type: object + properties: + dns: + type: + - string + - 'null' + description: DNS name of the relay (nullable) + example: relays-new.cardano-mainnet.iohk.io + srv: + type: + - string + - 'null' + description: DNS service name of the relay (nullable) + example: biostakingpool3.hopto.org + ipv4: + type: + - string + - 'null' + description: IPv4 address of the relay (nullable) + example: "54.220.20.40" + ipv6: + type: + - string + - 'null' + description: IPv6 address of the relay (nullable) + example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf + port: + type: + - number + - 'null' + description: Port number of the relay (nullable) + example: 6000 + meta_url: + type: + - string + - 'null' + description: Pool metadata URL + example: https://pools.iohk.io/IOGP.json + meta_hash: + type: + - string + - 'null' + description: Pool metadata hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + meta_json: + type: + - object + - 'null' + properties: + name: + type: string + description: Pool name + example: Input Output Global (IOHK) - Private + ticker: + type: string + description: Pool ticker + example: IOGP + homepage: + type: string + description: Pool homepage URL + example: https://iohk.io + description: + type: string + description: Pool description + example: Our mission is to provide economic identity to the billions of people who lack it. IOHK will not use the IOHK ticker. + pool_status: + type: string + description: Pool status + enum: ["registered", "retiring", "retired"] + example: registered + retiring_epoch: + type: + - number + - 'null' + description: Announced retiring epoch (nullable) + example: 'null' + op_cert: + type: + - string + - 'null' + description: Pool latest operational certificate hash + example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0 + op_cert_counter: + type: + - number + - 'null' + description: Pool latest operational certificate counter value + example: 8 + active_stake: + type: + - string + - 'null' + description: Pool active stake (will be null post epoch transition until dbsync calculation is complete) + example: "64328627680963" + sigma: + type: + - number + - 'null' + description: Pool relative active stake share + example: 0.0034839235 + block_count: + type: + - number + - 'null' + description: Total pool blocks on chain + example: 4509 + live_pledge: + type: + - string + - 'null' + description: Summary of account balance for all pool owner's + example: "64328594406327" + live_stake: + type: + - string + - 'null' + description: Pool live stake + example: "64328627680963" + live_delegators: + type: number + description: Pool live delegator count + example: 5 + live_saturation: + type: + - number + - 'null' + description: Pool live saturation (decimal format) + example: 94.52 + pool_snapshot: + type: array + items: + description: Array of pool stake information for 3 snapshots + type: object + properties: + snapshot: + type: string + description: Type of snapshot ("Mark", "Set" or "Go") + example: "Mark" + epoch_no: + type: number + description: Epoch number for the snapshot entry + example: 324 + nonce: + $ref: "#/components/schemas/epoch_params/items/properties/nonce" + pool_stake: + type: string + description: Pool's Active Stake for the given epoch + example: "100000000000" + active_stake: + type: string + description: Total Active Stake for the given epoch + example: "103703246364020" + pool_delegators: + description: Array of live pool delegators + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + description: Current delegator live stake (in lovelace) + example: 64328591517480 + active_epoch_no: + type: number + description: Epoch number in which the delegation becomes active + example: 324 + latest_delegation_tx_hash: + type: string + description: Latest transaction hash used for delegation by the account + example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948 + pool_registrations: + description: Array of pool registrations/retirements + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + active_epoch_no: + $ref: "#/components/schemas/pool_updates/items/properties/active_epoch_no" + pool_delegators_history: + description: Array of pool delegators (historical) + type: + - array + - 'null' + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + $ref: "#/components/schemas/pool_delegators/items/properties/amount" + epoch_no: + type: number + description: Epoch number for the delegation history + example: 324 + pool_blocks: + description: Array of blocks created by pool + type: array + items: + type: object + properties: + epoch_no: + $ref: "#/components/schemas/epoch_info/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_updates: + description: Array of historical pool updates + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + pool_id_hex: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_hex" + active_epoch_no: + type: + - number + - 'null' + description: Epoch number in which the update becomes active + example: 324 + vrf_key_hash: + $ref: "#/components/schemas/pool_info/items/properties/vrf_key_hash" + margin: + $ref: "#/components/schemas/pool_info/items/properties/margin" + fixed_cost: + $ref: "#/components/schemas/pool_info/items/properties/fixed_cost" + pledge: + $ref: "#/components/schemas/pool_info/items/properties/pledge" + reward_addr: + $ref: "#/components/schemas/pool_info/items/properties/reward_addr" + owners: + $ref: "#/components/schemas/pool_info/items/properties/owners" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + update_type: + type: string + description: Type of update task + enum: ["registration", "deregistration"] + example: registered + retiring_epoch: + $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch" + pool_relays: + description: Array of pool relay information + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + relays: + $ref: "#/components/schemas/pool_info/items/properties/relays" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + pool_metadata: + description: Array of pool metadata + type: array + items: + type: object + properties: + pool_id_bech32: + $ref: "#/components/schemas/pool_info/items/properties/pool_id_bech32" + meta_url: + $ref: "#/components/schemas/pool_info/items/properties/meta_url" + meta_hash: + $ref: "#/components/schemas/pool_info/items/properties/meta_hash" + meta_json: + $ref: "#/components/schemas/pool_info/items/properties/meta_json" + pool_status: + $ref: "#/components/schemas/pool_info/items/properties/pool_status" + epoch_info: + description: Array of detailed summary for each epoch + type: array + items: + type: object + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + out_sum: + type: string + description: Total output value across all transactions in epoch + example: 15432725054364942 + fees: + type: string + description: Total fees incurred by transactions in epoch + example: 74325855210 + tx_count: + type: number + description: Number of transactions submitted in epoch + example: 357919 + blk_count: + type: number + description: Number of blocks created in epoch + example: 17321 + start_time: + type: number + description: UNIX timestamp of the epoch start + example: 1506203091 + end_time: + type: number + description: UNIX timestamp of the epoch end + example: 1506635091 + first_block_time: + type: number + description: UNIX timestamp of the epoch's first block + example: 1506635091 + last_block_time: + type: number + description: UNIX timestamp of the epoch's last block + example: 1506635091 + active_stake: + type: + - string + - 'null' + description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs) + example: 23395112387185880 + total_rewards: + type: + - string + - 'null' + description: Total rewards earned in epoch (null for pre-Shelley epochs) + example: 252902897534230 + avg_blk_reward: + type: + - string + - 'null' + description: Average block reward for epoch (null for pre-Shelley epochs) + example: 660233450 + epoch_params: + description: Epoch parameters (all fields nullable for pre-Shelley/Gougen epochs except first block hash) + type: array + items: + properties: + epoch_no: + type: number + description: Epoch number + example: 294 + min_fee_a: + type: + - number + - 'null' + description: The 'a' parameter to calculate the minimum transaction fee + example: 44 + min_fee_b: + type: + - number + - 'null' + description: The 'b' parameter to calculate the minimum transaction fee + example: 155381 + max_block_size: + type: + - number + - 'null' + description: The maximum block size (in bytes) + example: 65536 + max_tx_size: + type: + - number + - 'null' + description: The maximum transaction size (in bytes) + example: 16384 + max_bh_size: + type: + - number + - 'null' + description: The maximum block header size (in bytes) + example: 1100 + key_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake address + example: 2000000 + pool_deposit: + type: + - string + - 'null' + description: The amount (in lovelace) required for a deposit to register a stake pool + example: 500000000 + max_epoch: + type: + - number + - 'null' + description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for + example: 18 + optimal_pool_count: + type: + - number + - 'null' + description: The optimal number of stake pools + example: 500 + influence: + type: + - number + - 'null' + format: double + description: The pledge influence on pool rewards + example: 0.3 + monetary_expand_rate: + type: + - number + - 'null' + format: double + description: The monetary expansion rate + example: 0.003 + treasury_growth_rate: + type: + - number + - 'null' + format: double + description: The treasury growth rate + example: 0.2 + decentralisation: + type: + - number + - 'null' + format: double + description: The decentralisation parameter (1 fully centralised, 0 fully decentralised) + example: 0.1 + extra_entropy: + type: + - string + - 'null' + description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool + example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa + protocol_major: + type: + - number + - 'null' + description: The protocol major version + example: 5 + protocol_minor: + type: + - number + - 'null' + description: The protocol minor version + example: 0 + min_utxo_value: + type: + - string + - 'null' + description: The minimum value of a UTxO entry + example: 34482 + min_pool_cost: + type: + - string + - 'null' + description: The minimum pool cost + example: 340000000 + nonce: + type: + - string + - 'null' + description: The nonce value for this epoch + example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2 + block_hash: + type: string + description: The hash of the first block where these parameters are valid + example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5 + cost_models: + type: + - object + - 'null' + description: The per language cost model in JSON + example: 'null' + price_mem: + type: + - number + - 'null' + format: double + description: The per word cost of script memory usage + example: 0.0577 + price_step: + type: + - number + - 'null' + format: double + description: The cost of script execution step usage + example: 7.21e-05 + max_tx_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single transaction + example: 10000000 + max_tx_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single transaction + example: 10000000000 + max_block_ex_mem: + type: + - number + - 'null' + description: The maximum number of execution memory allowed to be used in a single block + example: 50000000 + max_block_ex_steps: + type: + - number + - 'null' + description: The maximum number of execution steps allowed to be used in a single block + example: 40000000000 + max_val_size: + type: + - number + - 'null' + description: The maximum Val size + example: 5000 + collateral_percent: + type: + - number + - 'null' + description: The percentage of the tx fee which must be provided as collateral when including non-native scripts + example: 150 + max_collateral_inputs: + type: + - number + - 'null' + description: The maximum number of collateral inputs allowed in a transaction + example: 3 + coins_per_utxo_size: + type: + - string + - 'null' + description: The cost per UTxO size + example: 34482 + pvt_motion_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for motion of no-confidence. + example: 0.6 + pvt_committee_normal: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (normal state). + example: 0.65 + pvt_committee_no_confidence: + type: + - number + - 'null' + description: Pool Voting threshold for new committee/threshold (state of no-confidence). + example: 0.65 + pvt_hard_fork_initiation: + type: + - number + - 'null' + description: Pool Voting threshold for hard-fork initiation. + example: 0.51 + dvt_motion_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for motion of no-confidence. + example: 0.67 + dvt_committee_normal: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (normal state). + example: 0.67 + dvt_committee_no_confidence: + type: + - number + - 'null' + description: DRep Vote threshold for new committee/threshold (state of no-confidence). + example: 0.65 + dvt_update_to_constitution: + type: + - number + - 'null' + description: DRep Vote threshold for update to the Constitution. + example: 0.75 + dvt_hard_fork_initiation: + type: + - number + - 'null' + description: DRep Vote threshold for hard-fork initiation. + example: 0.6 + dvt_p_p_network_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, network group. + example: 0.67 + dvt_p_p_economic_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, economic group. + example: 0.67 + dvt_p_p_technical_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, technical group. + example: 0.67 + dvt_p_p_gov_group: + type: + - number + - 'null' + description: DRep Vote threshold for protocol parameter changes, governance group. + example: 0.75 + dvt_treasury_withdrawal: + type: + - number + - 'null' + description: DRep Vote threshold for treasury withdrawal. + example: 0.67 + committee_min_size: + type: + - number + - 'null' + description: Minimal constitutional committee size. + example: 5 + committee_max_term_length: + type: + - number + - 'null' + description: Constitutional committee term limits. + example: 146 + gov_action_lifetime: + type: + - number + - 'null' + description: Governance action expiration. + example: 14 + gov_action_deposit: + type: + - string + - 'null' + description: Governance action deposit. + example: 100000000000 + drep_deposit: + type: + - string + - 'null' + description: DRep deposit amount. + example: 500000000 + drep_activity: + type: + - number + - 'null' + description: DRep activity period. + example: 20 + pvtpp_security_group: + type: + - number + - 'null' + description: Pool Voting threshold for protocol parameter changes, security group. + example: 0.6 + min_fee_ref_script_cost_per_byte: + type: + - number + - 'null' + description: Minimum Fee for Reference Script cost pre byte + example: 15 + epoch_block_protocols: + description: Array of distinct block protocol versions counts in epoch + type: array + items: + properties: + proto_major: + type: number + description: Protocol major version + example: 6 + proto_minor: + type: number + description: Protocol major version + example: 2 + blocks: + type: number + description: Amount of blocks with specified major and protocol combination + example: 2183 + blocks: + description: Array of block information + type: array + items: + type: object + properties: + hash: + type: string + description: Hash of the block + example: 2fa5178c5be950c7f40d6c74efe9b3dd12c4836dc3f3dd052cd1c2a12edd477f + epoch_no: + type: number + description: Epoch number of the block + example: 117 + abs_slot: + type: number + description: Absolute slot number of the block + example: 49073930 + epoch_slot: + type: number + description: Slot number of the block in epoch + example: 171530 + block_height: + type: + - number + - 'null' + description: Block height + example: 1794506 + block_size: + type: number + description: Block size in bytes + example: 2433 + block_time: + type: number + description: UNIX timestamp of the block + example: 1704757130 + tx_count: + type: number + description: Number of transactions in the block + example: 2 + vrf_key: + type: string + description: VRF key of the block producer + example: "vrf_vk1400ju08429se790upcvurdyqrhl8rhm7spm2jxg0lfnedqeaexfq7jsf2x" + pool: + type: + - string + - 'null' + description: Pool ID in bech32 format (null for pre-Shelley blocks) + example: pool13m26ky08vz205232k20u8ft5nrg8u68klhn0xfsk9m4gsqsc44v + op_cert_counter: + type: number + description: Counter value of the operational certificate used to create this block + example: 5 + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + parent_hash: + type: string + description: Previous Hash of the current block + example: 7eb8d62f9d6a5e7cf2d9635f0b531d2693fef55a717894e3a97baf6183b8d189 + block_info: + description: Array of detailed block information + type: array + items: + type: object + properties: + hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + abs_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_size: + $ref: "#/components/schemas/blocks/items/properties/block_size" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + tx_count: + $ref: "#/components/schemas/blocks/items/properties/tx_count" + vrf_key: + $ref: "#/components/schemas/blocks/items/properties/vrf_key" + op_cert: + type: string + description: Hash of the block producers' operational certificate + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + op_cert_counter: + $ref: "#/components/schemas/blocks/items/properties/op_cert_counter" + pool: + $ref: "#/components/schemas/blocks/items/properties/pool" + proto_major: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_major" + proto_minor: + $ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" + total_output: + type: + - string + - 'null' + description: Total output of the block (in lovelace) + example: 92384672389 + total_fees: + type: + - string + - 'null' + description: Total fees of the block (in lovelace) + example: 2346834 + num_confirmations: + type: number + description: Number of confirmations for the block + example: 664275 + parent_hash: + type: string + description: Hash of the parent of this block + example: "16bfc28a7127d11805fe02df67f8c3909ab7e2e2cd81b6954d90eeff1938614c" + child_hash: + type: string + description: Hash of the child of this block (if present) + example: "a3b525ba0747ce9daa928fa28fbc680f95e6927943a1fbd6fa5394d96c9dc2fa" + block_txs: + description: Array of transactions hashes + type: array + items: + type: object + properties: + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + block_tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + $ref: "#/components/schemas/tx_info/items/properties/tx_timestamp" + tx_block_index: + $ref: "#/components/schemas/tx_info/items/properties/tx_block_index" + tx_size: + $ref: "#/components/schemas/tx_info/items/properties/tx_size" + total_output: + $ref: "#/components/schemas/tx_info/items/properties/total_output" + fee: + $ref: "#/components/schemas/tx_info/items/properties/fee" + treasury_donation: + $ref: "#/components/schemas/tx_info/items/properties/treasury_donation" + deposit: + $ref: "#/components/schemas/tx_info/items/properties/deposit" + invalid_before: + $ref: "#/components/schemas/tx_info/items/properties/invalid_before" + invalid_after: + $ref: "#/components/schemas/tx_info/items/properties/invalid_after" + collateral_inputs: + $ref: "#/components/schemas/tx_info/items/properties/collateral_inputs" + collateral_output: + $ref: "#/components/schemas/tx_info/items/properties/collateral_output" + reference_inputs: + $ref: "#/components/schemas/tx_info/items/properties/reference_inputs" + inputs: + description: An array of UTxO inputs spent in the transaction + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + outputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + withdrawals: + $ref: "#/components/schemas/tx_info/items/properties/withdrawals" + assets_minted: + $ref: "#/components/schemas/tx_info/items/properties/assets_minted" + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + $ref: "#/components/schemas/tx_info/items/properties/certificates" + native_scripts: + $ref: "#/components/schemas/tx_info/items/properties/native_scripts" + plutus_contracts: + $ref: "#/components/schemas/tx_info/items/properties/plutus_contracts" + address_info: + description: Array of information for address(es) + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + balance: + type: string + description: Sum of all UTxO values beloning to address + example: 10723473983 + stake_address: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/account_history/items/properties/stake_address" + script_address: + type: boolean + description: Signifies whether the address is a script address + example: true + utxo_set: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + address_txs: + description: Array of transaction hashes + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + address_assets: + description: Array of address-owned assets + type: array + items: + type: object + properties: + address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + + account_list: + description: Array of account (stake address) IDs + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + stake_address_hex: + type: string + description: Cardano staking address (reward account) in hex format + example: e1c865f10d66a2e375242b5ef9f05abc8840d413421982f62c35ce4fbf + script_hash: + type: string + description: Script hash in case the stake address is locked by a script + example: bf357f5de69e4aad71954bebd64357a4813ea5233df12fce4a9de582 + account_info: + description: Array of stake account information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + status: + type: string + description: Stake address status + enum: ["registered", "not registered"] + example: registered + delegated_drep: + anyOf: + - type: 'null' + - type: string + description: Account's current delegation status to DRep ID in Bech32 format + example: drep1gj49xmfcg6ev89ur2yad9c5p7z0pgfxggyakz9pua06vqh5vnp0 + delegated_pool: + anyOf: + - type: 'null' + - $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + total_balance: + type: string + description: Total balance of the account including UTxO, rewards and MIRs (in lovelace) + example: 207116800428 + utxo: + type: string + description: Total UTxO balance of the account + example: 162764177131 + rewards: + type: string + description: Total rewards earned by the account + example: 56457728047 + withdrawals: + type: string + description: Total rewards withdrawn by the account + example: 12105104750 + rewards_available: + type: string + description: Total rewards available for withdrawal + example: 44352623297 + deposit: + type: string + description: Total deposit available for withdrawal + example: 2000000 + reserves: + type: string + description: Total reserves MIR value of the account + example: "0" + treasury: + type: string + description: Total treasury MIR value of the account + example: "0" + utxo_infos: + description: Array of complete UTxO information + type: array + items: + type: object + properties: + tx_hash: + type: string + description: Hash identifier of the transaction + example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e + tx_index: + type: number + description: Index of UTxO in the transaction + example: 0 + address: + type: string + description: A Cardano payment/base address (bech32 encoded) + example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + payment_cred: + type: + - string + - 'null' + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: + - array + - 'null' + description: An array of assets on the UTxO + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of assets on the UTxO + example: 1 + is_spent: + type: boolean + description: True if the UTXO has been spent + example: true + account_rewards: + description: Array of reward history information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + rewards: + type: array + items: + type: object + properties: + earned_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/earned_epoch" + spendable_epoch: + $ref: "#/components/schemas/reserve_withdrawals/items/properties/spendable_epoch" + amount: + type: string + description: Amount of rewards earned (in lovelace) + type: + type: string + description: The source of the rewards + enum: [member, leader, treasury, reserves] + example: member + pool_id: + $ref: "#/components/schemas/pool_list/items/properties/pool_id_bech32" + account_updates: + description: Array of account updates information + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + updates: + type: array + items: + type: object + properties: + action_type: + type: string + description: Type of certificate submitted + enum: ["registration", "delegation", "withdrawal", "deregistration"] + example: "registration" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + account_addresses: + description: Array of payment addresses + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + addresses: + type: array + items: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + account_assets: + description: Array of assets owned by account + type: array + items: + type: object + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + account_history: + description: Array of active stake values per epoch + type: array + items: + properties: + stake_address: + type: string + description: Cardano staking address (reward account) in bech32 format + example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz + history: + type: array + items: + type: object + properties: + pool_id: + type: string + description: Bech32 representation of pool ID + example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt + epoch_no: + type: number + description: Epoch number + example: 301 + active_stake: + type: string + description: Active stake amount (in lovelaces) + example: 682334162 + tx_info: + description: Array of detailed information about transaction(s) + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + block_hash: + $ref: "#/components/schemas/blocks/items/properties/hash" + block_height: + $ref: "#/components/schemas/blocks/items/properties/block_height" + epoch_no: + $ref: "#/components/schemas/blocks/items/properties/epoch_no" + epoch_slot: + $ref: "#/components/schemas/blocks/items/properties/epoch_slot" + absolute_slot: + $ref: "#/components/schemas/blocks/items/properties/abs_slot" + tx_timestamp: + type: number + description: UNIX timestamp of the transaction + example: 1506635091 + tx_block_index: + type: number + description: Index of transaction within block + example: 6 + tx_size: + type: number + description: Size in bytes of transaction + example: 391 + total_output: + type: string + description: Total sum of all transaction outputs (in lovelaces) + example: 157832856 + fee: + type: string + description: Total Transaction fee (in lovelaces) + example: 172761 + treasury_donation: + type: string + description: Total Donation to on-chain treasury (in lovelaces) + example: 0 + deposit: + type: string + description: Total Deposits included in transaction (for example, if it is registering a pool/key) + example: 0 + invalid_before: + type: + - string + - 'null' + description: Slot before which transaction cannot be validated (if supplied, else null) + invalid_after: + type: + - string + - 'null' + description: Slot after which transaction cannot be validated + example: 42332172 + collateral_inputs: + description: An array of collateral inputs needed for smart contracts in case of contract failure + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + collateral_output: + description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40) + type: array + items: + properties: + payment_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/payment_addr" + stake_addr: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/stake_addr" + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/tx_index" + value: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/value" + datum_hash: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/datum_hash" + inline_datum: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum" + reference_script: + $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/reference_script" + asset_list: + type: array + description: Brief asset description from ledger + reference_inputs: + description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31) + anyOf: + - type: 'null' + - $ref: "#/components/schemas/tx_info/items/properties/outputs" + inputs: + $ref: "#/components/schemas/tx_info/items/properties/outputs" + #description: An array of UTxO inputs spent in the transaction + outputs: + type: array + description: An array of UTxO outputs created by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + datum_hash: + type: + - string + - 'null' + description: Hash of datum (if any) connected to UTxO + example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9 + inline_datum: + type: + - object + - 'null' + description: Allows datums to be attached to UTxO (CIP-32) + properties: + bytes: + type: string + description: Datum bytes (hex) + example: 19029a + value: + type: object + description: Value (json) + example: { "int": 666 } + reference_script: + type: + - object + - 'null' + description: Allow reference scripts to be used to satisfy script requirements during validation, rather than requiring the spending transaction to do so. (CIP-33) + properties: + hash: + type: string + description: Hash of referenced script + example: 67f33146617a5e61936081db3b2117cbf59bd2123748f58ac9678656 + size: + type: number + description: Size in bytes + example: 14 + type: + type: string + description: Type of script + example: plutusV1 + bytes: + type: string + description: Script bytes (hex) + example: 4e4d01000033222220051200120011 + value: + type: + - object + - 'null' + description: Value (json) + example: 'null' + asset_list: + $ref: "#/components/schemas/utxo_infos/items/properties/asset_list" + withdrawals: + type: + - array + - 'null' + description: Array of withdrawals with-in a transaction + items: + type: object + properties: + amount: + type: string + description: Withdrawal amount (in lovelaces) + example: 9845162 + stake_addr: + type: string + description: A Cardano staking address (reward account, bech32 encoded) + example: stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj + assets_minted: + type: + - array + - 'null' + description: Array of minted assets with-in a transaction + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + quantity: + type: string + description: Quantity of minted assets (negative on burn) + example: 1 + metadata: + $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + certificates: + type: + - array + - 'null' + description: Certificates present with-in a transaction (if any) + items: + properties: + index: + type: + - number + - 'null' + description: Certificate index + example: 0 + type: + type: string + description: Type of certificate (could be delegation, stake_registration, stake_deregistraion, pool_update, pool_retire, param_proposal, reserve_MIR, treasury_MIR) + example: delegation + info: + type: + - object + - 'null' + description: A JSON array containing information from the certificate + example: + { + "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj", + "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p", + } + native_scripts: + type: + - array + - 'null' + description: Native scripts present in a transaction (if any) + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + script_json: + type: object + description: JSON representation of the timelock script (null for other script types) + example: + { + "type": "all", + "scripts": + [ + { + "type": "sig", + "keyHash": "a96da581c39549aeda81f539ac3940ac0cb53657e774ca7e68f15ed9", + }, + { + "type": "sig", + "keyHash": "ccfcb3fed004562be1354c837a4a4b9f4b1c2b6705229efeedd12d4d", + }, + { + "type": "sig", + "keyHash": "74fcd61aecebe36aa6b6cd4314027282fa4b41c3ce8af17d9b77d0d1", + }, + ], + } + plutus_contracts: + type: + - array + - 'null' + description: Plutus contracts present in transaction (if any) + items: + properties: + address: + type: + - string + - 'null' + description: Plutus script address + example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3 + spends_input: + type: + - object + - 'null' + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + description: Input utxo this contract spends + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + bytecode: + $ref: "#/components/schemas/script_info/items/properties/bytes" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + valid_contract: + type: boolean + description: True if the contract is valid or there is no contract + example: true + input: + type: object + properties: + redeemer: + type: object + properties: + purpose: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/purpose" + fee: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/fee" + unit: + type: object + properties: + steps: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_steps" + mem: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/unit_mem" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + datum: + type: object + properties: + hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + value: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_value" + tx_cbor: + description: Raw Transaction(s) in CBOR format + item: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + cbor: + type: string + description: CBOR encoded raw transaction. + tx_utxos: + description: Array of inputs and outputs for given transaction(s) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/tx_info/items/properties/tx_hash" + inputs: + type: array + description: An array of UTxO inputs used by the transaction + items: + type: object + properties: + payment_addr: + type: object + properties: + bech32: + type: string + description: A Cardano payment/base address (bech32 encoded) where funds were sent or change to be returned + example: addr1q80rc8zj06yzdwwdyqc03rm4l3zv6n89rxuaak0t099n09yssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqad9mkw + cred: + type: string + description: Payment credential + example: de3c1c527e8826b9cd2030f88f75fc44cd4ce519b9ded9eb794b3794 + stake_addr: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + value: + type: string + description: Total sum of ADA on the UTxO + example: 157832856 + outputs: + description: An array of UTxO outputs created by the transaction + allOf: + - $ref: "#/components/schemas/tx_utxos/items/properties/inputs" + tx_metadata: + description: Array of metadata information present in each of the transactions queried + type: + - array + - 'null' + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + metadata: + type: + - object + - 'null' + description: A JSON array containing details about metadata within transaction + example: + { + "721": + { + "version": 1, + "copyright": "...", + "publisher": ["p...o"], + "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d": + {}, + }, + } + tx_status: + description: Array of transaction confirmation counts + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + num_confirmations: + type: + - number + - 'null' + description: Number of block confirmations + example: 17 + tx_metalabels: + description: Array of known metadata labels + type: array + items: + properties: + key: + type: string + description: A distinct known metalabel + example: "721" + asset_list: + description: Array of policy IDs and asset names + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + asset_token_registry: + description: An array of token registry information (registered via github) for each asset + type: array + items: + type: object + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + ticker: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/ticker" + description: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/description" + url: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/url" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + logo: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/logo" + asset_addresses: + description: An array of payment addresses holding the given token (including balances) + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + type: string + description: Asset balance on the payment address + example: 23 + asset_nft_address: + description: An array of payment addresses holding the given token + type: array + items: + properties: + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + asset_summary: + description: Array of asset summary information + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_transactions: + type: number + description: Total number of transactions including the given asset + example: 89416 + staked_wallets: + type: number + description: Total number of registered wallets holding the given asset + example: 548 + unstaked_addresses: + type: number + description: Total number of payment addresses (not belonging to registered wallets) holding the given asset + example: 245 + addresses: + type: number + description: Total number of unique addresses holding the given asset + example: 812 + asset_info: + description: Array of detailed asset information + type: array + items: + properties: + policy_id: + type: string + description: Asset Policy ID (hex) + example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff + asset_name: + type: + - string + - 'null' + description: Asset Name (hex) + example: 444f4e545350414d + asset_name_ascii: + type: string + description: Asset Name (ASCII) + example: DONTSPAM + fingerprint: + type: string + description: The CIP14 fingerprint of the asset + example: asset1ua6pz3yd5mdka946z8jw2fld3f8d0mmxt75gv9 + minting_tx_hash: + type: string + description: Hash of the latest mint transaction (with metadata if found for asset) + example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712 + total_supply: + type: string + description: Total supply for the asset + example: "35000" + mint_cnt: + type: number + description: Count of total mint transactions + example: 1 + burn_cnt: + type: number + description: Count of total burn transactions + example: 5 + creation_time: + type: number + description: UNIX timestamp of the first asset mint + example: 1506635091 + minting_tx_metadata: + allOf: + - $ref: "#/components/schemas/tx_metadata/items/properties/metadata" + description: Latest minting transaction metadata (aligns with CIP-25) + token_registry_metadata: + type: + - object + - 'null' + description: Asset metadata registered on the Cardano Token Registry + properties: + name: + type: string + example: Rackmob + description: + type: string + example: Metaverse Blockchain Cryptocurrency. + ticker: + type: string + example: MOB + url: + type: string + example: https://www.rackmob.com/ + logo: + type: string + description: A PNG image file as a byte string + example: iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAYAAACI7Fo9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAADnmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLyc + decimals: + type: number + example: 0 + cip68_metadata: + type: + - object + - 'null' + description: CIP 68 metadata if present for asset + example: {"222": {"fields": [{"map": [{"k": {"bytes": "6e616d65"}, "v": {"bytes": "74657374"}}]}], "constructor": 0}} + asset_history: + description: Array of asset mint/burn history + type: array + items: + properties: + policy_id: + $ref: "#/components/schemas/asset_info/items/properties/policy_id" + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_txs: + type: + - array + - 'null' + description: Array of all mint/burn transactions for an asset + items: + type: object + properties: + tx_hash: + type: string + description: Hash of minting/burning transaction + example: e1ecc517f95715bb87681cfde2c594dbc971739f84f8bfda16170b35d63d0ddf + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + quantity: + type: string + description: Quantity minted/burned (negative numbers indicate burn transactions) + example: "-10" + metadata: + type: array + description: Array of Transaction Metadata for given transaction + items: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + policy_asset_addresses: + description: Array of asset names and payment addresses for the given policy (including balances) + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + payment_address: + $ref: "#/components/schemas/utxo_infos/items/properties/address" + stake_address: + $ref: "#/components/schemas/address_info/items/properties/stake_address" + quantity: + $ref: "#/components/schemas/asset_addresses/items/properties/quantity" + policy_asset_info: + description: Array of detailed information of assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + token_registry_metadata: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata" + policy_asset_mints: + description: Array of mint information for assets under requested policies + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + asset_name_ascii: + $ref: "#/components/schemas/asset_info/items/properties/asset_name_ascii" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + minting_tx_hash: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_hash" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + mint_cnt: + $ref: "#/components/schemas/asset_info/items/properties/mint_cnt" + burn_cnt: + $ref: "#/components/schemas/asset_info/items/properties/burn_cnt" + creation_time: + $ref: "#/components/schemas/asset_info/items/properties/creation_time" + minting_tx_metadata: + $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + policy_asset_list: + description: Array of brief information of assets under the same policy + type: array + items: + properties: + asset_name: + $ref: "#/components/schemas/asset_info/items/properties/asset_name" + fingerprint: + $ref: "#/components/schemas/asset_info/items/properties/fingerprint" + total_supply: + $ref: "#/components/schemas/asset_info/items/properties/total_supply" + decimals: + $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata/properties/decimals" + drep_info: + description: Get detailed information about requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + type: string + description: DRep ID in bech32 format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + hex: + type: string + description: DRep ID in hex format + example: f948a9f7a863d8062565809aba3925aa41334e976c11c837fe1a74c0 + has_script: + type: boolean + description: Flag which shows if this DRep credentials are a script hash + example: false + registered: + type: boolean + description: Flag to show if the DRep is currently registered + example: false + deposit: + type: + - string + - 'null' + description: DRep's registration deposit in lovelace + example: 500000000 + active: + type: boolean + description: Flag to show if the DRep is (i.e. not expired) + example: true + expires_epoch_no: + type: + - number + - 'null' + description: After which epoch DRep is considered inactive. + example: 410 + amount: + type: string + description: The total amount of voting power this DRep is delegated. + example: 599496769641 + drep_list: + description: List of all active delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + has_script: + $ref: "#/components/schemas/drep_info/items/properties/has_script" + registered: + $ref: "#/components/schemas/drep_info/items/properties/registered" + drep_metadata: + description: List metadata for requested delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + url: + type: string + description: A URL to a JSON payload of metadata + example: "https://hornan7.github.io/Vote_Context.jsonld" + hash: + type: string + description: A hash of the contents of the metadata URL + example: dc208474e195442d07a5b6d42af19bb2db02229427dfb53ab23122e6b0e2487d + json: + type: object + description: The payload as JSON + example: + {"body": {"title": "...", "...": "...", "references": [{"uri": "...", "@type": "Other", "label": "Hardfork to PV10"}]}, "authors": [{"name": "...", "witness": {"publicKey": "...", "signature": "...", "witnessAlgorithm": "ed25519"}}], "@context": {"body": {"@id": "CIP108:body", "@context": {"title": "CIP108:title", "abstract": "CIP108:abstract", "rationale": "CIP108:rationale", "motivation": "CIP108:motivation", "references": {"@id": "CIP108:references", "@context": {"uri": "CIP100:reference-uri", "Other": "CIP100:OtherReference", "label": "CIP100:reference-label", "referenceHash": {"@id": "CIP108:referenceHash", "@context": {"hashDigest": "CIP108:hashDigest", "hashAlgorithm": "CIP100:hashAlgorithm"}}, "GovernanceMetadata": "CIP100:GovernanceMetadataReference"}, "@container": "@set"}}}, "CIP100": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#", "CIP108": "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0108/README.md#", "authors": {"@id": "CIP100:authors", "@context": {"name": "http://xmlns.com/foaf/0.1/name", "witness": {"@id": "CIP100:witness", "@context": {"publicKey": "CIP100:publicKey", "signature": "CIP100:signature", "witnessAlgorithm": "CIP100:witnessAlgorithm"}}}, "@container": "@set"}, "@language": "en-us", "hashAlgorithm": "CIP100:hashAlgorithm"}, "hashAlgorithm": "blake2b-256"} + bytes: + type: string + description: The raw bytes of the payload + example: 7b0a20202240636f6e74657874223a207b0a2020202022406c616e6775616765223a2022656e2d7573222c0a2020202022434950313030223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130302f524541444d452e6d6423222c0a2020202022434950313038223a202268747470733a2f2f6769746875622e636f6d2f63617264616e6f2d666f756e646174696f6e2f434950732f626c6f622f6d61737465722f4349502d303130382f524541444d452e6d6423222c0a202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d222c0a2020202022626f6479223a207b0a20202020202022406964223a20224349503130383a626f6479222c0a2020202020202240636f6e74657874223a207b0a2020202020202020227265666572656e636573223a207b0a2020202020202020202022406964223a20224349503130383a7265666572656e636573222c0a202020202020202020202240636f6e7461696e6572223a202240736574222c0a202020202020202020202240636f6e74657874223a207b0a20202020202020202020202022476f7665726e616e63654d65746164617461223a20224349503130303a476f7665726e616e63654d657461646174615265666572656e6365222c0a202020202020202020202020224f74686572223a20224349503130303a4f746865725265666572656e6365222c0a202020202020202020202020226c6162656c223a20224349503130303a7265666572656e63652d6c6162656c222c0a20202020202020202020202022757269223a20224349503130303a7265666572656e63652d757269222c0a202020202020202020202020227265666572656e636548617368223a207b0a202020202020202020202020202022406964223a20224349503130383a7265666572656e636548617368222c0a20202020202020202020202020202240636f6e74657874223a207b0a202020202020202020202020202020202268617368446967657374223a20224349503130383a68617368446967657374222c0a202020202020202020202020202020202268617368416c676f726974686d223a20224349503130303a68617368416c676f726974686d220a20202020202020202020202020207d0a2020202020202020202020207d0a202020202020202020207d0a20202020202020207d2c0a2020202020202020227469746c65223a20224349503130383a7469746c65222c0a2020202020202020226162737472616374223a20224349503130383a6162737472616374222c0a2020202020202020226d6f7469766174696f6e223a20224349503130383a6d6f7469766174696f6e222c0a202020202020202022726174696f6e616c65223a20224349503130383a726174696f6e616c65220a2020202020207d0a202020207d2c0a2020202022617574686f7273223a207b0a20202020202022406964223a20224349503130303a617574686f7273222c0a2020202020202240636f6e7461696e6572223a202240736574222c0a2020202020202240636f6e74657874223a207b0a2020202020202020226e616d65223a2022687474703a2f2f786d6c6e732e636f6d2f666f61662f302e312f6e616d65222c0a2020202020202020227769746e657373223a207b0a2020202020202020202022406964223a20224349503130303a7769746e657373222c0a202020202020202020202240636f6e74657874223a207b0a202020202020202020202020227769746e657373416c676f726974686d223a20224349503130303a7769746e657373416c676f726974686d222c0a202020202020202020202020227075626c69634b6579223a20224349503130303a7075626c69634b6579222c0a202020202020202020202020227369676e6174757265223a20224349503130303a7369676e6174757265220a202020202020202020207d0a20202020202020207d0a2020202020207d0a202020207d0a20207d2c0a20202268617368416c676f726974686d223a2022626c616b6532622d323536222c0a202022626f6479223a207b0a20202020227469746c65223a202248617264666f726b20746f2050726f746f636f6c2076657273696f6e203130222c0a20202020226162737472616374223a20224c6574277320686176652073616e63686f4e657420696e2066756c6c20676f7665726e616e636520617320736f6f6e20617320706f737369626c65222c0a20202020226d6f7469766174696f6e223a2022505639206973206e6f742061732066756e2061732050563130222c0a2020202022726174696f6e616c65223a20224c65742773206b6565702074657374696e67207374756666222c0a20202020227265666572656e636573223a205b0a2020202020207b0a2020202020202020224074797065223a20224f74686572222c0a2020202020202020226c6162656c223a202248617264666f726b20746f2050563130222c0a202020202020202022757269223a2022220a2020202020207d0a202020205d0a20207d2c0a202022617574686f7273223a205b0a202020207b0a202020202020226e616d65223a20224361726c6f73222c0a202020202020227769746e657373223a207b0a2020202020202020227769746e657373416c676f726974686d223a202265643235353139222c0a2020202020202020227075626c69634b6579223a202237656130396133346165626231336339383431633731333937623163616266656335646466393530343035323933646565343936636163326634333734383061222c0a2020202020202020227369676e6174757265223a20226134373639383562346363306434353766323437373937363131373939613666366138306663386362376563396463623561383232333838386430363138653330646531363566336438363963346130643931303764386135623631326164376335653432343431393037663562393137393666306437313837643634613031220a2020202020207d0a202020207d0a20205d0a7d + warning: + type: string + description: A warning that occured while validating the metadata + language: + type: string + description: The language described in the context of the metadata as per CIP-100 + example: en-us + comment: + type: string + description: Comment attached to the metadata + is_valid: + type: boolean + description: Indicate whether data is invalid + example: true + drep_updates: + description: List of updates for requested (or all) delegated representatives (DReps) + type: array + items: + properties: + drep_id: + $ref: "#/components/schemas/drep_info/items/properties/drep_id" + hex: + $ref: "#/components/schemas/drep_info/items/properties/hex" + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + type: string + description: The index of this certificate within the the transaction. + example: 1 + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + action: + type: string + description: Effective action for this DRep Update certificate + enum: ["updated","registered","deregistered"] + example: registered + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + drep_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + vote: + type: string + enum: ["Yes","No","Abstain"] + description: Actual Vote casted + example: "Yes" + pool_votes: + description: List of all votes casted by requested pool + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + committee_votes: + description: List of all votes casted by requested delegated representative (DRep) + type: array + items: + $ref: "#/components/schemas/drep_votes/items" + proposal_list: + description: List of all votes cast on specified governance action + type: array + items: + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + cert_index: + $ref: "#/components/schemas/drep_updates/items/properties/cert_index" + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + proposal_type: + type: string + enum: ["ParameterChange", "HardForkInitiation", "TreasuryWithdrawals", "NoConfidence", "NewCommittee", "NewConstitution", "InfoAction"] + description: Proposal Action Type + example: ParameterChange + proposal_description: + type: string + description: Description for Proposal Action + example: '{"tag": "InfoAction"}' + deposit: + $ref: "#/components/schemas/drep_info/items/properties/deposit" + return_address: + type: string + description: The StakeAddress index of the reward address to receive the deposit when it is repaid. + example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5 + proposed_epoch: + type: number + description: Shows the epoch at which this governance action was proposed. + example: 660 + ratified_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been ratified at the specfied epoch. + example: 670 + enacted_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been enacted at the specfied epoch. + example: 675 + dropped_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been dropped (expired/enacted) at the specfied epoch. + example: 680 + expired_epoch: + type: + - number + - 'null' + description: If not null, then this proposal has been expired at the specfied epoch. + example: 680 + expiration: + type: + - number + - 'null' + description: Shows the epoch at which this governance action is expected to expire. + meta_url: + $ref: "#/components/schemas/drep_metadata/items/properties/url" + meta_hash: + $ref: "#/components/schemas/drep_metadata/items/properties/hash" + meta_json: + $ref: "#/components/schemas/drep_metadata/items/properties/json" + meta_comment: + $ref: "#/components/schemas/drep_metadata/items/properties/comment" + meta_language: + $ref: "#/components/schemas/drep_metadata/items/properties/language" + meta_is_valid: + $ref: "#/components/schemas/drep_metadata/items/properties/is_valid" + withdrawal: + type: + - object + - 'null' + description: If not null, the amount withdrawn from treasury into stake address by this this proposal + properties: + stake_address: + $ref: "#/components/schemas/account_history/items/properties/stake_address" + amount: + type: string + example: "31235800000" + param_proposal: + description: If not null, the proposed new parameter set + type: + - object + - 'null' + example: {"id": 15, "key": null, "entropy": null, "epoch_no": null, "influence": null, "max_epoch": null, "min_fee_a": null, "min_fee_b": null, "price_mem": null, "price_step": null, "key_deposit": 1000000, "max_bh_size": null, "max_tx_size": null, "drep_deposit": null, "max_val_size": null, "pool_deposit": null, "cost_model_id": null, "drep_activity": null, "max_tx_ex_mem": null, "min_pool_cost": null, "max_block_size": null, "min_utxo_value": null, "protocol_major": null, "protocol_minor": null, "max_tx_ex_steps": null, "decentralisation": null, "max_block_ex_mem": null, "registered_tx_id": 12270, "dvt_p_p_gov_group": null, "collateral_percent": null, "committee_min_size": null, "gov_action_deposit": null, "max_block_ex_steps": null, "optimal_pool_count": null, "coins_per_utxo_size": null, "gov_action_lifetime": null, "dvt_committee_normal": null, "monetary_expand_rate": null, "pvt_committee_normal": null, "pvtpp_security_group": null, "treasury_growth_rate": null, "dvt_p_p_network_group": null, "max_collateral_inputs": null, "dvt_p_p_economic_group": null, "dvt_p_p_technical_group": null, "dvt_treasury_withdrawal": null, "dvt_hard_fork_initiation": null, "dvt_motion_no_confidence": null, "pvt_hard_fork_initiation": null, "pvt_motion_no_confidence": null, "committee_max_term_length": null, "dvt_update_to_constitution": null, "dvt_committee_no_confidence": null, "pvt_committee_no_confidence": null, "min_fee_ref_script_cost_per_byte": null} + proposal_votes: + type: array + description: List of all votes cast on specified governance action + items: + properties: + block_time: + $ref: "#/components/schemas/blocks/items/properties/block_time" + voter_role: + type: string + description: The role of the voter + enum: ["ConstitutionalCommittee", "DRep", "SPO"] + example: DRep + voter: + type: string + description: Voter's DRep ID (bech32 format), pool ID (bech32 format) or committee hash (hex format) + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + voter_hex: + type: string + description: Voter's DRep ID , pool ID or committee hash in hex format + example: drep1l9y2naagv0vqvft9szdt5wf94fqnxn5hdsgusdl7rf6vq4djqck + vote: + $ref: "#/components/schemas/drep_votes/items/properties/vote" + + script_info: + type: array + items: + description: Array of information for scripts + properties: + script_hash: + type: string + description: Hash of a script + example: bfa7ffa9b2e164873db6ac6d0528c82e212963bc62e10fd1d81da4af + creation_tx_hash: + type: string + description: Hash of the script creation transaction + example: 255f061502ad83230351fbcf2d9fade1b5d118d332f92c9861075010a1fe3fbe + type: + type: string + description: Type of the script + enum: ["plutusV1","plutusV2","timelock","multisig"] + example: plutusV1 + value: + type: + - object + - 'null' + description: Data in JSON format + example: 'null' + bytes: + type: + - string + - 'null' + description: Script bytes (cborSeq) + example: 5907f4010000332323232323232323233223232323232332232323232322223232533532533533355300712001323212330012233350052200200200100235001220011233001225335002101710010142325335333573466e3cd400488008d4020880080580544ccd5cd19b873500122001350082200101601510153500122002353500122002222222222200a101413357389201115554784f206e6f7420636f6e73756d6564000133333573466e1cd55cea8012400046644246600200600464646464646464646464646666ae68cdc39aab9d500a480008cccccccccc888888888848cccccccccc00402c02802402001c01801401000c008cd40508c8c8cccd5cd19b8735573aa0049000119910919800801801180f9aba150023019357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854028cd4050054d5d0a804999aa80bbae501635742a010666aa02eeb94058d5d0a80399a80a0109aba15006335014335502402275a6ae854014c8c8c8cccd5cd19b8735573aa00490001199109198008018011919191999ab9a3370e6aae754009200023322123300100300233502575a6ae854008c098d5d09aba2500223263533573805e05c05a05826aae7940044dd50009aba150023232323333573466e1cd55cea8012400046644246600200600466a04aeb4d5d0a80118131aba135744a004464c6a66ae700bc0b80b40b04d55cf280089baa001357426ae8940088c98d4cd5ce01581501481409aab9e5001137540026ae854010cd4051d71aba15003335014335502475c40026ae854008c070d5d09aba2500223263533573804e04c04a04826ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135744a00226aae7940044dd50009aba150023232323333573466e1d400520062321222230040053019357426aae79400c8cccd5cd19b875002480108c848888c008014c06cd5d09aab9e500423333573466e1d400d20022321222230010053015357426aae7940148cccd5cd19b875004480008c848888c00c014dd71aba135573ca00c464c6a66ae7008808408007c0780740704d55cea80089baa001357426ae8940088c98d4cd5ce00d80d00c80c080c89931a99ab9c4910350543500019018135573ca00226ea8004c8004d5405888448894cd40044d400c88004884ccd401488008c010008ccd54c01c4800401401000448c88c008dd6000990009aa80b111999aab9f00125009233500830043574200460066ae880080548c8c8c8cccd5cd19b8735573aa00690001199911091998008020018011919191999ab9a3370e6aae7540092000233221233001003002301735742a00466a01c02c6ae84d5d1280111931a99ab9c01b01a019018135573ca00226ea8004d5d0a801999aa803bae500635742a00466a014eb8d5d09aba2500223263533573802e02c02a02826ae8940044d55cf280089baa0011335500175ceb44488c88c008dd5800990009aa80a11191999aab9f0022500823350073355017300635573aa004600a6aae794008c010d5d100180a09aba100111220021221223300100400312232323333573466e1d4005200023212230020033005357426aae79400c8cccd5cd19b8750024800884880048c98d4cd5ce00980900880800789aab9d500113754002464646666ae68cdc39aab9d5002480008cc8848cc00400c008c014d5d0a8011bad357426ae8940088c98d4cd5ce00800780700689aab9e5001137540024646666ae68cdc39aab9d5001480008dd71aba135573ca004464c6a66ae7003803403002c4dd500089119191999ab9a3370ea00290021091100091999ab9a3370ea00490011190911180180218031aba135573ca00846666ae68cdc3a801a400042444004464c6a66ae7004404003c0380340304d55cea80089baa0012323333573466e1d40052002200523333573466e1d40092000200523263533573801a01801601401226aae74dd5000891001091000919191919191999ab9a3370ea002900610911111100191999ab9a3370ea004900510911111100211999ab9a3370ea00690041199109111111198008048041bae35742a00a6eb4d5d09aba2500523333573466e1d40112006233221222222233002009008375c6ae85401cdd71aba135744a00e46666ae68cdc3a802a400846644244444446600c01201060186ae854024dd71aba135744a01246666ae68cdc3a8032400446424444444600e010601a6ae84d55cf280591999ab9a3370ea00e900011909111111180280418071aba135573ca018464c6a66ae7004c04804404003c03803403002c0284d55cea80209aab9e5003135573ca00426aae7940044dd50009191919191999ab9a3370ea002900111999110911998008028020019bad35742a0086eb4d5d0a8019bad357426ae89400c8cccd5cd19b875002480008c8488c00800cc020d5d09aab9e500623263533573801801601401201026aae75400c4d5d1280089aab9e500113754002464646666ae68cdc3a800a400446424460020066eb8d5d09aab9e500323333573466e1d400920002321223002003375c6ae84d55cf280211931a99ab9c009008007006005135573aa00226ea800444888c8c8cccd5cd19b8735573aa0049000119aa80518031aba150023005357426ae8940088c98d4cd5ce00480400380309aab9e5001137540029309000a490350543100112212330010030021123230010012233003300200200133512233002489209366f09fe40eaaeb17d3cb6b0b61e087d664174c39a48a986f86b2b0ba6e2a7b00480008848cc00400c0088005 + size: + type: number + description: The size of the CBOR serialised script (in bytes) + example: 2039 + script_list: + description: List of script and creation tx hash pairs + type: array + items: + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + type: + $ref: "#/components/schemas/script_info/items/properties/type" + size: + $ref: "#/components/schemas/script_info/items/properties/size" + script_redeemers: + description: Array of all redeemers for a given script hash + type: array + items: + type: object + properties: + script_hash: + $ref: "#/components/schemas/script_info/items/properties/script_hash" + redeemers: + type: array + items: + type: object + properties: + tx_hash: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_hash" + tx_index: + $ref: "#/components/schemas/utxo_infos/items/properties/tx_index" + unit_mem: + type: + - string + - number + - 'null' + description: The budget in Memory to run a script + example: 520448 + unit_steps: + type: + - string + - number + - 'null' + description: The budget in Cpu steps to run a script + example: 211535239 + fee: + type: string + description: The budget in fees to run a script - the fees depend on the ExUnits and the current prices + example: 45282 + purpose: + type: string + description: What kind of validation this redeemer is used for + enum: ["spend", "mint", "cert", "reward"] + example: spend + datum_hash: + type: + - string + - 'null' + description: The Hash of the Plutus Data + example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4 + datum_value: + $ref: "#/components/schemas/script_info/items/properties/value" + datum_info: + description: Array of datum information for given datum hashes + type: array + items: + type: object + properties: + datum_hash: + $ref: "#/components/schemas/script_redeemers/items/properties/redeemers/items/properties/datum_hash" + creation_tx_hash: + $ref: "#/components/schemas/script_info/items/properties/creation_tx_hash" + value: + $ref: "#/components/schemas/script_info/items/properties/value" + bytes: + $ref: "#/components/schemas/script_info/items/properties/bytes" + ogmiostip: + description: Current tip of the chain, identified by a slot and a block header hash. + type: object + properties: + jsonrpc: + format: text + type: string + description: Identifier for JSON-RPC 2.0 standard + example: "2.0" + method: + format: text + type: string + description: The Ogmios method that was called in the request + example: "queryNetwork/tip" + result: + type: + - object + - 'null' + - string + - array + - number + description: Result of the query + properties: + slot: + type: number + description: Absolute slot number on chain + example: 59886800 + id: + type: string + description: Block Hash (Blake2b 32-byte hash digest, encoded in base16) + example: "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1" + example: {"slot": 59886800, "id": "df5678c9774b7bc8c60a4c83b63c3676e618640ad05f7d1ee775b68939cf77d1"} + headers: {} + responses: + NotFound: + description: The server does not recognise the combination of endpoint and parameters provided + Unauthorized: + description: Access token is missing or invalid + BadRequest: + description: The server cannot process the request due to invalid input +tags: + - name: Network + description: Query information about the network + x-tag-expanded: false + - name: Epoch + description: Query epoch-specific details + x-tag-expanded: false + - name: Block + description: Query information about particular block on chain + x-tag-expanded: false + - name: Transactions + description: Query blockchain transaction details + x-tag-expanded: false + - name: Stake Account + description: Query details about specific stake account addresses + x-tag-expanded: false + - name: Address + description: Query information about specific address(es) + x-tag-expanded: false + - name: Asset + description: Query Asset related informations + x-tag-expanded: false + - name: Governance + description: Query information about governance for network + x-tag-expanded: false + - name: Pool + description: Query information about specific pools + x-tag-expanded: false + - name: Script + description: Query information about specific scripts (Smart Contracts) + x-tag-expanded: false + - name: Ogmios + description: | + Various stateless queries against Ogmios v6 instance. Please note that ogmios follows JSON-RPC 2.0 method, the example spec on koios.rest is *ONLY* for `queryNetwork/tip`, + but all the methods listed below are all accepted. Instead of duplicating specs, we would refer you directly to Ogmios documentation [here](https://ogmios.dev/api) for complete specs. + +
+
+ Note that for queries to be stateless across instances on the globe, we cannot acquire local state as successive calls will be across different instances. Additionally, `queryLedgerState/utxo` method is removed to avoid DDoS impacts. + Thus, we only expose the following methods from monitoring servers, instance providers can expose entire ogmios endpoints if desirable: +
+ + + ### Network + - [queryNetwork/blockHeight](https://ogmios.dev/api/#operation-publish-/?QueryNetworkBlockHeight) + - [queryNetwork/genesisConfiguration](https://ogmios.dev/api/#operation-publish-/?QueryNetworkGenesisConfiguration) + - [queryNetwork/startTime](https://ogmios.dev/api/#operation-publish-/?QueryNetworkStartTime) + - [queryNetwork/tip](https://ogmios.dev/api/#operation-publish-/?QueryNetworkTip) + ### Ledger-State + - [queryLedgerState/epoch](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEpoch) + - [queryLedgerState/eraStart](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraStart) + - [queryLedgerState/eraSummaries](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateEraSummaries) + - [queryLedgerState/liveStakeDistribution](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateLiveStakeDistribution) + - [queryLedgerState/protocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProtocolParameters) + - [queryLedgerState/proposedProtocolParameters](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateProposedProtocolParameters) + - [queryLedgerState/stakePools](https://ogmios.dev/api/#operation-publish-/?QueryLedgerStateStakePools) + ### Transactions + - [submitTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#submitting-transactions) + - [evaluateTransaction](https://ogmios.dev/mini-protocols/local-tx-submission/#evaluating-transactions) + x-tag-expanded: true +security: + - [] + - bearerAuth: [] diff --git a/specs/templates/4-api-schemas.yaml b/specs/templates/4-api-schemas.yaml index ceb90280..42f1d39f 100644 --- a/specs/templates/4-api-schemas.yaml +++ b/specs/templates/4-api-schemas.yaml @@ -2476,13 +2476,19 @@ schemas: type: - object - 'null' - description: If not null, The amount withdrawn from treasury into stake address by this this proposal + description: If not null, the amount withdrawn from treasury into stake address by this this proposal properties: stake_address: $ref: "#/components/schemas/account_history/items/properties/stake_address" amount: type: string example: "31235800000" + param_proposal: + description: If not null, the proposed new parameter set + type: + - object + - 'null' + example: {"id": 15, "key": null, "entropy": null, "epoch_no": null, "influence": null, "max_epoch": null, "min_fee_a": null, "min_fee_b": null, "price_mem": null, "price_step": null, "key_deposit": 1000000, "max_bh_size": null, "max_tx_size": null, "drep_deposit": null, "max_val_size": null, "pool_deposit": null, "cost_model_id": null, "drep_activity": null, "max_tx_ex_mem": null, "min_pool_cost": null, "max_block_size": null, "min_utxo_value": null, "protocol_major": null, "protocol_minor": null, "max_tx_ex_steps": null, "decentralisation": null, "max_block_ex_mem": null, "registered_tx_id": 12270, "dvt_p_p_gov_group": null, "collateral_percent": null, "committee_min_size": null, "gov_action_deposit": null, "max_block_ex_steps": null, "optimal_pool_count": null, "coins_per_utxo_size": null, "gov_action_lifetime": null, "dvt_committee_normal": null, "monetary_expand_rate": null, "pvt_committee_normal": null, "pvtpp_security_group": null, "treasury_growth_rate": null, "dvt_p_p_network_group": null, "max_collateral_inputs": null, "dvt_p_p_economic_group": null, "dvt_p_p_technical_group": null, "dvt_treasury_withdrawal": null, "dvt_hard_fork_initiation": null, "dvt_motion_no_confidence": null, "pvt_hard_fork_initiation": null, "pvt_motion_no_confidence": null, "committee_max_term_length": null, "dvt_update_to_constitution": null, "dvt_committee_no_confidence": null, "pvt_committee_no_confidence": null, "min_fee_ref_script_cost_per_byte": null} proposal_votes: type: array description: List of all votes cast on specified governance action