📝 准备工作:获取 API 密钥
在开始调用任何接口之前,您首先需要获得一个用于身份验证的 API Key(有时在文档中也称为 key)。
- 获取方式:根据官方文档,您需要联系 StockTV 官方或其客服人员来获取您专属的 API Key 。
- 重要提示:请妥善保管您的 API Key,并在所有请求中将其作为
key参数传递。
🔑 核心接口详解
以下是几个最常用的加密货币数据接口及其使用方法。
1. 获取交易对列表
在获取具体数据前,您通常需要知道平台支持哪些交易对。这个接口可以获取所有支持的加密货币交易对列表 。
-
接口地址:
GET https://api.stocktv.top/crypto/getCoinMarket或GET https://api.stocktv.top/crypto/pairlist -
主要参数:
key:您的 API 密钥。start:列表起始位置,默认为1 。limit:返回的记录数量,默认100,最大支持100 。
-
返回示例:返回信息包括交易对符号(symbol)、名称(name)、最新价格、市值、涨跌幅等 。
2. 获取最新行情
此接口用于获取指定交易对的完整实时行情快照,信息非常全面 。
-
接口地址:
GET https://api.stocktv.top/crypto/tickerPrice -
主要参数:
key:您的 API 密钥。symbols:交易对列表,多个用英文逗号分隔,例如BTCUSDT,ETHUSDT。最多支持100个交易对 。
-
返回数据:通常包括最新价、开盘价、最高价、最低价、涨跌幅、成交量等 。
3. 获取K线数据
K线数据是进行技术分析和图表展示的核心,用于获取特定时间周期的历史价格走势 。
-
接口地址:
GET https://api.stocktv.top/crypto/getKlines或GET https://api.stocktv.top/crypto/kline -
主要参数:
key:您的 API 密钥。symbol:交易对,如BTCUSDT。interval:K线时间间隔,支持非常多的周期,如1m(1分钟)、5m、1h(1小时)、1d(1天)、1w(1周)等 。
-
返回数据:通常是一个数组,每条数据包含开盘时间、开盘价、最高价、最低价、收盘价、成交量等信息 。
💻 Python 代码示例
以下是一个使用 Python 的 requests库调用“获取最新价格”接口的简单示例,帮助您快速上手 。
import requests
def get_crypto_price(symbols="BTCUSDT,ETHUSDT"):
"""
获取加密货币的最新价格
"""
url = "https://api.stocktv.top/crypto/lastPrice"
params = {
"symbols": symbols,
"key": "YOUR_API_KEY_HERE" # 请务必替换为您的真实API Key
}
try:
response = requests.get(url, params=params, timeout=10)
response.raise_for_status() # 如果状态码不是200,将抛出异常
data = response.json()
# 检查API返回的业务状态码
if data.get('code') == 200:
return data.get('data', [])
else:
print(f"接口返回错误: {data.get('message')}")
return None
except requests.exceptions.RequestException as e:
print(f"请求发生错误: {e}")
return None
# 调用函数
if __name__ == "__main__":
prices = get_crypto_price()
if prices:
for coin in prices:
print(f"交易对: {coin['symbol']}, 最新价格: {coin['price']}")
⚠️ 注意事项与最佳实践
- 参数格式:确保交易对符号(如
BTCUSDT)的格式正确,并且多个符号之间使用英文逗号分隔,不要有空格 。 - 频率限制:虽然公开文档可能未明确说明具体的频率限制,但作为最佳实践,建议合理控制您的请求频率,避免过度频繁的调用,以免触发系统的限制 。
- 错误处理:在您的代码中务必添加完善的错误处理逻辑,检查HTTP状态码和API返回的业务码(例如,
code为 200 表示成功,400 表示参数错误,401 表示密钥无效等)。 - 实时数据:对于需要极高实时性的场景(如实时价格监控屏),可以考虑使用 StockTV 提供的 WebSocket 接口,这比反复轮询 HTTP API 更高效 。
- 数据用途:请注意,这些接口提供的数据主要用于学习和研究目的,不构成投资建议 。
希望这份指南能帮助您顺利对接 StockTV 的加密货币数据接口!如果您在具体实践中遇到某个接口的细节问题,可以告诉我,我们一起探讨。