Skip to main content

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aevopy-0.1.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

aevopy-0.1.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file aevopy-0.1.0.tar.gz.

File metadata

  • Download URL: aevopy-0.1.0.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

Hashes for aevopy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7ba90da03bb174c62d26e28b7b059204bb0f4f7a965b64e0e5fbc3742aeeef75
MD5 2488e94cf59eb41071dde8c2ba742018
BLAKE2b-256 42cc6ab0046df9caadc002cd397aaed5073284a34a9f8f827eba53d6ff024d74

See more details on using hashes here.

File details

Details for the file aevopy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: aevopy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 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

Hashes for aevopy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9a09d0cb5a73b572d72d1d3ded2cc34cd1eb1f4ef9d9ba0a39f67d289882e42
MD5 00f312f07e0c4ff2c80f0744417bf36e
BLAKE2b-256 7ceeb95176d175976894a035645963132e46b4cc0fa53c89c745919ac3851704

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page