Giter Site home page Giter Site logo

python-nexo's Introduction

Unofficial Nexo API Wrapper (Python)

✨ A Python wrapper for the Nexo Pro API ✨

lint tests codecov CodeFactor Percentage of issues still open PipPerMonths Pip version fury.io GitHub license GitHub contributors

About Nexo 💸

Nexo is a crypto lending platform that lets you borrow crypto or cash by placing your crypto as collateral. They offer high APY on holdings based on loyalty tier (the more Nexo token you hold the higher your tier). You can earn your interests in the same kind of your holding or as Nexo tokens. As an example, stablecoins can earn up to 12% APY. Bitcoin and Ethereum, 8%.

Unfortunately, Nexo doesn't offer some automated way of buying periodically. All you can do is setup a bank transfer and then convert/buy manually. This API Wrapper aims to offer a way of automating your purchases. You'd just have to setup your periodic bank transfer to Nexo, and then buy at spot price the coins that you want in an automated way by using the wrapped API calls.

Description 📰

This is an unofficial Python wrapper for the Nexo Pro exchange REST API v1. I am in no way affiliated with Nexo, use at your own risk.

If you came here looking for the Nexo exchange to purchase cryptocurrencies, then go to the official Nexo website. If you want to automate interactions with Nexo, stick around.

Click here to register a Nexo account

Heavily influenced by python-binance

You can check which endpoints are currently functional here

  • ✨ Work in Progress
  • 🎌 Built with Python
  • 🐋 Docker Available
  • 🍻 Actively Maintained

Roadmap 🌱

See it on Issue #2 Checkout the Changelog

Preparation 🔎

  • Register a Nexo Account. here
  • Generate an API Key in Nexo Pro with the permissions you want.

Advice

Priviledge Async Client. The advantage of async processing is that we don’t need to block on I/O which is every action that we make when we interact with the Nexo Pro servers.

By not blocking execution we can continue processing data while we wait for responses or new data from websockets.

Set it up 💾

PIP

  1. Install the pip package: python3 -m pip install python-nexo
  2. Explore the API:
#### Sync

import nexo
import os
from dotenv import load_dotenv

# Loads your API keys from the .env file you created
load_dotenv()
key = os.getenv("NEXO_PUBLIC_KEY")
secret = os.getenv("NEXO_SECRET_KEY")

# Instantiate Client and grab account balances
c = nexo.Client(key, secret)
balances = c.get_account_balances()
print(balances)

#### Async

import nexo
import os
import asyncio
from dotenv import load_dotenv

load_dotenv()

key = os.getenv("NEXO_PUBLIC_KEY")
secret = os.getenv("NEXO_SECRET_KEY")

async def main():
    client = await nexo.AsyncClient.create(key, secret)
    print(await client.get_account_balances())

    await client.close_connection()

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Docker (source)

  1. Clone the Project: git clone -b master https://github.com/guilyx/python-nexo.git
  2. Move to the Repository: cd python-nexo
  3. Create a copy of .env.example and name it .env
  4. Fill up your API Key/Secret
  5. Build and Compose the Docker: docker-compose -f docker/docker-compose.yml up - The container should keep running so that you can explore the API
  6. Attach to the docker: docker exec -it $(docker ps -qf "name=docker_python-nexo") /bin/bash
  7. Run python in the docker's bash environment: python3
  8. From there, copy the following snippet to instantiate a Client:
import nexo
import os
nexo_key = os.getenv("NEXO_PUBLIC_KEY")
nexo_secret = os.getenv("NEXO_SECRET_KEY")
assert(nexo_key)
assert(nexo_secret)
c = nexo.Client(nexo_key, nexo_secret)
  1. You can now explore the client's exposed endpoints, for instance:
balances = c.get_account_balances()
print(balances)

Contribute 🆘

Open an issue to state clearly the contribution you want to make. Upon aproval send in a PR with the Issue referenced. (Implement Issue #No / Fix Issue #No).

Maintainers Ⓜ️

  • Erwin Lejeune

Buy me a Coffee

ERC-20 / EVM: 0xebcc98573c3cd9b5b61900d1304da938b5036a0d

BTC: bc1q3lu85cfkrc20ut64v90y428l79wfnv83mu72jv

DOT: 1Nt7G2igCuvYrfuD2Y3mCkFaU4iLS9AZytyVgZ5VBUKktjX

DAG: DAG7rGLbD71VrU6nWPrepdzcyRS6rFVvfWjwRKg5

LUNC: terra12n3xscq5efr7mfd6pk5ehtlsgmaazlezhypa7g

python-nexo's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

python-nexo's Issues

Validate REST API v1

Account

  • GET /api/v1/accountSummary (Retrieves account balances)

Pairs

  • GET /api/v1/pairs (Gets a list of all pairs, min and max amounts.)

Quote

  • GET /api/v1/pairs (Gets a price quote.)

Order

  • POST /api/v1/orders (Places an order.)

  • POST /api/v1/orders/trigger (Places a trigger order.)

  • POST /api/v1/orders/advanced (Places an advanced order.)

  • POST /api/v1/orders/twap (Places a TWAP order.)

History

  • GET /api/v1/orders (Gets order history.)

  • GET /api/v1/orderDetails (Gets details of specific order.)

  • GET /api/v1/trades (Retrieves trades history.)

  • GET /api/v1/transactionInfo (Gets a transaction information.)

Roadmap

Urgent

  • Solve HMAC Signature Issues
  • Mock API for Tests
  • Validate REST API v1

What's Next

  • Websocket Implementation
  • Async Client for REST API
  • Caching
  • Github Pages Documentation
  • Push v0.0.1 to pyp packages

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.