Metadata-Version: 2.1
Name: bidfx-api
Version: 1.0.0
Summary: Public API for accessing the BidFX platform for pricing
Home-page: https://github.com/bidfx/bidfx-api-py
Author: Paul Sweeny
Author-email: paul.sweeny@bidfx.com
License: Apache License 2.0
Download-URL: https://github.com/bidfx/bidfx-api-py/tarball/v1.0.0
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Natural Language :: English
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pycryptodomex (==3.9.4)

# BidFX Public API for Python

[![Release](https://img.shields.io/pypi/v/bidfx-api)](https://pypi.org/project/bidfx-api)
[![Status](https://img.shields.io/pypi/status/bidfx-api)](https://pypi.org/project/bidfx-api)
[![Source Release](https://img.shields.io/github/v/release/bidfx/bidfx-api-py?sort=semver)](https://github.com/bidfx/bidfx-api-py)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![ReadTheDocs](https://img.shields.io/readthedocs/bidfx-api-py)](https://readthedocs.org/projects/bidfx-api-py)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

![BidFX-API-Python](https://user-images.githubusercontent.com/2197551/76171801-35d74100-6187-11ea-8cc5-7f29b66d00ea.png)

-------


A *pricing* API that connects to the BidFX trading platform 
to subscribe to realtime FX pricing. The API supports:

 - FX request for stream (RFS) pricing
 - FX request for quote (RFQ) pricing


## Quick start

### Installation

```sh
pip install bidfx-api
```

### API docs

Read the documentation on [Read The Docs](https://bidfx-api-py.readthedocs.io).


## Python version

The API is compatible with Python 3.6 and greater.
If you do not have Python, please install the latest 3.x version from [python.org](https://python.org) 
or refer to the [Installing Python](http://docs.python-guide.org/en/latest/starting/installation/) section 
of the Hitchhiker’s Guide to Python.


## Alternative APIs

If you prefer not to code in Python, you can read about the complete BidFX API range, and their different capabilities,
at [BidFX API Overview](https://www.bidfx.com/apis).


