API 参考REST APIv1

使用 AlphaX API 密钥查询交易所数据、当前新闻和联网工具。

接口地址https://alphax.pro
身份认证 API Key

注册并登录后,在账户中创建 API 密钥。使用下方任意一种请求头传递密钥,不要将密钥放入 URL 或公开的浏览器代码。

HTTP
Authorization: Bearer <API_KEY>
X-API-Key: <API_KEY>

API 密钥仅支持只读查询。浏览器本地工具,以及账户、自选和提醒的修改不属于开放接口范围。

调用限速 每秒 1 次

同一账户的全部密钥、所有接口共用每秒一次的调用额度。认证成功的请求即使参数错误或上游失败,也会占用本次间隔。收到 HTTP 429 后,请按 Retry-After 响应头等待再重试。

行情来自缓存中的观测数据,使用前请检查更新时间及 market-status 状态;空列表不代表数据源实际没有交易标的。

HTTP说明
400请求无效或交易所不支持该能力
401密钥缺失、无效或已撤销
404未知交易所或查询资源
422参数无效
429调用超限,请按 Retry-After 等待
502 / 503 / 504上游或依赖服务暂时不可用。
调用示例 cURL · Python · JavaScript

在服务端环境中设置 API_KEY。每个接口都提供可复制的示例,请求之间至少间隔一秒。

所有响应统一包含 data、meta 和 error。列表位于 data 数组,分页和来源等信息位于 meta;错误包含 code 和 message。

symbol 精确查询单个交易标识,symbols 查询最多 30 个逗号分隔的标识。加密货币交易对统一使用 BASE-QUOTE,例如 BTC-USDT;交易所原始标识由系统内部映射。模糊搜索使用 q。

新闻查询覆盖最近 72 小时。language 筛选原文语言,locale 控制响应标签与链接语言,简体和繁体中文分别筛选。

省略 ip 时查询调用方的公网 IP;从本机或内网调用时,需要显式传入公网 IP。

响应示例为演示数据,并非实时行情。

市场

交易所

返回已配置的交易所、数据源别名及现货/合约能力;数量不可用时可能为 null。

GET/api/v1/exchanges

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · ExchangeList

字段类型说明
dataExchange[]标准化查询结果;列表始终为数组。
data[].data_sourcestring—
data[].futures_countinteger | null已报告的合约标的数量,不可用时为 null。
data[].has_futuresboolean—
data[].has_spotboolean—
data[].idstring—
data[].market_data_sourcestring—
data[].namestring—
data[].spot_countinteger | null已报告的现货标的数量,不可用时为 null。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.totalinteger匹配记录总数。

市场

市场

分页查询行情,默认 Binance 现货。交易所 ID 从 /exchanges 获取;股票数据通过 /stocks 查询。

GET/api/v1/markets

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
exchange可选 string

已配置的交易所 ID,默认 binance。

market可选 string

市场类型,默认 spot。

允许值: spot, futures

q可选 string

搜索内容,最多 80 个字符。

maxLength: 80

page可选 integer

页码。

默认值: 1

minimum: 1 · maximum: 10000

limit可选 integer

每页条数。

默认值: 80

minimum: 1 · maximum: 200

sort可选 string

排序字段,默认 volume。

允许值: symbol, price, change, high, low, volume

dir可选 string

排序方向。

允许值: asc, desc

symbol可选 string

精确交易标识,例如 BTC-USDT 或 AAPL。不区分大小写;系统在内部映射交易所原始标识。不能与 symbols 或 q 同时使用。

symbols可选 string

逗号分隔的精确交易标识,最多 30 个。不能与 symbol 或 q 同时使用。先匹配再分页;股票在一页内返回所请求的结果。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · MarketPage

字段类型说明
dataTicker[]标准化查询结果;列表始终为数组。
data[].basestring基础资产代码。
data[].change_24hnumber价格涨跌百分数,请同时检查 change_period 统计周期。
data[].change_periodstring—
data[].exchangestring交易所或独立数据源 ID。
data[].high_24hnumber—
data[].low_24hnumber—
data[].market_typestring—
data[].pricenumber以报价币计价的观测价格。
data[].quotestring报价币种代码。
data[].range_periodstring—
data[].symbolstring站内规范化标的标识。
data[].updated_atinteger观测时间,单位为 Unix 秒。
data[].volume_24hnumber以报价币为单位的成交量,请同时检查可用性和估算标记。
data[].volume_estimatedboolean—
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.countsobject—
meta.exchangestring—
meta.market_typestring—
meta.paginationPagination分页元数据及指向本 API 的翻页链接。
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstring下一页 API 地址,没有下一页时为空字符串。
meta.pagination.pageinteger当前页码,从 1 开始。
meta.pagination.previous_urlstring上一页 API 地址,没有上一页时为空字符串。
meta.pagination.startinteger—
meta.pagination.totalinteger匹配记录总数。
meta.pagination.total_pagesinteger总页数。
meta.querystring—
meta.sourcestring—
meta.totalinteger—
meta.updated_atinteger观测时间,单位为 Unix 秒。

市场

现货行情

返回指定交易所的现货行情快照,请同时通过 /market-status 检查数据源健康状态和时间。

GET/api/v1/tickers/{exchange}/spot

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

路径参数

参数类型说明
exchange必填 string

已配置的交易所 ID。

查询参数

参数类型说明
symbol可选 string

精确交易标识,例如 BTC-USDT 或 AAPL。不区分大小写;系统在内部映射交易所原始标识。不能与 symbols 或 q 同时使用。

symbols可选 string

逗号分隔的精确交易标识,最多 30 个。不能与 symbol 或 q 同时使用。先匹配再分页;股票在一页内返回所请求的结果。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · TickerArray

字段类型说明
dataTicker[]标准化查询结果;列表始终为数组。
data[].basestring基础资产代码。
data[].change_24hnumber价格涨跌百分数,请同时检查 change_period 统计周期。
data[].change_periodstring—
data[].exchangestring交易所或独立数据源 ID。
data[].high_24hnumber—
data[].low_24hnumber—
data[].market_typestring—
data[].pricenumber以报价币计价的观测价格。
data[].quotestring报价币种代码。
data[].range_periodstring—
data[].symbolstring站内规范化标的标识。
data[].updated_atinteger观测时间,单位为 Unix 秒。
data[].volume_24hnumber以报价币为单位的成交量,请同时检查可用性和估算标记。
data[].volume_estimatedboolean—
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.exchangestring—
meta.totalinteger—

市场

合约行情

返回指定交易所的合约行情快照,请同时通过 /market-status 检查数据源健康状态和时间。

GET/api/v1/tickers/{exchange}/futures

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

路径参数

参数类型说明
exchange必填 string

已配置的交易所 ID。

查询参数

参数类型说明
symbol可选 string

精确交易标识,例如 BTC-USDT 或 AAPL。不区分大小写;系统在内部映射交易所原始标识。不能与 symbols 或 q 同时使用。

symbols可选 string

逗号分隔的精确交易标识,最多 30 个。不能与 symbol 或 q 同时使用。先匹配再分页;股票在一页内返回所请求的结果。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · TickerArray

字段类型说明
dataTicker[]标准化查询结果;列表始终为数组。
data[].basestring基础资产代码。
data[].change_24hnumber价格涨跌百分数,请同时检查 change_period 统计周期。
data[].change_periodstring—
data[].exchangestring交易所或独立数据源 ID。
data[].high_24hnumber—
data[].low_24hnumber—
data[].market_typestring—
data[].pricenumber以报价币计价的观测价格。
data[].quotestring报价币种代码。
data[].range_periodstring—
data[].symbolstring站内规范化标的标识。
data[].updated_atinteger观测时间,单位为 Unix 秒。
data[].volume_24hnumber以报价币为单位的成交量,请同时检查可用性和估算标记。
data[].volume_estimatedboolean—
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.exchangestring—
meta.totalinteger—

市场

资金费率

分页查询合约资金费率,每页 80 条。费率使用百分数,next_funding_time 为 Unix 秒。

GET/api/v1/funding-rates

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
source可选 string

独立合约数据源 ID,或 all(默认)。

q可选 string

搜索内容,最多 80 个字符。

maxLength: 80

page可选 integer

页码。

默认值: 1

minimum: 1 · maximum: 10000

sort可选 string

排序字段,默认 abs_rate。

允许值: abs_rate, rate, annualized, symbol, exchange, mark, index, interval, next

dir可选 string

排序方向,默认 desc。

允许值: asc, desc

symbol可选 string

精确交易标识,例如 BTC-USDT 或 AAPL。不区分大小写;系统在内部映射交易所原始标识。不能与 symbols 或 q 同时使用。

symbols可选 string

逗号分隔的精确交易标识,最多 30 个。不能与 symbol 或 q 同时使用。先匹配再分页;股票在一页内返回所请求的结果。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · FundingPage

字段类型说明
dataFundingRate[]标准化查询结果;列表始终为数组。
data[].basestring基础资产代码。
data[].exchangestring交易所或独立数据源 ID。
data[].funding_interval_hoursinteger资金费率结算间隔,单位为小时。
data[].funding_ratenumber资金费率百分数:0.01 表示 0.01%。
data[].funding_rate_annualizednumber—
data[].index_pricenumber—
data[].mark_pricenumber—
data[].next_funding_timeinteger下一次资金费率结算时间,单位为 Unix 秒。
data[].quotestring报价币种代码。
data[].symbolstring站内规范化标的标识。
data[].updated_atinteger观测时间,单位为 Unix 秒。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.all_totalinteger—
meta.paginationPagination分页元数据及指向本 API 的翻页链接。
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstring下一页 API 地址,没有下一页时为空字符串。
meta.pagination.pageinteger当前页码,从 1 开始。
meta.pagination.previous_urlstring上一页 API 地址,没有上一页时为空字符串。
meta.pagination.startinteger—
meta.pagination.totalinteger匹配记录总数。
meta.pagination.total_pagesinteger总页数。
meta.querystring—
meta.sourcestring媒体或查询数据提供方的名称。
meta.source_countsobject—
meta.totalinteger匹配记录总数。
meta.updated_atinteger观测时间,单位为 Unix 秒。

市场

交易所资金费率

返回完整资金费率快照,包含数据源状态和 generated_at 时间。

GET/api/v1/funding-rates/{exchange}

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

路径参数

参数类型说明
exchange必填 string

支持合约的交易所 ID。

查询参数

参数类型说明
symbol可选 string

精确交易标识,例如 BTC-USDT 或 AAPL。不区分大小写;系统在内部映射交易所原始标识。不能与 symbols 或 q 同时使用。

symbols可选 string

逗号分隔的精确交易标识,最多 30 个。不能与 symbol 或 q 同时使用。先匹配再分页;股票在一页内返回所请求的结果。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · FundingSnapshot

字段类型说明
dataFundingRate[]标准化查询结果;列表始终为数组。
data[].basestring基础资产代码。
data[].exchangestring交易所或独立数据源 ID。
data[].funding_interval_hoursinteger资金费率结算间隔,单位为小时。
data[].funding_ratenumber资金费率百分数:0.01 表示 0.01%。
data[].funding_rate_annualizednumber—
data[].index_pricenumber—
data[].mark_pricenumber—
data[].next_funding_timeinteger下一次资金费率结算时间,单位为 Unix 秒。
data[].quotestring报价币种代码。
data[].symbolstring站内规范化标的标识。
data[].updated_atinteger观测时间,单位为 Unix 秒。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.exchangestring交易所或独立数据源 ID。
meta.statusFeedStatus数据源或服务状态;HTTP 成功不代表上游健康。
meta.status.errorstring错误标识或诊断摘要。
meta.status.last_success_atinteger—
meta.status.okboolean该数据源是否健康。
meta.status.updated_atinteger观测时间,单位为 Unix 秒。
meta.totalinteger—
meta.updated_atinteger快照生成时间,单位为 Unix 秒。

市场

未平仓量

查询支持数据源的未平仓量榜单,默认 binance;单位和可用来源与本站未平仓量页面一致。

GET/api/v1/open-interest

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
source可选 string

支持未平仓量的数据源 ID,响应的 source_ids 提供可用列表。

q可选 string

搜索内容,最多 80 个字符。

maxLength: 80

page可选 integer

页码。

默认值: 1

minimum: 1 · maximum: 10000

limit可选 integer

每页条数。

默认值: 80

minimum: 1 · maximum: 80

sort可选 string

排序字段,默认 oi。

允许值: symbol, oi, change, exchange, volume, price

dir可选 string

排序方向,默认 desc。

允许值: asc, desc

symbol可选 string

精确交易标识,例如 BTC-USDT 或 AAPL。不区分大小写;系统在内部映射交易所原始标识。不能与 symbols 或 q 同时使用。

symbols可选 string

逗号分隔的精确交易标识,最多 30 个。不能与 symbol 或 q 同时使用。先匹配再分页;股票在一页内返回所请求的结果。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · OpenInterestPage

字段类型说明
dataOpenInterest[]标准化查询结果;列表始终为数组。
data[].basestring基础资产代码。
data[].change_24hnumber—
data[].change_periodstring—
data[].exchangestring交易所或独立数据源 ID。
data[].open_interestnumber以基础资产数量计的未平仓量。
data[].open_interest_change_pctnumber | null变化百分数,没有可比观测时为 null。
data[].open_interest_valuenumber以报价币计的未平仓量价值。
data[].pricenumber以报价币计价的观测价格。
data[].quotestring报价币种代码。
data[].symbolstring站内规范化标的标识。
data[].timestampinteger观测时间,单位为 Unix 秒。
data[].volume_24hnumber—
data[].volume_estimatedboolean—
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.all_totalinteger—
meta.paginationPagination分页元数据及指向本 API 的翻页链接。
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstring下一页 API 地址,没有下一页时为空字符串。
meta.pagination.pageinteger当前页码,从 1 开始。
meta.pagination.previous_urlstring上一页 API 地址,没有上一页时为空字符串。
meta.pagination.startinteger—
meta.pagination.totalinteger匹配记录总数。
meta.pagination.total_pagesinteger总页数。
meta.querystring—
meta.sourcestring媒体或查询数据提供方的名称。
meta.source_countsobject—
meta.source_idsstring[]—
meta.totalinteger匹配记录总数。
meta.updated_atinteger观测时间,单位为 Unix 秒。

市场

股票

Binance 股票行情及数据可用标记。分页信息位于 meta.pagination;精确标识查询在一页内返回结果。

GET/api/v1/stocks

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
q可选 string

搜索内容,最多 80 个字符。

maxLength: 80

region可选 string

地区,默认 all。

允许值: all, us

universe可选 string

股票范围,默认 all。

允许值: all, tokenized

page可选 integer

页码。

默认值: 1

minimum: 1 · maximum: 10000

limit可选 integer

每页条数。

默认值: 80

minimum: 1 · maximum: 200

sort可选 string

排序字段。

允许值: symbol, price, change, high, low, volume

dir可选 string

排序方向。

允许值: asc, desc

symbol可选 string

精确交易标识,例如 BTC-USDT 或 AAPL。不区分大小写;系统在内部映射交易所原始标识。不能与 symbols 或 q 同时使用。

symbols可选 string

逗号分隔的精确交易标识,最多 30 个。不能与 symbol 或 q 同时使用。先匹配再分页;股票在一页内返回所请求的结果。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · StockArray

字段类型说明
dataobject[]标准化查询结果;列表始终为数组。
data[].asset_codestring | null—
data[].asset_namestring | null—
data[].basestring | null—
data[].change_24hnumber | null—
data[].change_availableboolean—
data[].data_staleboolean该观测数据是否已过期。
data[].data_timestampinteger | null—
data[].exchangestring | null—
data[].high_24hnumber | null—
data[].low_24hnumber | null—
data[].market_phasestring | null—
data[].market_typestring—
data[].namestring | null—
data[].pricenumber | null—
data[].price_availableboolean是否存在可用的观测价格。
data[].quotestring | null—
data[].stock_marketstring—
data[].symbolstring站内规范化标的标识。
data[].tradabilitystring | null—
data[].trading_statusstring—
data[].volume_24hnumber | null—
data[].volume_availableboolean—
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.paginationPagination—
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstring下一页 API 地址,没有下一页时为空字符串。
meta.pagination.pageinteger当前页码,从 1 开始。
meta.pagination.previous_urlstring上一页 API 地址,没有上一页时为空字符串。
meta.pagination.startinteger—
meta.pagination.totalinteger匹配记录总数。
meta.pagination.total_pagesinteger总页数。
meta.totalinteger—

市场

行情数据状态

返回各数据源的健康状态、数量和最后成功时间。HTTP 请求成功不代表上游数据源健康。

GET/api/v1/market-status

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · MarketStatus

字段类型说明
dataobject标准化查询结果;列表始终为数组。
data.degraded_feedsstring[]—
data.exchangesobject[]—
data.exchanges[].countsobject—
data.exchanges[].exchangestring交易所或独立数据源 ID。
data.exchanges[].generated_atinteger快照生成时间,单位为 Unix 秒。
data.exchanges[].statusobject数据源或服务状态;HTTP 成功不代表上游健康。
data.statusstring数据源或服务状态;HTTP 成功不代表上游健康。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。

新闻

新闻

查询原始发布时间位于最近 72 小时的新闻,按时间倒序并按原文 URL 去重。语言筛选仅选择对应原文,不翻译文章;省略 language 时返回所有可用语言。

GET/api/v1/news

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
language可选 string

文章语言:en、zh-CN、zh-TW、es、de、ja、fr、all 或 auto;auto 跟随 locale,兼容中文语言别名。

source可选 string

新闻响应 sources 中的媒体显示名称。

asset可选 string

资产标识,例如 BTC。

q可选 string

搜索内容,最多 80 个字符。

maxLength: 80

page可选 integer

页码。

默认值: 1

minimum: 1 · maximum: 10000

limit可选 integer

每页文章数。

默认值: 24

minimum: 1 · maximum: 50

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · NewsPage

字段类型说明
dataArticle[]标准化查询结果;列表始终为数组。
data[].archived_isostring—
data[].assetsstring[]—
data[].descriptionstring—
data[].detail_urlstring—
data[].languagestring文章原文语言,不进行翻译。
data[].published_isostring原始发布时间,格式为 ISO 8601。
data[].slugstring—
data[].sourcestring媒体或查询数据提供方的名称。
data[].titlestring—
data[].urlstring原始媒体链接。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.assetstring—
meta.languagestring文章原文语言,不进行翻译。
meta.language_filtersobject[]—
meta.language_filters[].codestring—
meta.language_filters[].label_keystring—
meta.limitinteger—
meta.paginationPagination分页元数据及指向本 API 的翻页链接。
meta.pagination.endinteger—
meta.pagination.limitinteger—
meta.pagination.next_urlstring下一页 API 地址,没有下一页时为空字符串。
meta.pagination.pageinteger当前页码,从 1 开始。
meta.pagination.previous_urlstring上一页 API 地址,没有上一页时为空字符串。
meta.pagination.startinteger—
meta.pagination.totalinteger匹配记录总数。
meta.pagination.total_pagesinteger总页数。
meta.querystring—
meta.sourcestring媒体或查询数据提供方的名称。
meta.sourcesstring[]—
meta.totalinteger匹配记录总数。

工具箱

IP 查询

省略 ip 时查询调用方的公网 IP,仅信任来自回环地址反向代理的转发 IP。内网及保留地址返回 422,本机调用需显式传入公网 IP。

GET/api/v1/tools/ip

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
ip可选 string

可选的公网 IPv4 或 IPv6;省略或留空时查询调用方 IP。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · IPResult

字段类型说明
dataobject标准化查询结果;列表始终为数组。
data.as_domainstring自治系统域名,仅在数据提供方返回时存在。
data.asnstring自治系统编号,仅在数据提供方返回时存在。
data.citystring数据提供方报告的城市,有数据时返回。
data.countrystring国家名称,仅在数据提供方返回时存在。
data.country_codestring数据提供方报告的两位国家代码。
data.hostnamestring报告的主机名,有数据时返回。
data.ipstring规范化的公网 IPv4 或 IPv6 地址。
data.locationstring报告的经纬度,有数据时返回。
data.organizationstring网络组织名称,仅在数据提供方返回时存在。
data.regionstring数据提供方报告的地区,有数据时返回。
data.timezonestring报告的时区,有数据时返回。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.sourcestring媒体或查询数据提供方的名称。
meta.updated_atstring查询观测时间,格式为 ISO 8601。

工具箱

DNS 查询

通过现有 daemon 查询服务解析公开 DNS 记录。

GET/api/v1/tools/dns

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
input必填 string

域名;PTR 也接受公网 IP 地址。

type可选 string

记录类型,默认 A。

允许值: A, AAAA, MX, TXT, NS, CNAME, SOA, CAA, SRV, PTR

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · DNSResult

字段类型说明
dataobject标准化查询结果;列表始终为数组。
data.dnssecbooleanDNS 解析服务是否验证了该响应。
data.namestring规范化后的 DNS 查询名称。
data.recordsobject[]返回的 DNS 记录,数组可以为空。
data.records[].datastringDNS 记录内容。
data.records[].namestringDNS 记录的所属名称。
data.records[].ttlinteger记录的生存时间,单位为秒。
data.records[].typestringDNS 记录类型。
data.statusstringDNS 响应状态:NOERROR 或 NXDOMAIN。
data.typestring请求的 DNS 记录类型。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.sourcestring媒体或查询数据提供方的名称。
meta.updated_atstring查询观测时间,格式为 ISO 8601。

工具箱

WHOIS 查询

通过 RDAP 查询域名的公开注册资料。

GET/api/v1/tools/whois

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
input必填 string

公网域名。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · WhoisResult

字段类型说明
dataobject标准化查询结果;列表始终为数组。
data.dnssecboolean域名是否启用 DNSSEC 签名,仅在返回该信息时存在。
data.domainstring规范化域名。
data.eventsobject[]域名注册生命周期事件。
data.events[].actionstring—
data.events[].datestring—
data.handlestring注册局标识。
data.nameserversstring[]已注册的域名服务器列表。
data.registrarstring注册商名称,仅在返回该信息时存在。
data.statusstring[]域名注册状态列表。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.sourcestring媒体或查询数据提供方的名称。
meta.updated_atstring查询观测时间,格式为 ISO 8601。

工具箱

汇率查询

查询货币对的参考汇率,响应时间标明数据的参考日期。

GET/api/v1/tools/forex

授权

在以下任意一种请求头中传递有效的 API 密钥。

Authorization
Bearer <API_KEY>
X-API-Key
<API_KEY>

请求限速

每秒一次,同一账户的全部密钥共用额度。 调用限速 ↗

查询参数

参数类型说明
from必填 string

源货币,例如 USD。

to必填 string

目标货币,例如 CNY。

locale可选 string

响应标签及文章链接的语言:en、zh-cn、zh-tw、es、de、ja 或 fr,默认 en;不筛选文章原文语言。

响应字段 200

application/json · ForexResult

字段类型说明
dataobject标准化查询结果;列表始终为数组。
data.basestring源货币代码。
data.datestring参考汇率日期;源货币与目标货币相同时为空。
data.quotestring目标货币代码。
data.ratenumber一单位源货币对应的目标货币数量。
errornull失败时为错误对象,成功时为 null。
metaobject分页、数据来源和观测时间等元数据。
meta.sourcestring媒体或查询数据提供方的名称。
meta.updated_atstring查询观测时间,格式为 ISO 8601。