API Key

使用 TronGrid V1 API 前,先选择网络入口并配置 API key。API key 用于身份识别、配额管理、限流控制和安全策略配置。

TronGrid V1 API 同时覆盖 Mainnet、Shasta 测试网和 Nile 测试网。不同网络的数据互不相同,请在开发、测试和生产环境中分别使用对应入口。

网络入口

网络Base URL用途
Mainnethttps://api.trongrid.io主网生产环境
Shasta 测试网https://api.shasta.trongrid.io测试网开发与验证
Nile 测试网https://nile.trongrid.io测试网开发与验证

API Key 是什么

API key 是 TronGrid 分配给调用方的访问凭据。它不会替你签名交易,也不代表链上账户权限;它只用于 TronGrid 服务侧的调用识别、额度统计和访问控制。

生产环境应始终携带 API key。未携带 API key 的请求可能被严格限流或直接拒绝。通过 TronGrid 访问 Shasta 或 Nile 测试网时,是否需要 API key 以 TronGrid 当前控制台和服务策略为准。

创建 API Key

登录 TronGrid 控制台 后,在 API key 列表页创建 key。每把 key 都有独立配置页面,可以按业务需要调整配额、限流和安全策略。

建议按业务系统或环境拆分 key,例如:

Key 类型推荐用途
开发环境 key本地开发、测试脚本、临时验证
生产后端 key后端服务、DApp 后端、索引器
只读分析 key数据看板、监控、AI Agent 查询

不要在多个无关系统之间复用同一把 key。这样可以独立观察流量、定位异常请求,并在必要时只轮换受影响的 key。

使用 API Key

在 HTTP 请求头中添加 TRON-PRO-API-KEY

curl --request GET \
  --url 'https://api.trongrid.io/v1/accounts/TXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
  --header 'TRON-PRO-API-KEY: <your-trongrid-api-key>'

Python 示例:

import requests

url = "https://api.trongrid.io/v1/accounts/TXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
headers = {
    "TRON-PRO-API-KEY": "<your-trongrid-api-key>"
}

response = requests.get(url, headers=headers, timeout=10)
print(response.text)

JavaScript 示例:

const response = await fetch(
  "https://api.trongrid.io/v1/accounts/TXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  {
    headers: {
      "TRON-PRO-API-KEY": "<your-trongrid-api-key>"
    }
  }
);

console.log(await response.json());

配额、限流和安全配置

API key 还可以绑定限流和安全策略:

配置说明
速率限制控制单位时间内可发起的请求数量,避免流量突增影响服务稳定性
User-Agent 允许列表限制只有匹配指定 User-Agent 的请求可以使用该 key
Origin 允许列表限制浏览器请求只能来自指定站点
合约地址允许列表限制只能查询或调用指定合约地址
请求 API 允许列表限制 key 只能访问指定 API 方法
JWT在 API key 之外增加基于签名令牌的请求认证

相关资源

  • 速率限制 —— 请求配额、429 / 403 响应和退避策略
  • 安全设置 —— User-Agent、Origin、合约地址、API 方法允许列表和 JWT
  • TronGrid V1 API 概览 —— V1 API 分类与入口说明
  • TronGrid —— TronGrid 节点服务和扩展 API 介绍