公开API与私有API
API的URL通常分为两类:市场数据方面的公开API,以及交易和账户相关的私有API。
这两组API的方法通常分别使用前缀public
和private
。
公开API
公开API用来访问市场数据,不需要进行身份验证。大多数交易所为所有 用户提供开放的市场数据(通常有一定的限流措施)。使用ccxt库,任何人 都可以直接访问市场数据,而无需在交易所进行注册,也无需设置api key 和密码。
公开API包含如下内容:
- 交易对
- 价格流
- 委托账本(L1、L2、L3...)
- 交易历史(完成的订单、交易、执行)
- 行情数据(现价、24小时价格)
- 用于图表的OHLCV序列数据
- 其他公开访问点
私有API
要使用私有API进行交易,你需要从交易所获取API key。这通常意味着你需要 在交易所注册并使用你的账户创建API key。大多数交易所需要个人信息或身份 标识,一些身份验证也是必要的。
如果你希望交易,首先需要在交易所进行注册,ccxt库不会创建账户或者提供 API key。有些交易所的API提供了在代码中注册账户的接口,但是大多数交易所 都没有这样的接口。你必须在交易所的网站注册并创建API key。
私有API包含以下内容:
- 管理个人账户信息
- 查询账户余额
- 委托市价单和限价单
- 创建充值地址并进行账户充值
- 请求提取法币和加密货币
- 查询个人的敞口/完结委托单
- 查询杠杆交易的位置
- 获取账本历史
- 在不同账户之间转账
- 使用商户服务
有些交易所的相同服务采用了不同的名称。例如,公开API通常称为市场数据、 基础、市场、mapi、api、价格等等...所有这些指的都是一组用于访问公开 可用数据的方法。私有API通常称为trading、trade、tapi、exchange、account 等等。
有些交易所也暴露出商户API,可以让你创建发票并接收你的客户的数字货币和法币支付。 这一类API通常称为merchant、wallet、payment、ecapi(用于电子商务的API)。
要获取指定交易所实例的所有可用方法,你可以使用如下的简单代码:
console.log (new ccxt.kraken ()) // JavaScript
print (dir (ccxt.hitbtc ())) # Python
var_dump (new \ccxt\okcoinusd ()); // PHP