TypeScript

TypeScript/JavaScript SDK for Dune Data API

We have a community client that can be found here.

Installation

To install, run this command:

yarn add @duneanalytics/client-sdk

Or with npm:

npm install @duneanalytics/client-sdk

Currently this client only supports the execution based endpoints, and not Query Endpoints or uploads.

Quick Start

Initialize the client and run a query:

import { QueryParameter, DuneClient } from "@duneanalytics/client-sdk";
const { DUNE_API_KEY } = process.env;

const client = new DuneClient(DUNE_API_KEY ?? "");
const queryID = 1215383;
const params = {
  query_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
  .runQuery(queryID, params)
  .then((executionResult) => console.log(executionResult.result?.rows));

Working with Query Parameters

The SDK provides helper functions for creating typed query parameters:

• QueryParameter.text(name, value) - For text parameters
• QueryParameter.number(name, value) - For number parameters
• QueryParameter.date(name, value) - For date parameters
• QueryParameter.enum(name, value) - For enum/list parameters

Additional Resources

NPM Package

View package on NPM

GitHub Repository

View source code and documentation

Report Issues

Report bugs or request features

API Reference

View full API documentation