Name | TradeGate JSON |
Version |
0.3.9.1
JSON |
| download |
home_page | |
Summary | A Trading Gateway |
upload_time | 2024-01-08 01:19:29 |
maintainer | |
docs_url | None |
author | Rustin Soraki |
requires_python | >=3.6 |
license | |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Trade Gate
<div align="center">
![PyPI](https://img.shields.io/pypi/v/TradeGate?style=flat-square)
![PyPI - Downloads](https://img.shields.io/pypi/dm/TradeGate)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/TradeGate?style=flat-square)
![GitHub](https://img.shields.io/github/license/rastins/tradegate?style=flat-square)
</div>
An algorithmic trading library to use as a gateway to different exchanges.
## Documentations and examples
Documentations are available on [read the docs](https://tradegate.readthedocs.io), but currently it's not complete.
Examples for each exchange will be added soon, until then, there are good examples in the Test folder.
## How to install
Use this Github repository by running ```python setup.py install```, or using pip:
```bash
pip install TradeGate
```
## How to use
Use with a config file in JSON format. Your config file should look like this:
```json
{
"Binance": {
"exchangeName": "Binance",
"credentials": {
"main": {
"futures": {
"key": "API-KEY",
"secret": "API-SECRET"
},
"spot": {
"key": "API-KEY",
"secret": "API-SECRET"
}
},
"test": {
"futures": {
"key": "API-KEY",
"secret": "API-SECRET"
},
"spot": {
"key": "API-KEY",
"secret": "API-SECRET"
}
}
}
}
}
```
You should read this config file as JSON and give the desired exchange information to the main class initializer. Use
sandbox argument to connect to the testnets of exchanges (if it exists). This is shown below:
```python
from TradeGate import TradeGate
import json
with open('/path/to/config/file.json') as f:
config = json.load(f)
gate = TradeGate(config['Binance'], sandbox=True)
print(gate.get_symbol_ticker_price('BTCUSDT'))
```
## Current Supported Exchanges
- Binance
- ByBit
- KuCoin
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. The
best way to contribute right now is to implement as many exchanges as possible. Make sure all test cases are passing.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "",
"name": "TradeGate",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Rustin Soraki",
"author_email": "Rustin Soraki <rustin.soraki@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9d/b0/9a2b046faf1544146d546939f139fc8fe9c36641e237ff780049109d92c3/TradeGate-0.3.9.1.tar.gz",
"platform": null,
"description": "# Trade Gate\n\n<div align=\"center\">\n\n![PyPI](https://img.shields.io/pypi/v/TradeGate?style=flat-square)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/TradeGate)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/TradeGate?style=flat-square)\n![GitHub](https://img.shields.io/github/license/rastins/tradegate?style=flat-square)\n\n</div>\n\nAn algorithmic trading library to use as a gateway to different exchanges.\n\n## Documentations and examples\n\nDocumentations are available on [read the docs](https://tradegate.readthedocs.io), but currently it's not complete.\nExamples for each exchange will be added soon, until then, there are good examples in the Test folder.\n\n## How to install\n\nUse this Github repository by running ```python setup.py install```, or using pip:\n\n```bash\npip install TradeGate\n```\n\n## How to use\n\nUse with a config file in JSON format. Your config file should look like this:\n\n```json\n{\n \"Binance\": {\n \"exchangeName\": \"Binance\",\n \"credentials\": {\n \"main\": {\n \"futures\": {\n \"key\": \"API-KEY\",\n \"secret\": \"API-SECRET\"\n },\n \"spot\": {\n \"key\": \"API-KEY\",\n \"secret\": \"API-SECRET\"\n }\n },\n \"test\": {\n \"futures\": {\n \"key\": \"API-KEY\",\n \"secret\": \"API-SECRET\"\n },\n \"spot\": {\n \"key\": \"API-KEY\",\n \"secret\": \"API-SECRET\"\n }\n }\n }\n }\n}\n```\n\nYou should read this config file as JSON and give the desired exchange information to the main class initializer. Use\nsandbox argument to connect to the testnets of exchanges (if it exists). This is shown below:\n\n```python\nfrom TradeGate import TradeGate\nimport json\n\nwith open('/path/to/config/file.json') as f:\n config = json.load(f)\n\ngate = TradeGate(config['Binance'], sandbox=True)\n\nprint(gate.get_symbol_ticker_price('BTCUSDT'))\n```\n\n## Current Supported Exchanges\n\n- Binance\n- ByBit\n- KuCoin\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. The\nbest way to contribute right now is to implement as many exchanges as possible. Make sure all test cases are passing.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": "",
"summary": "A Trading Gateway",
"version": "0.3.9.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db8a906a878f198ec6817dd219a0ef1cab840ce16be59121408100a34960bf47",
"md5": "95f8aad58f929eecb0fd4fb5907cbac0",
"sha256": "999a6e2b4481171e75d1fcec7afe98d45d3241bfbdfc3167afb5f0fc10f92818"
},
"downloads": -1,
"filename": "TradeGate-0.3.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95f8aad58f929eecb0fd4fb5907cbac0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 130763,
"upload_time": "2024-01-08T01:19:28",
"upload_time_iso_8601": "2024-01-08T01:19:28.008280Z",
"url": "https://files.pythonhosted.org/packages/db/8a/906a878f198ec6817dd219a0ef1cab840ce16be59121408100a34960bf47/TradeGate-0.3.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9db09a2b046faf1544146d546939f139fc8fe9c36641e237ff780049109d92c3",
"md5": "c73fa91debfbd6b9ed8404c1b4ccc981",
"sha256": "6364c0b08e54a7dcfd16bb32db9d21dc86fd446fff3346f4ee1d239dcb5808f8"
},
"downloads": -1,
"filename": "TradeGate-0.3.9.1.tar.gz",
"has_sig": false,
"md5_digest": "c73fa91debfbd6b9ed8404c1b4ccc981",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 101958,
"upload_time": "2024-01-08T01:19:29",
"upload_time_iso_8601": "2024-01-08T01:19:29.946666Z",
"url": "https://files.pythonhosted.org/packages/9d/b0/9a2b046faf1544146d546939f139fc8fe9c36641e237ff780049109d92c3/TradeGate-0.3.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-08 01:19:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tradegate"
}