Installation

Install the DFlow SDK in your project

Installation

Install the DFlow SDK using your preferred package manager.

pnpm add dflow-sdk

Requirements

  • Node.js 18 or higher
  • TypeScript 5.0+ (recommended)

Peer Dependencies

The SDK uses Solana libraries internally. If you need to interact with the Solana blockchain directly (signing transactions, reading positions), you may want to install:

pnpm add @solana/web3.js @solana/spl-token

These packages are included as dependencies in the SDK, but you may want to install them explicitly for type definitions and direct usage.

Verify Installation

Create a simple test file to verify the installation:

test.ts
import { DFlowClient } from 'dflow-sdk';
 
const dflow = new DFlowClient();
 
async function test() {
  const series = await dflow.series.getSeries();
  console.log(`Found ${series.length} series`);
}
 
test();

Run it:

npx tsx test.ts

Next Steps

Once installed, head to the Quickstart guide to make your first API calls.

On this page