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。