一个简单的gateconi rest api客户端
gatecoin-api的Python项目详细描述
gatecoin python rest api客户端
这是一个简单的gateconi python rest api客户端库,它为最终用户抽象出了其余的部分。
安装
该库可以从pypi收集,如下所示:
$ pip install gatecoin_api
用法
包公开了GatecoinAPI
客户端类,该类具有来自gateconi rest api的方法。可以直接使用公共方法,对于交易方法,需要设置api凭据:
api=GatecoinAPI('private_key','public_key')
或
api=GatecoinAPI()api.set_credentials('private_key','public_key')
之后,可以使用交易api。公共api的示例用法:
api=GatecoinAPI()res=api.get_currency_pairs()print(res.response_status.message)# 'OK'print(res.currency_pairs[0].trading_code)# 'BTCEUR'print(res.currency_pairs[0].base_currency)# 'BTC'print(res.currency_pairs[0].price_decimal_places)# 1
实现的方法
- 交易
- 设置凭据
- 获得余额
- 获得平衡
- 获取打开订单
- 获取打开订单
- 创建订单
- 取消订单
- 取消所有订单
- 获取交易记录
- 公众
- 获取货币对
- 获得市场深度
- 获取订单
- 获取最近的交易
开发
要在不从pypi安装的情况下使用此软件包进行开发或测试,可以克隆存储库,并在工作副本根目录下的虚拟环境中设置环境:
$ virtualenv venv --python=python3
激活虚拟环境:
$ source venv/bin/activate
安装开发依赖项:
$ pip install -r requirements.txt
运行交互式python shell,您可以将该包用作下面给出的示例:
$python>>>fromgatecoin_apiimportGatecoinAPIasGA>>>api=GA()>>>res=api.get_currency_pairs()>>>res.response_status.message'OK'>>>res.currency_pairs[0].trading_code'BTCEUR'>>>res.currency_pairs[0].base_currency'BTC'>>>res.currency_pairs[0].quote_currency'EUR'>>>res.currency_pairs[0].display_name'BTC / EUR'>>>res.currency_pairs[0].name'BTC / EUR'>>>res.currency_pairs[0].price_decimal_places1
测试
要正确设置测试,请在shell环境中设置有效的开发api密钥和api基url:
exportGTC_TESTS_PRIVATE_KEY=<PRIVATE_KEY> exportGTC_TESTS_PUBLIC_KEY=<PUBLIC_KEY> exportGTC_API_BASE_URL=<API_BASE_URL>
对于windows命令行,请使用set
命令:
setGTC_TESTS_PRIVATE_KEY=<PRIVATE_KEY> setGTC_TESTS_PUBLIC_KEY=<PUBLIC_KEY> setGTC_API_BASE_URL=<API_BASE_URL>
要运行测试,请执行:
$ python setup.py test
如果未设置开发密钥,则交易范围测试将失败。