개요

This QuickStart shows how to install the Quicknode SDK, configure an API key, and make your first product API request.

Create one configured SDK instance, then use the product clients attached to that instance. Your API key, timeouts, and optional base URL overrides are shared across every client, so scripts, services, and agents can move between Quicknode products without rebuilding authentication or HTTP configuration.

• qn.admin: Manage endpoints, teams, usage, billing, logs, metrics, security, rate limits, and tags.
• qn.rpc: Send JSON-RPC requests to the account's Tooling Access endpoint; session JWTs are minted and refreshed per call.
• qn.streams: Create, list, update, pause, activate, test, and delete Streams.
• qn.webhooks: Manage webhook templates, destinations, lifecycle actions, and enabled counts.
• qn.kvstore: Store and retrieve sets and lists for cursors, watchlists, filters, and lightweight agent state.
• qn.sql: Run SQL queries against indexed blockchain data and retrieve table schemas.

필수 조건

Before you begin, create a Quicknode API key from the Quicknode dashboard. Agents can also create their own API keys, to learn more check out Agent Subscriptions.

Then set it in your environment:

export QN_SDK__API_KEY="YOUR_API_KEY"

Install

The SDK ships precompiled binaries for Linux (glibc and musl, x86_64 and aarch64) and macOS Apple Silicon. Browsers, Windows (use WSL2), and Intel macOS are not supported. See Platform support for the full matrix.

Node.js

npm 설치 @quicknode/sdk

The Node.js package supports TypeScript, CommonJS, ES modules, and Bun.

파이썬

pip install quicknode-sdk

The Python package requires Python 3.11 or newer.

Rust

cargo add quicknode-sdk

루비

gem install quicknode_sdk

Make your first request

List the endpoints available to your account with the Admin API client.

Node.js

import { QuicknodeSdk } from "@quicknode/sdk";

const qn = QuicknodeSdk.fromEnv();
const response = await qn.admin.getEndpoints({ limit: 20 });

console.log(response.data);

파이썬

import asyncio
from quicknode_sdk import QuicknodeSdk

async def main():
    qn = QuicknodeSdk.from_env()
    response = await qn.admin.get_endpoints(limit=20)
    print(response.data)

asyncio.run(main())

Rust

use quicknode_sdk::QuicknodeSdk;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let qn = QuicknodeSdk::from_env()?;
    let response = qn.admin.get_endpoints(&Default::default()).await?;

    println!("{:?}", response.data);
    Ok(())
}

루비

require "quicknode_sdk"

qn = QuicknodeSdk::SDK.from_env
response = qn.admin.get_endpoints(limit: 20)

puts response["data"]

Configure directly

You can also pass in a configuration directly instead of using default environment variables.

Node.js

import { QuicknodeSdk } from "@quicknode/sdk";

const qn = new QuicknodeSdk({
  apiKey: "YOUR_API_KEY",
  http: {
    timeoutSecs: 30,
  },
});

파이썬

from quicknode_sdk import HttpConfig, QuicknodeSdk, SdkFullConfig

qn = QuicknodeSdk(
    SdkFullConfig(
        api_key="YOUR_API_KEY",
        http=HttpConfig(timeout_secs=30),
    )
)

Rust

use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};

let qn = QuicknodeSdk::new(
    &SdkFullConfig::builder()
        .api_key("YOUR_API_KEY")
        .build(),
)?;

루비

require "quicknode_sdk"

qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")

Environment variables

변수	Required	Default	설명
QN_SDK__API_KEY	네	없음	Your Quicknode API key
QN_SDK__HTTP__TIMEOUT_SECS	아니요	30	HTTP request timeout in seconds
QN_SDK__HTTP__POOL_MAX_IDLE_PER_HOST	아니요	없음	Max idle HTTP connections per host
QN_SDK__ADMIN__BASE_URL	아니요	https://api.quicknode.com/v0/	Override the Admin API base URL
QN_SDK__STREAMS__BASE_URL	아니요	https://api.quicknode.com/streams/rest/v1/	Override the Streams API base URL
QN_SDK__WEBHOOKS__BASE_URL	아니요	https://api.quicknode.com/webhooks/rest/v1/	Override the Webhooks API base URL
QN_SDK__KVSTORE__BASE_URL	아니요	https://api.quicknode.com/kv/rest/v1/	Override the Key-Value Store API base URL
QN_SDK__SQL__BASE_URL	아니요	https://api.quicknode.com/sql/rest/v1/	Override the SQL Explorer API base URL

Product clients

Once initializated, a single client gives you access to all Quicknode product APIs:

const endpoints = await qn.admin.getEndpoints();
const blockNumber = await qn.rpc.call("eth_blockNumber");
const streams = await qn.streams.listStreams();
const webhooks = await qn.webhooks.listWebhooks();
const sets = await qn.kvstore.getSets();
const trades = await qn.sql.query("SELECT * FROM hyperliquid_trades LIMIT 5", "hyperliquid-core-mainnet");

Language conventions

Language	Convention
Node.js / TypeScript	Methods are async and use camelCase names. Pass parameters as a single options object.
파이썬	Methods are async and use snake_case names. Pass parameters as keyword arguments.
Rust	Methods are async and return Result types. Request structs use builders where available.
루비	Methods are blocking and use snake_case names. Responses are returned as Ruby hashes; access keys directly.

For complete workflows, see Examples. To review the full behavior for each product API, see the REST API docs for Admin API, Streams, Webhooks, Key-Value Store, and SQL Explorer.