An open API service indexing awesome lists of open source software.

https://github.com/bidfx/bidfx-api-py

BidFX Public API for Python
https://github.com/bidfx/bidfx-api-py

fx market-data realtime trading

Last synced: 6 months ago
JSON representation

BidFX Public API for Python

Awesome Lists containing this project

README

          

# 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)
[![Docs](https://img.shields.io/badge/docs-docs.bidfx.com-green)](https://docs.bidfx.com/api-py/index.html)
[![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 [here](https://docs.bidfx.com/api-py/index.html).

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