Skip to main content

A package to interact with OVEX API

Project description

OVEX-py

OVEX Python API.

Installation

pip install ovex-py

How to use it

Most functions should have useful help text, but essentially:

API object creation

from ovex_python.client import Client
c = Client(api_key_id='key_id', base_url='', timeout=0)

Where optional parameters can be passed as follows:

Parameter Description Default
api_key_id Your API key created on the OVEX website Required for authenticated calls
base_url The API host URL https://www.ovex.io/api/v2
timeout The maximum time to wait for requests 10 (s)

API calls

Get accounts for all currencies

c.get_accounts()

Returns: list of dictionaries containing balances for all currencies

Get currency info

c.get_currency_info('btc')

Returns: dictionary containing information about the currency requested

Request a quote

o.get_quote_rfq(to_amount=1, market='btczar', side='buy')

Returns: dictionary containing quote information including a token

Known Issues

  • Not all error handling has been handled
  • Not all endpoints work as expected, sometimes parameters get ignored
  • Exceptions have not been handled and might not even output a warning

Acknowledgements

This repo was largely based on the work done on pyluno, thanks to Grant Stephens https://github.com/grantstephens/pyluno

To Do

  • Add in a rate limiter
  • Add in processing layer to make results more user-friendly

Contribute

  • Fork it
  • Contribute
  • Give feedback
  • Start again

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

ovex_py-0.1.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

ovex_py-0.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ovex_py-0.1.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for ovex_py-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4931ffe7284551f15f89c736354be6fd9f8ba840eeabaafa2b1f2a625da7b29f
MD5 2a5c84c0463dc0bdfeccb0a495817832
BLAKE2b-256 01afa9895fdb44abe43172fbf8a7a47b068d8225b660f6dc1355699d0a4e9c8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovex_py-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for ovex_py-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00368fda42d2289516d94ee6ebd2e7a507625c7e3c2f759e09709ed0a31ebb82
MD5 92a895e7589eb7e3112e537ff6ece4db
BLAKE2b-256 62755e58bd04371c064110241c5e5a709aa80c13e2d3b5bb76113f59d8adb81e

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