Skip to main content

PYTHON WRAPPER FOR VITEX.NET API v2

Project description

Python wrapper for vitex.net API v2

vitex-py by `blacktyger

Installation:

python -m pip install vitexpy

Description:

Python wrapper for ViteX - Decentralized cryptocurrency exchange API.

Features:

  • Handling transaction signatures required by ViteX API
  • Decimal library to keep high precision with floating point numbers
  • Well documented and readable for everyone
  • OOP approach with Token, TraidingPair, Order, and API objects

How to use:

from vitexpy import PublicAPI

api = PublicAPI(print_response=True)  # Default: False

# Test connection with ViteX server
api.test_connection()
>>> Successfully connected to ViteX API with vitex-py module
>>> Server time: 2021-10-28 12:50:44.469000
>>> USD  /  CNY: 6.466199999999926

# Get list with Token object/s
api.get_token('EPIC-002')  
>>> [Token(EPIC-002)]

# Get list with all Token object/s
api.get_all_tokens()  
>>> [Token(AAVO-000), Token(ABC-000), Token(AGS-000), ...]

# Get list with TradingPair object/s
api.get_trading_pair('EPIC-002_BTC-000')  
>>> [TradingPair(EPIC-002/BTC-000)]

  • 📈 TradingAPI requires signature authentication by API Key and API Secret, which you can apply for on ViteX platform. Please note that API Key and API Secret are both case sensitive. Also it is recommended to stake some VITE for QUOTA ('transactions fuel') in order to execute multiple transactions.
  • All TradingAPI endpoints https://vite.wiki/dex/api/dex-apis.html#private-rest-api
from vitexpy import TradingAPI, TradingPair

api_key = "YOUR VITEX API KEY"
api_secret = "YOUR VITEX API SECRET"

api = TradingAPI(api_key=user_key,
                 api_secret=user_secret,
                 print_response=True)

# Create dictionary with required values
order_params = {
    'test': True,  # Optional, when True transactions are not executed in network
    'symbol': 'EPIC-002_BTC-000',  # Market pair symbol ('BASE-XXX_QUOTA-XXX')
    'amount': 5,  # Amount to buy or sell in base token ('EPIC-002' in this case)
    'price': 0.00006000,  # Price for each base token ('EPIC-002') in quota token ('BTC-000')
    'side': 1,  # Buy(0) or Sell(1)
    }

# Create Order object with given params
order = api.prepare_order(**order_params)  

# Prepare, sign and execute Order object to Vitex network
api.execute_order(order)  

# Cancel all orders within given pair (TradingPair object or string with symbol)
api.cancel_all_orders(pair='EPIC-002_BTC-000')

💌 Donations

Project is open-source and free, if you like it please consider donation:

  • Vite Chain: vite_15d3230e3c31c009c968beea7160ae98b491475236ae2cddbc
  • EPIC Chain: https://fastepic.eu/keybaseid_blacktyg3r
  • WAN Chain: 0x37b056F68120a250D28C7de9650Fa02Ee740fec1
  • BSC Chain: 0xE6F431178cD7B44FBCb4381eBDb14Db213BDD866

Contact: @blacktyg3r via Telegram

Thanks!

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

vitexpy-1.0.4.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

vitexpy-1.0.4-py2.py3-none-any.whl (13.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file vitexpy-1.0.4.tar.gz.

File metadata

  • Download URL: vitexpy-1.0.4.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.26.0

File hashes

Hashes for vitexpy-1.0.4.tar.gz
Algorithm Hash digest
SHA256 7141609eaf3c1048062697ec69883cb15af410fedd8a50504203f0f7ae0228bd
MD5 dcbd8ff2534f1ed9261bb9975af928d2
BLAKE2b-256 9452edc4143c99e62db44be98315312f2ca89e55ccc5d8b717c9224c9daa4399

See more details on using hashes here.

File details

Details for the file vitexpy-1.0.4-py2.py3-none-any.whl.

File metadata

  • Download URL: vitexpy-1.0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.26.0

File hashes

Hashes for vitexpy-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 09d8a9d23e3323f866ee6d182a6f8a3ab292923eda11172cc3563170bea9c423
MD5 ff09787d61769487447106e248978274
BLAKE2b-256 29f1c2c50f5937aaee55ee007cbe1cc0685ae97ee9cf3d0f1af2b7677102d3ab

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