REST API 命令行客户端 (Python)

上次更新时间： 2025年4月1日

Python 中的 REST API 命令行客户端允许通过命令行（例如 macOS 上的终端）完全访问 Kraken REST API，因此无需编程知识或 API 经验。

所有 REST API 功能均可访问，包括：

  • •

    公共市场数据端点

  • •

    私人账户数据端点

  • •

    私人交易端点

  • •

    私人资金端点

  • •

    私人赚取端点

命令行客户端可用作独立的 API 客户端，也可从其他程序（例如 Bash 脚本等其他解释型语言，或 C/C++ 等编译型语言）调用。

安装

1. 安装 Python 3（如有必要）。

  • •

    macOS 和 Linux 可能已安装 Python 3。

  • •

    Windows 可能未安装 Python 3，但可以从 https://www.python.org/ 安装。

2. 将 krakenapi.py 文件下载并保存到您计算机上选择的文件夹（目录）中。

例如：Macintosh HD > Users > Satoshi > KrakenAPI


3. 打开命令提示符（例如 macOS 的终端），并导航到上一步中选择的文件夹（目录）。您可以使用 UNIX/Linux 的“cd”命令（更改目录）进行导航。

例如：cd /Users/Satoshi/KrakenAPI


4. 使 krakenapi.py 文件可执行。

您可以使用 UNIX/Linux 的“chmod 755”命令（更改模式）。

例如：chmod 755 krakenapi.py


5. 将您的 API 密钥添加到您保存 krakenapi.py 文件的同一文件夹中。

  • •

    将您的 API 公钥从账户管理中复制/粘贴到一个名为“API_Public_Key”的纯文本文件中。

  • •

    将您的 API 私钥（秘密密钥）复制/粘贴到一个名为“API_Private_Key”的纯文本文件中。

创建/配置 API 密钥的说明可用。

仅当您计划使用私人 API 端点访问您的 Kraken 账户（例如余额查询、下达/取消订单、账户历史导出等）时才需要 API 密钥。

示例命令

REST API 命令行客户端的使用方法如下：

./krakenapi.py endpoint [parameters] [-pretty]

命令行客户端支持所有 REST API 端点，以下仅是几个示例命令：

python

Python

# Time
./krakenapi.py Time

# Ticker
./krakenapi.py Ticker pair=xbtusd

# Trades
./krakenapi.py Trades pair=etheur since=1574067140000000000

# Balance
./krakenapi.py Balance

# Trade Balance
./krakenapi.py TradeBalance asset=xbt

# Query Orders
./krakenapi.py QueryOrders txid=O7MN22-ZCX7J-TGLQHD

# Add Order
./krakenapi.py AddOrder pair=xbtusd type=buy ordertype=limit price=6500 volume=0.002 leverage=5

# Cancel Order
./krakenapi.py CancelOrder txid=O7MN22-ZCX7J-TGLQHD

默认情况下，命令行客户端将输出原始 API 响应（适合通过代码解释的 JSON），但如果使用额外的命令行参数 -pretty：

./krakenapi.py TradeBalance asset=shib -pretty

客户端将以用户友好的 JSON 格式（带换行符/缩进）输出相同的 API 响应。

Python 代码：

python

Python

#!/usr/bin/env python3

# Kraken Rest API
#
# Usage: ./krakenapi endpoint [parameters]
# Example: ./krakenapi Time
# Example: ./krakenapi OHLC pair=xbtusd interval=1440
# Example: ./krakenapi Balance
# Example: ./krakenapi TradeBalance asset=xdg
# Example: ./krakenapi OpenPositions
# Example: ./krakenapi AddOrder pair=xxbtzusd type=buy ordertype=market volume=0.003 leverage=5

import sys
import time
import base64
import hashlib
import hmac
import urllib.request
import json

api_public = {"Time", "Assets", "AssetPairs", "Ticker", "OHLC", "Depth", "Trades", "Spread", "SystemStatus"}
api_private = {"Balance", "BalanceEx", "TradeBalance", "OpenOrders", "ClosedOrders", "QueryOrders", "TradesHistory", "QueryTrades", "OpenPositions", "Ledgers", "QueryLedgers", "TradeVolume", "AddExport", "ExportStatus", "RetrieveExport", "RemoveExport", "GetWebSocketsToken", "CreateSubaccount", "AccountTransfer"}
api_trading = {"AddOrder", "AddOrderBatch", "EditOrder", "CancelOrder", "CancelOrderBatch", "CancelAll", "CancelAllOrdersAfter","OrderAmends","AmendOrder","ListSubaccounts"}
api_funding = {"DepositMethods", "DepositAddresses", "DepositStatus", "WithdrawMethods", "WithdrawAddresses", "WithdrawInfo", "Withdraw", "WithdrawStatus", "WithdrawCancel", "WalletTransfer"}
api_staking = {"Earn/Strategies", "Earn/Allocations", "Earn/Allocate", "Earn/Deallocate", "Earn/AllocateStatus", "Earn/DeallocateStatus", "Staking/Assets", "Staking/Balance", "Stake", "Unstake", "Staking/Pending", "Staking/Transactions"}

api_domain = "https://api.kraken.com"
api_data = ""

output_format = 0

if len(sys.argv) < 2:
	api_method = "Time"
elif len(sys.argv) == 2:
	api_method = sys.argv[1]
else:
	api_method = sys.argv[1]
	for count in range(2, len(sys.argv)):
		if sys.argv[count] == '-pretty':
			output_format = 1
			continue
		if count == 2:
			api_data = sys.argv[count]
		else:
			api_data = api_data + "&" + sys.argv[count]

if api_method in api_private or api_method in api_trading or api_method in api_funding or api_method in api_staking:
	api_path = "/0/private/"
	api_nonce = str(int(time.time()*1000))
	try:
		api_key = open("API_Public_Key").read().strip()
		api_secret = base64.b64decode(open("API_Private_Key").read().strip())
	except:
		print("API public key and API private (secret) key must be in plain text files called API_Public_Key and API_Private_Key")
		sys.exit(1)
	api_postdata = api_data + "&nonce=" + api_nonce
	api_postdata = api_postdata.encode('utf-8')
	api_sha256 = hashlib.sha256(api_nonce.encode('utf-8') + api_postdata).digest()
	api_hmacsha512 = hmac.new(api_secret, api_path.encode('utf-8') + api_method.encode('utf-8') + api_sha256, hashlib.sha512)
	api_request = urllib.request.Request(api_domain + api_path + api_method, api_postdata)
	api_request.add_header("API-Key", api_key)
	api_request.add_header("API-Sign", base64.b64encode(api_hmacsha512.digest()))
	api_request.add_header("User-Agent", "Kraken REST API")
elif api_method in api_public:
	api_path = "/0/public/"
	api_request = urllib.request.Request(api_domain + api_path + api_method + '?' + api_data)
	api_request.add_header("User-Agent", "Kraken REST API")
else:
	print("Usage: %s method [parameters]" % sys.argv[0])
	print("Example: %s OHLC pair=xbtusd interval=1440" % sys.argv[0])
	sys.exit(1)

try:
	api_reply = urllib.request.urlopen(api_request).read()
except Exception as error:
	print("API call failed (%s)" % error)
	sys.exit(1)

try:
	api_reply = api_reply.decode()
except Exception as error:
	if api_method == 'RetrieveExport':
		sys.stdout.buffer.write(api_reply)
		sys.exit(0)
	print("API response invalid (%s)" % error)
	sys.exit(1)

if '"error":[]' in api_reply:
	print(api_reply if output_format == 0 else json.dumps(json.loads(api_reply), indent = 4))
	sys.exit(0)
else:
	print(api_reply if output_format == 0 else json.dumps(json.loads(api_reply), indent = 4))
	sys.exit(1)

需要更多帮助吗？