Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

Onyx Websocket API v2

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

Metadata

Release files for onyx-otc 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for onyx-otc 0.3.1
File	Size	Uploaded
onyx_otc-0.3.1.tar.gz	22.2 kB	May 2, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for onyx-otc 0.3.1
File	Interpreter	ABI	Platform	Reset
onyx_otc-0.3.1-py3-none-any.whl 31.8 kB May 2, 2025	Python 3	none	any	Details

Total release size: 53.9 kB

Release files / onyx_otc-0.3.1.tar.gz

Download URL	onyx_otc-0.3.1.tar.gz
Size	22.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`e9b10429fe4c2ada5a13df90f5449cbf7aebf6200505e38927ec05ee002180b2`
BLAKE2b-256 checksum How to use checksums	`55b8774efdbfc899565377c67626ee5ef1f55b8bb82acf9a408f8cc94279b38e`
Upload date	May 2, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Onyx-Capital-Technology/onyx-otc
Publishing commit: github.com/Onyx-Capital-Technology/onyx-otc/tree/e33507eb2f18204737b0c883b1d24948187c1201

Workflow

Publishing configuration: github.com/Onyx-Capital-Technology/onyx-otc/blob/e33507eb2f18204737b0c883b1d24948187c1201/.github/workflows/build.yml
Publishing logs: github.com/Onyx-Capital-Technology/onyx-otc/actions/runs/14794404333/attempts/1

Artifact

Subject: onyx_otc-0.3.1.tar.gz
SHA-256 checksum: e9b10429fe4c2ada5a13df90f5449cbf7aebf6200505e38927ec05ee002180b2 Verifying attestations

Release files / onyx_otc-0.3.1-py3-none-any.whl

Download URL	onyx_otc-0.3.1-py3-none-any.whl
Size	31.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ae05928992c487bbc74b23105a64abdaeecd41cce8c1b971d1f01b19a39c2147`
BLAKE2b-256 checksum How to use checksums	`572cfc56004b65763fe50e17ca0c2530d756d4a2895753d62eccfbf345eca056`
Upload date	May 2, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.12.9`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Onyx-Capital-Technology/onyx-otc
Publishing commit: github.com/Onyx-Capital-Technology/onyx-otc/tree/e33507eb2f18204737b0c883b1d24948187c1201

Workflow

Publishing configuration: github.com/Onyx-Capital-Technology/onyx-otc/blob/e33507eb2f18204737b0c883b1d24948187c1201/.github/workflows/build.yml
Publishing logs: github.com/Onyx-Capital-Technology/onyx-otc/actions/runs/14794404333/attempts/1

Artifact

Subject: onyx_otc-0.3.1-py3-none-any.whl
SHA-256 checksum: ae05928992c487bbc74b23105a64abdaeecd41cce8c1b971d1f01b19a39c2147 Verifying attestations