Metadata-Version: 2.3
Name: onyx-otc
Version: 0.2.1
Summary: Onyx otc python client and documentation
Author: lsbardel
Author-email: lsbardella@onyxcapitaltechnology.com
Requires-Python: >=3.11,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: cli
Requires-Dist: aiohttp (>=3.10.10,<4.0.0)
Requires-Dist: click (>=8.1.8,<9.0.0) ; extra == "cli"
Requires-Dist: grpcio (>=1.64.1,<2.0.0)
Requires-Dist: protobuf (>=5.27.2,<6.0.0)
Requires-Dist: pydantic (>=2.10.6,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Project-URL: Homepage, https://github.com/Onyx-Capital-Technology/onyx-otc
Project-URL: Repository, https://github.com/Onyx-Capital-Technology/onyx-otc
Description-Content-Type: text/markdown

# Onyx OTC

[![PyPI version](https://badge.fury.io/py/onyx-otc.svg)](https://badge.fury.io/py/onyx-otc)
[![Python versions](https://img.shields.io/pypi/pyversions/onyx-otc.svg)](https://pypi.org/project/onyx-otc)
[![Python downloads](https://img.shields.io/pypi/dd/onyx-otc.svg)](https://pypi.org/project/onyx-otc)
[![build](https://github.com/Onyx-Capital-Technology/onyx-otc/actions/workflows/build.yml/badge.svg)](https://github.com/Onyx-Capital-Technology/onyx-otc/actions/workflows/build.yml)

* [Onyx Flux Rest API docs](https://api.onyxhub.co/v1/docs)
* [Onyx Flux Websocket API v2 docs](https://ws.dev.onyxhub.co/doc/v2)
* [Onyx Flux web app](https://www.onyxcapitalgroup.com/flux)

## 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.

Install the library via pip:

```bash
pip install onyx-otc
```

To install the library with command line support

```bash
pip install onyx-otc[cli]
```


## Example

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

```bash
onyx --help
```

Stream tickers for a list of product symbols.

```bash
onyx stream -t ebob -t brt
```

Stream tradable quotes for a list of contract symbols.

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

