alchemy-api

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

AI + Alchemy API Integration Guide

AI + Alchemy API 集成指南

Mandatory Routing Gate (Hard Requirement)

强制路由检查(硬性要求)

If
ALCHEMY_API_KEY
is unset or empty, you MUST use the
agentic-gateway
skill. You MUST NOT call any keyless or public fallback (including
.../v2/demo
) unless the user explicitly asks for that endpoint. Execute no network calls before this gate is evaluated.
Escape hatch: Only re-evaluate the routing gate if the user explicitly requests to switch to the
alchemy-api
skill with an API key. A key appearing in the environment or conversation does not automatically trigger a switch — the user must ask for it.
Duplicate resolution: If this skill is installed both locally and globally, the local copy overrides the global copy. Do not mix behavior from different copies.
如果
ALCHEMY_API_KEY
未设置或为空,您必须使用
agentic-gateway
技能。除非用户明确要求,否则不得调用任何无密钥或公共备用端点(包括
.../v2/demo
)。在完成此检查前,不得执行任何网络调用。
例外情况: 只有当用户明确要求切换到使用API密钥的
alchemy-api
技能时,才重新评估路由检查。即使环境或对话中出现密钥,也不会自动触发切换——必须得到用户的明确请求。
副本冲突解决: 如果此技能同时在本地和全局安装,本地副本将覆盖全局副本。不得混合不同副本的行为。

Required Preflight Check

必要的预检查

Before the first network call, internally evaluate:
  1. Is
    ALCHEMY_API_KEY
    present and non-empty?
  2. If no, switch to the
    agentic-gateway
    skill immediately. Demo and public endpoints are disallowed.
Do not output this check to the user.
在首次发起网络调用前,内部执行以下检查:
  1. ALCHEMY_API_KEY
    是否已设置且不为空?
  2. 如果未设置,立即切换到
    agentic-gateway
    技能。禁止使用演示和公共端点。
无需向用户输出此检查过程。

Summary

概述

A self-contained guide for AI agents integrating Alchemy APIs using an API key. This file alone should be enough to ship a basic integration. Use the reference files for depth, edge cases, and advanced workflows.
这是一份供AI Agent使用API密钥集成Alchemy APIs的独立指南。仅通过本文件即可完成基础集成的开发。如需深入了解、处理边缘情况或实现高级工作流,请参考相关参考文件。

Before Making Any Request

发起请求前的准备

  1. Check if
    $ALCHEMY_API_KEY
    is set (e.g.,
    echo $ALCHEMY_API_KEY
    ).
  2. If not set, do NOT proceed with API-key URLs. Use the
    agentic-gateway
    skill instead
    — it requires no API key.
  3. If set, use the Base URLs + Auth table below.
  1. 检查是否已设置
    $ALCHEMY_API_KEY
    (例如:
    echo $ALCHEMY_API_KEY
    )。
  2. 如果未设置,请勿继续使用需要API密钥的URL。请改用
    agentic-gateway
    技能
    ——该技能无需API密钥。
  3. 如果已设置,请使用下方的基础URL + 身份验证表格。

Do This First

第一步

  1. Choose the right product using the Endpoint Selector below.
  2. Use the Base URLs + Auth table for the correct endpoint and headers.
  3. Copy a Quickstart example and test against a testnet first.
  1. 使用下方的端点选择器选择合适的产品。
  2. 参考基础URL + 身份验证表格获取正确的端点和请求头。
  3. 复制快速入门示例并先在测试网进行测试。

Base URLs + Auth (Cheat Sheet)

基础URL + 身份验证(速查表)

ProductBase URLAuthNotes
Ethereum RPC (HTTPS)
https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLStandard EVM reads and writes.
Ethereum RPC (WSS)
wss://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLSubscriptions and realtime.
Base RPC (HTTPS)
https://base-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLEVM L2.
Base RPC (WSS)
wss://base-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLSubscriptions and realtime.
Arbitrum RPC (HTTPS)
https://arb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLEVM L2.
Arbitrum RPC (WSS)
wss://arb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLSubscriptions and realtime.
BNB RPC (HTTPS)
https://bnb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLEVM L1.
BNB RPC (WSS)
wss://bnb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLSubscriptions and realtime.
Solana RPC (HTTPS)
https://solana-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
API key in URLSolana JSON-RPC.
Solana Yellowstone gRPC
https://solana-mainnet.g.alchemy.com
X-Token: $ALCHEMY_API_KEY
gRPC streaming (Yellowstone).
NFT API
https://<network>.g.alchemy.com/nft/v3/$ALCHEMY_API_KEY
API key in URLNFT ownership and metadata.
Prices API
https://api.g.alchemy.com/prices/v1/$ALCHEMY_API_KEY
API key in URLPrices by symbol or address.
Portfolio API
https://api.g.alchemy.com/data/v1/$ALCHEMY_API_KEY
API key in URLMulti-chain wallet views.
Notify API
https://dashboard.alchemy.com/api
X-Alchemy-Token: <ALCHEMY_NOTIFY_AUTH_TOKEN>
Generate token in dashboard.
产品基础URL身份验证方式说明
Ethereum RPC (HTTPS)
https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥标准EVM读写操作。
Ethereum RPC (WSS)
wss://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥订阅和实时数据。
Base RPC (HTTPS)
https://base-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥EVM L2网络。
Base RPC (WSS)
wss://base-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥订阅和实时数据。
Arbitrum RPC (HTTPS)
https://arb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥EVM L2网络。
Arbitrum RPC (WSS)
wss://arb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥订阅和实时数据。
BNB RPC (HTTPS)
https://bnb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥EVM L1网络。
BNB RPC (WSS)
wss://bnb-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥订阅和实时数据。
Solana RPC (HTTPS)
https://solana-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY
URL中包含API密钥Solana JSON-RPC。
Solana Yellowstone gRPC
https://solana-mainnet.g.alchemy.com
X-Token: $ALCHEMY_API_KEY
gRPC流(Yellowstone)。
NFT API
https://<network>.g.alchemy.com/nft/v3/$ALCHEMY_API_KEY
URL中包含API密钥NFT所有权和元数据。
Prices API
https://api.g.alchemy.com/prices/v1/$ALCHEMY_API_KEY
URL中包含API密钥通过符号或地址查询价格。
Portfolio API
https://api.g.alchemy.com/data/v1/$ALCHEMY_API_KEY
URL中包含API密钥多链钱包视图。
Notify API
https://dashboard.alchemy.com/api
X-Alchemy-Token: <ALCHEMY_NOTIFY_AUTH_TOKEN>
在控制台生成令牌。

Endpoint Selector (Top Tasks)

端点选择器(常见任务)

You needUse thisSkill / File
EVM read/writeJSON-RPC
eth_*
references/node-json-rpc.md
Realtime events
eth_subscribe
references/node-websocket-subscriptions.md
Token balances
alchemy_getTokenBalances
references/data-token-api.md
Token metadata
alchemy_getTokenMetadata
references/data-token-api.md
Transfers history
alchemy_getAssetTransfers
references/data-transfers-api.md
NFT ownership
GET /getNFTsForOwner
references/data-nft-api.md
NFT metadata
GET /getNFTMetadata
references/data-nft-api.md
Prices (spot)
GET /tokens/by-symbol
references/data-prices-api.md
Prices (historical)
POST /tokens/historical
references/data-prices-api.md
Portfolio (multi-chain)
POST /assets/*/by-address
references/data-portfolio-apis.md
Simulate tx
alchemy_simulateAssetChanges
references/data-simulation-api.md
Create webhook
POST /create-webhook
references/webhooks-details.md
Solana NFT data
getAssetsByOwner
(DAS)
references/solana-das-api.md
需求使用工具技能/文件
EVM读写JSON-RPC
eth_*
references/node-json-rpc.md
实时事件
eth_subscribe
references/node-websocket-subscriptions.md
代币余额
alchemy_getTokenBalances
references/data-token-api.md
代币元数据
alchemy_getTokenMetadata
references/data-token-api.md
转账历史
alchemy_getAssetTransfers
references/data-transfers-api.md
NFT所有权
GET /getNFTsForOwner
references/data-nft-api.md
NFT元数据
GET /getNFTMetadata
references/data-nft-api.md
现货价格
GET /tokens/by-symbol
references/data-prices-api.md
历史价格
POST /tokens/historical
references/data-prices-api.md
多链投资组合
POST /assets/*/by-address
references/data-portfolio-apis.md
模拟交易
alchemy_simulateAssetChanges
references/data-simulation-api.md
创建Webhook
POST /create-webhook
references/webhooks-details.md
Solana NFT数据
getAssetsByOwner
(DAS)
references/solana-das-api.md

One-File Quickstart (Copy/Paste)

单文件快速入门(复制粘贴)

No API key? Use the
agentic-gateway
skill instead. Replace API-key URLs with
https://x402.alchemy.com/rpc/eth-mainnet
and add
Authorization: SIWE <token>
. See the
agentic-gateway
skill for setup.
没有API密钥? 请改用
agentic-gateway
技能。将需要API密钥的URL替换为
https://x402.alchemy.com/rpc/eth-mainnet
,并添加请求头
Authorization: SIWE <token>
。设置方法请参考
agentic-gateway
技能文档。

EVM JSON-RPC (Read)

EVM JSON-RPC(读取)

bash
curl -s https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"eth_blockNumber","params":[]}'
bash
curl -s https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"eth_blockNumber","params":[]}'

Token Balances

代币余额

bash
curl -s https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"alchemy_getTokenBalances","params":["0x00000000219ab540356cbb839cbe05303d7705fa"]}'
bash
curl -s https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"alchemy_getTokenBalances","params":["0x00000000219ab540356cbb839cbe05303d7705fa"]}'

Transfer History

转账历史

bash
curl -s https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"alchemy_getAssetTransfers","params":[{"fromBlock":"0x0","toBlock":"latest","toAddress":"0x00000000219ab540356cbb839cbe05303d7705fa","category":["erc20"],"withMetadata":true,"maxCount":"0x3e8"}]}'
bash
curl -s https://eth-mainnet.g.alchemy.com/v2/$ALCHEMY_API_KEY \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"alchemy_getAssetTransfers","params":[{"fromBlock":"0x0","toBlock":"latest","toAddress":"0x00000000219ab540356cbb839cbe05303d7705fa","category":["erc20"],"withMetadata":true,"maxCount":"0x3e8"}]}'

NFT Ownership

NFT所有权

bash
curl -s "https://eth-mainnet.g.alchemy.com/nft/v3/$ALCHEMY_API_KEY/getNFTsForOwner?owner=0x00000000219ab540356cbb839cbe05303d7705fa"
bash
curl -s "https://eth-mainnet.g.alchemy.com/nft/v3/$ALCHEMY_API_KEY/getNFTsForOwner?owner=0x00000000219ab540356cbb839cbe05303d7705fa"

Prices (Spot)

现货价格

bash
curl -s "https://api.g.alchemy.com/prices/v1/$ALCHEMY_API_KEY/tokens/by-symbol?symbols=ETH&symbols=USDC"
bash
curl -s "https://api.g.alchemy.com/prices/v1/$ALCHEMY_API_KEY/tokens/by-symbol?symbols=ETH&symbols=USDC"

Prices (Historical)

历史价格

bash
curl -s -X POST "https://api.g.alchemy.com/prices/v1/$ALCHEMY_API_KEY/tokens/historical" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"ETH","startTime":"2024-01-01T00:00:00Z","endTime":"2024-01-02T00:00:00Z"}'
bash
curl -s -X POST "https://api.g.alchemy.com/prices/v1/$ALCHEMY_API_KEY/tokens/historical" \
  -H "Content-Type: application/json" \
  -d '{"symbol":"ETH","startTime":"2024-01-01T00:00:00Z","endTime":"2024-01-02T00:00:00Z"}'

Create Notify Webhook

创建Notify Webhook

bash
curl -s -X POST "https://dashboard.alchemy.com/api/create-webhook" \
  -H "Content-Type: application/json" \
  -H "X-Alchemy-Token: $ALCHEMY_NOTIFY_AUTH_TOKEN" \
  -d '{"network":"ETH_MAINNET","webhook_type":"ADDRESS_ACTIVITY","webhook_url":"https://example.com/webhook","addresses":["0x00000000219ab540356cbb839cbe05303d7705fa"]}'
bash
curl -s -X POST "https://dashboard.alchemy.com/api/create-webhook" \
  -H "Content-Type: application/json" \
  -H "X-Alchemy-Token: $ALCHEMY_NOTIFY_AUTH_TOKEN" \
  -d '{"network":"ETH_MAINNET","webhook_type":"ADDRESS_ACTIVITY","webhook_url":"https://example.com/webhook","addresses":["0x00000000219ab540356cbb839cbe05303d7705fa"]}'

Verify Webhook Signature (Node)

验证Webhook签名(Node.js)

ts
import crypto from "crypto";

export function verify(rawBody: string, signature: string, secret: string) {
  const hmac = crypto.createHmac("sha256", secret).update(rawBody).digest("hex");
  return crypto.timingSafeEqual(Buffer.from(hmac), Buffer.from(signature));
}
ts
import crypto from "crypto";

export function verify(rawBody: string, signature: string, secret: string) {
  const hmac = crypto.createHmac("sha256", secret).update(rawBody).digest("hex");
  return crypto.timingSafeEqual(Buffer.from(hmac), Buffer.from(signature));
}

Network Naming Rules

网络命名规则

  • Data APIs and JSON-RPC use lowercase network enums like
    eth-mainnet
    .
  • Notify API uses uppercase enums like
    ETH_MAINNET
    .
  • 数据API和JSON-RPC使用小写网络枚举,如
    eth-mainnet
  • Notify API使用大写枚举,如
    ETH_MAINNET

Pagination + Limits (Cheat Sheet)

分页 + 限制(速查表)

EndpointLimitNotes
alchemy_getTokenBalances
maxCount
<= 100
Use
pageKey
for pagination.
alchemy_getAssetTransfers
maxCount
default
0x3e8
Use
pageKey
for pagination.
Portfolio token balances3 address/network pairs, 20 networks total
pageKey
supported.
Portfolio NFTs2 address/network pairs, 15 networks each
pageKey
supported.
Prices by address25 addresses, 3 networksPOST body
addresses[]
.
Transactions history (beta)1 address/network pair, 2 networksETH and BASE mainnets only.
端点限制说明
alchemy_getTokenBalances
maxCount
<= 100
使用
pageKey
进行分页。
alchemy_getAssetTransfers
maxCount
默认
0x3e8
使用
pageKey
进行分页。
投资组合代币余额3个地址/网络对,最多20个网络支持
pageKey
投资组合NFT2个地址/网络对,每个网络最多15个支持
pageKey
按地址查询价格25个地址,3个网络POST请求体中使用
addresses[]
交易历史(测试版)1个地址/网络对,最多2个网络仅支持ETH和BASE主网。

Common Token Addresses

常见代币地址

TokenChainAddress
ETHethereum
0x0000000000000000000000000000000000000000
WETHethereum
0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
USDCethereum
0xA0b86991c6218b36c1d19d4a2e9eb0ce3606eB48
USDCbase
0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
代币地址
ETHethereum
0x0000000000000000000000000000000000000000
WETHethereum
0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2
USDCethereum
0xA0b86991c6218b36c1d19d4a2e9eb0ce3606eB48
USDCbase
0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913

Failure Modes + Retries

故障模式 + 重试策略

  • HTTP
    429
    means rate limit. Use exponential backoff with jitter.
  • JSON-RPC errors come in
    error
    fields even with HTTP 200.
  • Use
    pageKey
    to resume pagination after failures.
  • De-dupe websocket events on reconnect.
  • HTTP
    429
    表示触发了速率限制。使用带抖动的指数退避策略进行重试。
  • 即使HTTP状态码为200,JSON-RPC错误也会包含在
    error
    字段中。
  • 故障后使用
    pageKey
    恢复分页。
  • 重新连接WebSocket时,需要去重事件。

Skill Map

技能映射

Node

Node

FileNameShort Description
references/node-overview.md
node-apisCore JSON-RPC and WebSocket APIs for EVM chains via Alchemy node endpoints, plus Debug/Trace and utility methods. Use when building EVM integrations that need standard RPC calls, real-time subscriptions, enhanced Alchemy methods, or execution-level tracing
references/node-debug-api.md
Debug APIDebug methods provide execution-level traces for a transaction or call. Use these for simulation, gas profiling, and internal call inspection
references/node-enhanced-apis.md
Enhanced APIs (Alchemy RPC Extensions)Alchemy provides enhanced JSON-RPC methods (prefixed with
alchemy_
) that offer indexed, higher-level data without manual log scanning
references/node-json-rpc.md
JSON-RPC (EVM)Use Alchemy's EVM JSON-RPC endpoints for standard blockchain reads and writes (e.g.,
eth_call
,
eth_getLogs
,
eth_sendRawTransaction
). This is the baseline for any EVM integration
references/node-trace-api.md
Trace APITrace APIs expose internal call data and state changes for transactions and blocks. Useful for analytics and auditing
references/node-utility-api.md
Utility APIConvenience RPC methods that reduce round trips for common tasks like bulk transaction receipt retrieval
references/node-websocket-subscriptions.md
WebSocket SubscriptionsUse WebSockets for real-time blockchain events without polling. Best for pending transactions, new blocks, and logs
文件名称简短描述
references/node-overview.md
node-apis通过Alchemy节点端点访问EVM链的核心JSON-RPC和WebSocket API,以及调试/跟踪和工具方法。当构建需要标准RPC调用、实时订阅、增强型Alchemy方法或执行级跟踪的EVM集成时使用
references/node-debug-api.md
Debug API调试方法提供交易或调用的执行级跟踪。用于模拟、gas分析和内部调用检查
references/node-enhanced-apis.md
Enhanced APIs (Alchemy RPC扩展)Alchemy提供增强型JSON-RPC方法(前缀为
alchemy_
),无需手动扫描日志即可获取索引化的高级数据
references/node-json-rpc.md
JSON-RPC (EVM)使用Alchemy的EVM JSON-RPC端点进行标准区块链读写操作(如
eth_call
eth_getLogs
eth_sendRawTransaction
)。这是任何EVM集成的基础
references/node-trace-api.md
Trace APITrace API暴露交易和区块的内部调用数据和状态变化。适用于分析和审计
references/node-utility-api.md
Utility API便捷的RPC方法,减少常见任务的往返次数,如批量获取交易收据
references/node-websocket-subscriptions.md
WebSocket订阅使用WebSocket获取实时区块链事件,无需轮询。最适合处理待处理交易、新区块和日志

Data

Data

FileNameShort Description
references/data-overview.md
data-apisHigher-level Alchemy APIs for asset discovery, wallet analytics, transfer history, NFT data, and token pricing. Use when you need indexed blockchain data without raw RPC log scanning, including token balances, NFT ownership, portfolio views, price feeds, and transaction simulation
references/data-nft-api.md
NFT APIQuery NFT ownership, metadata, collections, and contract-level info via Alchemy's NFT REST APIs
references/data-portfolio-apis.md
Portfolio APIsPortfolio APIs provide consolidated wallet views (tokens, NFTs, and transaction history) across multiple networks in single requests
references/data-prices-api.md
Prices APIQuery token prices for current and historical data using Alchemy's Prices API
references/data-simulation-api.md
Simulation APISimulate transactions before submitting them on-chain. Use this for safety checks and user previews
references/data-token-api.md
Token APIFetch token balances, metadata, and allowances without manual contract calls. Token API methods are exposed as Alchemy JSON-RPC methods
references/data-transfers-api.md
Transfers APIQuery historical transfers across ERC-20/721/1155 and native transfers without manual log scanning
文件名称简短描述
references/data-overview.md
data-apisAlchemy的高级API,用于资产发现、钱包分析、转账历史、NFT数据和代币定价。当您需要索引化的区块链数据而无需手动扫描原始RPC日志时使用,包括代币余额、NFT所有权、投资组合视图、价格馈送和交易模拟
references/data-nft-api.md
NFT API通过Alchemy的NFT REST API查询NFT所有权、元数据、集合和合约级信息
references/data-portfolio-apis.md
Portfolio APIsPortfolio API通过单次请求提供跨多个网络的整合钱包视图(代币、NFT和交易历史)
references/data-prices-api.md
Prices API使用Alchemy的Prices API查询代币的当前和历史价格
references/data-simulation-api.md
Simulation API在提交交易到链上之前进行模拟。用于安全检查和用户预览
references/data-token-api.md
Token API无需手动调用合约即可获取代币余额、元数据和授权信息。Token API方法以Alchemy JSON-RPC方法的形式提供
references/data-transfers-api.md
Transfers API查询ERC-20/721/1155和原生代币的历史转账记录,无需手动扫描日志

Webhooks

Webhooks

FileNameShort Description
references/webhooks-overview.md
webhooksPush-based delivery of blockchain events via Alchemy Notify API. Use when you need real-time notifications for address activity, NFT transfers, or custom on-chain events instead of polling. Covers webhook creation, payload formats, signature verification, and filtering
references/webhooks-address-activity.md
Address Activity WebhooksAddress activity webhooks notify you when specified addresses send or receive assets
references/webhooks-custom-webhooks.md
Custom Webhooks (GraphQL)Custom webhooks allow flexible event filtering using a GraphQL query hosted by Alchemy
references/webhooks-details.md
Webhooks Overview (Notify)Notify webhooks push blockchain events to your server so you don't need to poll. They are ideal for near real-time pipelines
references/webhooks-nft-activity.md
NFT Activity WebhooksReceive notifications for NFT transfers, mints, and burns for specified contracts or collections
references/webhooks-verify-signatures.md
Verify Webhook SignaturesAlways verify webhook signatures to ensure payloads are authentic and untampered
references/webhooks-webhook-payloads.md
Webhook PayloadsWebhook payloads include event metadata plus event-specific fields. Treat them as untrusted input and validate carefully
references/webhooks-webhook-types.md
Webhook TypesWebhook types determine what events you receive and how they're filtered
文件名称简短描述
references/webhooks-overview.md
webhooks通过Alchemy Notify API以推送方式交付区块链事件。当您需要实时通知地址活动、NFT转账或自定义链上事件而无需轮询时使用。涵盖Webhook创建、负载格式、签名验证和过滤
references/webhooks-address-activity.md
地址活动Webhook当指定地址发送或接收资产时,地址活动Webhook会向您发送通知
references/webhooks-custom-webhooks.md
自定义Webhook(GraphQL)自定义Webhook允许使用Alchemy托管的GraphQL查询进行灵活的事件过滤
references/webhooks-details.md
Webhooks概述(Notify)Notify Webhook将区块链事件推送到您的服务器,无需轮询。非常适合近实时管道
references/webhooks-nft-activity.md
NFT活动Webhook接收指定合约或集合的NFT转账、铸造和销毁通知
references/webhooks-verify-signatures.md
验证Webhook签名始终验证Webhook签名,确保负载真实且未被篡改
references/webhooks-webhook-payloads.md
Webhook负载Webhook负载包含事件元数据和特定事件字段。请将其视为不可信输入并仔细验证
references/webhooks-webhook-types.md
Webhook类型Webhook类型决定您接收的事件以及过滤方式

Solana

Solana

FileNameShort Description
references/solana-overview.md
solanaSolana-specific APIs including standard JSON-RPC, Digital Asset Standard (DAS) for NFTs and compressed assets, and wallet integration. Use when building Solana applications that need RPC access, NFT/asset queries, or Solana wallet tooling. For high-throughput streaming, see the yellowstone-grpc skill
references/solana-das-api.md
Solana DAS (Digital Asset Standard) APIDAS provides normalized access to Solana NFT and compressed asset data
references/solana-grpc-best-practices.md
Yellowstone Best PracticesPractical guidance to keep Yellowstone consumers reliable and efficient
references/solana-grpc-details.md
Yellowstone gRPC OverviewYellowstone gRPC provides high-throughput Solana data streams for blocks, transactions, accounts, and slots. Use this for real-time indexing at scale
references/solana-grpc-examples.md
Yellowstone ExamplesMinimal examples for connecting and subscribing. The exact client depends on your gRPC stack
references/solana-grpc-overview.md
yellowstone-grpcHigh-throughput Solana event streaming via Yellowstone gRPC. Use when you need near real-time block, transaction, account, or slot streams at scale. Covers subscription configuration, filtering, backpressure handling, and reconnection strategies
references/solana-grpc-subscribe-accounts.md
Subscribe AccountsAccount streams deliver updates when account state changes
references/solana-grpc-subscribe-blocks.md
Subscribe BlocksBlock streams provide full block data with transactions and metadata
references/solana-grpc-subscribe-request.md
Subscribe RequestThe subscribe request configures what streams and filters you want from Yellowstone
references/solana-grpc-subscribe-slots.md
Subscribe SlotsSlot updates provide heartbeat-style updates and can be used to track chain progress
references/solana-grpc-subscribe-transactions.md
Subscribe TransactionsTransaction streams deliver raw or decoded transaction data in near real-time
references/solana-rpc.md
Solana JSON-RPCStandard Solana JSON-RPC endpoints for account, program, and transaction data
references/solana-wallets.md
Solana Wallet IntegrationHigh-level guidance for integrating Solana wallets and signing transactions
文件名称简短描述
references/solana-overview.md
solanaSolana专用API,包括标准JSON-RPC、用于NFT和压缩资产的Digital Asset Standard (DAS),以及钱包集成。当构建需要RPC访问、NFT/资产查询或Solana钱包工具的Solana应用时使用。如需高吞吐量流,请参考yellowstone-grpc技能
references/solana-das-api.md
Solana DAS(数字资产标准)APIDAS提供对Solana NFT和压缩资产数据的标准化访问
references/solana-grpc-best-practices.md
Yellowstone最佳实践保持Yellowstone消费者可靠高效的实用指南
references/solana-grpc-details.md
Yellowstone gRPC概述Yellowstone gRPC提供高吞吐量的Solana数据流,包括区块、交易、账户和插槽。用于大规模实时索引
references/solana-grpc-examples.md
Yellowstone示例连接和订阅的最简示例。具体客户端取决于您的gRPC栈
references/solana-grpc-overview.md
yellowstone-grpc通过Yellowstone gRPC实现高吞吐量Solana事件流。当您需要大规模的近实时区块、交易、账户或插槽流时使用。涵盖订阅配置、过滤、背压处理和重连策略
references/solana-grpc-subscribe-accounts.md
订阅账户当账户状态变化时,账户流会推送更新
references/solana-grpc-subscribe-blocks.md
订阅区块区块流提供包含交易和元数据的完整区块数据
references/solana-grpc-subscribe-request.md
订阅请求订阅请求配置您从Yellowstone获取的流和过滤器
references/solana-grpc-subscribe-slots.md
订阅插槽插槽更新提供心跳式更新,可用于跟踪链的进度
references/solana-grpc-subscribe-transactions.md
订阅交易交易流以近实时方式推送原始或解码的交易数据
references/solana-rpc.md
Solana JSON-RPC用于账户、程序和交易数据的标准Solana JSON-RPC端点
references/solana-wallets.md
Solana钱包集成集成Solana钱包和签署交易的高级指南

Wallets

Wallets

FileNameShort Description
references/wallets-overview.md
walletsIntegration guide for Alchemy Wallets and smart wallet tooling including Account Kit, account abstraction, bundler, gas manager, and paymaster. Use when building wallet onboarding flows, sponsoring gas, or integrating smart wallets into your application
references/wallets-account-kit.md
Account KitAccount Kit is Alchemy's wallet SDK for onboarding users and managing wallet UX. Use it for embedded wallet flows or seamless authentication
references/wallets-bundler.md
BundlerA bundler aggregates and submits account abstraction user operations. Use this when integrating smart wallets
references/wallets-details.md
Wallets OverviewAlchemy Wallets tooling helps developers embed or integrate wallets with minimal infrastructure. This section is intentionally basic and focuses on integration touchpoints
references/wallets-gas-manager.md
Gas ManagerGas Manager (paymaster) enables gas sponsorship and cost control for smart wallet flows
references/wallets-smart-wallets.md
Smart WalletsSmart wallets (account abstraction) enable programmable accounts with features like session keys, batched transactions, and gas sponsorship
references/wallets-solana-notes.md
Solana Wallet NotesSolana wallet integration differs from EVM. Use Solana-specific tooling and RPC semantics
references/wallets-supported-chains.md
Wallet Supported ChainsWallet tooling may support a subset of chains compared to raw RPC. Always confirm chain support before launch
references/wallets-wallet-apis.md
Wallet APIsHigh-level wallet APIs enable programmatic wallet operations such as signing, transaction preparation, or account management. This guide stays minimal and focuses on integration awareness
文件名称简短描述
references/wallets-overview.md
walletsAlchemy钱包和智能钱包工具的集成指南,包括Account Kit、账户抽象、bundler、gas管理器和paymaster。当构建钱包入职流程、赞助gas或在应用中集成智能钱包时使用
references/wallets-account-kit.md
Account KitAccount Kit是Alchemy的钱包SDK,用于用户入职和管理钱包UX。用于嵌入式钱包流程或无缝身份验证
references/wallets-bundler.md
BundlerBundler聚合并提交账户抽象的用户操作。在集成智能钱包时使用
references/wallets-details.md
Wallets概述Alchemy钱包工具帮助开发者以最少的基础设施嵌入或集成钱包。本节内容基础,重点关注集成接触点
references/wallets-gas-manager.md
Gas ManagerGas Manager(paymaster)支持智能钱包流程的gas赞助和成本控制
references/wallets-smart-wallets.md
Smart Wallets智能钱包(账户抽象)支持可编程账户,具备会话密钥、批量交易和gas赞助等功能
references/wallets-solana-notes.md
Solana钱包注意事项Solana钱包集成与EVM不同。请使用Solana专用工具和RPC语义
references/wallets-supported-chains.md
钱包支持的链与原始RPC相比,钱包工具可能仅支持部分链。发布前请务必确认链支持情况
references/wallets-wallet-apis.md
Wallet APIs高级钱包API支持程序化钱包操作,如签署、交易准备或账户管理。本指南内容基础,重点关注集成认知

Rollups

Rollups

FileNameShort Description
references/rollups-overview.md
rollupsHigh-level overview of Alchemy Rollups for deploying custom L2/L3 chains. Use when exploring rollup deployment options or understanding what Alchemy Rollups offers. This section is intentionally minimal as rollup deployment is not a typical API integration task
references/rollups-details.md
Rollups OverviewAlchemy Rollups provide infrastructure for teams building their own rollup chains. This section is intentionally high-level because rollup deployment typically requires a sales or solutions process rather than a purely programmatic integration
文件名称简短描述
references/rollups-overview.md
rollupsAlchemy Rollups的高级概述,用于部署自定义L2/L3链。当探索rollup部署选项或了解Alchemy Rollups提供的功能时使用。本节内容基础,因为rollup部署通常不是典型的API集成任务
references/rollups-details.md
Rollups概述Alchemy Rollups为构建自有rollup链的团队提供基础设施。本节内容为高级概述,因为rollup部署通常需要销售或解决方案流程,而非纯程序化集成

Recipes

Recipes

FileNameShort Description
references/recipes-overview.md
recipesEnd-to-end runnable workflows that combine multiple Alchemy APIs to achieve real product goals. Includes token balances, NFT queries, transfer history, portfolio views, price feeds, transaction simulation, pending tx monitoring, and webhook setup. Use when you need a complete integration pattern, not just a single API call
references/recipes-get-nft-metadata.md
Recipe: Get NFT MetadataFetch NFT metadata for a token or collection using Alchemy NFT endpoints
references/recipes-get-nft-ownership.md
Recipe: Get NFT OwnershipRetrieve wallet-level NFT ownership with pagination and filtering
references/recipes-get-portfolio.md
Recipe: Get Full PortfolioBuild a consolidated wallet portfolio view across supported networks
references/recipes-get-prices-current-historical.md
Recipe: Get Current and Historical PricesQuery spot and historical token prices for analytics and UI displays
references/recipes-get-token-balances.md
Recipe: Get Token BalancesGet ERC-20 token balances for a wallet and handle paginated responses
references/recipes-get-token-metadata.md
Recipe: Get Token MetadataResolve token metadata (symbol, decimals, logo) for contract addresses
references/recipes-get-transfers-history.md
Recipe: Get Transfer HistoryPull historical transfer activity with category and block-range filters
references/recipes-simulate-transaction.md
Recipe: Simulate a TransactionSimulate transaction effects before submission for risk checks and UX previews
references/recipes-subscribe-pending-txs.md
Recipe: Subscribe to Pending TransactionsStream pending transactions in real time via WebSocket subscriptions
references/recipes-webhook-address-activity.md
Recipe: Address Activity WebhookConfigure address activity webhooks and verify delivered signatures
文件名称简短描述
references/recipes-overview.md
recipes端到端可运行的工作流,结合多个Alchemy API实现实际产品目标。包括代币余额、NFT查询、转账历史、投资组合视图、价格馈送、交易模拟、待处理交易监控和Webhook设置。当您需要完整的集成模式而非单一API调用时使用
references/recipes-get-nft-metadata.md
方案:获取NFT元数据使用Alchemy NFT端点获取代币或集合的NFT元数据
references/recipes-get-nft-ownership.md
方案:获取NFT所有权检索钱包级NFT所有权,支持分页和过滤
references/recipes-get-portfolio.md
方案:获取完整投资组合构建跨支持网络的整合钱包投资组合视图
references/recipes-get-prices-current-historical.md
方案:获取当前和历史价格查询现货和历史代币价格,用于分析和UI展示
references/recipes-get-token-balances.md
方案:获取代币余额获取钱包的ERC-20代币余额,处理分页响应
references/recipes-get-token-metadata.md
方案:获取代币元数据解析合约地址的代币元数据(符号、小数位数、logo)
references/recipes-get-transfers-history.md
方案:获取转账历史拉取带分类和区块范围过滤的历史转账活动
references/recipes-simulate-transaction.md
方案:模拟交易提交前模拟交易效果,用于风险检查和UX预览
references/recipes-subscribe-pending-txs.md
方案:订阅待处理交易通过WebSocket订阅实时获取待处理交易流
references/recipes-webhook-address-activity.md
方案:地址活动Webhook配置地址活动Webhook并验证推送的签名

Operational

Operational

FileNameShort Description
references/operational-overview.md
operationalOperational guidance for securely and reliably integrating Alchemy APIs. Covers API key management, JWT authentication, rate limits, compute unit budgeting, monitoring, alerting, and production readiness. Use before deploying any Alchemy integration to production
references/operational-alerts.md
AlertsSet alerts to catch rate limit issues, spikes in usage, or webhook failures
references/operational-allowlists.md
AllowlistsAllowlisting restricts API key usage to approved IPs or domains, reducing key abuse risk
references/operational-auth-and-keys.md
Auth and API KeysAlchemy uses API keys for most products. Keep keys server-side and scope them to environments
references/operational-best-practices.md
Production Best PracticesOperational checklist for deploying Alchemy-backed services
references/operational-dashboard-tools.md
Dashboard ToolsUse the Alchemy dashboard to create apps, manage keys, track usage, and configure webhooks
references/operational-jwt-and-header-auth.md
JWT and Header-Based AuthSome Alchemy APIs use header-based auth (e.g., JWTs or API tokens) instead of API keys in URLs. Use this for server-side integrations where you need stronger access control
references/operational-pricing-and-plans.md
Pricing and PlansAlchemy plans are primarily based on compute units and product access. Choose a plan that matches your expected traffic and data needs
references/operational-rate-limits-and-compute-units.md
Rate Limits and Compute UnitsAlchemy meters usage using compute units (CU) and enforces per-key rate limits. Plan your request patterns accordingly
references/operational-request-logs.md
Request LogsRequest logs help debug failed calls and monitor latency
references/operational-roles-and-sso.md
Roles and SSOTeam access control ensures API keys and billing settings are managed safely
references/operational-sandbox.md
Sandbox / Test EnvironmentUse testnets or a separate Alchemy app for safe development and QA
references/operational-supported-networks.md
Supported NetworksAlchemy supports multiple EVM and Solana networks. Always verify network availability in the dashboard for each product
文件名称简短描述
references/operational-overview.md
operational安全可靠地集成Alchemy API的操作指南,涵盖API密钥管理、JWT身份验证、速率限制、计算单元预算、监控、告警和生产就绪性。在将任何Alchemy集成部署到生产环境前使用
references/operational-alerts.md
告警设置告警以捕获速率限制问题、使用量峰值或Webhook故障
references/operational-allowlists.md
白名单白名单将API密钥的使用限制在批准的IP或域名,降低密钥滥用风险
references/operational-auth-and-keys.md
身份验证和API密钥Alchemy大多数产品使用API密钥。将密钥保存在服务器端,并按环境划分范围
references/operational-best-practices.md
生产最佳实践部署基于Alchemy的服务的操作清单
references/operational-dashboard-tools.md
控制台工具使用Alchemy控制台创建应用、管理密钥、跟踪使用量和配置Webhook
references/operational-jwt-and-header-auth.md
JWT和基于请求头的身份验证部分Alchemy API使用基于请求头的身份验证(如JWT或API令牌),而非URL中的API密钥。用于需要更强访问控制的服务器端集成
references/operational-pricing-and-plans.md
定价和方案Alchemy方案主要基于计算单元和产品访问权限。选择符合您预期流量和数据需求的方案
references/operational-rate-limits-and-compute-units.md
速率限制和计算单元Alchemy使用计算单元(CU)计量使用量,并对每个密钥实施速率限制。请据此规划您的请求模式
references/operational-request-logs.md
请求日志请求日志有助于调试失败的调用和监控延迟
references/operational-roles-and-sso.md
角色和SSO团队访问控制确保API密钥和账单设置的安全管理
references/operational-sandbox.md
沙箱/测试环境使用测试网或单独的Alchemy应用进行安全开发和QA
references/operational-supported-networks.md
支持的网络Alchemy支持多个EVM和Solana网络。请务必在控制台中确认每个产品的网络可用性

Ecosystem

Ecosystem

FileNameShort Description
references/ecosystem-overview.md
ecosystemPopular open-source libraries that pair well with Alchemy for building crypto applications. Covers EVM tools (viem, ethers, web3.js, wagmi, RainbowKit, Hardhat, Foundry) and Solana tools (solana/web3.js, spl-token, Anchor, Metaplex). Use when choosing or configuring a client library for your Alchemy integration
references/ecosystem-anchor.md
AnchorAnchor is a Solana framework for building programs with a higher-level Rust and TypeScript SDK
references/ecosystem-ethers.md
Ethers.jsEthers.js is a widely used Ethereum library for wallets, providers, and contract interactions
references/ecosystem-foundry.md
FoundryFoundry is a fast, Rust-based Ethereum toolchain for testing and deployment
references/ecosystem-hardhat.md
HardhatHardhat is a popular Ethereum development environment for compiling, testing, and deploying contracts
references/ecosystem-metaplex.md
MetaplexMetaplex provides NFT standards and tooling on Solana, including metadata and token standards
references/ecosystem-rainbowkit.md
RainbowKitRainbowKit is a wallet connection UI kit commonly used with wagmi
references/ecosystem-solana-web3js.md
@solana/web3.jsThe primary JavaScript library for Solana RPC, transactions, and accounts
references/ecosystem-spl-token.md
SPL TokenSPL Token is the standard token program on Solana and includes tools for minting and token account management
references/ecosystem-viem.md
ViemViem is a modern TypeScript Ethereum client library with strong types and a functional API
references/ecosystem-wagmi.md
wagmiwagmi provides React hooks for Ethereum, commonly used with wallet connectors and UI kits
references/ecosystem-web3js.md
Web3.jsWeb3.js is a long-standing Ethereum JavaScript library for providers and contracts
文件名称简短描述
references/ecosystem-overview.md
ecosystem与Alchemy搭配使用的热门开源库,用于构建加密应用。涵盖EVM工具(viem、ethers、web3.js、wagmi、RainbowKit、Hardhat、Foundry)和Solana工具(solana/web3.js、spl-token、Anchor、Metaplex)。当为您的Alchemy集成选择或配置客户端库时使用
references/ecosystem-anchor.md
AnchorAnchor是Solana的框架,用于使用高级Rust和TypeScript SDK构建程序
references/ecosystem-ethers.md
Ethers.jsEthers.js是广泛使用的以太坊库,用于钱包、提供者和合约交互
references/ecosystem-foundry.md
FoundryFoundry是基于Rust的快速以太坊工具链,用于测试和部署
references/ecosystem-hardhat.md
HardhatHardhat是流行的以太坊开发环境,用于编译、测试和部署合约
references/ecosystem-metaplex.md
MetaplexMetaplex在Solana上提供NFT标准和工具,包括元数据和代币标准
references/ecosystem-rainbowkit.md
RainbowKitRainbowKit是常用的钱包连接UI套件,通常与wagmi搭配使用
references/ecosystem-solana-web3js.md
@solana/web3.jsSolana RPC、交易和账户的主要JavaScript库
references/ecosystem-spl-token.md
SPL TokenSPL Token是Solana上的标准代币程序,包括铸造和代币账户管理工具
references/ecosystem-viem.md
ViemViem是现代TypeScript以太坊客户端库,具备强类型和函数式API
references/ecosystem-wagmi.md
wagmiwagmi为以太坊提供React钩子,通常与钱包连接器和UI套件搭配使用
references/ecosystem-web3js.md
Web3.jsWeb3.js是历史悠久的以太坊JavaScript库,用于提供者和合约

Official Links

官方链接