Metadata-Version: 2.1
Name: bidfx-api
Version: 0.2.0
Summary: Public API for accessing the BidFX platform for pricing and trading
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/v0.2.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 :: 4 - Beta
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pycryptodomex (==3.9.4)
Requires-Dist: requests (==2.22.0)
Requires-Dist: websocket-client (==0.57.0)

![BidFX logo](docs/_static/BidFX-API-Python-640px.png)

# Public API for Python

[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![ReadTheDocs](https://img.shields.io/readthedocs/bidfx-api-py)](https://readthedocs.org/projects/bidfx-api-py)

-------

## Features

The BidFX Python API is a *pricing* and *trading* API that connects to
the BidFX platform to subscribe to realtime pricing and to place orders.
The API supports:

 - FX request for stream (RFS) pricing
 - FX request for quote (RFQ) pricing
 - FX and Futures trading with
    [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) or 
    [WebSockets](https://en.wikipedia.org/wiki/WebSocket).

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


## Quick start

### Installation

The API can be installed by running.

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

### API Docs

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


## Alternative APIs

You can read about the complete BidFX API range, and their different capabilities,
at [BidFX API Overview](https://www.bidfx.com/apis).


## Development notes

API developers should read the [Developer Notes](DEVELOPMENT.md).


