@cowprotocol/ts-dune-client
v0.0.2
Published
Node Client for Dune Analytics' officially supported API.
Downloads
431
Keywords
Readme
Dune Client TS
This NPM package implements all the basic routes defined in the Dune API Docs. It also introduces a convenience method refresh
which combines execute
, getStatus
and getResults
in a way that makes it nearly trivial to fetch query execution results.
Install the package
yarn add @cowprotocol/ts-dune-client
import { QueryParameter, DuneClient } from "@cowprotocol/ts-dune-client";
const { DUNE_API_KEY } = process.env;
const client = new DuneClient(DUNE_API_KEY ?? "");
const queryID = 1215383;
const parameters = [
QueryParameter.text("TextField", "Plain Text"),
QueryParameter.number("NumberField", 3.1415926535),
QueryParameter.date("DateField", "2022-05-04 00:00:00"),
QueryParameter.enum("ListField", "Option 1"),
];
client
.refresh(queryID, parameters)
.then((executionResult) => console.log(executionResult.result?.rows));
// should look like
// [
// {
// date_field: "2022-05-04 00:00:00",
// list_field: "Option 1",
// number_field: "3.1415926535",
// text_field: "Plain Text",
// },
// ]
Note also that the client has methods execute
, getStatus
, getResult
and cancelExecution
Check out this Demo Project!