Kraken 交易所 API 使用指南
Kraken 交易所提供了一套强大的 API (Application Programming Interface),允许开发者以编程方式访问其交易平台,并进行各种操作,例如获取市场数据、下单、管理账户等。 本文将深入探讨 Kraken API 的使用方法,帮助你快速上手并构建自己的交易应用。
API 概述
Kraken API 提供强大的接口,允许开发者与 Kraken 交易所进行交互。API 主要分为两种类型,满足不同的用户需求:
Public API: 无需认证即可访问,主要用于获取公开的市场数据,例如交易对信息、当前价格、成交历史等。所有 API 请求都使用 HTTPS 协议,返回数据格式通常为 JSON。
认证与授权
访问 Private API 之前,必须进行严格的认证流程。 认证过程的核心在于生成一对独一无二的 API 密钥和私钥,并且至关重要的是,你需要将它们以加密形式安全地存储在你的应用程序或服务器环境中,以防止未经授权的访问。API 密钥用于识别你的应用程序或账户,而私钥则用于生成加密签名,这个签名附加到每一个 API 请求中,作为验证请求来源和数据完整性的重要手段。
认证机制确保只有经过授权的用户或应用程序才能访问敏感数据和执行特定操作,从而保护系统免受潜在的安全威胁。 密钥管理是安全认证的关键环节,务必采取最佳实践,例如使用环境变量、密钥管理系统 (KMS) 或硬件安全模块 (HSM) 来安全地存储和管理你的 API 密钥和私钥。 定期轮换密钥也是一种推荐的安全措施,可以降低密钥泄露带来的风险。
生成 API 密钥: 登录你的 Kraken 账户,进入 "API" 页面,创建一个新的 API 密钥。 在创建密钥时,请务必设置权限,只赋予应用程序所需的最小权限,以降低安全风险。- 创建 POST 数据: 将请求参数转换为字符串,并进行 URL 编码。
- 计算 Nonce: Nonce (Number used Once) 是一个唯一的随机数,用于防止重放攻击。 每次请求都需要生成一个新的 Nonce。 可以使用 Unix 时间戳乘以 1000 来生成 Nonce。
- 创建签名消息: 将 API 路径、Nonce 和 POST 数据连接起来,并进行 SHA256 哈希。
- 计算 HMAC 签名: 使用你的私钥作为密钥,对 SHA256 哈希后的消息进行 HMAC-SHA512 计算。
-
将签名添加到请求头: 将生成的签名添加到
API-Sign
请求头中。
Public API 使用
Public API 提供了一系列接口,用于获取实时和历史的市场数据,无需身份验证即可访问。这些接口旨在为开发者、交易员和研究人员提供便捷的数据访问途径,从而支持各种应用场景,例如量化交易策略开发、市场分析和数据可视化。 以下是一些常用的接口及其详细说明:
-
交易对信息查询:
获取所有可用交易对的详细信息,包括交易对代码、基础货币、报价货币、最小交易数量、价格精度等。这些信息对于构建交易系统和进行交易参数校验至关重要。
-
实时行情数据:
获取特定交易对的最新价格、最高价、最低价、成交量等实时行情数据。此接口是构建实时交易看板、价格预警系统以及高频交易策略的基础。
-
历史K线数据:
获取指定交易对在一定时间范围内的历史K线数据,包括开盘价、收盘价、最高价、最低价和成交量。K线数据是技术分析的基础,可用于识别趋势、支撑位和阻力位,以及构建各种技术指标。
该接口通常支持多种时间周期选择,例如分钟线、小时线、日线等,以满足不同时间尺度的分析需求。
-
深度数据:
获取特定交易对的买单和卖单的深度信息,展示市场上买卖双方的挂单情况。深度数据可以帮助用户了解市场的供需关系,判断价格走势,并优化交易策略。
通常,深度数据会按照价格排序,并显示每个价格档位的挂单数量,以便用户更直观地了解市场深度分布。
-
最新成交记录:
获取特定交易对的最新成交记录,包括成交时间、成交价格和成交数量。通过分析成交记录,用户可以了解市场的活跃程度和交易情况,并及时捕捉交易机会。
/0/public/Time
: 获取服务器时间。
/0/public/Assets
: 获取所有可交易资产的信息,例如资产名称、精度等。/0/public/AssetPairs
: 获取所有交易对的信息,例如交易对名称、精度、手续费等。/0/public/Ticker
: 获取指定交易对的最新行情数据,包括当前价格、成交量、最高价、最低价等。/0/public/Depth
: 获取指定交易对的深度数据,即买单和卖单的列表。/0/public/Trades
: 获取指定交易对的成交历史。示例 (Python):
在Python中,我们可以使用requests库与区块链交互。以下是一个简单的例子,展示了如何使用requests库从以太坊节点获取最新的区块高度:
import requests
import
def get_latest_block_number(rpc_endpoint):
"""
从指定的以太坊节点获取最新的区块高度。
参数:
rpc_endpoint (str): 以太坊节点的RPC端点URL。
返回值:
int: 最新的区块高度。
"""
payload = {
"rpc": "2.0",
"method": "eth_blockNumber",
"params": [],
"id": 1
}
headers = {'Content-type': 'application/'}
try:
response = requests.post(rpc_endpoint, =payload, headers=headers)
response.raise_for_status() # 检查HTTP错误
_response = response.()
# 检查JSON RPC 错误
if 'error' in _response:
raise Exception(f"RPC Error: {_response['error']}")
block_number_hex = _response['result']
block_number = int(block_number_hex, 16) # 将十六进制转换为整数
return block_number
except requests.exceptions.RequestException as e:
print(f"请求错误: {e}")
return None
except .JSONDecodeError as e:
print(f"JSON解码错误: {e}")
return None
except Exception as e:
print(f"其他错误: {e}")
return None
# 示例用法
rpc_endpoint = "https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID" # 替换为你的Infura项目ID或其他以太坊节点
latest_block = get_latest_block_number(rpc_endpoint)
if latest_block is not None:
print(f"最新的区块高度: {latest_block}")
else:
print("未能获取最新的区块高度。")
代码解释:
-
导入库:
首先导入
requests
库,用于发送HTTP请求,以及 -
get_latest_block_number
函数:- 接受以太坊节点的RPC端点URL作为参数。
-
构造一个符合JSON-RPC 2.0规范的payload,指定方法为
eth_blockNumber
(获取最新区块高度)。 -
使用
requests.post
发送POST请求到指定的RPC端点。 - 处理响应,包括检查HTTP状态码和JSON解码错误。
- 将返回的十六进制区块高度转换为十进制整数。
-
错误处理:
使用
try...except
块捕获可能的异常,例如网络错误、JSON解码错误和RPC错误。 -
示例用法:
-
将
rpc_endpoint
替换为实际的以太坊节点URL(例如,Infura或Alchemy的URL)。 请务必替换YOUR_INFURA_PROJECT_ID
为你自己的 Infura 项目 ID。 -
调用
get_latest_block_number
函数获取最新区块高度。 - 打印结果。
-
将
注意:
-
你需要安装
requests
库。可以使用pip install requests
命令安装。 - 以太坊节点的RPC端点URL可能需要API密钥或身份验证。请根据你使用的节点提供商的要求进行配置。
- 不同的区块链(例如,比特币、莱特币)使用不同的RPC方法来获取最新区块高度。请参考相应的区块链文档。
- 这段代码是一个基础的例子,你可以根据实际需求进行修改和扩展,例如添加错误处理、自定义请求头等。
-
错误处理包括检查HTTP状态码(使用
response.raise_for_status()
)和JSON-RPC错误(检查_response['error']
)。
Kraken API Ticker Endpoint
Kraken交易所提供了一个强大的API,允许开发者获取实时的市场数据。其中,Ticker endpoint 是获取交易对最新信息的关键接口。该接口返回指定交易对的当前市场价格、交易量和其他重要指标。
API Endpoint URL:
https://api.kraken.com/0/public/Ticker
该URL是用于访问Kraken交易所公开Ticker数据的地址。
/0/
表示API的版本号,
/public/
表明该接口是公开的,无需API密钥即可访问。
/Ticker
则指定了要访问的具体endpoint,即Ticker信息。
请求参数 (可选):
-
pair
: 指定要查询的交易对。例如,XBTUSD
(比特币/美元)。可以同时请求多个交易对的信息,用逗号分隔,例如:XBTUSD,ETHUSD
。
响应数据:
API响应将返回一个JSON对象,包含指定交易对的Ticker信息。重要的字段包括:
-
a
: Ask (卖方报价)。a[0]
是当前最佳卖价,a[1]
是整个卖方挂单的交易量,a[2]
是卖方挂单的笔数。 -
b
: Bid (买方报价)。b[0]
是当前最佳买价,b[1]
是整个买方挂单的交易量,b[2]
是买方挂单的笔数。 -
c
: Close (收盘价)。c[0]
是最近成交价,c[1]
是成交量加权平均价。 -
v
: Volume (交易量)。v[0]
是最近24小时的交易量,v[1]
是今天的交易量。 -
p
: VWAP (Volume Weighted Average Price,成交量加权平均价)。p[0]
是最近24小时的VWAP,p[1]
是今天的VWAP。 -
t
: Trades (成交笔数)。t[0]
是最近24小时的成交笔数,t[1]
是今天的成交笔数。 -
l
: Low (最低价)。l[0]
是最近24小时的最低价,l[1]
是今天的最低价。 -
h
: High (最高价)。h[0]
是最近24小时的最高价,h[1]
是今天的最高价。 -
o
: Open (开盘价)。o
是今天的开盘价。
示例请求:
要获取比特币/美元(XBTUSD)和以太坊/美元(ETHUSD)的Ticker信息,可以使用以下URL:
https://api.kraken.com/0/public/Ticker?pair=XBTUSD,ETHUSD
错误处理:
如果API请求失败,响应将包含一个
error
字段,其中包含错误的详细信息。例如,如果请求了无效的交易对,API将返回一个错误信息。
Request Parameters
请求参数对于成功调用API至关重要。它们定义了您希望检索或修改的特定数据。以下是一个示例,展示了如何设置参数以请求有关XBTUSD交易对的信息:
params = {"pair": "XBTUSD"}
在这个例子中,
params
是一个字典,它包含一个键值对。键
"pair"
指定了您感兴趣的交易对,而值
"XBTUSD"
表示比特币兑美元永续合约。不同的API端点可能需要不同的参数,因此务必查阅相应的API文档以了解每个请求所需的具体参数。
其他常用的参数可能包括:
- count: 返回结果的数量。
- start: 开始时间。
- end: 结束时间。
- resolution: K线图的时间粒度(例如:1m, 5m, 1h, 1d)。
- symbol: 交易品种的符号(例如:BTC, ETH)。
- side: 交易方向(例如:buy, sell)。
- orderQty: 订单数量。
- price: 订单价格。
- orderType: 订单类型(例如:market, limit)。
正确设置请求参数是确保您能够从API获取所需数据的关键步骤。请仔细阅读API文档,了解每个端点所需的参数及其数据类型,并确保您的请求符合API的要求。错误的参数会导致请求失败或返回不正确的数据。
发起请求
在Python中,我们可以使用
requests
库来发起HTTP请求,这是与Web服务器进行交互的关键步骤。以下代码展示了如何使用
requests.get()
方法发送一个GET请求,并将服务器的响应存储在名为
response
的变量中。
response = requests.get(url, params=params)
详细解释:
-
requests.get(url, params=params)
: 这是一个函数调用,用于向指定的URL发送GET请求。 -
url
: 这是一个字符串变量,包含了你想要访问的Web服务器的地址。例如,url
可以是"https://api.example.com/data"
。 -
params
(可选): 这是一个字典(dictionary),包含了要作为查询参数添加到URL中的数据。查询参数通常用于传递额外的信息给服务器,例如排序规则、筛选条件或分页信息。举例:params = {'sort': 'date', 'filter': 'new'}
,这将生成类似"https://api.example.com/data?sort=date&filter=new"
的URL。如果没有查询参数,可以省略params
。 -
response
: 这是requests.get()
函数返回的对象。它包含了服务器对你的请求的响应,包括状态码、响应头和响应体(实际的数据)。通过这个response
对象,你可以进一步处理和分析服务器返回的信息。
请求头(Headers)的配置:
您可以通过在
requests.get()
中添加
headers
参数来定制请求头,这对于模拟不同的客户端或传递认证信息非常重要。
headers = {'User-Agent': 'Mozilla/5.0', 'Authorization': 'Bearer YOUR_API_KEY'}
response = requests.get(url, params=params, headers=headers)
错误处理:
在实际应用中,应该包含错误处理机制,以便应对网络问题或服务器错误。 可以使用
try...except
块来捕获异常。例如:
try:
response = requests.get(url, params=params)
response.raise_for_status() # 如果响应状态码不是 200 OK,则引发 HTTPError 异常
except requests.exceptions.RequestException as e:
print(f"发生错误: {e}")
检查响应状态码
在与加密货币交易所或其他区块链相关服务进行API交互时,检查HTTP响应状态码至关重要。状态码提供了关于请求是否成功以及如果未成功的原因的重要信息。
如果
response.status_code == 200:
,这表明HTTP请求已成功完成。状态码200 OK表示服务器已成功处理请求,并且响应包含请求的数据。
# 解析JSON响应
。加密货币API通常以JSON格式返回数据。因此,需要使用JSON解析器(例如Python中的
.loads()
)将响应文本转换为Python字典或列表,以便可以轻松地访问和操作数据。
data = .loads(response.text)
这行代码使用
.loads()
函数将响应的文本内容(
response.text
)解析为Python数据结构(通常是字典或列表)。解析后的数据存储在变量
data
中。
# 打印数据
。解析JSON数据后,您可以根据需要打印、处理或存储数据。例如,您可以打印整个数据结构或访问特定的字段。
print(data)
这行代码将解析后的数据
data
打印到控制台。这允许开发者查看API返回的数据,并验证数据是否正确。
else:
如果
response.status_code
不是200,则表明请求失败。这时,我们需要处理错误并采取适当的措施。
print(f"请求失败,状态码: {response.status_code}")
这行代码打印一个错误消息,指示请求失败,并显示HTTP状态码。这有助于调试问题,例如,400表示错误请求,401表示未授权,404表示未找到资源,500表示服务器内部错误。
print(response.text)
这行代码打印完整的响应文本。有时,即使状态码不是200,响应文本也可能包含有用的错误消息或调试信息,例如API返回的详细错误描述。检查响应文本可以帮助确定请求失败的原因,并采取纠正措施。
Private API 使用
Private API,也称为私有 API 或认证 API,允许用户执行与自身账户密切相关的操作。这些操作通常涉及账户信息的访问、交易执行、资金管理等。由于涉及敏感数据和资金安全,Private API 通常需要进行身份验证和授权,确保只有账户所有者或授权方才能执行相关操作。
一些常用的 Private API 接口包括:
- 账户余额查询:获取指定账户的可用余额、冻结余额、总资产等信息。这对于跟踪账户资金状况至关重要。
- 交易下单/撤单:允许用户提交买入或卖出订单,并随时撤销未成交的订单。不同类型的订单,例如限价单、市价单等,可能对应不同的 API 接口。
- 历史交易记录查询:检索指定时间范围内的交易历史记录,包括交易时间、交易价格、交易数量、手续费等详细信息。这对于交易分析和税务申报非常有用。
- 资金划转:在不同的账户之间转移资金,例如从交易账户转移到提现账户。
- API 密钥管理:生成、修改或删除 API 密钥。API 密钥用于身份验证,必须妥善保管,防止泄露。
- 提币/充币:发起提币请求将加密货币转移到外部地址,或将加密货币充值到平台账户。通常需要提供提币地址、提币数量等信息。
/0/private/Balance
: 获取账户余额。
/0/private/TradeBalance
: 获取交易余额。/0/private/OpenOrders
: 获取当前未成交的订单。/0/private/ClosedOrders
: 获取已成交的订单。/0/private/AddOrder
: 下单。/0/private/CancelOrder
: 取消订单。示例 (Python):使用HMAC-SHA256签名进行API请求
本示例展示了如何使用Python语言构建一个带有HMAC-SHA256签名的API请求。这种签名方法常用于加密货币交易所和其他需要安全认证的API。
以下是实现此功能的Python代码段:
import requests
import hashlib
import hmac
import base64
import urllib.parse
import time
# API密钥和秘钥 (请替换为你的实际凭据)
api_key = "YOUR_API_KEY"
secret_key = "YOUR_SECRET_KEY"
# API请求的URL
base_url = "https://api.example.com" # 替换为实际的API地址
endpoint = "/v1/orders" # 示例接口,替换为实际的接口
url = base_url + endpoint
# 请求参数 (字典形式)
params = {
"symbol": "BTCUSDT",
"side": "BUY",
"type": "LIMIT",
"quantity": 0.01,
"price": 40000,
"timestamp": int(time.time() * 1000) # 毫秒级时间戳
}
# 构建查询字符串
query_string = urllib.parse.urlencode(params)
# 使用秘钥对查询字符串进行HMAC-SHA256签名
message = query_string.encode('utf-8')
secret = secret_key.encode('utf-8')
signature = hmac.new(secret, message, hashlib.sha256).hexdigest()
# 将签名添加到请求头
headers = {
"X-MBX-APIKEY": api_key, # 一些交易所使用此header
"X-YOUR-API-SIGNATURE": signature # 可自定义Header name
}
# 发送GET请求 (可以使用POST,根据API要求)
try:
response = requests.get(url, params=params, headers=headers)
# 检查响应状态码
response.raise_for_status() # 如果状态码不是200,则引发HTTPError异常
# 解析JSON响应
data = response.()
print(data)
except requests.exceptions.HTTPError as errh:
print(f"HTTP Error: {errh}")
except requests.exceptions.ConnectionError as errc:
print(f"Connection Error: {errc}")
except requests.exceptions.Timeout as errt:
print(f"Timeout Error: {errt}")
except requests.exceptions.RequestException as err:
print(f"Request Error: {err}")
代码解释:
-
api_key
和secret_key
: 替换成你自己的API密钥和私钥。这是访问API的凭证。 切勿将你的密钥泄露给他人! -
base_url
和endpoint
: API的基础URL和具体接口地址。请根据你要访问的API文档进行修改。 -
params
: 请求参数,以字典形式存储。这些参数会附加到URL中。timestamp
通常是必需的,一些交易所要求毫秒级的时间戳。 -
urllib.parse.urlencode(params)
: 将参数字典转换为URL编码的字符串,例如symbol=BTCUSDT&side=BUY
。 -
hmac.new(secret, message, hashlib.sha256).hexdigest()
: 使用HMAC-SHA256算法对消息进行签名。secret
是你的私钥,message
是URL编码后的参数字符串。结果是一个十六进制字符串。 -
headers
: HTTP请求头,包含了API密钥和签名。不同的API可能要求不同的头部字段名称。 交易所经常使用X-MBX-APIKEY
。 -
requests.get(url, params=params, headers=headers)
: 发送GET请求。你可以根据API的要求使用requests.post
发送POST请求。 -
错误处理: 代码包含了
try...except
块,用于捕获常见的网络请求错误,例如HTTP错误,连接错误,超时错误等。
注意事项:
- 安全性:始终妥善保管你的API密钥和私钥。不要将它们硬编码到代码中,建议使用环境变量或其他安全的方式存储。
- 时间戳:确保你的时间戳与API服务器的时间同步。时间偏差过大可能会导致请求失败。
- API文档:详细阅读API文档,了解请求的参数,签名方式,以及错误代码的含义。
-
速率限制:注意API的速率限制。如果你的请求频率过高,可能会被API服务器阻止。 可以增加
time.sleep()
延迟。 - 错误处理:编写健壮的错误处理代码,以便在出现问题时能够及时发现并解决。
这段代码提供了一个基本的HMAC-SHA256签名API请求的示例。你需要根据你所使用的具体API的文档进行相应的修改。
请替换为您的API密钥和私钥
API KEY = "YOUR API KEY" API SECRET = "YOUR API SECRET"
以下函数用于生成Kraken API的签名,该签名是安全地与Kraken交易所进行身份验证和数据交换的关键组成部分。它结合了时间戳(nonce)、请求数据和您的私钥,以创建一个唯一的哈希值,防止未经授权的访问。
def get
kraken
signature(urlpath, data, secret):
# 对请求数据进行URL编码,以便与时间戳连接。
postdata = urllib.parse.urlencode(data)
# 将时间戳和编码后的数据组合成一个字符串,并进行UTF-8编码,以便进行SHA256哈希计算。
encoded = (str(data['nonce']) + postdata).encode()
# 将URL路径和SHA256哈希值组合成一个消息,该消息将用于生成HMAC-SHA512签名。
message = urlpath.encode() + hashlib.sha256(encoded).digest()
# 使用HMAC-SHA512算法和您的私钥对消息进行哈希计算。私钥需要先进行Base64解码。
mac = hmac.new(base64.b64decode(secret), message, hashlib.sha512)
# 将HMAC-SHA512哈希值进行Base64编码,以便在HTTP请求头中传递。
sigdigest = base64.b64encode(mac.digest())
# 将Base64编码的签名解码为UTF-8字符串,以便在HTTP请求头中使用。
return sigdigest.decode()
以下函数封装了与Kraken API进行交互的逻辑。它接收API路径、请求数据、API密钥和私钥作为输入,并返回一个包含响应的requests对象。
def kraken
request(uri
path, data, api
key, api
sec):
# 初始化一个空字典,用于存储HTTP请求头。
headers = {}
# 将您的API密钥添加到HTTP请求头中。
headers['API-Key'] = api
key
# 使用get_kraken_signature函数生成API签名,并将其添加到HTTP请求头中。
headers['API-Sign'] = get
kraken
signature(uri
path, data, api
sec)
# 使用requests.post函数向Kraken API发送POST请求。
# 将API路径与Kraken API的根URL连接起来,以形成完整的API端点。
# 将HTTP请求头和请求数据传递给requests.post函数。
req = requests.post(("https://api.kraken.com" + uri
path), headers=headers, data=data)
# 返回包含响应的requests对象。
return req
示例:获取账户余额
在加密货币交易中,获取账户余额是进行交易和投资决策的基础。以下代码演示了如何通过API调用获取账户余额信息。
api_url = "/0/private/Balance"
api_url
变量定义了Kraken API中用于获取账户余额的端点。该端点是一个私有API,需要进行身份验证才能访问。
nonce = str(int(time.time() * 1000))
nonce
(Number used once) 是一个仅使用一次的随机数,用于防止重放攻击。每次API请求都应该生成一个新的
nonce
值。 这里,我们使用当前时间戳(毫秒级)生成
nonce
。
data = { "nonce": nonce }
data
字典包含了API请求所需的参数。 对于获取账户余额,只需要
nonce
参数。 其他 API 可能需要其他参数。
response = kraken_request(api_url, data, API_KEY, API_SECRET)
kraken_request
是一个自定义函数,用于处理与Kraken API的通信。该函数接收API端点、请求数据、API密钥和API密钥作为参数。 它负责构建请求头,对请求进行签名,并发送请求到API服务器。 重要的是,API_KEY 和 API_SECRET 应该安全地存储,避免泄露。
if response.status_code == 200:
response.status_code
属性包含了API请求的HTTP状态码。状态码200表示请求成功。其他状态码可能表示错误,例如400表示请求错误,401表示未授权,500表示服务器内部错误。
data = .loads(response.text)
如果请求成功,
response.text
属性包含了API返回的JSON数据。
.loads()
函数将JSON字符串转换为Python字典,方便后续处理。
print(data)
打印输出包含账户余额信息的字典。字典的结构取决于API的具体实现。通常会包含各种货币的可用余额、总余额等信息。
else:
如果请求失败,执行以下错误处理代码。
print(f"Request failed with status code: {response.status_code}")
打印错误信息,包含HTTP状态码。这有助于诊断错误原因。
print(response.text)
打印API返回的原始错误信息。API通常会返回详细的错误描述,帮助开发者定位问题。
下单示例 (Python):
本示例演示如何使用 Python 与加密货币交易所的 API 进行交互,实现下单操作。示例代码使用了常见的 Python 库,例如
requests
用于发送 HTTP 请求,
hashlib
、
hmac
和
base64
用于处理 API 签名,
urllib.parse
用于处理 URL 编码,以及
time
用于处理时间戳。
import requests
: 导入
requests
库,该库允许 Python 程序发送 HTTP 请求。这是与交易所 API 交互的基础。
import hashlib
: 导入
hashlib
库,该库提供多种哈希算法,例如 SHA256,常用于生成 API 签名。
import hmac
: 导入
hmac
库,该库用于创建带密钥的哈希消息认证码 (HMAC),是生成安全 API 签名的关键。
import base64
: 导入
base64
库,该库用于将二进制数据编码为 ASCII 字符串,常用于处理 API 密钥和签名。
import urllib.parse
: 导入
urllib.parse
库,该库提供用于解析、构造和编码 URL 的函数,例如,将请求参数进行 URL 编码。
import time
: 导入
time
库,该库提供与时间相关的函数,例如获取当前时间戳,许多交易所 API 需要时间戳作为请求参数。
替换为您的 API 密钥和私钥
API_KEY = "YOUR_API_KEY"
API_SECRET = "YOUR_API_SECRET"
此函数用于生成Kraken交易所API请求所需的签名。签名是基于请求的数据、私钥以及特定的加密算法生成的,用于验证请求的合法性。
def get_kraken_signature(urlpath, data, secret):
"""
生成Kraken API请求的签名。
参数:
urlpath (str): API端点的路径。
data (dict): 包含请求参数的字典。
secret (str): 您的私钥。
返回值:
str: 生成的API签名。
"""
postdata = urllib.parse.urlencode(data)
encoded = (str(data['nonce']) + postdata).encode()
message = urlpath.encode() + hashlib.sha256(encoded).digest()
mac = hmac.new(base64.b64decode(secret), message, hashlib.sha512)
sigdigest = base64.b64encode(mac.digest())
return sigdigest.decode()
该函数封装了与Kraken交易所API的交互。 它负责构建请求头,包含API密钥和签名,然后发送POST请求到指定的API端点。
def kraken_request(uri_path, data, api_key, api_sec):
"""
向Kraken API发送请求。
参数:
uri_path (str): API端点的路径。
data (dict): 包含请求参数的字典。
api_key (str): 您的API密钥。
api_sec (str): 您的私钥。
返回值:
requests.Response: 来自API的响应对象。
"""
headers = {}
headers['API-Key'] = api_key
headers['API-Sign'] = get_kraken_signature(uri_path, data, api_sec)
req = requests.post(("https://api.kraken.com" + uri_path), headers=headers, data=data)
return req
示例:挂限价买单
api_url = "/0/private/AddOrder"
定义API端点,用于提交新的订单请求。Kraken API使用
/0/private/AddOrder
路径处理私有订单操作。
nonce = str(int(time.time() * 1000))
生成一个nonce值(一次性随机数),这是API请求中必不可少的一部分,用于防止重放攻击。nonce基于当前时间戳乘以1000得到毫秒级精度,然后转换为字符串类型。每个请求的nonce都必须是唯一的且递增的。
data = {
"nonce": nonce,
"ordertype": "limit",
"pair": "XBTUSD",
"type": "buy",
"price": "20000", # 示例价格
"volume": "0.01" # 示例数量
}
构建一个包含订单参数的字典。
"nonce"
: 前面生成的nonce值。
"ordertype"
: 设置为
"limit"
,表明这是一个限价单,只有当市场价格达到指定价格时才会执行。
"pair"
: 设置为
"XBTUSD"
,指定交易对为比特币/美元。
"type"
: 设置为
"buy"
,表示买入订单。
"price"
: 设置为
"20000"
,表示希望以20000美元的价格买入比特币。这是一个示例价格,用户应根据市场情况设置。
"volume"
: 设置为
"0.01"
,表示购买0.01个比特币。这是一个示例数量,用户可以根据需要调整。
response = kraken_request(api_url, data, API_KEY, API_SECRET)
使用
kraken_request
函数发送API请求。该函数接受API端点、包含订单数据的字典、API密钥和API私钥作为参数。
API_KEY
和
API_SECRET
是用于身份验证的凭据,必须妥善保管。
kraken_request
函数负责处理签名、加密和发送请求,并返回服务器的响应。
if response.status_code == 200:
data = .loads(response.text)
print(data)
else:
print(f"请求失败,状态码: {response.status_code}")
print(response.text)
检查API响应的状态码。如果状态码为200,表示请求成功。
data = .loads(response.text)
: 将响应的JSON文本解析为Python字典,方便后续处理。
print(data)
: 打印解析后的响应数据,通常包含订单ID和其他相关信息。
如果状态码不是200,则表示请求失败。
print(f"请求失败,状态码: {response.status_code}")
: 打印失败的状态码,帮助诊断问题。
print(response.text)
: 打印完整的响应文本,提供更多错误细节。
错误处理
在使用 Kraken API 时,开发者可能会遇到各种预期或非预期的错误。为了确保应用程序的健壮性和用户体验,理解和妥善处理这些错误至关重要。Kraken API 返回的 JSON 响应中包含一个名为
error
的数组字段,该字段用于指示发生的错误类型。该数组可以包含一个或多个错误代码,每个代码都描述了遇到的特定问题。务必检查此字段,以便了解 API 请求是否成功。常见的错误类型包括:
EAPI:Invalid key
: API 密钥无效。
EAPI:Invalid nonce
: Nonce 无效。EAPI:Rate limit exceeded
: 超过速率限制。EGeneral:Invalid arguments
: 请求参数无效。EOrder:Insufficient funds
: 账户余额不足。在你的应用程序中,需要对这些错误进行处理,并采取相应的措施,例如重试请求、调整参数、或者通知用户。
速率限制
Kraken API 实施了速率限制机制,旨在保障平台的稳定性和可用性,有效防止恶意滥用行为。这些限制的具体数值会根据你所调用的 API 接口类型以及你的 Kraken 账户等级而有所不同。速率限制主要通过限制特定时间内请求的数量来实现,确保所有用户都能公平地访问 API 资源。当你的应用程序发送的请求频率超出允许的范围时,API 服务器将会返回一个包含
EAPI:Rate limit exceeded
错误代码的响应,表明已达到或超过速率限制。
为优化你的应用程序并避免频繁触发速率限制错误,你可以采取以下策略:
缓存数据: 对于不经常变化的数据,可以进行缓存,避免频繁请求 API。安全注意事项
在使用 Kraken API 进行加密货币交易和数据访问时,务必高度重视安全问题,采取以下安全措施以保护您的账户和数据安全:
- 启用双因素认证(2FA):为 Kraken 账户启用双因素认证是至关重要的第一步。2FA 能够在用户名和密码之外增加一层安全保护,即使密码泄露,攻击者也难以访问您的账户。 Kraken 支持多种 2FA 方式,例如基于时间的一次性密码(TOTP)应用程序。
通过遵循这些安全建议,可以保护你的应用程序和账户安全。