Simple client for aevo.xyz API
Project description
Aevopy
Aevopy is a python client for the perp and options trading platform aevo.xyz. It is still in a very early stage, but maybe useful if you consider automated crypto currency trading.
For signup with Aevo you can use this link to save on fees:
https://app.aevo.xyz/r/Tulip-Sturdy-Laffont
You can find complete tutorials on how to use this code to build your own trading strategies on my substack or medium account:
https://substack.com/@crjameson
Table of Contents
Introduction
Aevopy is a simple to use python library to execute cryptocurrency perp and options trades via Aevo. It should work with all Python versions > 3.11. Older versions are untested but might work as well.
Usage
Here is some example code to give you a basic idea how to use it:
import aevopy
client = aevopy.AevoClient()
portfolio = client.get_portfolio()
print(f"available portfolio margin balance: {portfolio.user_margin.balance}")
# # get the market details about the asset we want to trade - TIA in this example
instrument = aevopy.get_markets(asset="TIA")
print(f"instrument: {instrument}")
# create a market buy order
order = client.buy_market(instrument.instrument_id, amount=1)
print(f"order: {order} order_id: {order.order_id} avg_price: {order.avg_price}")
# set stop loss and take profit
stop_loss_price = order.avg_price * 0.99
take_profit_price = order.avg_price * 1.02
order = client.sell_stop_loss(instrument.instrument_id, trigger=stop_loss_price)
order = client.sell_take_profit(instrument.instrument_id, trigger=take_profit_price)
If you need to work with multiple Accounts, you can create an account object and pass that as parameter to the client:
account = aevopy.AevoAccount(key, wallet_address, api_key, api_secret, env)
...
client = aevopy.AevoClient(account)
Installation
Recommended:
pip install aevopy
Or if you are using poetry:
poetry add aevopy
Alternative:
From github: pip install pip@git+https://github.com/crjameson/aevopy
Create a .env file with your credentials in the same directory as your script is running. Take a look at .env.example in the examples folder. This file should at least configure the following values:
AEVO_SIGNING_KEY =
AEVO_WALLET_ADDRESS =
AEVO_API_KEY =
AEVO_API_SECRET =
AEVO_ENV = mainnet
Hint: You can create the signing key and API credentials in your userprofile settings on aevo.xyz.
To run the example:
poetry run python examples/basic_trade_and_risk_management.py
To run the tests:
poetry run pytest
Contact
For questions or ideas you can find my contact information on crjameson.xyz
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aevopy-0.1.1.tar.gz
.
File metadata
- Download URL: aevopy-0.1.1.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/6.6.13-amd64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6aa9ee013e8441f3ff1960c947c8b3d224378d9177fe43f7d195ec7f209e679 |
|
MD5 | ec9a2961dd3b50916b85ebe0f0660fbd |
|
BLAKE2b-256 | 09ea77104c65c5301e938fbad8822169657b234897c78daaf5260f122375c3e5 |
File details
Details for the file aevopy-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: aevopy-0.1.1-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/6.6.13-amd64
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64bc3e501a659fcaec079d99c388e96d99ebca2986f13f2744a1db2ce6415867 |
|
MD5 | ac09bc088f5a13218a27de2804a21854 |
|
BLAKE2b-256 | d28f2c98ea631a1a7dc96ef80a793fd3fd92f47bda076098d2697d5164181e6b |