# Client MEXC Exchange
A simple python client for the [MEXC](https://www.mexc.com/) exchange.
Open, unofficial project, intended to consume all endpoints provided by Exchange
[documentation](https://mxcdevelop.github.io/apidocs/spot_v3_en/#introduction).
## Summary
* [Pypi](#pypi)
* [Dependencies](#dependencies)
* [how to use](#how-to-use)
* [functions implemented so far](#functions-implemented-so-far)
* [Instalation](#installation)
* [Python version](#python-version)
## Pypi
see the project on Pypi by accessing the [link](https://pypi.org/project/mexcapiclient/).
## Dependencies
This project uses some libraries for its operation as well as tests and linter for code organization. Its dependencies are:
* [Requests](https://requests.readthedocs.io/en/latest/)
* [Black](https://github.com/psf/black)
* [Pytest](https://docs.pytest.org/en/7.1.x/contents.html)
## how to use
A simple code example for client use is:
from MexcClient.client import MexcClient
client = MexcClient("API_KEY", "API_SECRET")
client.server_time()
## functions implemented so far
| Func | Method | Endpoint | Params | Section |
|-------------------------------------|--------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| check_connection | GET | /api/v3/ping | None | Market Data Endpoints |
| server_time | GET | /api/v3/time | None | Market Data Endpoints |
| exchange_info | GET | /api/v3/exchangeInfo | None | Market Data Endpoints |
| order_book_of_symbol | GET | /api/v3/depth | symbol: str, limit: int | Market Data Endpoints |
| recent_trades_list | GET | /api/v3/trades | symbol: str, limit: int | Market Data Endpoints |
| old_trade_lookup | GET | /api/v3/historicalTrades | symbol: str, limit: int | Market Data Endpoints |
| kline_data | GET | /api/v3/klines | symbol: str, interval: EnumKlineInterval, start_time: int, end_time: int, limit: int = 500 | Market Data Endpoints |
| current_average_price | GET | /api/v3/avgPrice | symbol: str | Market Data Endpoints |
| create_order_test | POST | /api/v3/order/test | symbol: str, side: EnumOrderSide, _type: EnumOrderType, timestamp: int, quantity: str, quote_order_quantity: str, price: str, new_client_order_id: str, recv_window: int | Spot Account/Trade |
| create_new_order | POST | /api/v3/order | symbol: str, side: EnumOrderSide, _type: EnumOrderType, timestamp: int, quantity: str, quote_order_quantity: str, price: str, new_client_order_id: str, recv_window: int | Spot Account/Trade |
| load_balances | GET | /api/v3/account | None | Spot Account/Trade |
| load_balance_by_symbol | GET | /api/v3/account | symbol: str | Spot Account/Trade |
| cancel_order | DELETE | /api/v3/order | symbol: str, order_id: str, timestamp: int | Spot Account/Trade |
| cancel_all_open_orders_on_a_symbol | DELETE | /api/v3/openOrders | symbols: list, timestamp: int | Spot Account/Trade |
## installation
To install just run the following command:
pip install mexcapiclient
### Python version
python version used in this project was:
* [Python3.9](https://www.python.org/)
Raw data
{
"_id": null,
"home_page": "https://github.com/suportebeloj/client-mexc-exchange",
"name": "mexcapiclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Carlos Eduardo",
"author_email": "suportebeloj@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/58/2a/ca0b9fba30dd102fd7473daa8b59af41c8489da891fd577d54c16c4d01d0/mexcapiclient-0.1.9.tar.gz",
"platform": null,
"description": "# Client MEXC Exchange\n\nA simple python client for the [MEXC](https://www.mexc.com/) exchange. \nOpen, unofficial project, intended to consume all endpoints provided by Exchange \n[documentation](https://mxcdevelop.github.io/apidocs/spot_v3_en/#introduction).\n\n## Summary\n\n* [Pypi](#pypi)\n* [Dependencies](#dependencies)\n* [how to use](#how-to-use)\n* [functions implemented so far](#functions-implemented-so-far)\n* [Instalation](#installation)\n * [Python version](#python-version)\n\n## Pypi\nsee the project on Pypi by accessing the [link](https://pypi.org/project/mexcapiclient/).\n\n## Dependencies\n\nThis project uses some libraries for its operation as well as tests and linter for code organization. Its dependencies are:\n\n* [Requests](https://requests.readthedocs.io/en/latest/)\n* [Black](https://github.com/psf/black)\n* [Pytest](https://docs.pytest.org/en/7.1.x/contents.html)\n\n## how to use \n\nA simple code example for client use is:\n\n from MexcClient.client import MexcClient\n\n client = MexcClient(\"API_KEY\", \"API_SECRET\")\n client.server_time()\n\n## functions implemented so far\n\n| Func | Method | Endpoint | Params | Section |\n|-------------------------------------|--------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|\n| check_connection | GET | /api/v3/ping | None | Market Data Endpoints |\n| server_time | GET | /api/v3/time | None | Market Data Endpoints |\n| exchange_info | GET | /api/v3/exchangeInfo | None | Market Data Endpoints |\n| order_book_of_symbol | GET | /api/v3/depth | symbol: str, limit: int | Market Data Endpoints |\n| recent_trades_list | GET | /api/v3/trades | symbol: str, limit: int | Market Data Endpoints |\n| old_trade_lookup | GET | /api/v3/historicalTrades | symbol: str, limit: int | Market Data Endpoints |\n| kline_data | GET | /api/v3/klines | symbol: str, interval: EnumKlineInterval, start_time: int, end_time: int, limit: int = 500 | Market Data Endpoints |\n| current_average_price | GET | /api/v3/avgPrice | symbol: str | Market Data Endpoints |\n| create_order_test | POST | /api/v3/order/test | symbol: str, side: EnumOrderSide, _type: EnumOrderType, timestamp: int, quantity: str, quote_order_quantity: str, price: str, new_client_order_id: str, recv_window: int | Spot Account/Trade |\n| create_new_order | POST | /api/v3/order | symbol: str, side: EnumOrderSide, _type: EnumOrderType, timestamp: int, quantity: str, quote_order_quantity: str, price: str, new_client_order_id: str, recv_window: int | Spot Account/Trade |\n| load_balances | GET | /api/v3/account | None | Spot Account/Trade |\n| load_balance_by_symbol | GET | /api/v3/account | symbol: str | Spot Account/Trade |\n| cancel_order | DELETE | /api/v3/order | symbol: str, order_id: str, timestamp: int | Spot Account/Trade |\n| cancel_all_open_orders_on_a_symbol | DELETE | /api/v3/openOrders | symbols: list, timestamp: int | Spot Account/Trade |\n\n\n## installation\nTo install just run the following command:\n\n pip install mexcapiclient\n\n\n### Python version\npython version used in this project was:\n\n* [Python3.9](https://www.python.org/)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "0.1.9",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8f2965afbdfc55ebda07690c9ca9f20c",
"sha256": "1528ccdc67f6d06673b2581319d7cf1dc0988000c10232224286ce3831a62b3f"
},
"downloads": -1,
"filename": "mexcapiclient-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f2965afbdfc55ebda07690c9ca9f20c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 6297,
"upload_time": "2022-12-09T15:18:50",
"upload_time_iso_8601": "2022-12-09T15:18:50.881468Z",
"url": "https://files.pythonhosted.org/packages/84/c3/18ed06cadfad0049e8ce09c160b639d5482a48b541803b6bfdd4c4121973/mexcapiclient-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "83cb462ae4636d99fce222ecaabce5a3",
"sha256": "3373163e655c0a963b129b12d3e10c94312c4371553a7dd72d34eb398f6b4341"
},
"downloads": -1,
"filename": "mexcapiclient-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "83cb462ae4636d99fce222ecaabce5a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 4938,
"upload_time": "2022-12-09T15:18:53",
"upload_time_iso_8601": "2022-12-09T15:18:53.066070Z",
"url": "https://files.pythonhosted.org/packages/58/2a/ca0b9fba30dd102fd7473daa8b59af41c8489da891fd577d54c16c4d01d0/mexcapiclient-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-09 15:18:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "suportebeloj",
"github_project": "client-mexc-exchange",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "certifi",
"specs": [
[
"==",
"2022.9.24"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"2.1.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.4"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.28.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"1.26.13"
]
]
}
],
"lcname": "mexcapiclient"
}
JSON
