quicknode-skill
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseQuicknode Blockchain Infrastructure
Quicknode 区块链基础设施
Intake Questions
接入问题
- Which chain and network should Quicknode target?
- Is this read-only or should I create infrastructure (streams, webhooks, IPFS writes)?
- Does this require real-time streaming (gRPC/Yellowstone/Hypercore) or standard RPC?
- What endpoint or API key should I use (default: , optional
QUICKNODE_RPC_URL/QUICKNODE_WSS_URL)?QUICKNODE_API_KEY - Any constraints (latency, regions, throughput, destinations)?
- Quicknode应指向哪条链和网络?
- 这是只读操作还是需要创建基础设施(流、Webhook、IPFS写入)?
- 是否需要实时流(gRPC/Yellowstone/Hypercore)还是标准RPC?
- 应使用哪个端点或API密钥(默认:,可选
QUICKNODE_RPC_URL/QUICKNODE_WSS_URL)?QUICKNODE_API_KEY - 有任何约束条件吗(延迟、区域、吞吐量、目标地址)?
Safety Defaults
安全默认设置
- Default to testnet/devnet when a network is not specified.
- Prefer read-only operations and dry runs before creating resources.
- Never ask for or accept private keys or secret keys.
- 未指定网络时,默认使用测试网/开发网。
- 优先选择只读操作,在创建资源前先进行试运行。
- 绝不索要或接受私钥或密钥。
Confirm Before Write
写入前确认
- Require explicit confirmation before creating or modifying Streams, Webhooks, or IPFS uploads.
- If confirmation is missing, return the exact API payload for review.
- 创建或修改Streams、Webhooks或IPFS上传前,需要明确的确认。
- 如果缺少确认,返回完整的API负载供审核。
Quick Reference
快速参考
| Product | Description | Use Case |
|---|---|---|
| RPC Endpoints | High-performance blockchain access | dApp backend, wallet interactions |
| Streams | Real-time & historical blockchain data pipelines | Event monitoring, analytics, indexing |
| Webhooks | Event-driven notifications | Alerts, transaction monitoring |
| IPFS | Decentralized file storage | NFT metadata, asset hosting |
| Add-ons | Enhanced blockchain APIs | Token balances, NFT data, DeFi |
| DAS API | Solana Digital Asset Standard (add-on) | NFT/token queries, compressed NFTs, asset search |
| Yellowstone gRPC | Solana Geyser streaming (add-on) | Real-time account, transaction, slot data |
| Hypercore | Hyperliquid gRPC/JSON-RPC/WS (beta) | Trades, orders, book updates, blocks, TWAP, events, writer actions |
| Console API | REST API for account management | Endpoint CRUD, usage monitoring, billing |
| Key-Value Store | Serverless key-value and list storage (beta) | Persistent state for Streams, dynamic address lists |
| x402 | Pay-per-request RPC via USDC micropayments | Keyless RPC access, AI agents, pay-as-you-go |
| 产品 | 描述 | 使用场景 |
|---|---|---|
| RPC Endpoints | 高性能区块链访问 | dApp后端、钱包交互 |
| Streams | 实时与历史区块链数据管道 | 事件监控、数据分析、索引构建 |
| Webhooks | 事件驱动通知 | 告警、交易监控 |
| IPFS | 去中心化文件存储 | NFT元数据、资产托管 |
| Add-ons | 增强型区块链API | 代币余额、NFT数据、DeFi应用 |
| DAS API | Solana数字资产标准(附加组件) | NFT/代币查询、压缩NFT、资产搜索 |
| Yellowstone gRPC | Solana Geyser流(附加组件) | 实时账户、交易、槽位数据 |
| Hypercore | Hyperliquid gRPC/JSON-RPC/WS(测试版) | 交易、订单、订单簿更新、区块、时间加权平均价格(TWAP)、事件、写入操作 |
| Console API | 账户管理REST API | 端点增删改查、使用监控、账单管理 |
| Key-Value Store | 无服务器键值与列表存储(测试版) | Streams持久化状态、动态地址列表 |
| x402 | 基于USDC微支付的按次付费RPC | 无密钥RPC访问、AI Agent、按需付费 |
RPC Endpoints
RPC Endpoints
Quicknode provides low-latency RPC endpoints for 80+ blockchain networks.
Quicknode为80+条区块链网络提供低延迟RPC端点。
Endpoint Setup
端点设置
typescript
// EVM chains (ethers.js)
import { JsonRpcProvider } from 'ethers';
const provider = new JsonRpcProvider(process.env.QUICKNODE_RPC_URL!);
// EVM chains (viem)
import { createPublicClient, http } from 'viem';
import { mainnet } from 'viem/chains';
const client = createPublicClient({
chain: mainnet,
transport: http(process.env.QUICKNODE_RPC_URL!),
});
// Solana
import { createSolanaRpc } from '@solana/kit';
const rpc = createSolanaRpc(process.env.QUICKNODE_RPC_URL!);typescript
// EVM链(ethers.js)
import { JsonRpcProvider } from 'ethers';
const provider = new JsonRpcProvider(process.env.QUICKNODE_RPC_URL!);
// EVM链(viem)
import { createPublicClient, http } from 'viem';
import { mainnet } from 'viem/chains';
const client = createPublicClient({
chain: mainnet,
transport: http(process.env.QUICKNODE_RPC_URL!),
});
// Solana
import { createSolanaRpc } from '@solana/kit';
const rpc = createSolanaRpc(process.env.QUICKNODE_RPC_URL!);Authentication
认证
Quicknode endpoints include authentication in the URL:
https://{ENDPOINT_NAME}.{NETWORK}.quiknode.pro/{API_KEY}/For additional security, enable JWT authentication or IP allowlisting in the Quicknode dashboard.
Quicknode端点在URL中包含认证信息:
https://{ENDPOINT_NAME}.{NETWORK}.quiknode.pro/{API_KEY}/为提升安全性,可在Quicknode控制台启用JWT认证或IP白名单。
Supported Networks
支持的网络
| Category | Networks |
|---|---|
| EVM | Ethereum, Polygon, Arbitrum, Optimism, Base, BSC, Avalanche, Fantom, zkSync, Scroll, Linea, Hyperliquid EVM (HyperEVM) |
| Non-EVM | Solana, Bitcoin, NEAR, Stacks, Cosmos, Sei, Aptos, Sui, TON, Hyperliquid (HyperCore) |
Not exhaustive. Full list: https://www.quicknode.com/chains
| 分类 | 网络 |
|---|---|
| EVM | Ethereum、Polygon、Arbitrum、Optimism、Base、BSC、Avalanche、Fantom、zkSync、Scroll、Linea、Hyperliquid EVM(HyperEVM) |
| 非EVM | Solana、Bitcoin、NEAR、Stacks、Cosmos、Sei、Aptos、Sui、TON、Hyperliquid(HyperCore) |
以上为非完整列表,完整列表:https://www.quicknode.com/chains
Rate Limits & Plans
速率限制与套餐
As of 2026-02-02. Verify current limits in Quicknode docs before sizing a production system.
| Plan | Requests/sec | Credits/month |
|---|---|---|
| Free Trial | 15 | 10M |
| Build | 50 | 80M |
| Accelerate | 125 | 450M |
| Scale | 250 | 950M |
| Business | 500 | 2B |
See references/rpc-reference.md for complete RPC documentation including method tables for EVM, Solana, and Bitcoin chains, WebSocket patterns, and batch request examples.
截至2026-02-02。在规划生产系统前,请在Quicknode文档中核实当前限制。
| 套餐 | 请求数/秒 | 月度额度 |
|---|---|---|
| 免费试用 | 15 | 1000万 |
| Build | 50 | 8000万 |
| Accelerate | 125 | 4.5亿 |
| Scale | 250 | 9.5亿 |
| Business | 500 | 20亿 |
完整RPC文档(包括EVM、Solana、Bitcoin链的方法表、WebSocket模式、批量请求示例)请参考references/rpc-reference.md。
Streams
Streams
Real-time & historical blockchain data pipelines that filter, transform, and deliver data to your destinations.
可过滤、转换并将数据交付至目标地址的实时与历史区块链数据管道。
Stream Types
流类型
| Type | Data | Use Case |
|---|---|---|
| Block | Full block data | Block explorers, analytics |
| Transaction | Transaction details | Tx monitoring, indexing |
| Logs | Contract events | DeFi tracking, NFT sales, token transfers |
| Receipt | Transaction receipts | Gas analysis, status tracking |
| 类型 | 数据 | 使用场景 |
|---|---|---|
| Block | 完整区块数据 | 区块浏览器、数据分析 |
| Transaction | 交易详情 | 交易监控、索引构建 |
| Logs | 合约事件 | DeFi追踪、NFT销售、代币转账 |
| Receipt | 交易收据 | 燃气费分析、状态追踪 |
Quick Setup
快速设置
- Create stream in Quicknode dashboard
- Select network and data type
- Add filter function (JavaScript)
- Configure destination (webhook, S3, database)
- 在Quicknode控制台创建流
- 选择网络与数据类型
- 添加过滤函数(JavaScript)
- 配置目标地址(webhook、S3、数据库)
Basic Filter Function
基础过滤函数
See references/streams-reference.md for filter examples and full Streams documentation.
过滤示例与完整Streams文档请参考references/streams-reference.md。
Webhooks
Webhooks
Event-driven notifications for blockchain activity.
针对区块链活动的事件驱动通知。
Webhooks vs Streams
Webhooks vs Streams
| Feature | Webhooks | Streams |
|---|---|---|
| Setup | Simple | More configuration |
| Filtering | Address/event-based | Custom JavaScript |
| Destinations | HTTP endpoint only | Webhook, S3, Postgres, Azure |
| Processing | Basic | Full transformation |
| Use Case | Simple alerts | Complex pipelines |
| 特性 | Webhooks | Streams |
|---|---|---|
| 设置 | 简单 | 配置复杂 |
| 过滤 | 基于地址/事件 | 自定义JavaScript |
| 目标地址 | 仅HTTP端点 | Webhook、S3、Postgres、Azure |
| 处理能力 | 基础 | 完整转换 |
| 使用场景 | 简单告警 | 复杂数据管道 |
Webhook Setup
Webhook设置
See references/webhooks-reference.md for API examples and full Webhooks documentation.
API示例与完整Webhooks文档请参考references/webhooks-reference.md。
IPFS Storage
IPFS存储
Decentralized file storage with Quicknode's IPFS gateway.
See references/ipfs-reference.md for upload examples, metadata examples, and complete IPFS documentation.
基于Quicknode IPFS网关的去中心化文件存储。
上传示例、元数据示例与完整IPFS文档请参考references/ipfs-reference.md。
Marketplace Add-ons
市场附加组件
Enhanced APIs available through Quicknode's marketplace.
通过Quicknode市场提供的增强型API。
Token API (Ethereum)
Token API(Ethereum)
javascript
// Get all token balances for an address
const response = await fetch(process.env.QUICKNODE_RPC_URL!, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
method: 'qn_getWalletTokenBalance',
params: [{ wallet: '0x...', contracts: [] }]
})
});javascript
// 获取地址的所有代币余额
const response = await fetch(process.env.QUICKNODE_RPC_URL!, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
method: 'qn_getWalletTokenBalance',
params: [{ wallet: '0x...', contracts: [] }]
})
});NFT API (Ethereum)
NFT API(Ethereum)
javascript
// Fetch NFTs owned by address
const response = await fetch(process.env.QUICKNODE_RPC_URL!, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
method: 'qn_fetchNFTs',
params: [{ wallet: '0x...', page: 1, perPage: 10 }]
})
});javascript
// 获取地址拥有的NFT
const response = await fetch(process.env.QUICKNODE_RPC_URL!, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
method: 'qn_fetchNFTs',
params: [{ wallet: '0x...', page: 1, perPage: 10 }]
})
});Solana Priority Fee API
Solana Priority Fee API
javascript
// Get recommended priority fees
const response = await rpc.request('qn_estimatePriorityFees', {
last_n_blocks: 100,
account: 'YOUR_ACCOUNT'
}).send();javascript
// 获取推荐优先费用
const response = await rpc.request('qn_estimatePriorityFees', {
last_n_blocks: 100,
account: 'YOUR_ACCOUNT'
}).send();Metis - Jupiter Swap API
Metis - Jupiter Swap API
typescript
// Using Metis - Jupiter Swap API
import { createJupiterApiClient } from '@jup-ag/api';
const jupiterApi = createJupiterApiClient({
basePath: `${process.env.QUICKNODE_METIS_URL}`
});
const quote = await jupiterApi.quoteGet({
inputMint: 'So11111111111111111111111111111111111111112',
outputMint: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: 1000000000,
slippageBps: 50
});
const swapResult = await jupiterApi.swapPost({
swapRequest: {
quoteResponse: quote,
userPublicKey: 'YourPubkey...'
}
});See references/marketplace-addons.md for complete Add-ons documentation.
typescript
// 使用Metis - Jupiter Swap API
import { createJupiterApiClient } from '@jup-ag/api';
const jupiterApi = createJupiterApiClient({
basePath: `${process.env.QUICKNODE_METIS_URL}`
});
const quote = await jupiterApi.quoteGet({
inputMint: 'So11111111111111111111111111111111111111112',
outputMint: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
amount: 1000000000,
slippageBps: 50
});
const swapResult = await jupiterApi.swapPost({
swapRequest: {
quoteResponse: quote,
userPublicKey: 'YourPubkey...'
}
});完整附加组件文档请参考references/marketplace-addons.md。
Solana DAS API (Digital Asset Standard)
Solana DAS API(数字资产标准)
Comprehensive API for querying Solana digital assets — standard NFTs, compressed NFTs (cNFTs), fungible tokens, MPL Core Assets, and Token 2022 Assets. Available as a Marketplace add-on (Metaplex DAS API).
用于查询Solana数字资产的综合API,支持标准NFT、压缩NFT(cNFT)、 fungible代币、MPL核心资产与Token 2022资产。作为市场附加组件提供(Metaplex DAS API)。
Quick Setup
快速设置
javascript
// Get all assets owned by a wallet
const response = await fetch(process.env.QUICKNODE_RPC_URL, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
jsonrpc: '2.0',
id: 1,
method: 'getAssetsByOwner',
params: {
ownerAddress: 'E645TckHQnDcavVv92Etc6xSWQaq8zzPtPRGBheviRAk',
limit: 10,
options: { showFungible: true, showCollectionMetadata: true }
}
})
});
const { result } = await response.json();
// result.total — total assets
// result.items — array of asset metadata
// result.cursor — for paginationjavascript
// 获取钱包拥有的所有资产
const response = await fetch(process.env.QUICKNODE_RPC_URL, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
jsonrpc: '2.0',
id: 1,
method: 'getAssetsByOwner',
params: {
ownerAddress: 'E645TckHQnDcavVv92Etc6xSWQaq8zzPtPRGBheviRAk',
limit: 10,
options: { showFungible: true, showCollectionMetadata: true }
}
})
});
const { result } = await response.json();
// result.total — 资产总数
// result.items — 资产元数据数组
// result.cursor — 分页游标Available Methods
可用方法
| Method | Description |
|---|---|
| Get metadata for a single asset |
| Get metadata for multiple assets |
| Get Merkle proof for a compressed asset |
| Get Merkle proofs for multiple assets |
| List assets by authority |
| List assets by creator |
| List assets by group (e.g., collection) |
| List assets by wallet owner |
| Transaction signatures for compressed assets |
| Token accounts by mint or owner |
| Edition details of a master NFT |
| Search assets with flexible filters |
See references/solana-das-api-reference.md for complete DAS API documentation with all methods, parameters, and examples.
| 方法 | 描述 |
|---|---|
| 获取单个资产元数据 |
| 获取多个资产元数据 |
| 获取压缩资产的默克尔证明 |
| 获取多个压缩资产的默克尔证明 |
| 按权限列出资产 |
| 按创建者列出资产 |
| 按组列出资产(如系列) |
| 按钱包所有者列出资产 |
| 压缩资产的交易签名 |
| 按铸币或所有者列出代币账户 |
| 主NFT的版本详情 |
| 使用灵活过滤器搜索资产 |
完整DAS API文档(含所有方法、参数与示例)请参考references/solana-das-api-reference.md。
Yellowstone gRPC (Solana)
Yellowstone gRPC(Solana)
High-performance Solana Geyser plugin for real-time blockchain data streaming via gRPC. Available as a Marketplace add-on.
高性能Solana Geyser插件,通过gRPC实现实时区块链数据流。作为市场附加组件提供。
Quick Setup
快速设置
typescript
import Client, { CommitmentLevel } from "@triton-one/yellowstone-grpc";
// Derive from HTTP URL: https://example.solana-mainnet.quiknode.pro/TOKEN/
const client = new Client(
"https://example.solana-mainnet.quiknode.pro:10000",
"TOKEN",
{}
);
const stream = await client.subscribe();
stream.on("data", (data) => {
if (data.transaction) console.log("Tx:", data.transaction);
});
stream.write({
transactions: {
txn_filter: {
vote: false,
failed: false,
accountInclude: ["PROGRAM_PUBKEY"],
accountExclude: [],
accountRequired: [],
},
},
accounts: {},
slots: {},
blocks: {},
blocksMeta: {},
transactionsStatus: {},
entry: {},
accountsDataSlice: [],
commitment: CommitmentLevel.CONFIRMED,
});typescript
import Client, { CommitmentLevel } from "@triton-one/yellowstone-grpc";
// 从HTTP URL推导:https://example.solana-mainnet.quiknode.pro/TOKEN/
const client = new Client(
"https://example.solana-mainnet.quiknode.pro:10000",
"TOKEN",
{}
);
const stream = await client.subscribe();
stream.on("data", (data) => {
if (data.transaction) console.log("Tx:", data.transaction);
});
stream.write({
transactions: {
txn_filter: {
vote: false,
failed: false,
accountInclude: ["PROGRAM_PUBKEY"],
accountExclude: [],
accountRequired: [],
},
},
accounts: {},
slots: {},
blocks: {},
blocksMeta: {},
transactionsStatus: {},
entry: {},
accountsDataSlice: [],
commitment: CommitmentLevel.CONFIRMED,
});Filter Types
过滤类型
| Filter | Description |
|---|---|
| accounts | Account data changes by pubkey, owner, or data pattern |
| transactions | Transaction events with vote/failure/account filters |
| transactionsStatus | Lightweight transaction status updates |
| slots | Slot progression and status changes |
| blocks | Full block data with optional tx/account inclusion |
| blocksMeta | Block metadata without full contents |
| entry | PoH entry updates |
See references/yellowstone-grpc-reference.md for complete Yellowstone gRPC documentation.
| 过滤器 | 描述 |
|---|---|
| accounts | 按公钥、所有者或数据模式过滤账户数据变更 |
| transactions | 带投票/失败/账户过滤器的交易事件 |
| transactionsStatus | 轻量交易状态更新 |
| slots | 槽位进度与状态变更 |
| blocks | 包含可选交易/账户的完整区块数据 |
| blocksMeta | 不含完整内容的区块元数据 |
| entry | PoH条目更新 |
完整Yellowstone gRPC文档请参考references/yellowstone-grpc-reference.md。
HyperCore (Hyperliquid)
HyperCore(Hyperliquid)
Quicknode's data delivery infrastructure for the Hyperliquid L1 chain. Provides gRPC, JSON-RPC, WebSocket, and Info API access. Currently in public beta.
Quicknode为Hyperliquid L1链提供的数据交付基础设施,支持gRPC、JSON-RPC、WebSocket与Info API访问。当前为公开测试版。
Access Methods
访问方式
| Method | Path / Port | Use Case |
|---|---|---|
| Info API | | 50+ methods for market data, positions, orders |
| JSON-RPC | | Block queries ( |
| WebSocket | | Real-time subscriptions ( |
| gRPC | Port 10000 | Lowest-latency streaming for trades, orders, books |
| 方式 | 路径/端口 | 使用场景 |
|---|---|---|
| Info API | | 50+种市场数据、仓位、订单方法 |
| JSON-RPC | | 区块查询( |
| WebSocket | | 实时订阅( |
| gRPC | 端口10000 | 交易、订单、订单簿的最低延迟流 |
gRPC Stream Types
gRPC流类型
| Stream | Volume | Description |
|---|---|---|
| TRADES | High | Execution data: coin, price, size, side, fees |
| ORDERS | Very High | Order lifecycle with 18+ status types |
| BOOK_UPDATES | Very High | L2 order book diffs |
| TWAP | Low | Time-weighted average price order updates |
| EVENTS | High | Ledger updates, funding, deposits, withdrawals |
| BLOCKS | Extreme | Raw HyperCore blocks (gRPC only) |
| WRITER_ACTIONS | Low | System-level token transfers |
| 流 | 数据量 | 描述 |
|---|---|---|
| TRADES | 高 | 执行数据:币种、价格、数量、方向、手续费 |
| ORDERS | 极高 | 包含18+种状态类型的订单生命周期 |
| BOOK_UPDATES | 极高 | L2订单簿差分 |
| TWAP | 低 | 时间加权平均价格订单更新 |
| EVENTS | 高 | 账本更新、资金费用、存款、提款 |
| BLOCKS | 极大 | 原始HyperCore区块(仅gRPC) |
| WRITER_ACTIONS | 低 | 系统级代币转账 |
HyperEVM
HyperEVM
| Path | Debug/Trace | Archive | Use Case |
|---|---|---|---|
| No | Partial | Standard EVM operations |
| Yes | Extended | Debug, trace, WebSocket subscriptions |
See references/hypercore-hyperliquid-reference.md for complete HyperCore and Hyperliquid documentation.
| 路径 | 调试/追踪 | 归档 | 使用场景 |
|---|---|---|---|
| 否 | 部分 | 标准EVM操作 |
| 是 | 扩展 | 调试、追踪、WebSocket订阅 |
完整HyperCore与Hyperliquid文档请参考references/hypercore-hyperliquid-reference.md。
Quicknode SDK
Quicknode SDK
Official JavaScript/TypeScript SDK for Quicknode services.
Quicknode服务的官方JavaScript/TypeScript SDK。
Installation
安装
bash
npm install @quicknode/sdkbash
npm install @quicknode/sdkBasic Usage
基础用法
typescript
import { Core } from '@quicknode/sdk';
const core = new Core({
endpointUrl: process.env.QUICKNODE_RPC_URL!,
});
// Token API
const balances = await core.client.qn_getWalletTokenBalance({
wallet: '0x...',
});
// NFT API
const nfts = await core.client.qn_fetchNFTs({
wallet: '0x...',
page: 1,
perPage: 10,
});See references/sdk-reference.md for complete SDK documentation.
typescript
import { Core } from '@quicknode/sdk';
const core = new Core({
endpointUrl: process.env.QUICKNODE_RPC_URL!,
});
// Token API
const balances = await core.client.qn_getWalletTokenBalance({
wallet: '0x...',
});
// NFT API
const nfts = await core.client.qn_fetchNFTs({
wallet: '0x...',
page: 1,
perPage: 10,
});完整SDK文档请参考references/sdk-reference.md。
Console API
Console API
REST API for programmatic management of Quicknode endpoints, usage, rate limits, security, billing, and teams. Enables infrastructure-as-code workflows.
用于程序化管理Quicknode端点、使用情况、速率限制、安全设置、账单与团队的REST API,支持基础设施即代码工作流。
Quick Reference
快速参考
| Resource | Methods | Endpoint |
|---|---|---|
| Chains | GET | |
| Endpoints | GET, POST, PATCH, DELETE | |
| Metrics | GET | |
| Rate Limits | GET, POST, PUT | |
| Security | GET | |
| Usage | GET | |
| Billing | GET | |
| Teams | GET | |
| 资源 | 方法 | 端点 |
|---|---|---|
| 链 | GET | |
| 端点 | GET、POST、PATCH、DELETE | |
| 指标 | GET | |
| 速率限制 | GET、POST、PUT | |
| 安全设置 | GET | |
| 使用情况 | GET | |
| 账单 | GET | |
| 团队 | GET | |
Authentication
认证
All requests use the header against .
x-api-keyhttps://api.quicknode.com/v0/typescript
const QN_API_KEY = process.env.QUICKNODE_API_KEY!;
const res = await fetch('https://api.quicknode.com/v0/endpoints', {
headers: { 'x-api-key': QN_API_KEY },
});
const endpoints = await res.json();See references/console-api-reference.md for full Console API documentation including endpoint CRUD, usage monitoring, rate limit configuration, security options, billing, and teams.
所有请求需在上携带头。
https://api.quicknode.com/v0/x-api-keytypescript
const QN_API_KEY = process.env.QUICKNODE_API_KEY!;
const res = await fetch('https://api.quicknode.com/v0/endpoints', {
headers: { 'x-api-key': QN_API_KEY },
});
const endpoints = await res.json();完整Console API文档(含端点增删改查、使用监控、速率限制配置、安全选项、账单与团队管理)请参考references/console-api-reference.md。
Key-Value Store (Beta)
键值存储(测试版)
Serverless storage for lists and key-value sets, primarily accessed from within Streams filter functions via the helper library. Also available via REST API.
qnLib用于列表与键值对的无服务器存储,主要通过辅助库在Streams过滤函数中访问,也可通过REST API使用。
qnLibStream Integration (qnLib)
流集成(qnLib)
List operations — manage lists of items (e.g., wallet addresses):
- — create or update a list
qnLib.qnUpsertList - — add item to a list
qnLib.qnAddListItem - — remove item from a list
qnLib.qnRemoveListItem - — batch membership check
qnLib.qnContainsListItems - — delete a list
qnLib.qnDeleteList
Set operations — manage key-value pairs:
- — create a key-value set
qnLib.qnAddSet - — retrieve value by key
qnLib.qnGetSet - — bulk create/remove sets
qnLib.qnBulkSets - — delete a set
qnLib.qnDeleteSet
列表操作 — 管理项目列表(如钱包地址):
- — 创建或更新列表
qnLib.qnUpsertList - — 向列表添加项目
qnLib.qnAddListItem - — 从列表移除项目
qnLib.qnRemoveListItem - — 批量成员检查
qnLib.qnContainsListItems - — 删除列表
qnLib.qnDeleteList
集合操作 — 管理键值对:
- — 创建键值集合
qnLib.qnAddSet - — 通过键检索值
qnLib.qnGetSet - — 批量创建/移除集合
qnLib.qnBulkSets - — 删除集合
qnLib.qnDeleteSet
x402 (Pay-Per-Request RPC)
x402(按次付费RPC)
Pay-per-request RPC access via USDC micropayments on Base. No API key required — authenticate with Sign-In with Ethereum (SIWE), purchase credits, and access 140+ chain endpoints.
基于Base链上USDC微支付的按次付费RPC访问,无需API密钥 — 通过以太坊登录(SIWE)认证、购买额度即可访问140+条链的端点。
Quick Setup
快速设置
typescript
import { wrapFetch } from "@x402/fetch";
import { createWalletClient, http } from "viem";
import { privateKeyToAccount } from "viem/accounts";
import { base } from "viem/chains";
const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`);
const walletClient = createWalletClient({
account,
chain: base,
transport: http(),
});
// Wrap fetch to auto-handle 402 payments
const x402Fetch = wrapFetch(fetch, walletClient);
// Use like normal fetch — payments are handled automatically
const response = await x402Fetch("https://x402.quicknode.com/ethereum-mainnet", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
jsonrpc: "2.0",
method: "eth_blockNumber",
params: [],
id: 1,
}),
});See references/x402-reference.md for complete x402 documentation including SIWE authentication, credit management, and the wrapper.
@x402/fetchtypescript
import { wrapFetch } from "@x402/fetch";
import { createWalletClient, http } from "viem";
import { privateKeyToAccount } from "viem/accounts";
import { base } from "viem/chains";
const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`);
const walletClient = createWalletClient({
account,
chain: base,
transport: http(),
});
// 包装fetch以自动处理402支付
const x402Fetch = wrapFetch(fetch, walletClient);
// 像普通fetch一样使用 — 支付将自动处理
const response = await x402Fetch("https://x402.quicknode.com/ethereum-mainnet", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
jsonrpc: "2.0",
method: "eth_blockNumber",
params: [],
id: 1,
}),
});完整x402文档(含SIWE认证、额度管理、包装器)请参考references/x402-reference.md。
@x402/fetchCommon Patterns
常见模式
Multi-Chain dApp Setup
多链dApp设置
typescript
import { Core } from '@quicknode/sdk';
const chains = {
ethereum: new Core({
endpointUrl: 'https://YOUR_ETH_ENDPOINT.quiknode.pro/KEY/'
}),
polygon: new Core({
endpointUrl: 'https://YOUR_POLYGON_ENDPOINT.quiknode.pro/KEY/'
}),
arbitrum: new Core({
endpointUrl: 'https://YOUR_ARB_ENDPOINT.quiknode.pro/KEY/'
}),
};
// Use appropriate chain
const ethBalance = await chains.ethereum.client.getBalance({ address: '0x...' });typescript
import { Core } from '@quicknode/sdk';
const chains = {
ethereum: new Core({
endpointUrl: 'https://YOUR_ETH_ENDPOINT.quiknode.pro/KEY/'
}),
polygon: new Core({
endpointUrl: 'https://YOUR_POLYGON_ENDPOINT.quiknode.pro/KEY/'
}),
arbitrum: new Core({
endpointUrl: 'https://YOUR_ARB_ENDPOINT.quiknode.pro/KEY/'
}),
};
// 使用对应链
const ethBalance = await chains.ethereum.client.getBalance({ address: '0x...' });Real-Time Transaction Monitoring
实时交易监控
- Create Stream filtering for your contract address
- Add Filter Function to extract relevant events
- Configure Webhook destination to your server
- Process Events in your backend
- 创建流,过滤你的合约地址
- 添加过滤函数,提取相关事件
- 配置Webhook目标地址到你的服务器
- 在后端处理事件
NFT Collection Indexing
NFT系列索引
- Use Streams to capture mint/transfer events
- Store in Database via PostgreSQL destination
- Query via Add-ons for current ownership data
- Query via SDK for custom API endpoints
- 使用Streams捕获铸造/转账事件
- 通过PostgreSQL目标地址存储到数据库
- 通过附加组件查询当前所有权数据
- 通过SDK查询自定义API端点
Real-Time Solana Monitoring with Yellowstone gRPC
基于Yellowstone gRPC的Solana实时监控
- Connect via gRPC on port 10000 with your auth token
- Subscribe to transactions filtering by program or account
- Process updates in real-time via the streaming interface
- Implement reconnection with exponential backoff
- 通过端口10000连接gRPC,携带你的认证令牌
- 订阅交易,按程序或账户过滤
- 通过流接口实时处理更新
- 实现带指数退避的重连机制
Hyperliquid Trading Data Pipeline
Hyperliquid交易数据管道
- Connect via gRPC on port 10000 for lowest-latency data
- Subscribe to TRADES/ORDERS streams with coin filters
- Process events — handle ~12 blocks/sec throughput
- Use Info API () for account state and market metadata
/info
- 通过端口10000连接gRPC获取最低延迟数据
- 订阅TRADES/ORDERS流,带币种过滤器
- 处理事件 — 处理约12区块/秒的吞吐量
- 使用Info API()获取账户状态与市场元数据
/info
Best Practices
最佳实践
RPC
RPC
- Use WebSocket for subscriptions and real-time data
- Implement retry logic with exponential backoff
- Cache responses when data doesn't change frequently
- Use batch requests to reduce API calls
- 使用WebSocket进行订阅与实时数据
- 实现带指数退避的重试逻辑
- 数据无频繁变化时缓存响应
- 使用批量请求减少API调用
Streams
Streams
- Start with narrow filters, expand as needed
- Test filter functions locally before deployment
- Streams will automatically retry on failures
- Monitor stream health via dashboard
- 从窄范围过滤器开始,按需扩展
- 部署前在本地测试过滤函数
- Streams会自动重试失败请求
- 通过控制台监控流健康状态
Security
安全
- Store API keys in environment variables
- Enable IP allowlisting for production
- Use JWT authentication for sensitive operations
- Rotate API keys periodically
- 将API密钥存储在环境变量中
- 生产环境启用IP白名单
- 敏感操作使用JWT认证
- 定期轮换API密钥
gRPC
gRPC
- Enable zstd compression to reduce bandwidth (up to 70% for Hyperliquid)
- Implement reconnection logic with exponential backoff — streams can drop
- Use narrow filters (specific accounts, coins, or programs) to minimize data volume
- Set appropriate commitment levels (Yellowstone: CONFIRMED for most use cases, FINALIZED for irreversibility)
- Send keepalive pings (every 10s for Yellowstone, every 30s for Hypercore) to maintain connections
- 启用zstd压缩以减少带宽(Hyperliquid可减少高达70%)
- 实现带指数退避的重连逻辑 — 流可能中断
- 使用窄范围过滤器(特定账户、币种或程序)以最小化数据量
- 设置合适的确认级别(Yellowstone:多数场景用CONFIRMED,需不可逆性用FINALIZED)
- 发送保活 ping(Yellowstone每10秒一次,Hypercore每30秒一次)以维持连接
Documentation Links
文档链接
Quicknode Products
Quicknode产品
- Main Docs: https://www.quicknode.com/docs/
- Streams: https://www.quicknode.com/docs/streams
- Webhooks: https://www.quicknode.com/docs/webhooks
- IPFS: https://www.quicknode.com/docs/ipfs
- SDK: https://www.quicknode.com/docs/quicknode-sdk
- Console API: https://www.quicknode.com/docs/console-api
- DAS API (Solana): https://www.quicknode.com/docs/solana/solana-das-api
- Yellowstone gRPC: https://www.quicknode.com/docs/solana/yellowstone-grpc/overview
- Hyperliquid: https://www.quicknode.com/docs/hyperliquid
- Hyperliquid gRPC: https://www.quicknode.com/docs/hyperliquid/grpc-api
- Key-Value Store: https://www.quicknode.com/docs/key-value-store
- x402: https://x402.quicknode.com
- 主文档:https://www.quicknode.com/docs/
- Streams:https://www.quicknode.com/docs/streams
- Webhooks:https://www.quicknode.com/docs/webhooks
- IPFS:https://www.quicknode.com/docs/ipfs
- SDK:https://www.quicknode.com/docs/quicknode-sdk
- Console API:https://www.quicknode.com/docs/console-api
- DAS API(Solana):https://www.quicknode.com/docs/solana/solana-das-api
- Yellowstone gRPC:https://www.quicknode.com/docs/solana/yellowstone-grpc/overview
- Hyperliquid:https://www.quicknode.com/docs/hyperliquid
- Hyperliquid gRPC:https://www.quicknode.com/docs/hyperliquid/grpc-api
- 键值存储:https://www.quicknode.com/docs/key-value-store
- x402:https://x402.quicknode.com
Chain-Specific Docs
链专属文档
- Ethereum: https://www.quicknode.com/docs/ethereum
- Solana: https://www.quicknode.com/docs/solana
- Polygon: https://www.quicknode.com/docs/polygon
- Arbitrum: https://www.quicknode.com/docs/arbitrum
- Base: https://www.quicknode.com/docs/base
- Optimism: https://www.quicknode.com/docs/optimism
- Avalanche: https://www.quicknode.com/docs/avalanche
- BNB Smart Chain: https://www.quicknode.com/docs/bnb-smart-chain
- Hyperliquid: https://www.quicknode.com/docs/hyperliquid
- Ethereum:https://www.quicknode.com/docs/ethereum
- Solana:https://www.quicknode.com/docs/solana
- Polygon:https://www.quicknode.com/docs/polygon
- Arbitrum:https://www.quicknode.com/docs/arbitrum
- Base:https://www.quicknode.com/docs/base
- Optimism:https://www.quicknode.com/docs/optimism
- Avalanche:https://www.quicknode.com/docs/avalanche
- BNB Smart Chain:https://www.quicknode.com/docs/bnb-smart-chain
- Hyperliquid:https://www.quicknode.com/docs/hyperliquid
LLM-Optimized Documentation
LLM优化文档
- Platform Overview (llms.txt): https://www.quicknode.com/llms.txt — High-level index of all Quicknode products, chains, guides, and solutions
- Docs Index (llms.txt): https://www.quicknode.com/docs/llms.txt — Per-chain and per-product documentation index (links to )
https://www.quicknode.com/docs/{chain-or-product}/llms.txt - x402 (llms.txt): https://x402.quicknode.com/llms.txt
- 平台概览(llms.txt):https://www.quicknode.com/llms.txt — Quicknode所有产品、链、指南与解决方案的高层级索引
- 文档索引(llms.txt):https://www.quicknode.com/docs/llms.txt — 按链与产品分类的文档索引(链接至)
https://www.quicknode.com/docs/{chain-or-product}/llms.txt - x402(llms.txt):https://x402.quicknode.com/llms.txt
Additional Resources
附加资源
- Quicknode Guides: https://www.quicknode.com/guides
- SDK Reference: https://www.quicknode.com/docs/quicknode-sdk
- Marketplace: https://marketplace.quicknode.com/
- Sample App Library: https://www.quicknode.com/sample-app-library
- Guide Examples Repo: https://github.com/quiknode-labs/qn-guide-examples