Koios-tiny-client NPM

Automatically generated Axios-based client for Koios Cardano RESTful API based on koiosapi.yaml schema. Works great with raygraph-output (a dockered Koios-based & DB Sync Cardano API solution extended by Postgraphile) and the original Koios. Visit RayGraph.io for more information.

Installation

To install the client with Yarn, run:

yarn install koios-tiny-client

To install the client with NPM, run:

npm i koios-tiny-client

Usage

Request Types Response Types

import KoiosTinyClient from "koios-tiny-client"

const { client, methods: Koios } = new KoiosTinyClient("https://api.koios.rest/api/v0")

// async call
const app = async () => {
  const Tip = await Koios.Tip()
  if (Tip.success) {
    console.log(Tip.success.data[0].block_no)
  }
  if (Tip.error) {
    console.error(Tip.error)
  }
}

app()

Advanced Usage

const { methods: Koios } = new KoiosTinyClient("https://api.koios.rest/api/v0")

// simple offset limit
const Blocks = await Koios.Blocks("&offset=10&limit=5")
console.log(Blocks)

// advanced pagination
const headers = { Prefer: "count=estimated" } // get the exact "content-range" header in the request
const PoolListFirst5Items = await Koios.PoolList("&limit=5", headers)
if (PoolListFirst5Items.success) {
  const contentRange = PoolListFirst5Items.success.headers?.["content-range"] || ""
  const [currentPosition, totalItems] = contentRange.split('/')
  const queryRange = `${Number(totalItems) - 5}-${Number(totalItems)}`
  const PoolListLast5Items = await Koios.PoolList(undefined, { ...headers, Range: queryRange})
  console.log(PoolListLast5Items)
}

const { client, methods: Koios } = new KoiosTinyClient("https://api.koios.rest/api/v0")

// your response interceptor, used as default shown in the example below
client.interceptors.response.use(
  (response: AxiosResponse): any => {
    return {
      success: response,
    }
  },
  (error: AxiosError): { error: AxiosError } => {
    return {
      error,
    }
  }
)

// your request interceptor
client.interceptors.request.use(
  // ...
)

const { methods: Koios } = new KoiosTinyClient("https://api.koios.rest/api/v0")

const abortController = new AbortController()
setTimeout(() => {
  abortController.abort() // cancel request
  console.log('Aborted!')
}, 200)
const PoolList = await Koios.PoolList(undefined, undefined, abortController.signal)

import KoiosTinyClient, { KoiosTypes } from "koios-tiny-client"

// no error
const correctItem: KoiosTypes.IAssetTokenRegistry = {
  policy_id: "somePolidyId",
  asset_name: "someAssetNameOrNull",
  asset_name_ascii: "someAsciiName",
  ticker: "someTicker",
  description: "someDescription",
  url: "someUrl",
  decimals: 6,
  logo: "someBase64PngString"
}

// error
const wrongItem: KoiosTypes.IAssetTokenRegistry = {
  policy_id: "somePolidyId",
}