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.1.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.1-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: onyx_otc-0.3.1.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.1.tar.gz
Algorithm Hash digest
SHA256 e9b10429fe4c2ada5a13df90f5449cbf7aebf6200505e38927ec05ee002180b2
MD5 818a66cf9559285dcb2d7499d64806ab
BLAKE2b-256 55b8774efdbfc899565377c67626ee5ef1f55b8bb82acf9a408f8cc94279b38e

See more details on using hashes here.

Provenance

The following attestation bundles were made for onyx_otc-0.3.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: onyx_otc-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 31.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae05928992c487bbc74b23105a64abdaeecd41cce8c1b971d1f01b19a39c2147
MD5 469b37b21a9a9a432277ad2408f5d016
BLAKE2b-256 572cfc56004b65763fe50e17ca0c2530d756d4a2895753d62eccfbf345eca056

See more details on using hashes here.

Provenance

The following attestation bundles were made for onyx_otc-0.3.1-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