Onyx otc python client and documentation
Project description
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
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e9b10429fe4c2ada5a13df90f5449cbf7aebf6200505e38927ec05ee002180b2
|
|
| MD5 |
818a66cf9559285dcb2d7499d64806ab
|
|
| BLAKE2b-256 |
55b8774efdbfc899565377c67626ee5ef1f55b8bb82acf9a408f8cc94279b38e
|
Provenance
The following attestation bundles were made for onyx_otc-0.3.1.tar.gz:
Publisher:
build.yml on Onyx-Capital-Technology/onyx-otc
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
onyx_otc-0.3.1.tar.gz -
Subject digest:
e9b10429fe4c2ada5a13df90f5449cbf7aebf6200505e38927ec05ee002180b2 - Sigstore transparency entry: 206054884
- Sigstore integration time:
-
Permalink:
Onyx-Capital-Technology/onyx-otc@e33507eb2f18204737b0c883b1d24948187c1201 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Onyx-Capital-Technology
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build.yml@e33507eb2f18204737b0c883b1d24948187c1201 -
Trigger Event:
push
-
Statement type:
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae05928992c487bbc74b23105a64abdaeecd41cce8c1b971d1f01b19a39c2147
|
|
| MD5 |
469b37b21a9a9a432277ad2408f5d016
|
|
| BLAKE2b-256 |
572cfc56004b65763fe50e17ca0c2530d756d4a2895753d62eccfbf345eca056
|
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
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
onyx_otc-0.3.1-py3-none-any.whl -
Subject digest:
ae05928992c487bbc74b23105a64abdaeecd41cce8c1b971d1f01b19a39c2147 - Sigstore transparency entry: 206054886
- Sigstore integration time:
-
Permalink:
Onyx-Capital-Technology/onyx-otc@e33507eb2f18204737b0c883b1d24948187c1201 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Onyx-Capital-Technology
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build.yml@e33507eb2f18204737b0c883b1d24948187c1201 -
Trigger Event:
push
-
Statement type: