Skip to content

zeriontech/defi-sdk-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0e038a8 · Dec 19, 2024
Apr 22, 2021
Nov 7, 2024
Dec 19, 2024
May 4, 2021
May 13, 2021
May 6, 2021
May 4, 2021
May 1, 2021
May 26, 2020
May 4, 2021
Nov 8, 2022
Nov 7, 2024
Nov 7, 2024
May 4, 2021

Repository files navigation

defi-sdk

A JS client for interacting with Zerion API

Install

npm install defi-sdk

Getting Started

import { client } from "defi-sdk";

client.configure({ url: endpoint, apiToken: API_TOKEN });

API

General usage

client.subscribe(options)

import { client } from "defi-sdk";

client.subscribe({
  namespace: "assets",
  body: {
    scope: ["prices"],
    payload: { asset_codes: ["eth"], currency: "usd" }
  },
  onMessage: (event: Event, data: Response) => {
    /* handle data */
  }
});

Domain Helpers

Instead of calling client.subscribe and passing type information manually, the SDK provides helpers for most of the existing request scopes

addressAssets

import { client } from "defi-sdk";

client.addressAssets({
  payload: { asset_codes: ["eth"], currency: "usd" },
  onData: data => {
    /* handle data */
  }
});

Types

Request

interface Request<T, ScopeName extends string> {
  scope: ScopeName[];
  payload: T;
}

Response

interface Response<T> {
  meta: any;
  payload: T;
}

See Response in Zerion Docs

License

MIT License, see the included LICENSE file.