crjameson / aevopy

Simple client for aevo.xyz API to trade cryptocurrency PERPs and Options

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

https://medium.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

About

Simple client for aevo.xyz API to trade cryptocurrency PERPs and Options

License:MIT License


Languages

Language:Python 100.0%