TypeScript Client for Kupo blockchain indexer

Automatically generated Openapi-fetch client for Kupo based on schema.yaml OpenAPI schema.

Installation

To install the client with Yarn, run:

yarn install cardano-kupo-client

To install the client with NPM, run:

npm i cardano-kupo-client

Usage

import KupoClient from "cardano-kupo-client"

const client = KupoClient("https://graph.xray.app/output/services/kupo/mainnet/api/v1")

const app = async () => {
  const health = await client.GET("/health")

  if (health.data) {
    console.log(health.data)
  }
  if (health.error) {
    console.error(health.error)
  }
}

app()

Endpoints

• Check OpenAPI fetch documentations for available endpoint parameters: https://openapi-ts.pages.dev/openapi-fetch/
• The client uses OpenAPI definitions from the Kupo configuration: nightly.yaml
• A complete list of endpoints can be found here (RapiDoc): https://cardanosolutions.github.io/kupo

API URLs

Managed by XRAY/Network (XRAY/Graph, Cloudflare WAF & Load Balancer), requires paid subscription

https://graph.xray.app/output/services/kupo/mainnet/api/v1

https://graph.xray.app/output/services/kupo/preprod/api/v1

https://graph.xray.app/output/services/kupo/preview/api/v1