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.0.1.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

ovex_py-0.0.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ovex_py-0.0.1.tar.gz
  • Upload date:
  • Size: 7.1 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.0.1.tar.gz
Algorithm Hash digest
SHA256 68142eec6881651de39a798c5a0ee16ebdd7328c82d74a1e57a25250914251fe
MD5 8515bd30ec43cbee2527152fcdc0146f
BLAKE2b-256 ed8bcb72ee1c72fe492cbfce8034ac142d020ed3d28f1fdcc376c0feba0f7a05

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovex_py-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b28110416575296afc722b38c09da678d9b6557c6a5c9c712d375fa05127dbe5
MD5 35b42547acb3a83bb9ac3e3a5acbcb0e
BLAKE2b-256 bc57306b55c7b4c804dfcab958a5ca7f1dcdf955b1edf2e7a3e6fddd19496eea

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