Skip to main content

Onyx otc python client and documentation

Project description

Onyx Websocket API v2

PyPI version Python versions Python downloads build

The websocket API v2 support both JSON and Protobuf (binary) encoding. The protobuf encoding is more efficient and faster than JSON encoding.

Environment Protocol URL
Production JSON wss://ws.onyxhub.co/stream/v2
Production Protobuf wss://ws.onyxhub.co/stream/v2/binary
UAT JSON wss://ws.uat.onyxhub.co/stream/v2
UAT Protobuf wss://ws.uat.onyxhub.co/stream/v2/binary

Installation

Install the library via pip:

pip install onyx-otc

To install the library with command line support

pip install onyx-otc[cli]

Example

Install the library with command line support and run the client:

onyx --help

Stream tickers for a list of product symbols.

onyx stream -t ebob -t brt

Stream tradable quotes for a list of contract symbols.

onyx stream -r brtm25@ice -r ebobm25@ice

Protobuf support

The binary endpoints uses protobuf encoding and the definitions are available in the protos/onyx_otc/v2 directory.

Other resources

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

onyx_otc-0.3.0.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

onyx_otc-0.3.0-py3-none-any.whl (31.6 kB view details)

Uploaded Python 3

File details

Details for the file onyx_otc-0.3.0.tar.gz.

File metadata

  • Download URL: onyx_otc-0.3.0.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for onyx_otc-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a040094a6a17108ef123ceb77d4e80c6a2d542870f903ffdd149c70be7cd8eb8
MD5 c9d1696095fac9f1f5501ed940a4af27
BLAKE2b-256 9ef13fd3bd0f3bcf85f8420a099f1f2abf15df38ca6b896a8a48664ded19bc2b

See more details on using hashes here.

Provenance

The following attestation bundles were made for onyx_otc-0.3.0.tar.gz:

Publisher: build.yml on Onyx-Capital-Technology/onyx-otc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file onyx_otc-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: onyx_otc-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 31.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for onyx_otc-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8eeb2f85549d3689f2c4d3436f63363415ab0a3537d92e94d557c369338f3bdc
MD5 729f3536b8678f63ee6d574cfb7fa43b
BLAKE2b-256 1fe6a280ac96448377791b939bf6e534fec2997e034fa3381cc3f47ed7fd1e21

See more details on using hashes here.

Provenance

The following attestation bundles were made for onyx_otc-0.3.0-py3-none-any.whl:

Publisher: build.yml on Onyx-Capital-Technology/onyx-otc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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