概要
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: インデックス化されたブロックチェーンデータに対してSQLクエリを実行し、テーブルのスキーマを取得します。
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.
一般的なワークフローには、次のようなものがあります：
- Create or manage endpoints with the Admin API.
- Make on-chain JSON-RPC calls to any supported network.
- ストリームを作成し、フィルタリング済みのオンチェーンデータをWebhookの宛先に配信します。
- 処理状態やウォッチリストをキーバリューストアに保存する。
- Create webhooks from templates and manage their lifecycle.
- SQL Explorer を使用して、インデックス化されたブロックチェーンデータに対して SQL クエリを実行します。
- Build agent workflows that can inspect account state, provision resources, and clean up test infrastructure.
パッケージ
| 言語 | パッケージ | インストール |
|---|---|---|
| Node.js / TypeScript | @quicknode/sdk | npm install @quicknode/sdk |
| Python | quicknode-sdk | pip install quicknode-sdk |
| Rust | quicknode-sdk | cargo add quicknode-sdk --features rust |
| ルビー | quicknode_sdk | gem install quicknode_sdk |
プラットフォームの対応状況
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.
対応対象
プリコンパイル済みのネイティブモジュールは、以下のプラットフォーム向けに公開されています：
| プラットフォーム | 目標 |
|---|---|
| Linux (glibc) | glibc 2.17 以降上の x86_64、aarch64 (manylinux2014) |
| Linux (musl) | Alpine およびその他の musl ディストリビューションにおける x86_64、aarch64 |
| macOS | Apple Silicon (arm64) |
Linuxのglibcバイナリはglibc 2.17に基づいてビルドされているため、2014年以降にリリースされたあらゆるディストリビューション（RHEL 7以降、Ubuntu 14.04以降、Debian 8以降、Amazon Linux 2以降、SLES 12以降、Fedora 19以降など）で動作します。
対応していません
- 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：プリコンパイル済みのバイナリは公開されていません。WSL2は正常に動作しており、Windows開発者にはこちらを推奨します。
- Intel版 macOS：Apple Silicon のみ対応。
- 古いLinuxディストリビューション：glibcの最低要件を下回るもの：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.
製品クライアント
Construct the SDK once, then use the product clients exposed from that shared configuration.
| クライアント | 目的 | REST API |
|---|---|---|
admin | エンドポイント、チーム、利用状況、ログ、課金、メトリクス、セキュリティ、レート制限 | 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のテンプレート、送信先、ライフサイクル、およびカウント | https://api.quicknode.com/webhooks/rest/v1/ |
kvstore | 永続化された状態のためのセットとリスト | https://api.quicknode.com/kv/rest/v1/ |
sql | インデックス化されたブロックチェーンデータに対するSQLクエリ | https://api.quicknode.com/sql/rest/v1/ |
The SDK entry point is QuicknodeSdk 各言語のバインディングにおいて。Rubyではこれを QuicknodeSdk::SDK.
SQL Explorer のメソッド
その sql クライアントは2つのメソッドを提供しています：
query(sql, clusterId): インデックスが設定されたブロックチェーンデータに対してSQLクエリを実行します。型指定された行とクエリの統計情報（クレジット、スキャンされた行数、読み込まれたバイト数）を返します。getSchema(clusterId): クラスタのテーブルスキーマを取得します。
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");
認証
でAPIキーを作成します。 Quicknode dashboard, then configure the SDK with the QN_SDK__API_KEY 環境変数。
エクスポート QN_SDK__API_KEY="YOUR_API_KEY"
The SDK also supports base URL overrides for local development, staging, and agent sandboxes:
| 環境変数 | デフォルト |
|---|---|
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.
今後の手順
- 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.
皆様からのフィードバックを心よりお待ちしております❤️
Share feedback on missing methods, naming, examples, and agent workflows so we can keep improving the SDK.