OpenAPI Specification

View the complete OpenAPI specification for this REST API.

概述

The Key-Value Store REST API enables you to manage and access your lists and sets programmatically from any environment — your backend services, CI/CD pipelines, scripts, or anywhere you make HTTP requests.

Use the REST API to:

• Pre-populate lists with wallet addresses, token contracts, or other data before your Stream starts processing
• Update your Key-Value Store data on demand from outside of a Streams filter
• Build management tools and dashboards around your Key-Value Store data

For managing Key-Value Store data from within a Streams filter (e.g., during real-time block processing), use the qnLib.* methods documented in the 流过滤器文档.

身份验证

To access the Key-Value Store REST API, create an API key and include it as an x-api-key 每个请求都包含该标头。

API Base URL: https://api.quicknode.com/

Making Key-Value Store REST API Requests

In this documentation, you will see example requests made with cURL, the Quicknode CLI, and various programming languages for each supported Key-Value Store REST API method. This section will explain how to execute them on your machine.

cURL

大多数基于 *nix 的系统默认都支持 cURL。cURL 是一个用于通过 URL 传输数据的命令行工具和库。请运行以下命令检查是否已安装：

curl -h

Here's an example of how to retrieve all list keys using the Key-Value Store REST API with cURL:

curl -X GET \
  "https://api.quicknode.com/kv/rest/v1/lists" \
  -H "accept: application/json" \
  -H "x-api-key: YOUR_API_KEY"

Quicknode 命令行界面

要运行 Quicknode CLI 示例，请安装 qn 命令行工具：

brew 安装 quicknode/tap/qn

请运行以下命令，检查是否已安装：

qn --version

Then authenticate with an API key from your Quicknode dashboard:

qn 身份验证 登录

您也可以直接提供 API 密钥：

qn auth login --api-key 您的API密钥

有关其他安装方法、输出格式和配置选项，请参阅Quicknode CLI 文档。

可用端点

列表

Lists store collections of string items under a single key. Use them for membership checks against streaming data (e.g., checking if a wallet address is in your watchlist).

方法	端点	描述
POST	/kv/rest/v1/lists	Create a new list
GET	/kv/rest/v1/lists	Retrieve all list keys
GET	/kv/rest/v1/lists/{key}	Retrieve items from a specific list
PATCH	/kv/rest/v1/lists/{key}	Add/remove items from a list
POST	/kv/rest/v1/lists/{key}/items	Add a single item to a list
GET	/kv/rest/v1/lists/{key}/contains/{item}	Check if a list contains an item
DELETE	/kv/rest/v1/lists/{key}/items/{item}	Remove an item from a list
DELETE	/kv/rest/v1/lists/{key}	Delete a list

集合

Sets store individual key-value pairs. Use them for tracking data points that change over time (e.g., last processed block, running totals).

方法	端点	描述
POST	/kv/rest/v1/sets	Create a new key-value set
GET	/kv/rest/v1/sets	Retrieve all set keys
GET	/kv/rest/v1/sets/{key}	Retrieve a set value by key
POST	/kv/rest/v1/sets/bulk	Bulk create/delete sets
DELETE	/kv/rest/v1/sets/{key}	Delete a set

注

Key-Value Store items are case-sensitive. This is particularly important when working with blockchain addresses, as they must be entered exactly as they appear onchain.