Spaces:
Runtime error
Runtime error
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.1.0 | |
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):<br><br> | |
``` bash | |
curl "https://api.koios.rest/api/v1/tip" | |
# [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}] | |
curl "https://api.koios.rest/api/v1/blocks?select=epoch,epoch_slot,block_height" | |
# [{"epoch":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:<br><br> | |
``` bash | |
curl "https://api.koios.rest/api/v1/blocks?epoch=eq.250&epoch_slot=lt.180" | |
# [{"hash":"8fad2808ac6b37064a0fa69f6fe065807703d5235a57442647bbcdba1c02faf8","epoch":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":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` 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.<br><br> | |
``` 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:<br><br> | |
``` 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/* | |
``` | |
For GET endpoints, there is also another method to achieve the above, instead of adding parameters to the URL itself, you can specify a `Range` header as below to achieve something similar:<br><br> | |
``` bash | |
curl -s "https://api.koios.rest/api/v1/blocks?select=block_height" -H "Range: 1000-1499" -I | grep -i content-range | |
# content-range: 1000-1499/* | |
``` | |
The above methods for pagination are very useful to keep your queries light as well as process the output in smaller pages, making better use of your resources and respecting server timeouts for response times. | |
## Ordering | |
You can set a sorting order for returned queries against specific column(s). | |
Consider example where you want to check `epoch` 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:<br><br> | |
``` bash | |
curl -s "https://api.koios.rest/api/v1/blocks?pool=eq.pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc&order=block_height.asc&limit=5" | |
# [{"hash":"610b4c7bbebeeb212bd002885048cc33154ba29f39919d62a3d96de05d315706","epoch":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":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":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":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":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.<br><br> | |
``` bash | |
curl -s "https://api.koios.rest/api/v1/blocks?select=epoch,epoch_slot,block_time&limit=3" | |
# [{"epoch":318,"epoch_slot":27867,"block_time":1643606958}, | |
# {"epoch":318,"epoch_slot":27841,"block_time":1643606932}, | |
# {"epoch":318,"epoch_slot":27839,"block_time":1643606930}] | |
curl -s "https://api.koios.rest/api/v1/blocks?select=epoch,epoch_slot,block_time&limit=3" -H "Accept: text/csv" | |
# epoch,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). | |
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 | |
paths: | |
/tip: | |
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: | |
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: | |
get: | |
tags: | |
- Network | |
summary: Get historical tokenomic stats | |
description: >- | |
Get the circulating utxo, treasury, rewards, supply, and reserves in lovelace for the specified epoch. Returns data for all epochs if the epoch number is not provided. | |
operationId: totals | |
parameters: | |
- in: query | |
name: _epoch_no | |
required: true | |
schema: | |
type: string | |
description: Epoch number (required to get specific epoch data). | |
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' | |
/param_updates: | |
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 | |
/reserve_withdrawals: | |
get: | |
tags: | |
- Network | |
parameters: | |
- in: query | |
name: epoch_no | |
description: | | |
Filter blocks by epoch. Use "epoch_no=eq.{value}" to filter by an exact match. | |
If not specified, the API defaults to "eq.{epoch_no}" where {epoch_no} is the latest epoch fetched from the /tip endpoint. | |
required: false | |
schema: | |
type: string | |
default: "eq.450" | |
example: "eq.450" | |
- in: query | |
name: limit | |
required: true | |
schema: | |
type: number | |
default: "5" | |
example: "15" | |
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: | |
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" | |
parameters: | |
- in: query | |
name: epoch_no | |
description: | | |
Filter blocks by epoch. Use "epoch_no=eq.{value}" to filter by an exact match. | |
If not specified, the API defaults to "eq.{epoch_no}" where {epoch_no} is the latest epoch fetched from the /tip endpoint. | |
required: false | |
schema: | |
type: string | |
default: "eq.450" | |
example: "eq.450" | |
- in: query | |
name: limit | |
required: true | |
schema: | |
type: number | |
default: "5" | |
example: "15" | |
summary: Treasury Withdrawals | |
description: List of all withdrawals from treasury against stake accounts | |
operationId: treasury_withdrawals | |
/epoch_info: | |
get: | |
tags: | |
- Epoch | |
parameters: | |
- in: query | |
name: _epoch_no | |
required: true | |
schema: | |
type: string | |
description: Epoch number (required to get specific epoch data). | |
- in: query | |
name: include_next_epoch | |
description: Include details of the next epoch if available. | |
schema: | |
type: boolean | |
responses: | |
"200": | |
description: Success!! | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
id: | |
type: integer | |
description: Unique identifier for the epoch. | |
startDate: | |
type: string | |
format: date-time | |
description: Start date and time of the epoch. | |
endDate: | |
type: string | |
format: date-time | |
description: End date and time of the epoch. | |
status: | |
type: string | |
description: Current status of the epoch. | |
"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: | |
get: | |
tags: | |
- Epoch | |
parameters: | |
- in: query | |
name: _epoch_no | |
required: true | |
schema: | |
type: string | |
description: Epoch number (required to get specific epoch data). | |
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: | |
get: | |
tags: | |
- Epoch | |
parameters: | |
- in: query | |
name: _epoch_no | |
required: true | |
schema: | |
type: string | |
description: Epoch number (required to get specific epoch data). | |
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: | |
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 | |
parameters: | |
- in: query | |
name: epoch_no | |
description: Filter blocks by epoch. Use "epoch_no=eq.{value}" to filter by an exact match. When epoch_no is not specified, the API defaults to "eq.{epoch_no}" where {epoch_no} is the latest epoch fetched from the /tip endpoint. | |
required: true | |
schema: | |
type: string | |
example: "eq.450" | |
- in: query | |
name: limit | |
required: true | |
schema: | |
type: number | |
default: "5" | |
example: "15" | |
/block_info: | |
post: | |
tags: | |
- Block | |
requestBody: | |
description: Array of Cardano stake address(es) in bech32 format with optional epoch number to filter by. | |
required: true | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
_block_hashes: | |
type: array | |
items: | |
type: string | |
description: Hash of the block | |
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: | |
post: | |
tags: | |
- Block | |
requestBody: | |
description: Array of Cardano stake address(es) in bech32 format with optional epoch number to filter by. | |
required: true | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
_block_hashes: | |
type: array | |
items: | |
type: string | |
description: Hash of the block | |
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 | |
/utxo_info: | |
post: | |
tags: | |
- Transactions | |
requestBody: | |
description: Array of Cardano stake address(es) in bech32 format with optional epoch number to filter by. | |
required: true | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
_utxo_refs: | |
type: array | |
items: | |
type: string | |
description: Array of Cardano utxo references in the form "hash#index" | |
_extended: | |
type: boolean | |
default: false | |
description: Controls whether or not certain optional fields supported by a given endpoint are populated | |
required: | |
- _utxo_refs | |
example: | |
_utxo_refs: | |
- "f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e#0" | |
- "0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94#0" | |
_extended: false | |
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_info: | |
post: | |
tags: | |
- Transactions | |
requestBody: | |
description: Array of Cardano stake address(es) in bech32 format with optional epoch number to filter by. | |
required: true | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
_tx_hashes: | |
type: array | |
items: | |
type: string | |
description: Array of Cardano Transaction hashes | |
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: | |
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 | |
parameters: | |
- in: query | |
name: _tx_hashes | |
required: true | |
schema: | |
type: string | |
example: ["e2741f3ee7d3d033be03eabe2c74a181a2ee765c08a32b6a6e8a2d39ca451505"] | |
/tx_metalabels: | |
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 | |
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: | |
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 | |
parameters: | |
- in: query | |
name: _tx_hashes | |
required: true | |
schema: | |
type: string | |
example: ["e2741f3ee7d3d033be03eabe2c74a181a2ee765c08a32b6a6e8a2d39ca451505"] | |
/tx_utxos: | |
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 | |
parameters: | |
- in: query | |
name: _tx_hashes | |
required: true | |
schema: | |
type: string | |
example: ["e2741f3ee7d3d033be03eabe2c74a181a2ee765c08a32b6a6e8a2d39ca451505"] | |
/address_info: | |
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 | |
parameters: | |
- in: query | |
name: _addresses | |
required: true | |
schema: | |
type: string | |
example: ["addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv"] | |
/address_assets: | |
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 | |
parameters: | |
- in: query | |
name: _addresses | |
required: true | |
schema: | |
type: string | |
example: ["addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv"] | |
/account_list: | |
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: | |
post: | |
tags: | |
- Stake Account | |
requestBody: | |
description: Array of Cardano stake credential(s) in bech32 format | |
required: true | |
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 | |
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_txs: | |
get: | |
tags: | |
- Stake Account | |
summary: Account Txs | |
description: Get a list of all Txs for a given stake address (account) | |
operationId: account_txs | |
parameters: | |
- in: query | |
name: _stake_address | |
description: Cardano staking address (reward account) in bech32 format for which the transactions are requested. | |
required: true | |
schema: | |
type: string | |
example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz | |
- in: query | |
name: _after_block_height | |
description: Block height for specifying time delta | |
required: true | |
allowEmptyValue: true | |
schema: | |
type: number | |
default: 1000000 | |
example: 100000 | |
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' | |
/account_rewards: | |
post: | |
tags: | |
- Stake Account | |
requestBody: | |
description: Array of Cardano stake address(es) in bech32 format with optional epoch number to filter by. | |
required: true | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
_stake_addresses: | |
type: array | |
items: | |
type: string | |
description: Array of Cardano stake address(es) in bech32 format. | |
_epoch_no: | |
type: integer | |
description: Only fetch information for a specific epoch. | |
required: | |
- _stake_addresses | |
example: | |
_stake_addresses: | |
- stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250 | |
- stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy | |
_epoch_no: 409 | |
"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: | |
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_assets: | |
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 | |
parameters: | |
- in: query | |
name: _stake_address | |
description: Cardano staking address (reward account) in bech32 format for which the transactions are requested. | |
required: true | |
schema: | |
type: string | |
example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz | |
/asset_list: | |
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 | |
components: | |
securitySchemes: | |
bearerAuth: # This is an arbitrary name for the security scheme | |
type: http | |
scheme: bearer | |
bearerFormat: JWT # Optional, can be omitted if not using JWT bearer tokens | |
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 | |
in: query | |
required: true | |
schema: | |
type: integer | |
format: int32 | |
description: The epoch number to retrieve data for. | |
example: "320" | |
_stake_address: | |
deprecated: false | |
name: _stake_address | |
description: Cardano staking address (reward account) in bech32 format for which the transactions are requested. | |
schema: | |
type: string | |
example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz | |
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 | |
_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 | |
_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: | |
bearerAuth: | |
description: Bearer token for authentication, used as a placeholder. | |
required: true | |
content: | |
application/json: | |
schema: | |
type: object | |
properties: | |
token: | |
type: string | |
description: Bearer Token. This field is a placeholder and should not be used as actual authentication mechanism. | |
$ref: "#/security/bearerAuth" | |
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 | |
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 | |
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 | |
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: <CBOR-serialized signed transaction (base16)> | |
evaluateTransaction: | |
description: Evaluate execution units of scripts in a well-formed transaction. | |
value: | |
jsonrpc: "2.0" | |
method: evaluateTransaction | |
params: | |
transaction: | |
cbor: <CBOR-serialized signed transaction (base16)> | |
additionalUtxo: | |
- ...: null | |
description: JSON-RPC 2.0 standard request body | |
schemas: | |
hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: The actual hash value. | |
epoch_no: | |
type: object | |
properties: | |
value: | |
type: integer | |
format: int64 | |
description: Epoch number. | |
example: 320 | |
abs_slot: | |
type: object | |
properties: | |
value: | |
type: integer | |
format: int64 | |
description: Absolute slot number. | |
example: 45005678 | |
epoch_slot: | |
type: object | |
properties: | |
value: | |
type: integer | |
format: int64 | |
description: Slot number within the epoch. | |
example: 2150 | |
block_height: | |
type: object | |
properties: | |
value: | |
type: integer | |
format: int64 | |
description: Height of the block in the blockchain. | |
example: 562789 | |
block_time: | |
type: object | |
properties: | |
value: | |
type: string | |
format: date-time | |
description: Timestamp of when the block was minted. | |
example: 2021-05-26T21:32:00Z | |
tx_hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Transaction hash. | |
example: 4b5018b82f1c2e3c6d8bf7768a05a5bced1b8d576a0f3db8b4d5973d2b4a22b6 | |
amount: | |
type: object | |
properties: | |
value: | |
type: string | |
description: The amount in the smallest currency unit (e.g., lovelace in Cardano). | |
example: "1000000" | |
stake_address: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Cardano staking address in bech32 format. | |
example: stake1u92n...kchkq | |
pool_id_bech32: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Stake pool identifier in bech32 format. | |
example: pool1wx...jsdf | |
pool_id_hex: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Stake pool identifier in hexadecimal format. | |
example: 1e1d7...abcd | |
active_epoch_no: | |
type: object | |
properties: | |
value: | |
type: integer | |
format: int64 | |
description: The epoch number in which the stake pool became active. | |
example: 250 | |
margin: | |
type: object | |
properties: | |
value: | |
type: number | |
format: float | |
description: The margin (percentage of rewards taken by the stake pool operator). | |
example: 0.02 | |
fixed_cost: | |
type: object | |
properties: | |
value: | |
type: string | |
description: The fixed cost per epoch charged by the stake pool, in the smallest currency unit. | |
example: "340000000" | |
pledge: | |
type: object | |
properties: | |
value: | |
type: string | |
description: The amount of currency pledged by the stake pool operator, in the smallest currency unit. | |
example: "500000000000" | |
reward_addr: | |
type: object | |
properties: | |
value: | |
type: string | |
description: The reward address in bech32 format. | |
example: stake1u92... | |
owners: | |
type: object | |
properties: | |
value: | |
type: array | |
items: | |
type: string | |
description: List of owner addresses in bech32 format. | |
example: | |
- stake1u92... | |
- stake1u93... | |
relays: | |
type: object | |
properties: | |
value: | |
type: array | |
items: | |
type: object | |
description: Array of relay objects providing various relay types and addresses. | |
meta_url: | |
type: object | |
properties: | |
value: | |
type: string | |
format: uri | |
description: URL to the metadata file. | |
example: https://example.com/poolMetadata.json | |
meta_hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Hexadecimal hash of the metadata file. | |
example: a3b8d... | |
pool_status: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Status of the pool (e.g., active, retired). | |
example: active | |
retiring_epoch: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Epoch number when the pool is scheduled to retire. | |
example: 290 | |
nonce: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Nonce value. | |
example: "12345" | |
vrf_key_hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: VRF (Verifiable Random Function) key hash. | |
example: abcd1234... | |
meta_json: | |
type: object | |
properties: | |
value: | |
type: object | |
description: A JSON object containing metadata information. | |
protocol_major: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Major version of the protocol. | |
example: 2 | |
protocol_minor: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Minor version of the protocol. | |
example: 0 | |
block_size: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Size of the block in bytes. | |
example: 2048 | |
tx_count: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: The number of transactions. | |
example: 1500 | |
vrf_key: | |
type: object | |
properties: | |
value: | |
type: string | |
description: VRF (Verifiable Random Function) key. | |
example: vrf_key1234567890 | |
op_cert_counter: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Operational certificate counter. | |
example: 25 | |
pool: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Pool ID in bech32 or hexadecimal format. | |
example: pool1xyz... | |
address: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Cardano address in bech32 format. | |
example: addr1qxyz... | |
tx_index: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Transaction index within a block. | |
example: 1 | |
value: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Value, often representing an amount of ADA or another asset. | |
example: "1000000" | |
datum_hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Hash of the datum. | |
example: hash123... | |
inline_datum: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Inline datum content, encoded in hexadecimal. | |
example: 48656c6c6f2c20776f726c6421 | |
reference_script: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Reference script, encoded in hexadecimal. | |
example: 736372697074123... | |
policy_id: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Policy ID for a multi-asset token, in hexadecimal format. | |
example: policy123... | |
asset_name: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Asset name, in hexadecimal format. | |
example: assetname123... | |
fingerprint: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Fingerprint of the multi-asset token. | |
example: asset1xyz... | |
decimals: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Number of decimal places for a token. | |
example: 6 | |
quantity: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Quantity of the token. | |
example: "1000000" | |
outputs: | |
type: object | |
properties: | |
value: | |
type: array | |
description: List of transaction outputs. | |
items: | |
type: object | |
items: | |
type: object | |
properties: | |
value: | |
type: array | |
description: List of items, possibly transaction inputs or outputs. | |
items: | |
type: object | |
metadata: | |
type: object | |
properties: | |
value: | |
type: object | |
description: Transaction metadata. | |
script_hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Script hash in hexadecimal format. | |
example: abcd1234... | |
bytes: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Data in byte format, typically hexadecimal encoded. | |
example: 48656c6c6f... | |
size: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Size of an object, like a transaction, in bytes. | |
example: 250 | |
purpose: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Purpose of the transaction or script. | |
example: payment | |
fee: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Transaction fee in lovelaces. | |
example: "168965" | |
unit_steps: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Number of computational steps for smart contract execution. | |
example: 1234567 | |
unit_mem: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Amount of memory used by smart contract execution, in bytes. | |
example: 1024 | |
datum_value: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Value of the datum, often in hexadecimal format. | |
example: 736f6d652076616c7565 | |
inputs: | |
type: object | |
properties: | |
value: | |
type: array | |
description: List of transaction inputs. | |
items: | |
type: object | |
asset_name_ascii: | |
type: object | |
properties: | |
value: | |
type: string | |
description: ASCII representation of the asset name. | |
example: MyToken | |
ticker: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Ticker symbol for the asset. | |
example: MTKN | |
description: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Description of the asset. | |
example: MyToken is a utility token. | |
url: | |
type: object | |
properties: | |
value: | |
type: string | |
format: uri | |
description: URL associated with the asset. | |
example: https://example.com/mytoken | |
logo: | |
type: object | |
properties: | |
value: | |
type: string | |
format: uri | |
description: URL to the asset's logo image. | |
example: https://example.com/mytoken/logo.png | |
minting_tx_metadata: | |
type: object | |
properties: | |
value: | |
type: object | |
description: Metadata of the minting transaction. | |
minting_tx_hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Hash of the minting transaction. | |
example: abcd1234... | |
total_supply: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Total supply of the asset. | |
example: "1000000" | |
mint_cnt: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Count of mint transactions for the asset. | |
example: 10 | |
burn_cnt: | |
type: object | |
properties: | |
value: | |
type: integer | |
description: Count of burn transactions for the asset. | |
example: 2 | |
creation_time: | |
type: object | |
properties: | |
value: | |
type: string | |
format: date-time | |
description: Timestamp of the asset's creation. | |
example: 2021-05-26T21:32:00Z | |
token_registry_metadata: | |
type: object | |
properties: | |
value: | |
type: object | |
description: Metadata registered in the token registry. | |
creation_tx_hash: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Hash of the transaction where the asset was created. | |
example: efgh5678... | |
type: | |
type: object | |
properties: | |
value: | |
type: string | |
description: Type of the object or entity. | |
example: SmartContract | |
BearerToken: | |
type: object | |
properties: | |
token: | |
type: string | |
description: Access token required for authentication | |
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: | |
type: object | |
properties: | |
circulatingUtxo: | |
type: integer | |
description: Circulating UTXO in lovelace. | |
treasury: | |
type: integer | |
description: Treasury amount in lovelace. | |
rewards: | |
type: integer | |
description: Rewards amount in lovelace. | |
supply: | |
type: integer | |
description: Total supply in lovelace. | |
reserves: | |
type: integer | |
description: Total reserves in lovelace. | |
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 | |
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" | |
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" | |
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: integer | |
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: 0.0000721 | |
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 | |
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: e8c6992d52cd74b577b79251e0351be25070797a0dbc486b2c284d0bf7aeea9c | |
epoch_no: | |
type: number | |
description: Epoch number of the block | |
example: 321 | |
abs_slot: | |
type: number | |
description: Absolute slot number of the block | |
example: 53384242 | |
epoch_slot: | |
type: number | |
description: Slot number of the block in epoch | |
example: 75442 | |
block_height: | |
type: | |
- number | |
- "null" | |
description: Block height | |
example: 42325043 | |
block_size: | |
type: number | |
description: Block size in bytes | |
example: 79109 | |
block_time: | |
type: number | |
description: UNIX timestamp of the block | |
example: 1506635091 | |
tx_count: | |
type: number | |
description: Number of transactions in the block | |
example: 44 | |
vrf_key: | |
type: string | |
description: VRF key of the block producer | |
example: vrf_vk1pmxyz8efuyj6eq6zkk373f28u47v06nwp5t59jr5fcmcusaazlmqhxu8k2 | |
pool: | |
type: | |
- string | |
- "null" | |
description: Pool ID in bech32 format (null for pre-Shelley blocks) | |
example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc | |
op_cert_counter: | |
type: number | |
description: Counter value of the operational certificate used to create this block | |
example: 8 | |
proto_major: | |
$ref: "#/components/schemas/epoch_params/items/properties/protocol_major" | |
proto_minor: | |
$ref: "#/components/schemas/epoch_params/items/properties/protocol_minor" | |
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" | |
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: | |
id: | |
$ref: "#/components/schemas/account_history/items/properties/stake_address" | |
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_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 withdawal | |
example: 44352623297 | |
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/epoch_info/items/properties/epoch_no" | |
spendable_epoch: | |
$ref: "#/components/schemas/epoch_info/items/properties/epoch_no" | |
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 | |
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) | |
anyOf: | |
- type: "null" | |
- $ref: "#/components/schemas/tx_info/items/properties/outputs/items" | |
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" | |
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 | |
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_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" | |
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" | |
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" | |
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 | |
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 | |
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" | |
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_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" | |
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 | |
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" | |
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: 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 | |
security: | |
- bearerAuth: [] |