# ChainExAPI Python Client
## Overview
ChainExAPI is a Python client library for interacting with the ChainEx cryptocurrency exchange API. It provides a convenient way to integrate ChainEx's services into your Python applications.
## Features
- Easy to use methods for market, wallet, and trading operations.
- HMAC-SHA-256 authentication for secure API calls.
- Fetch market summaries, statistics, trades, and orders.
- Manage wallet balances, deposits, withdrawals, and addresses.
- Execute and manage trading orders and trades.
## Installation
You can install the ChainExAPI library via pip:
```bash
pip install chainexapi
```
## Quick Start
Here's a quick example to get you started:
```python
from chainex import ChainExAPI
# Initialize the API client
client = ChainExAPI('your_public_key', 'your_private_key')
# Fetch market summary
market_summary = client.get_market_summary('BTC_ETH')
print(market_summary)
# Fetch wallet balances
wallet_balances = client.get_wallet_balances()
print(wallet_balances)
```
## Usage
### Initializing the Client
First, import the `ChainExAPI` class and initialize it with your public and private API keys:
```python
from chainex import ChainExAPI
client = ChainExAPI('your_public_key', 'your_private_key')
```
### Market Methods
- `get_market_summary(exchange)`: Fetches market summary for a given exchange.
- `get_market_stats(coin, exchange)`: Fetches market statistics for a given coin and exchange.
- ... (and so on for other market methods)
### Wallet Methods
- `get_wallet_balances(coin=None)`: Fetches wallet balances.
- `get_wallet_deposits(coin="ALL", start=0, limit=25)`: Fetches wallet deposits.
- ... (and so on for other wallet methods)
### Trading Methods
- `get_trading_orders(coin="ALL", start=0, limit=25)`: Fetches trading orders.
- `add_order(coin, exchange, price, amount, order_type)`: Adds an order to a specified market.
- ... (and so on for other trading methods)
## Contributing
Contributions to the ChainExAPI library are welcome! Please feel free to submit issues and pull requests to the repository.
## License
This project is licensed under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/RichardAtCT//chainexapi",
"name": "ChainExAPI",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "chainex cryptocurrency exchange api",
"author": "Richard A",
"author_email": "richardatk01@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/58/0b/3f7f87bf396a98d4ee107c1972bcb6b54a71f80fd2da74e2e1f4f58da33d/ChainExAPI-0.1.0.tar.gz",
"platform": null,
"description": "# ChainExAPI Python Client\n\n## Overview\n\nChainExAPI is a Python client library for interacting with the ChainEx cryptocurrency exchange API. It provides a convenient way to integrate ChainEx's services into your Python applications.\n\n## Features\n\n- Easy to use methods for market, wallet, and trading operations.\n- HMAC-SHA-256 authentication for secure API calls.\n- Fetch market summaries, statistics, trades, and orders.\n- Manage wallet balances, deposits, withdrawals, and addresses.\n- Execute and manage trading orders and trades.\n\n## Installation\n\nYou can install the ChainExAPI library via pip:\n\n```bash\npip install chainexapi\n```\n\n## Quick Start\n\nHere's a quick example to get you started:\n\n```python\nfrom chainex import ChainExAPI\n\n# Initialize the API client\nclient = ChainExAPI('your_public_key', 'your_private_key')\n\n# Fetch market summary\nmarket_summary = client.get_market_summary('BTC_ETH')\nprint(market_summary)\n\n# Fetch wallet balances\nwallet_balances = client.get_wallet_balances()\nprint(wallet_balances)\n```\n\n## Usage\n\n### Initializing the Client\n\nFirst, import the `ChainExAPI` class and initialize it with your public and private API keys:\n\n```python\nfrom chainex import ChainExAPI\n\nclient = ChainExAPI('your_public_key', 'your_private_key')\n```\n\n### Market Methods\n\n- `get_market_summary(exchange)`: Fetches market summary for a given exchange.\n- `get_market_stats(coin, exchange)`: Fetches market statistics for a given coin and exchange.\n- ... (and so on for other market methods)\n\n### Wallet Methods\n\n- `get_wallet_balances(coin=None)`: Fetches wallet balances.\n- `get_wallet_deposits(coin=\"ALL\", start=0, limit=25)`: Fetches wallet deposits.\n- ... (and so on for other wallet methods)\n\n### Trading Methods\n\n- `get_trading_orders(coin=\"ALL\", start=0, limit=25)`: Fetches trading orders.\n- `add_order(coin, exchange, price, amount, order_type)`: Adds an order to a specified market.\n- ... (and so on for other trading methods)\n\n## Contributing\n\nContributions to the ChainExAPI library are welcome! Please feel free to submit issues and pull requests to the repository.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python client library for interacting with the ChainEx cryptocurrency exchange API.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/RichardAtCT//chainexapi"
},
"split_keywords": [
"chainex",
"cryptocurrency",
"exchange",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "580b3f7f87bf396a98d4ee107c1972bcb6b54a71f80fd2da74e2e1f4f58da33d",
"md5": "f74f1db85274316f513a88c1b78c997d",
"sha256": "244ba30d18c7473dc237ad455a4a2c9122a432633a710b840ab95d804d8e9fd6"
},
"downloads": -1,
"filename": "ChainExAPI-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f74f1db85274316f513a88c1b78c997d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5596,
"upload_time": "2023-12-06T08:43:43",
"upload_time_iso_8601": "2023-12-06T08:43:43.521099Z",
"url": "https://files.pythonhosted.org/packages/58/0b/3f7f87bf396a98d4ee107c1972bcb6b54a71f80fd2da74e2e1f4f58da33d/ChainExAPI-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 08:43:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "chainexapi"
}
JSON