koiosapi.yaml

openapi: 3.0.2
info:
  title: Koios API
  version: 1.0.9
  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.

    > Note: While we've done sufficient ground work - we're still going through testing/learning/adapting phase based on feedback. Feel free to give it a go, but just remember it is not yet finalized for production consumption and will be refreshed weekly (Saturday 8am UTC).

    # Problems solved by Koios
    - As the size of blockchain grows rapidly, we're looking at increasingly expensive resources and maintenance costs (financially as well as time-wise)
    to maintain a scalable solution that will automatically failover and have health-checks, ensuring most synched versions are returned. With Koios, anyone is
    free to either add their backend instance to the cluster, or use the query layer without running a node or cardano-db-sync instance themselves. There will be
    health-checks for each endpoint to ensure that connections do not go to a dud backend with stale information.
    - Moreover, folks who do put in tremendous amount of efforts to go through discovery phrase - are often ending up with local solutions, that may not be
    consistent across the board (e.g. Live Stake queries across existing explorers). Since all the queries used by/for Koios layer is on GitHub, anyone can contribute
    or leverage the query knowledge base, and help each other out while doing so. An additional endpoint added will only be load balanced between the servers that
    pass the health-check for the endpoint.
    - It is almost impossible to fetch some live data (for example, Live Stake against a pool) due to the cost of computation and amount of data on chain. For 
    such queries, many folks are already using different cache methods, or capturing ledger information from node. Wouldn't it be nice to have these crunched data that
    take quite a few minutes to run be shared and available to be able to pick a relatively recent execution across the nodes? This will be available out of the box as part
    of Koios API.
    - There is also a worry when going through updates about feasibility/breaking changes/etc. that can become a bottleneck for providers. Since Koios participants
    automatically receive failover support, they reduce impact of any subset of clusters going through update process.
    - The lightweight query layers currently present are unfortunately closed source, centralised, and create a single point of failure. With Koios, our aim is to
    give enough flexibility to all the participants to select their backend, or pick from any of the available ones instead.
    - Bad human errors causing an outage? The bandwidth for Koios becomes better with more participation, but just in case there is not enough participation - we will
    ensure that at least 4 trusted Koios instances across the globe will be around for the initial year, allowing for enough time for adoption to build up gradually.
    - Flexibility to participate at different levels. A consumer of these services can participate with a complete independent instance (optionally extend existing ones), by running only certain parts (e.g. submit-api or PostgREST only), or simply consuming the API without running anything locally.

    # Architecture

    ## How does Koios work?

    ![High-Level architecture overview](/koios-design.png)

    We will go bottom to top (from builder's eyes to run through the above) briefly:

    - *Instance(s)* : These are essentially [PostgREST](https://postgrest.org/en/latest/) instances with the REST service attached to Postgres DB populated using [cardano-db-sync](https://cardano-community.github.io/guild-operators/Build/dbsync/). Every consumer who is providing their own instance will be expected to serve at least a PostgREST instance, as this is what allows us to string instances together after health-checks. If using guild-operator setup instructions, these will be provisioned for you by setup scripts.
    - *Health-check Services* : These are lightweight [HAProxy](http://www.haproxy.org) instances that will be gatekeepers for individual endpoints, handling health-checks, sample data verification, etc. A builder _may_ opt-in to run this monitoring service, and add their instance to GitHub repository. Again, setting up HAProxy will be part of setup scripts on guild-operator's repo for those interested.
    - *DNS Routing* : These will be the entry points from monitoring layer to trusted instances that will route to health-check proxy services. We will be using at least two DNS servers ourselves to not have single point of failure, but that does not limit users to elect any of the other server endpoints instead, since the API works right from the PostgREST layer itself.

    # 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/v0/tip"

    # [{"hash":"4d44c8a453e677f933c3df42ebcf2fe45987c41268b9cfc9b42ae305e8c3d99a","epoch":317,"abs_slot":51700871,"epoch_slot":120071,"block_height":6806994,"block_time":1643267162}]

    curl "https://api.koios.rest/api/v0/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/v0/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 `"Profile: 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/v0/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/v0/blocks?select=block_height&offset=1000&limit=500" -I | grep -i content-range

    # content-range: 1000-1499/*

    ```

    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/v0/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/v0/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/v0/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/v0/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.


    # Community projects

    A big thank you to the following projects who are already starting to use Koios from early days:

    ## CLI

      - [Koios CLI in GoLang](https://github.com/cardano-community/koios-cli)

    ## Libraries

      - [.Net SDK](https://github.com/CardanoSharp/cardanosharp-koios)
      - [Go Client](https://github.com/cardano-community/koios-go-client)
      - [Java Client](https://github.com/cardano-community/koios-java-client)

    ## Community Projects/Tools

      - [Building On Cardano](https://buildingoncardano.com)
      - [CardaStat](cardastat.info)
      - [CNFT.IO](https://cnft.io)
      - [CNTools](https://cardano-community.github.io/guild-operators/Scripts/cntools/)
      - [Dandelion](https://dandelion.link)
      - [Eternl](https://eternl.io/)
      - [PoolPeek](https://poolpeek.com)
      - [TosiDrop](https://tosidrop.io)

    # FAQ

    ### Is there a price attached to using services?
    For most of the queries, there are no charges. But there are DDoS protection and strict timeout rules (see API Usage) that may prevent heavy consumers from using this *remotely* (for which, there should be an interaction to ensure the usage is proportional to sizing and traffic expected).

    ### Who are the folks behind Koios?
    It will be increasing list of community builders. But for initial think-tank and efforts, the work done is primarily by [guild-operators](https://cardano-community.github.io/guild-operators)
    who are a well-recognised team of members behind Cardano tools like CNTools, gLiveView, topologyUpdater, etc. We also run a parallel a short (60-min) epoch blockchain, viz, guild used by many
    for experiments.

    ### I am only interested in collaborating on queries, where can I find the code and how to collaborate?
    All the Postgres codebase against db-sync instance is available on guild-operator's github repo [here](https://github.com/cardano-community/guild-operators/tree/alpha/files/grest/rpc). Feel free to raise an issue/PR to discuss anything related to those queries.

    ### I am not sure how to set up an instance. Is there an easy start guide?
    Yes, there is a setup script (expect you to read carefully the help section) and instructions [here](https://cardano-community.github.io/guild-operators/Build/grest/). Should you need any assistance, feel free to hop in to the [discussion group](https://t.me/joinchat/+zE4Lce_QUepiY2U1).

    ### Too much reading, I want to discuss in person
    There are bi-weekly calls held that anyone is free to join - or you can drop in to the [telegram group](https://t.me/+zE4Lce_QUepiY2U1) and start a discussion from there.

  x-logo:
    url: "https://api.koios.rest/koios.png"
servers:
  - url: https://api.koios.rest/api/v0
  - url: https://guild.koios.rest/api/v0
  - url: https://testnet.koios.rest/api/v0
paths:
  /tip: #RPC
    get:
      tags:
        - Network
      responses:
        "200":
          description: Array of block summary (limit+paginated)
          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
  /genesis: #RPC
    get:
      tags:
        - Network
      responses:
        "200":
          description: Array of genesis parameters used to start each era on chain
          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
  /totals: #RPC
    get:
      tags:
        - Network
      parameters:
        - $ref: "#/components/parameters/_epoch_no"
      responses:
        "200":
          description: Array of supply/reserves/utxo/fees/treasury stats
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/totals"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Get historical tokenomic stats
      description: >-
        Get the circulating utxo, treasury, rewards, supply and reserves in
        lovelace for specified epoch, all epochs if empty
  /epoch_info: #RPC
    get:
      tags:
        - Epoch
      parameters:
        - $ref: "#/components/parameters/_epoch_no"
      responses:
        "200":
          description: Array of detailed summary for each epoch
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/epoch_info"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Epoch Information
      description: Get the epoch information, all epochs if no epoch specified
  /epoch_params: #RPC
    get:
      tags:
        - Epoch
      parameters:
        - $ref: "#/components/parameters/_epoch_no"
      responses:
        "200":
          description: Array of protocol parameters for each epoch
          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
  /epoch_block_protocols: #RPC
    get:
      tags:
        - Epoch
      parameters:
        - $ref: "#/components/parameters/_epoch_no"
      responses:
        "200":
          description: Array of distinct block protocol versions counts in epoch
          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
  /blocks:
    get:
      tags:
        - Block
      responses:
        "200":
          description: Array of block information
          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)
  /block_info: #RPC
    post:
      tags:
        - Block
      requestBody:
        $ref: "#/components/requestBodies/block_hashes"
      responses:
        "200":
          description: Array of detailed block information
          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
  /block_txs: #RPC
    post:
      tags:
        - Block
      requestBody:
        $ref: "#/components/requestBodies/block_hashes"
      responses:
        "200":
          description: Array of transactions hashes
          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
  /tx_info: #RPC
    post:
      tags:
        - Transactions
      requestBody:
        $ref: "#/components/requestBodies/tx_ids"
      responses:
        "200":
          description: Array of detailed information about transaction(s)
          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)
  /tx_utxos: #RPC
    post:
      tags:
        - Transactions
      requestBody:
        $ref: "#/components/requestBodies/tx_ids"
      responses:
        "200":
          description: Array of inputs and outputs for given transaction(s)
          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.
  /tx_metadata: #RPC
    post:
      tags:
        - Transactions
      requestBody:
        $ref: "#/components/requestBodies/tx_ids"
      responses:
        "200":
          description: Array of metadata information present in each of the transactions queried
          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)
  /tx_metalabels: #RPC
    get:
      tags:
        - Transactions
      responses:
        "200":
          description: Array of known metadata labels
          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
  /submittx: #submit-api
    post:
      tags:
        - Transactions
      requestBody:
        $ref: "#/components/requestBodies/txbin"
      x-code-samples:
        - lang: "Shell"
          source: |
            # Assuming ${data} is a raw binary serialized transaction on the file-system.
            # If using a CLI-generated tx file, please ensure to deserialise (using `xxd -p -r <<< $(jq .cborHex ${tx.signed}) > ${data}`) first before submitting.
            curl -X POST \
                --header "Content-Type: application/cbor" \
                --data-binary ${data} https://api.koios.rest/api/v0/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.
  /tx_status: #RPC
    post:
      tags:
        - Transactions
      requestBody:
        $ref: "#/components/requestBodies/tx_ids"
      responses:
        "200":
          description: Array of transaction confirmation counts
          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 (Block Confirmations)
      description: Get the number of block confirmations for a given transaction hash list
  /address_info: #RPC
    post:
      tags:
        - Address
      requestBody:
        $ref: "#/components/requestBodies/payment_addresses"
      responses:
        "200":
          description: Array of address information
          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
  /address_txs: #RPC
    post:
      tags:
        - Address
      requestBody:
        $ref: "#/components/requestBodies/address_txs"
      responses:
        "200":
          description: Array of transaction hashes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/address_txs"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Address Transactions
      description: Get the transaction hash list of input address array, optionally filtering after specified block height (inclusive)
  /address_assets: #RPC
    post:
      tags:
        - Address
      requestBody:
        $ref: "#/components/requestBodies/payment_addresses"
      responses:
        "200":
          description: Array of address-owned assets
          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
  /credential_txs: #RPC
    post:
      tags:
        - Address
      requestBody:
        $ref: "#/components/requestBodies/credential_txs"
      responses:
        "200":
          description: Array of transaction hashes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/credential_txs"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Transactions from payment credentials
      description: Get the transaction hash list of input payment credential array, optionally filtering after specified block height (inclusive)
  /account_list:
    get:
      tags:
        - Account
      responses:
        "200":
          description: Array of account (stake address) IDs
          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 accounts
  /account_info: #RPC
    post:
      tags:
        - Account
      requestBody:
        $ref: "#/components/requestBodies/stake_addresses"
      responses:
        "200":
          description: Array of account information
          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 (accounts)
  /account_info_cached: #RPC
    post:
      tags:
        - Account
      requestBody:
        $ref: "#/components/requestBodies/stake_addresses"
      responses:
        "200":
          description: Array of account information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_info"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Account Information (Cached)
      description: Get the cached account information for given stake addresses (accounts)
  /account_rewards: #RPC
    post:
      tags:
        - Account
      requestBody:
        $ref: "#/components/requestBodies/stake_addresses_with_epoch_no"
      responses:
        "200":
          description: Array of reward history information
          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 (accounts)
  /account_updates: #RPC
    post:
      tags:
        - Account
      requestBody:
        $ref: "#/components/requestBodies/stake_addresses"
      responses:
        "200":
          description: Array of account updates information
          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 (accounts)
  /account_addresses: #RPC
    post:
      tags:
        - Account
      requestBody:
        $ref: "#/components/requestBodies/stake_addresses"
      responses:
        "200":
          description: Array of payment addresses
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_addresses"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Account Addresses
      description: Get all addresses associated with given staking accounts
  /account_assets: #RPC
    post:
      tags:
        - Account
      requestBody:
        $ref: "#/components/requestBodies/stake_addresses"
      responses:
        "200":
          description: Array of assets owned by account
          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 of given accounts
  /account_history: #RPC
    post:
      tags:
        - Account
      requestBody:
        $ref: "#/components/requestBodies/stake_addresses_with_epoch_no"
      responses:
        "200":
          description: Array of active stake values per epoch
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_history"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Account History
      description: Get the staking history of given stake addresses (accounts)
  /asset_list:
    get:
      tags:
        - Asset
      responses:
        "200":
          description: Array of policy IDs and asset names
          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)
  /asset_address_list: #RPC
    get:
      tags:
        - Asset
      parameters:
        - $ref: "#/components/parameters/_asset_policy"
        - $ref: "#/components/parameters/_asset_name"
      responses:
        "200":
          description: Array of payment addresses holding the given token (including balances)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/asset_address_list"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Asset Address List
      description: Get the list of all addresses holding a given asset
  /asset_info: #RPC
    get:
      tags:
        - Asset
      parameters:
        - $ref: "#/components/parameters/_asset_policy"
        - $ref: "#/components/parameters/_asset_name"
      responses:
        "200":
          description: Array of detailed asset information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/asset_info"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Asset Information
      description: Get the information of an asset including first minting & token registry metadata
  /asset_history: #RPC
    get:
      tags:
        - Asset
      parameters:
        - $ref: "#/components/parameters/_asset_policy"
        - $ref: "#/components/parameters/_asset_name"
      responses:
        "200":
          description: Array of asset mint/burn history
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/asset_history"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Asset History
      description: Get the mint/burn history of an asset
  /asset_policy_info: #RPC
    get:
      tags:
        - Asset
      parameters:
        - $ref: "#/components/parameters/_asset_policy"
      responses:
        "200":
          description: Array of detailed information of assets under the same policy
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/asset_policy_info"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Asset Policy Information
      description: Get the information for all assets under the same policy
  /asset_summary: #RPC
    get:
      tags:
        - Asset
      parameters:
        - $ref: "#/components/parameters/_asset_policy"
        - $ref: "#/components/parameters/_asset_name"
      responses:
        "200":
          description: Array of asset summary information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/asset_summary"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Asset Summary
      description: Get the summary of an asset (total transactions exclude minting/total wallets include only wallets with asset balance)
  /asset_txs: #RPC
    get:
      tags:
        - Asset
      parameters:
        - $ref: "#/components/parameters/_asset_policy"
        - $ref: "#/components/parameters/_asset_name"
        - $ref: "#/components/parameters/_after_block_height"
        - $ref: "#/components/parameters/_history"
      responses:
        "200":
          description: Array of Tx hashes that included the given asset
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/asset_txs"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Asset Transactions
      description: Get the list of current or all asset transaction hashes (newest first)
  /pool_list: #RPC
    get:
      tags:
        - Pool
      responses:
        "200":
          description: Array of pool IDs and tickers
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_list"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool List
      description: A list of all currently registered/retiring (not retired) pools
  /pool_info: #RPC
    post:
      tags:
        - Pool
      requestBody:
        $ref: "#/components/requestBodies/pool_ids"
      responses:
        "200":
          description: Array of pool information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_info"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Information
      description: Current pool statuses and details for a specified list of pool ids
  /pool_stake_snapshot: #RPC
    get:
      tags:
        - Pool
      parameters:
        - $ref: "#/components/parameters/_pool_bech32"
      responses:
        "200":
          description: Array of pool stake information for 3 snapshots
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_snapshot"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Stake Snapshot
      description: Returns Mark, Set and Go stake snapshots for the selected pool, useful for leaderlog calculation
  /pool_delegators: #RPC
    get:
      tags:
        - Pool
      parameters:
        - $ref: "#/components/parameters/_pool_bech32"
      responses:
        "200":
          description: Array of pool delegator information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_delegators"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Delegators List
      description: Return information about live delegators for a given pool.
  /pool_delegators_history: #RPC
    get:
      tags:
        - Pool
      parameters:
        - $ref: "#/components/parameters/_pool_bech32"
        - $ref: "#/components/parameters/_epoch_no"
      responses:
        "200":
          description: Array of pool delegator information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_delegators_history"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Delegators History
      description: Return information about active delegators (incl. history) for a given pool and epoch number (all epochs if not specified).
  /pool_blocks: #RPC
    get:
      tags:
        - Pool
      parameters:
        - $ref: "#/components/parameters/_pool_bech32"
        - $ref: "#/components/parameters/_epoch_no"
      responses:
        "200":
          description: Array of blocks created by pool
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_blocks"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Blocks
      description: >-
        Return information about blocks minted by a given pool for all epochs
        (or _epoch_no if provided)
  /pool_history: #RPC
    get:
      tags:
        - Pool
      parameters:
        - $ref: "#/components/parameters/_pool_bech32"
        - $ref: "#/components/parameters/_epoch_no"
      responses:
        "200":
          description: Array of pool history information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_history_info"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Stake, Block and Reward History
      description: >-
        Return information about pool stake, block and reward history in a given epoch _epoch_no
        (or all epochs that pool existed for, in descending order if no _epoch_no was provided)
  /pool_updates: #RPC
    get:
      tags:
        - Pool
      parameters:
        - $ref: "#/components/parameters/_pool_bech32_optional"
          required: false
      responses:
        "200":
          description: Array of historical pool updates
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_updates"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Updates (History)
      description: Return all pool updates for all pools or only updates for specific pool if specified
  /pool_relays: #RPC
    get:
      tags:
        - Pool
      responses:
        "200":
          description: Array of pool relay information
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_relays"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Relays
      description: A list of registered relays for all currently registered/retiring (not retired) pools
  /pool_metadata: #RPC
    post:
      tags:
        - Pool
      requestBody:
        $ref: "#/components/requestBodies/pool_ids_optional"
      responses:
        "200":
          description: Array of pool metadata
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pool_metadata"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Pool Metadata
      description: Metadata (on & off-chain) for all currently registered/retiring (not retired) pools
  /native_script_list: #RPC
    get:
      tags:
        - Script
      responses:
        "200":
          description: List of native script and creation tx hash pairs
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/native_script_list"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Native Script List
      description: List of all existing native script hashes along with their creation transaction hashes
  /plutus_script_list: #RPC
    get:
      tags:
        - Script
      responses:
        "200":
          description: List of Plutus script and creation tx hash pairs
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/plutus_script_list"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Plutus Script List
      description: List of all existing Plutus script hashes along with their creation transaction hashes
  /script_redeemers: #RPC
    get:
      tags:
        - Script
      parameters:
        - $ref: "#/components/parameters/_script_hash"
      responses:
        "200":
          description: List of all redeemers for a given script hash
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/script_redeemers"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Script Redeemers
      description: List of all redeemers for a given script hash
  /datum_info: #RPC
    post:
      tags:
        - Script
      requestBody:
        $ref: "#/components/requestBodies/datum_hashes"
      responses:
        "200":
          description: List of datum information for given datum hashes
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/datum_info"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
      summary: Datum Information
      description: List of datum information for given datum hashes
components:
  parameters:
    select:
      name: select
      description: Filtering Columns
      schema:
        type: string
      in: query
      required: false
    on_conflict:
      name: on_conflict
      description: On Conflict
      schema:
        type: string
      in: query
      required: false
    order:
      name: order
      description: Ordering
      schema:
        type: string
      in: query
      required: false
    range:
      name: Range
      description: Limiting and Pagination
      schema:
        type: string
      in: header
      required: false
    rangeUnit:
      name: Range-Unit
      description: Limiting and Pagination
      schema:
        default: items
        type: string
      in: header
      required: false
    offset:
      name: offset
      description: Limiting and Pagination
      schema:
        type: string
      in: query
      required: false
    limit:
      name: limit
      description: Limiting and Pagination
      schema:
        type: string
      in: query
      required: false
      example: 10
    _block_hash:
      deprecated: false
      name: _block_hash
      description: Block Hash in hex format
      schema:
        type: string
        example: f6192a1aaa6d3d05b4703891a6b66cd757801c61ace86cbe5ab0d66e07f601ab
      in: query
      required: true
      allowEmptyValue: false
    _after_block_height:
      deprecated: false
      name: _after_block_height
      description: Block height for specifying time delta
      schema:
        type: integer
        example: 50000
      in: query
      required: false
      allowEmptyValue: true
    _epoch_no:
      deprecated: false
      name: _epoch_no
      description: Epoch Number to fetch details for
      schema:
        type: string
        example: 320
      in: query
      required: false
      allowEmptyValue: true
    _earned_epoch_no:
      deprecated: false
      name: _epoch_no
      description: Filter for earned rewards Epoch Number
      schema:
        type: string
        example: 320
      in: query
      required: false
      allowEmptyValue: true
    _any_address:
      deprecated: false
      name: _address
      description: Cardano payment or staking address in bech32 format
      schema:
        type: string
        example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz
      in: query
      required: true
      allowEmptyValue: false
    _address:
      deprecated: false
      name: _address
      description: Cardano payment address in bech32 format
      schema:
        type: string
        example: addr1qyp9kz50sh9c53hpmk3l4ewj9ur794t2hdqpngsjn3wkc5sztv9glpwt3frwrhdrltjaytc8ut2k4w6qrx3p98zad3fq07xe9g
      in: query
      required: true
      allowEmptyValue: false
    _address_assets:
      deprecated: false
      name: _address
      description: Cardano payment address in bech32 format
      schema:
        type: string
        example: addr1q8h22z0n3zqecr9n4q9ysds2m2ms3dqesz575accjpc3jclw55yl8zypnsxt82q2fqmq4k4hpz6pnq9fafm33yr3r93sgnpdw6
      in: query
      required: true
      allowEmptyValue: false
    _stake_address:
      deprecated: false
      name: _stake_address
      description: Cardano staking address (reward account) in bech32 format
      schema:
        type: string
        example: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz
      in: query
      required: true
      allowEmptyValue: false
    _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
    _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
    _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:
    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
    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
    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: integer
                description: Only fetch information after specific block height
            example:
              _addresses:
                - addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv
                - addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y
              _after_block_height: 6238675
    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: integer
                description: Only fetch information for a specific epoch
            example:
              _stake_addresses:
                - stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250
                - stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy
              _epoch_no: 350
    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
    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: integer
                description: Only fetch information after specific block height
            example:
              _payment_credentials:
                - 025b0a8f85cb8a46e1dda3fae5d22f07e2d56abb4019a2129c5d6c52
                - 13f6870c5e4f3b242463e4dc1f2f56b02a032d3797d933816f15e555
              _after_block_height: 6238675
    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
    txbin:
      content:
        application/cbor:
          schema:
            type: string
            format: binary
            example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e
    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
    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
    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
  securitySchemes: {}
  schemas:
    tip:
      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:
      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: integer
            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: array
      items:
        properties:
          epoch_no:
            type: integer
            description: Epoch number
            example: 294
          circulation:
            type: string
            description: Circulating UTxOs for given epoch (in lovelaces)
            example: 32081169442642320
          treasury:
            type: string
            description: Funds in treasury for given epoch (in lovelaces)
            example: 637024173474141
          reward:
            type: string
            description: Rewards accumulated as of given epoch (in lovelaces)
            example: 506871250479840
          supply:
            type: string
            description: Total Active Supply (sum of treasury funds, rewards, UTxOs, deposits and fees) for given epoch (in lovelaces)
            example: 33228495612391330
          reserves:
            type: string
            description: Total Reserves yet to be unlocked on chain
            example: 11771504387608670
    pool_list:
      type: array
      items:
        properties:
          pool_id_bech32:
            type: string
            nullable: true
            description: Bech32 representation of pool ID
            example: pool1z5uqdk7dzdxaae5633fqfcu2eqzy3a3rgtuvy087fdld7yws0xt
          ticker:
            type: string
            nullable: true
            description: Pool ticker
            example: JAZZ
    pool_history_info:
      type: array
      items:
        type: object
        properties:
          epoch_no:
            type: integer
            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: integer
            nullable: true
            description: Number of blocks pool created in that epoch
            example: 14
          delegator_cnt:
            type: integer
            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"
          epoch_ros:
            type: number
            description: Annualized ROS (return on staking) for delegators for this epoch
            example: 3.000340466
    pool_info:
      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
            description: Pool VRF key hash
            example: 25efdad1bc12944d38e4e3c26c43565bec84973a812737b163b289e87d0d5ed3
          margin:
            type: number
            description: Margin (decimal format)
            example: 0.1
          fixed_cost:
            type: string
            description: Pool fixed cost per epoch
            example: "500000000"
          pledge:
            type: string
            description: Pool pledge in lovelace
            example: "64000000000000"
          reward_addr:
            type: string
            description: Pool reward address
            example: stake1uy6yzwsxxc28lfms0qmpxvyz9a7y770rtcqx9y96m42cttqwvp4m5
          owners:
            type: array
            items:
              type: string
              description: Pool (co)owner address
              example: stake1u8088wvudd7dp3rxl0v9xgng8r3j50s65ge3l3jvgd94keqfm3nv3
          relays:
            type: array
            items:
              type: object
              properties:
                dns:
                  type: string
                  nullable: true
                  description: DNS name of the relay (nullable)
                  example: relays-new.cardano-mainnet.iohk.io
                srv:
                  type: string
                  nullable: true
                  description: DNS service name of the relay (nullable)
                  example: biostakingpool3.hopto.org
                ipv4:
                  type: string
                  nullable: true
                  description: IPv4 address of the relay (nullable)
                  example: "54.220.20.40"
                ipv6:
                  type: string
                  nullable: true
                  description: IPv6 address of the relay (nullable)
                  example: 2604:ed40:1000:1711:6082:78ff:fe0c:ebf
                port:
                  type: number
                  nullable: true
                  description: Port number of the relay (nullable)
                  example: 6000
          meta_url:
            type: string
            description: Pool metadata URL
            nullable: true
            example: https://pools.iohk.io/IOGP.json
          meta_hash:
            type: string
            description: Pool metadata hash
            nullable: true
            example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0
          meta_json:
            type: object
            nullable: true
            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: integer
            description: Announced retiring epoch (nullable)
            example: null
            nullable: true
          op_cert:
            type: string
            nullable: true
            description: Pool latest operational certificate hash
            example: 37eb004c0dd8a221ac3598ca1c6d6257fb5207ae9857b7c163ae0f39259d6cc0
          op_cert_counter:
            type: integer
            nullable: true
            description: Pool latest operational certificate counter value
            example: 8
          active_stake:
            type: string
            nullable: true
            description: Pool active stake (will be null post epoch transition until dbsync calculation is complete)
            example: "64328627680963"
          sigma:
            type: number
            nullable: true
            description: Pool relative active stake share
            example: 0.0034839235
          block_count:
            type: integer
            nullable: true
            description: Total pool blocks on chain
            example: 4509
          live_pledge:
            type: string
            nullable: true
            description: Summary of account balance for all pool owner's
            example: "64328594406327"
          live_stake:
            type: string
            nullable: true
            description: Pool live stake
            example: "64328627680963"
          live_delegators:
            type: integer
            description: Pool live delegator count
            example: 5
          live_saturation:
            type: number
            nullable: true
            description: Pool live saturation (decimal format)
            example: 94.52
    pool_snapshot:
      type: array
      nullable: true
      items:
        type: object
        properties:
          snapshot:
            type: string
            description: Type of snapshot ("Mark", "Set" or "Go")
            example: "Mark"
          epoch_no:
            type: integer
            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:
      type: array
      nullable: true
      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: integer
            description: Epoch number in which the delegation becomes active
            example: 324
          latest_delegation_hash:
            type: string
            description: Latest transaction hash used for delegation by the account
            example: 368d08fe86804d637649341d3aec4a9baa7dffa6d00f16de2ba9dba814f1c948
    pool_delegators_history:
      type: array
      nullable: true
      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: integer
            description: Epoch number for the delegation history
            example: 324
    pool_blocks:
      type: array
      nullable: true
      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:
      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: integer
            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"
          pool_status:
            $ref: "#/components/schemas/pool_info/items/properties/pool_status"
          retiring_epoch:
            $ref: "#/components/schemas/pool_info/items/properties/retiring_epoch"
    pool_relays:
      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_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"
    epoch_info:
      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: integer
            description: Number of transactions submitted in epoch
            example: 357919
          blk_count:
            type: integer
            description: Number of blocks created in epoch
            example: 17321
          start_time:
            type: integer
            description: UNIX timestamp of the epoch start
            example: 1506203091
          end_time:
            type: integer
            description: UNIX timestamp of the epoch end
            example: 1506635091
          first_block_time:
            type: integer
            description: UNIX timestamp of the epoch's first block
            example: 1506635091
          last_block_time:
            type: integer
            description: UNIX timestamp of the epoch's last block
            example: 1506635091
          active_stake:
            type: string
            description: Total active stake in epoch stake snapshot (null for pre-Shelley epochs)
            example: 23395112387185880
            nullable: true
          total_rewards:
            type: string
            description: Total rewards earned in epoch (null for pre-Shelley epochs)
            example: 252902897534230
            nullable: true
          avg_blk_reward:
            type: string
            description: Average block reward for epoch (null for pre-Shelley epochs)
            example: 660233450
            nullable: true
    epoch_params:
      type: array
      items:
        properties:
          epoch_no:
            type: integer
            description: Epoch number
            example: 294
          min_fee_a:
            type: integer
            description: The 'a' parameter to calculate the minimum transaction fee
            example: 44
            nullable: true
          min_fee_b:
            type: integer
            description: The 'b' parameter to calculate the minimum transaction fee
            example: 155381
            nullable: true
          max_block_size:
            type: integer
            description: The maximum block size (in bytes)
            example: 65536
            nullable: true
          max_tx_size:
            type: integer
            description: The maximum transaction size (in bytes)
            example: 16384
            nullable: true
          max_bh_size:
            type: integer
            description: The maximum block header size (in bytes)
            example: 1100
            nullable: true
          key_deposit:
            type: string
            description: The amount (in lovelace) required for a deposit to register a stake address
            example: 2000000
            nullable: true
          pool_deposit:
            type: string
            description: The amount (in lovelace) required for a deposit to register a stake pool
            example: 500000000
            nullable: true
          max_epoch:
            type: integer
            description: The maximum number of epochs in the future that a pool retirement is allowed to be scheduled for
            example: 18
            nullable: true
          optimal_pool_count:
            type: integer
            description: The optimal number of stake pools
            example: 500
            nullable: true
          influence:
            type: number
            format: double
            description: The pledge influence on pool rewards
            example: 0.3
            nullable: true
          monetary_expand_rate:
            type: number
            format: double
            description: The monetary expansion rate
            example: 0.003
            nullable: true
          treasury_growth_rate:
            type: number
            format: double
            description: The treasury growth rate
            example: 0.2
            nullable: true
          decentralisation:
            type: number
            format: double
            description: The decentralisation parameter (1 fully centralised, 0 fully decentralised)
            example: 0.1
            nullable: true
          extra_entropy:
            type: string
            description: The hash of 32-byte string of extra random-ness added into the protocol's entropy pool
            example: d982e06fd33e7440b43cefad529b7ecafbaa255e38178ad4189a37e4ce9bf1fa
            nullable: true
          protocol_major:
            type: integer
            description: The protocol major version
            example: 5
            nullable: true
          protocol_minor:
            type: integer
            description: The protocol minor version
            example: 0
            nullable: true
          min_utxo_value:
            type: string
            description: The minimum value of a UTxO entry
            example: 34482
            nullable: true
          min_pool_cost:
            type: string
            description: The minimum pool cost
            example: 340000000
            nullable: true
          nonce:
            type: string
            description: The nonce value for this epoch
            example: 01304ddf5613166be96fce27be110747f2c8fcb38776618ee79225ccb59b81e2
            nullable: true
          block_hash:
            type: string
            description: The hash of the first block where these parameters are valid
            example: f9dc2a2fc3a2db09a71af007a740261de585afc9e3022b8e30535592ff4dd9e5
          cost_models:
            type: string
            description: The per language cost models
            example: null
            nullable: true
          price_mem:
            type: number
            format: double
            description: The per word cost of script memory usage
            example: 0.0577
            nullable: true
          price_step:
            type: number
            format: double
            description: The cost of script execution step usage
            example: 7.21e-05
            nullable: true
          max_tx_ex_mem:
            type: number
            description: The maximum number of execution memory allowed to be used in a single transaction
            example: 10000000
            nullable: true
          max_tx_ex_steps:
            type: number
            description: The maximum number of execution steps allowed to be used in a single transaction
            example: 10000000000
            nullable: true
          max_block_ex_mem:
            type: number
            description: The maximum number of execution memory allowed to be used in a single block
            example: 50000000
            nullable: true
          max_block_ex_steps:
            type: number
            description: The maximum number of execution steps allowed to be used in a single block
            example: 40000000000
            nullable: true
          max_val_size:
            type: number
            description: The maximum Val size
            example: 5000
            nullable: true
          collateral_percent:
            type: integer
            description: The percentage of the tx fee which must be provided as collateral when including non-native scripts
            example: 150
            nullable: true
          max_collateral_inputs:
            type: integer
            description: The maximum number of collateral inputs allowed in a transaction
            example: 3
            nullable: true
          coins_per_utxo_size:
            type: string
            description: The cost per UTxO size
            example: 34482
            nullable: true
    epoch_block_protocols:
      type: array
      items:
        properties:
          proto_major:
            type: integer
            description: Protocol major version
            example: 6
          proto_minor:
            type: integer
            description: Protocol major version
            example: 2
          blocks:
            type: integer
            description: Amount of blocks with specified major and protocol combination
            example: 2183
    blocks:
      type: array
      items:
        type: object
        properties:
          hash:
            type: string
            description: Hash of the block
            example: e8c6992d52cd74b577b79251e0351be25070797a0dbc486b2c284d0bf7aeea9c
          epoch_no:
            type: integer
            description: Epoch number of the block
            example: 321
          abs_slot:
            type: integer
            description: Absolute slot number of the block
            example: 53384242
          epoch_slot:
            type: integer
            description: Slot number of the block in epoch
            example: 75442
          block_height:
            type: integer
            description: Block height
            example: 42325043
          block_size:
            type: integer
            description: Block size in bytes
            example: 79109
          block_time:
            type: integer
            description: UNIX timestamp of the block
            example: 1506635091
          tx_count:
            type: integer
            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
            description: Pool ID in bech32 format (null for pre-Shelley blocks)
            example: pool155efqn9xpcf73pphkk88cmlkdwx4ulkg606tne970qswczg3asc
            nullable: true
          op_cert_counter:
            type: integer
            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:
      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
            description: Total output of the block (in lovelace)
            example: 92384672389
            nullable: true
          total_fees:
            type: string
            description: Total fees of the block (in lovelace)
            example: 2346834
            nullable: true
          num_confirmations:
            type: integer
            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:
      type: array
      items:
        type: object
        properties:
          block_hash:
            $ref: "#/components/schemas/blocks/items/properties/hash"
          tx_hashes:
            type: array
            items:
              $ref: "#/components/schemas/tx_info/items/properties/tx_hash"
    address_info:
      type: array
      items:
        type: object
        properties:
          address:
            $ref: "#/components/schemas/asset_address_list/items/properties/payment_address"
          balance:
            type: string
            description: Sum of all UTxO values beloning to address
            example: 10723473983
          stake_address:
            nullable: true
            allOf:
            - $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/tx_info/items/properties/outputs/items/properties/tx_hash"
                tx_index:
                  $ref: "#/components/schemas/tx_info/items/properties/outputs/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/account_assets/items/properties/asset_list"
    address_txs:
      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:
      type: array
      items:
        type: object
        properties:
          address:
            $ref: "#/components/schemas/asset_address_list/items/properties/payment_address"
          asset_list:
            $ref: "#/components/schemas/account_assets/items/properties/asset_list"
    credential_txs:
      $ref: "#/components/schemas/address_txs"
    account_list:
      type: array
      items:
        type: object
        properties:
          id:
            $ref: "#/components/schemas/account_history/items/properties/stake_address"
    account_info:
      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:
            $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"
    account_rewards:
      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:
      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/tx_info/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:
      type: array
      items:
        type: object
        properties:
          stake_address:
            $ref: "#/components/schemas/account_history/items/properties/stake_address"
          addresses:
            type: array
            items:
              $ref: "#/components/schemas/asset_address_list/items/properties/payment_address"
    account_assets:
      type: array
      items:
        type: object
        properties:
          stake_address:
            $ref: "#/components/schemas/account_history/items/properties/stake_address"
          asset_list:
            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"
                quantity:
                  type: string
                  description: Asset quantity owned by account
                  example: 990000
    account_history:
      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: integer
                  description: Epoch number
                  example: 301
                active_stake:
                  type: string
                  description: Active stake amount (in lovelaces)
                  example: 682334162
    tx_info:
      type: array
      items:
        type: object
        properties:
          tx_hash:
            type: string
            description: Hash identifier of the transaction
            example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e
          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: integer
            description: UNIX timestamp of the transaction
            example: 1506635091
          tx_block_index:
            type: integer
            description: Index of transaction within block
            example: 6
          tx_size:
            type: integer
            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: integer
            description: Slot before which transaction cannot be validated (if supplied, else null)
            nullable: true
          invalid_after:
            type: integer
            description: Slot after which transaction cannot be validated
            example: 42332172
            nullable: true
          collateral_inputs:
            $ref: "#/components/schemas/tx_info/items/properties/outputs"
            description: An array of collateral inputs needed for smart contracts in case of contract failure
          collateral_output:
            $ref: "#/components/schemas/tx_info/items/properties/outputs/items"
            description: A collateral output for change if the smart contract fails to execute and collateral inputs are spent. (CIP-40)
            nullable: true
          reference_inputs:
            $ref: "#/components/schemas/tx_info/items/properties/outputs"
            description: An array of reference inputs. A reference input allows looking at an output without spending it. (CIP-31)
          inputs:
            $ref: "#/components/schemas/tx_info/items/properties/outputs"
            description: An array of UTxO inputs spent in the transaction
          outputs:
            type: array
            description: An array of UTxO outputs created by the transaction
            items:
              type: object
              properties:
                payment_addr:
                  type: object
                  properties:
                    bech32:
                      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:
                  nullable: true
                  allOf:
                  - $ref: "#/components/schemas/account_history/items/properties/stake_address"
                tx_hash:
                  type: string
                  description: Hash of transaction for UTxO
                  example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e
                tx_index:
                  type: integer
                  description: Index of UTxO in the transaction 
                  example: 0
                value:
                  type: string
                  description: Total sum of ADA on the UTxO
                  example: 157832856
                datum_hash:
                  type: string
                  nullable: true
                  description: Hash of datum (if any) connected to UTxO 
                  example: 30c16dd243324cf9d90ffcf211b9e0f2117a7dc28d17e85927dfe2af3328e5c9
                inline_datum:
                  type: object
                  nullable: true
                  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
                  nullable: true
                  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: integer
                      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
                      nullable: true
                      description: Value (json)
                      example: null
                asset_list:
                  type: array
                  nullable: true
                  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"
                      quantity:
                        type: string
                        description: Quantity of assets on the UTxO
                        example: 1
          withdrawals:
            type: array
            description: Array of withdrawals with-in a transaction
            nullable: true
            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
            description: Array of minted assets with-in a transaction
            nullable: true
            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"
                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
            nullable: true
            description: Certificates present with-in a transaction (if any)
            items:
              properties:
                index:
                  type: integer
                  nullable: true
                  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
                  description: A JSON array containing information from the certificate
                  nullable: true
                  example:
                    {
                      "stake_address": "stake1uxggf4shfvpghcangm67ky0q4zlc3xn7gezy0auhxczu3pslm9wrj",
                      "pool": "pool1k53pf4wzn263c08e3wr3gttndfecm9f4uzekgctcx947vt7fh2p",
                    }
          native_scripts:
            type: array
            nullable: true
            description: Native scripts present in a transaction (if any)
            items:
              properties:
                script_hash:
                  $ref: "#/components/schemas/plutus_script_list/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
            description: Plutus contracts present in transaction (if any)
            items:
              properties:
                address:
                  type: string
                  description: Plutus script address
                  example: addr1w999n67e86jn6xal07pzxtrmqynspgx0fwmcmpua4wc6yzsxpljz3
                script_hash:
                  $ref: "#/components/schemas/plutus_script_list/items/properties/script_hash"
                bytecode:
                  type: string
                  description: CBOR-encoded Plutus script data
                  example: 5911ea010000332333222332233223322332232323332223233322232333333332222222232333222323333222232323322323332223233322232323322332232323333322222332233223322332233223322223223223232533530333330083333573466e1cd55cea8032400046460a000264646464646666ae68cdc39aab9d5004480008cccc8888cccc16c01000c008004dd71aba15004375c6ae85400cdd71aba15002375a6ae84d5d1280111a8279a982819ab9c491035054310005149926135744a00226ae8940044d55cf280089baa001357426aae79401c8d4124d4c128cd5ce2481035054310004b499263333573466e1d40112002205323333573466e1d40152000205523504a35304b335738921035054310004c49926498cccd5cd19b8735573aa004900011980599191919191919191919191999ab9a3370e6aae754029200023333333333019335027232323333573466e1cd55cea8012400046603e60746ae854008c0b0d5d09aba2500223505935305a3357389201035054310005b49926135573ca00226ea8004d5d0a80519a8138141aba150093335502e75ca05a6ae854020ccd540b9d728169aba1500733502704335742a00c66a04e66aa0a8098eb4d5d0a8029919191999ab9a3370e6aae754009200023350213232323333573466e1cd55cea80124000466a05266a084eb4d5d0a80118239aba135744a00446a0ba6a60bc66ae712401035054310005f49926135573ca00226ea8004d5d0a8011919191999ab9a3370e6aae7540092000233502733504275a6ae854008c11cd5d09aba2500223505d35305e3357389201035054310005f49926135573ca00226ea8004d5d09aba2500223505935305a3357389201035054310005b49926135573ca00226ea8004d5d0a80219a813bae35742a00666a04e66aa0a8eb88004d5d0a801181c9aba135744a00446a0aa6a60ac66ae71241035054310005749926135744a00226ae8940044d5d1280089aba25001135744a00226ae8940044d5d1280089aba25001135573ca00226ea8004d5d0a8011919191999ab9a3370ea00290031180f181d9aba135573ca00646666ae68cdc3a801240084603a608a6ae84d55cf280211999ab9a3370ea00690011180e98181aba135573ca00a46666ae68cdc3a80224000460406eb8d5d09aab9e50062350503530513357389201035054310005249926499264984d55cea80089baa001357426ae8940088d4124d4c128cd5ce249035054310004b49926104a1350483530493357389201035054350004a4984d55cf280089baa001135573a6ea80044dd50009109198008018011000911111111109199999999980080580500480400380300280200180110009109198008018011000891091980080180109000891091980080180109000891091980080180109000909111180200290911118018029091111801002909111180080290008919118011bac0013200135503b2233335573e0024a01c466a01a60086ae84008c00cd5d100101991919191999ab9a3370e6aae75400d200023330073232323333573466e1cd55cea8012400046601a60626ae854008cd404c0b4d5d09aba25002235036353037335738921035054310003849926135573ca00226ea8004d5d0a801999aa805bae500a35742a00466a01eeb8d5d09aba25002235032353033335738921035054310003449926135744a00226aae7940044dd50009110919980080200180110009109198008018011000899aa800bae75a224464460046eac004c8004d540d488c8cccd55cf80112804919a80419aa81898031aab9d5002300535573ca00460086ae8800c0b84d5d08008891001091091198008020018900089119191999ab9a3370ea002900011a80418029aba135573ca00646666ae68cdc3a801240044a01046a0526a605466ae712401035054310002b499264984d55cea80089baa001121223002003112200112001232323333573466e1cd55cea8012400046600c600e6ae854008dd69aba135744a00446a0466a604866ae71241035054310002549926135573ca00226ea80048848cc00400c00880048c8cccd5cd19b8735573aa002900011bae357426aae7940088d407cd4c080cd5ce24810350543100021499261375400224464646666ae68cdc3a800a40084a00e46666ae68cdc3a8012400446a014600c6ae84d55cf280211999ab9a3370ea00690001280511a8111a981199ab9c490103505431000244992649926135573aa00226ea8004484888c00c0104488800844888004480048c8cccd5cd19b8750014800880188cccd5cd19b8750024800080188d4068d4c06ccd5ce249035054310001c499264984d55ce9baa0011220021220012001232323232323333573466e1d4005200c200b23333573466e1d4009200a200d23333573466e1d400d200823300b375c6ae854014dd69aba135744a00a46666ae68cdc3a8022400c46601a6eb8d5d0a8039bae357426ae89401c8cccd5cd19b875005480108cc048c050d5d0a8049bae357426ae8940248cccd5cd19b875006480088c050c054d5d09aab9e500b23333573466e1d401d2000230133016357426aae7940308d407cd4c080cd5ce2481035054310002149926499264992649926135573aa00826aae79400c4d55cf280109aab9e500113754002424444444600e01044244444446600c012010424444444600a010244444440082444444400644244444446600401201044244444446600201201040024646464646666ae68cdc3a800a400446660106eb4d5d0a8021bad35742a0066eb4d5d09aba2500323333573466e1d400920002300a300b357426aae7940188d4040d4c044cd5ce2490350543100012499264984d55cea80189aba25001135573ca00226ea80048488c00800c888488ccc00401401000c80048c8c8cccd5cd19b875001480088c018dd71aba135573ca00646666ae68cdc3a80124000460106eb8d5d09aab9e500423500a35300b3357389201035054310000c499264984d55cea80089baa001212230020032122300100320011122232323333573466e1cd55cea80124000466aa016600c6ae854008c014d5d09aba25002235007353008335738921035054310000949926135573ca00226ea8004498480048004448848cc00400c008448004848c0040088004888848cccc00401401000c00880044880084880048004448c8c00400488cc00cc008008004c8ccc888c8c8cc88cc88ccc888c8c8c8c8cc88c8c8cc88c8cccc8888c8c8c8c8c8c8c8c8ccc888c8ccc888ccc888cccccccc88888888cc88ccccc88888cccc8888cc88cc88cc88ccc888cc88cc88cc88cc88cc88c8c8c8cc88c8c8c8c8c8c8cc88c8c8c8c8c8c8cc888c888c8c94cd4c1240104cc0352401297369676e617475726520646f6573206e6f74206d617463682063726561746f7220696e20646174756d0033223530200022222222222533535032333553068120015027253353079333573466e3c0300041ec1e84d40d4004540d000c841ec41e54008c04540144cc054cc03524012f65787065637465642063726561746f7220746f2067657420616c6c206f66207768617420736865206f72646572656400330153350133335500e305c12001504f350481223335501b2253353070333505006353353502a3235302900122335304c0022350300012502f300e00221001132635300b335738920117696e76616c6964207075626c6963206b657920686173680000c498c05540244cc010c0340080044004004c8d4c08400488888888880254010ccd41354138c1894014c04920c08db7013350133335500e305c12001504f350481223335501b22533530703005002133004335506500d30100020011001001300d5004333504d504e30625005333504d504e533535026301a00321300a300d0011630124830236dc04cc0352401276f6e6c79206d617463686573206f66207061697273206f66206f726465727320616c6c6f77656400533535063350481223335501b225335307030050021330040020011001001300d50041306a162215335350650011306c16221533535067001107222130701623253353502732353024001222001500121333504e223530280022235302a0032232335304e0052335304f004253353077333573466e3c0080041e41e05400c41e081e08cd4c13c01081e094cd4c1dcccd5cd19b8f002001079078150031078153353502e0032153353502f00221335304c0022335304d002233530510022335305200223306d002001207b23353052002207b23306d00200122207b222335304f004207b2225335307c333573466e1c01800c1f81f454cd4c1f0ccd5cd19b8700500207e07d1333573466e1c0100041f81f441f441f441d854cd4d40b8004841d841d8c03140094cd4d40a0c07001484cd54190034c03c0045841b84c0300044d4c068004880084d4c02800480044800480048d4c0680048880088d4c06400488800c8d4c05000488888888880288d4c05400488004894cd4c184004418c4cd5ce001031089119aa8011a82600090009091800801100091a982c0009111002119a82999aa82b245003350533355056489000015054505412233355304b120013500550032353550560012233355304e120013500850062353550590012233353550490012330614800000488cc1880080048cc184005200000133040002001133500400105a22533530590021001105a123350492233353500400322002002001353500200122001122123300100300212001112232001320013550582253353504e00110032213300600230040012353003001223530070022222222222533335302600b21501b21501b21501b2133355305012001500f2353015001225335306353353063333573466e3cd4c0bc00888008d4c0bc010880081941904ccd5cd19b8735302f0022200135302f00422001065064106413501f0031501e00b13350432253353500d002210031001500c2212330010030022001222222222212333333333300100b00a009008007006005004003002200122123300100300220012221233300100400300220012212330010030022001121223002003112200112001122123300100300212001122123300100300212001122123300100300212001121222300300411222002112220011200121222230040052122223003005212222300200521222230010052001221233001003002200121222222230070082212222222330060090082122222223005008122222220041222222200322122222223300200900822122222223300100900820012122300200322212233300100500400320012122300200321223001003200112335001501d501e1220021220012001120011200113002012133500b2233300301300200150162223355300e1200123535501a00122335501d002335530111200123535501d001223355020002333535500d00123300a4800000488cc02c0080048cc028005200000133004002001223355300c1200123535501800122335501b00233353550080012335530101200123535501c00122335501f00235500f001001223335550080150020012335530101200123535501c00122335501f00235500d0010013335550030100020011112223335530041200150153355300c1200123535501800122335501b00235500b0013335530041200122353550190022253353021333553011120013500d33500f22533530230021025100102223535501c001223300a0020050061003133501900400350160013355300c120012353550180012232335501c00330010053200135502322533535019001135500b0032213535501e00222533530263300c00200813355010007001130060030023200135501c221122253353501500110022213300500233355300712001005004001112122230030041122122233002005004112122230010041120011233500722333535004003220020020013535002001220011221233001003002120013200135501422112253353500c0011500e22133500f3004002335530061200100400132001355013221122253353500c00113535006003220012213335350080052200230040023335530071200100500400112212330010030021200122333573466e3c00800404404088cdc000100088911801000919991119a80319aa80480199a80319aa804801000a803a8039a980380091110019a980380091110011a98038009111000889100109109119800802001890008891091980080180108900091110919998008028020018011000900211199ab9a3371000400200800a244004244002400222464600200244660066004004003
                size:
                  type: integer
                  description: The size of the CBOR serialised script (in bytes)
                  example: 234895
                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"
                output:
                  type: object
                  nullable: true
                  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:
      type: array
      items:
        properties:
          tx_hash:
            $ref: "#/components/schemas/tx_info/items/properties/tx_hash"
          inputs:
            $ref: "#/components/schemas/tx_info/items/properties/inputs"
          outputs:
            $ref: "#/components/schemas/tx_info/items/properties/outputs"
    tx_metadata:
      type: array
      nullable: true
      items:
        properties:
          tx_hash:
            $ref: "#/components/schemas/tx_info/items/properties/tx_hash"
          metadata:
            type: object
            nullable: true
            description: A JSON array containing details about metadata within transaction
            example:
              {
                "721":
                  {
                    "version": 1,
                    "copyright": "...",
                    "publisher": ["p...o"],
                    "4bf184e01e0f163296ab253edd60774e2d34367d0e7b6cbc689b567d":
                      {},
                  },
              }
    tx_status:
      type: array
      items:
        properties:
          tx_hash:
            $ref: "#/components/schemas/tx_info/items/properties/tx_hash"
          num_confirmations:
            type: integer
            description: Number of block confirmations
            example: 17
            nullable: true
    tx_metalabels:
      type: array
      items:
        properties:
          key:
            type: string
            description: A distinct known metalabel
            example: "721"
    asset_list:
      type: array
      description: Array of policy IDs and asset names
      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_address_list:
      type: array
      description: An array of payment addresses holding the given token (including balances)
      items:
        properties:
          payment_address:
            type: string
            description: A Cardano payment/base address (bech32 encoded) for transaction's input UTxO
            example: addr1qxkfe8s6m8qt5436lec3f0320hrmpppwqgs2gah4360krvyssntpwjcz303mx3h4avg7p29l3zd8u3jyglmewds9ezrqdc3cxp
          quantity:
            type: string
            description: Asset balance on the payment address
            example: 23
    asset_summary:
      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: integer
            description: Total number of transactions including the given asset
            example: 89416
          staked_wallets:
            type: integer
            description: Total number of registered wallets holding the given asset
            example: 548
          unstaked_addresses:
            type: integer
            description: Total number of payment addresses (not belonging to registered wallets) holding the given asset
            example: 245
    asset_info:
      type: array
      items:
        properties:
          policy_id:
            type: string
            description: Asset Policy ID (hex)
            example: d3501d9531fcc25e3ca4b6429318c2cc374dbdbcf5e99c1c1e5da1ff
          asset_name:
            type: string
            nullable: true
            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 first mint transaction
            example: cb07b7e51b77079776c4a78f2daf8f14f9945d2b047da7bfcb71d7fbb9f86712
          mint_cnt:
            type: integer
            description: Count of total mint transactions
            example: 1
          burn_cnt:
            type: integer
            description: Count of total burn transactions
            example: 5
          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
            description: Asset metadata registered on the Cardano Token Registry
            nullable: true
            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: integer
                example: 0
          total_supply:
            type: string
            example: "35000"
          creation_time:
            type: integer
            description: UNIX timestamp of the first asset mint
            example: 1506635091
    asset_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
            description: Array of all mint/burn transactions for an asset
            nullable: true
            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"
    asset_policy_info:
      type: array
      description: List of policy assets
      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_metadata:
            $ref: "#/components/schemas/asset_info/items/properties/minting_tx_metadata"
          token_registry_metadata:
            $ref: "#/components/schemas/asset_info/items/properties/token_registry_metadata"
          total_supply:
            type: string
            example: "35000"
          creation_time:
            type: string
            $ref: "#/components/schemas/asset_info/items/properties/creation_time"
    asset_txs:
      type: array
      description: An array of Tx hashes that included the given asset (latest first)
      items:
        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"
    native_script_list:
      type: array
      items:
        properties:
          script_hash:
            $ref: "#/components/schemas/plutus_script_list/items/properties/script_hash"
          creation_tx_hash:
            $ref: "#/components/schemas/plutus_script_list/items/properties/creation_tx_hash"
          type:
            type: string
            description: Type of the script
            enum: ["timelock", "multisig"]
            example: timelock
    plutus_script_list:
      type: array
      items:
        properties:
          script_hash:
            type: string
            description: Hash of a script
            example: d8480dc869b94b80e81ec91b0abe307279311fe0e7001a9488f61ff8
          creation_tx_hash:
            type: string
            description: Hash of the script creation transaction
            example: fda6c7697009237975ffc30f36666addf4c6e2a2c6f90411a24431b700baaab1
    script_redeemers:
      type: array
      items:
        type: object
        properties:
          script_hash:
            type: string
            description: Hash of Transaction for which details are being shown
            example: f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e
          redeemers:
            type: array
            items:
              type: object
              properties:
                tx_hash:
                  type: string
                  description: Hash of Transaction containing the redeemer
                  example: fda6c7697009237975ffc30f36666addf4c6e2a2c6f90411a24431b700baaab1
                tx_index:
                  type: integer
                  description: The index of the redeemer pointer in the transaction
                  example: 0
                unit_mem:
                  description: The budget in Memory to run a script
                  example: 520448
                  nullable: true
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: integer
                unit_steps:
                  description: The budget in Cpu steps to run a script
                  example: 211535239
                  nullable: true
                  additionalProperties:
                    oneOf:
                      - type: string
                      - type: integer
                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
                  description: The Hash of the Plutus Data
                  nullable: true
                  example: 5a595ce795815e81d22a1a522cf3987d546dc5bb016de61b002edd63a5413ec4
                datum_value:
                  type: object
                  description: The actual data in json format
                  example: { "bytes": "3c33" }
    datum_info:
      type: array
      items:
        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"
          bytes:
            $ref: "#/components/schemas/tx_info/items/properties/outputs/items/properties/inline_datum/properties/bytes"
  headers: {}
  responses:
    OK:
      description: Success!
    NotFound:
      description: The server does not recognise the combination of endpoint and parameters provided
    Unauthorized:
      description: The selected server has restricted the endpoint to be only usable via authentication. The authentication supplied was not authorized to access the endpoint
    PartialContent:
      description: The result was truncated
    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: Address
    description: Query information about specific address(es)
    x-tag-expanded: false
  - name: Account
    description: Query details about specific stake account addresses
    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: []