Overzicht
The SDK is a single SDK for working with Quicknode product APIs from the language you already use: Rust, Python, Node.js, and Ruby.
Use it to build Quicknode product workflows, operational services, scripts, and AI agents that need typed access to:
- Admin API: Manage endpoints, usage, billing, teams, endpoint security, rate limits, logs, metrics, and account tags.
- RPC: Make on-chain JSON-RPC calls to any supported network without provisioning an endpoint.
- Streams: Create, update, pause, activate, test, and delete Streams.
- Webhooks: Create and manage webhook subscriptions from Quicknode webhook templates.
- Key-Value Store: Store and retrieve sets and lists for application state, stream filters, watchlists, cursors, and agent memory.
- SQL Explorer: Voer SQL-query's uit op geïndexeerde blockchain-gegevens en haal tabelschema's op.
Complete reference for developers and agents building with the SDK:
When to use the SDK
Use the SDK when you want one consistent client for Quicknode product APIs, especially when your app or agent needs to coordinate multiple products in one workflow.
Veelvoorkomende werkprocessen zijn onder meer:
- Create or manage endpoints with the Admin API.
- Make on-chain JSON-RPC calls to any supported network.
- Maak een stream aan en stuur gefilterde on-chain-gegevens naar een webhook-bestemming.
- Sla de verwerkingsstatus of watchlists op in de Key-Value Store.
- Create webhooks from templates and manage their lifecycle.
- Voer met SQL Explorer SQL-query’s uit op geïndexeerde blockchain-gegevens.
- Build agent workflows that can inspect account state, provision resources, and clean up test infrastructure.
Pakketten
| Taal | Verpakking | Installeren |
|---|---|---|
| Node.js / TypeScript | @quicknode/sdk | npm install @quicknode/sdk |
| Python | quicknode-sdk | pip install quicknode-sdk |
| Roest | quicknode-sdk | cargo add quicknode-sdk --features rust |
| Ruby | quicknode_sdk | gem install quicknode_sdk |
Platformondersteuning
The SDK is built around a shared Rust core with bindings for specific languages. The core compiles to native libraries for each supported platform, giving you predictable performance and a small dependency footprint. The trade-off is that we publish binaries for a specific set of targets rather than running in every environment our host languages support.
Ondersteunde doelen
Er worden vooraf gecompileerde native modules gepubliceerd voor:
| Platform | Doelstellingen |
|---|---|
| Linux (glibc) | x86_64, aarch64 op glibc 2.17+ (manylinux2014) |
| Linux (musl) | x86_64, aarch64 op Alpine en andere musl-distributies |
| macOS | Apple Silicon (arm64) |
De Linux glibc-binaire bestanden zijn gebouwd op basis van glibc 2.17, waardoor ze op elke distributie werken die vanaf 2014 is uitgebracht, waaronder RHEL 7+, Ubuntu 14.04+, Debian 8+, Amazon Linux 2+, SLES 12+ en Fedora 19+.
Niet ondersteund
- Browsers: The SDK is not browser-compatible. It uses a Rust core through native bindings, which require Node.js or another runtime that supports native add-ons. Standard browser bundles cannot load these bindings.
- Windows: Er is geen voorgecompileerd binaire bestand beschikbaar. WSL2 werkt en is de aanbevolen methode voor Windows-ontwikkelaars.
- Intel macOS: uitsluitend Apple Silicon.
- Oudere Linux-distributies: onder de glibc-drempel: RHEL/CentOS 6 (glibc 2.12), Debian 7 (glibc 2.13), Ubuntu 12.04 (glibc 2.15), SLES 11 (glibc 2.11).
On an unsupported platform, importing the SDK fails fast at load time with an error listing the available targets. The failure surfaces at install or import, not at first call.
Productklanten
Construct the SDK once, then use the product clients exposed from that shared configuration.
| Klant | Doel | REST-API |
|---|---|---|
admin | Eindpunten, teams, gebruik, logbestanden, facturering, statistieken, beveiliging en tarieflimieten | https://api.quicknode.com/v0/ |
rpc | On-chain JSON-RPC calls to any supported network via Tooling Access | Account Tooling Access endpoint |
streams | Streams creation, updates, lifecycle, and filter testing | https://api.quicknode.com/streams/rest/v1/ |
webhooks | Webhook-sjablonen, bestemmingen, levenscyclus en aantallen | https://api.quicknode.com/webhooks/rest/v1/ |
kvstore | Sets en lijsten voor een permanente status | https://api.quicknode.com/kv/rest/v1/ |
sql | SQL-query’s op geïndexeerde blockchain-gegevens | https://api.quicknode.com/sql/rest/v1/ |
The SDK entry point is QuicknodeSdk in elke taalbinding. Ruby stelt het beschikbaar als QuicknodeSdk::SDK.
Methoden van SQL Explorer
De sql De client biedt twee methoden:
query(sql, clusterId): Voer een SQL-query uit op geïndexeerde blockchain-gegevens. Geeft getypeerde rijen en querystatistieken terug (credits, gescande rijen, gelezen bytes).getSchema(clusterId): Haal het tabelschema voor een cluster op.
const qn = new QuicknodeSdk();
// Run a SQL query
const resp = await qn.sql.query(
"SELECT action_type, user FROM hyperliquid_system_actions LIMIT 3",
"hyperliquid-core-mainnet"
);
console.log(`${resp.rows} rows, ${resp.credits} credits`);
// Get the schema for a cluster
const schema = await qn.sql.getSchema("hyperliquid-core-mainnet");
Authenticatie
Maak een API-sleutel aan in de Quicknode dashboard, then configure the SDK with the QN_SDK__API_KEY omgevingsvariabele.
exporteren QN_SDK__API_KEY="UW_API_SLEUTEL"
The SDK also supports base URL overrides for local development, staging, and agent sandboxes:
| Omgevingsvariabele | Standaard |
|---|---|
QN_SDK__ADMIN__BASE_URL | https://api.quicknode.com/v0/ |
QN_SDK__STREAMS__BASE_URL | https://api.quicknode.com/streams/rest/v1/ |
QN_SDK__WEBHOOKS__BASE_URL | https://api.quicknode.com/webhooks/rest/v1/ |
QN_SDK__KVSTORE__BASE_URL | https://api.quicknode.com/kv/rest/v1/ |
QN_SDK__SQL__BASE_URL | https://api.quicknode.com/sql/rest/v1/ |
QN_SDK__HTTP__TIMEOUT_SECS | 30 |
For agents
The SDK is designed to be useful for humans and agents. Agents can initialize one SDK handle, reuse the same credentials across product clients, and rely on typed method inputs and responses instead of composing raw REST calls for each workflow.
Volgende stappen
- Start with the QuickStart to install and initialize the SDK.
- Use Examples to see Admin API, RPC & Tooling Access, Streams, Webhooks, and Key-Value Store workflows.
- Refer to the product API docs for complete endpoint behavior: Admin API, Streams, Webhooks, Key-Value Store, and SQL Explorer.
We ❤️ feedback
Share feedback on missing methods, naming, examples, and agent workflows so we can keep improving the SDK.