# BidFX Public API for Python
[](https://pypi.org/project/bidfx-api)
[](https://pypi.org/project/bidfx-api)
[](https://github.com/bidfx/bidfx-api-py)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://docs.bidfx.com/api-py/index.html)
[](https://github.com/psf/black)
-------
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).
Raw data
{
"_id": null,
"home_page": "https://github.com/bidfx/bidfx-api-py",
"name": "bidfx-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Paul Sweeny",
"author_email": "paul.sweeny@bidfx.com",
"download_url": "https://files.pythonhosted.org/packages/cd/ee/2fe4e8ac9010e09b06915478b84fcdc4d7f2239b5f4a24577a43d7edbe01/bidfx-api-1.1.4.tar.gz",
"platform": null,
"description": "# BidFX Public API for Python\n\n[](https://pypi.org/project/bidfx-api)\n[](https://pypi.org/project/bidfx-api)\n[](https://github.com/bidfx/bidfx-api-py)\n[](https://www.apache.org/licenses/LICENSE-2.0.html)\n[](https://docs.bidfx.com/api-py/index.html)\n[](https://github.com/psf/black)\n\n\n\n-------\n\n\nA *pricing* API that connects to the BidFX trading platform \nto subscribe to realtime FX pricing. The API supports:\n\n - FX request for stream (RFS) pricing\n - FX request for quote (RFQ) pricing\n\n\n## Quick start\n\n### Installation\n\n```sh\npip install bidfx-api\n```\n\n### API docs\n\nRead the documentation [here](https://docs.bidfx.com/api-py/index.html).\n\n\n## Python version\n\nThe API is compatible with Python 3.6 and greater.\nIf you do not have Python, please install the latest 3.x version from [python.org](https://python.org) \nor refer to the [Installing Python](http://docs.python-guide.org/en/latest/starting/installation/) section \nof the Hitchhiker\u2019s Guide to Python.\n\n\n## Alternative APIs\n\nIf you prefer not to code in Python, you can read about the complete BidFX API range, and their different capabilities,\nat [BidFX API Overview](https://www.bidfx.com/apis).\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Public API for accessing the BidFX platform for pricing",
"version": "1.1.4",
"project_urls": {
"Download": "https://github.com/bidfx/bidfx-api-py/tarball/v1.1.4",
"Homepage": "https://github.com/bidfx/bidfx-api-py"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "399679361feb4a0b5cbad1a2d118df9c3fe5646d8f85bc57a3320e30a862aa4e",
"md5": "40208e4c385ee7931c8fcc2796f8c700",
"sha256": "9e92ada5a8f84ef8d832fcca33928e3fd9d232a224f993b8f899f667c9d7ab6d"
},
"downloads": -1,
"filename": "bidfx_api-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40208e4c385ee7931c8fcc2796f8c700",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 72448,
"upload_time": "2024-11-05T09:12:13",
"upload_time_iso_8601": "2024-11-05T09:12:13.260897Z",
"url": "https://files.pythonhosted.org/packages/39/96/79361feb4a0b5cbad1a2d118df9c3fe5646d8f85bc57a3320e30a862aa4e/bidfx_api-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cdee2fe4e8ac9010e09b06915478b84fcdc4d7f2239b5f4a24577a43d7edbe01",
"md5": "fe157c3eb33f59b7148a69b82b05ecc4",
"sha256": "afe08d4daa87ddf7502c090232342b063c6583f31b3231a1c590760b0fa56766"
},
"downloads": -1,
"filename": "bidfx-api-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "fe157c3eb33f59b7148a69b82b05ecc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 41064,
"upload_time": "2024-11-05T09:12:15",
"upload_time_iso_8601": "2024-11-05T09:12:15.350665Z",
"url": "https://files.pythonhosted.org/packages/cd/ee/2fe4e8ac9010e09b06915478b84fcdc4d7f2239b5f4a24577a43d7edbe01/bidfx-api-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 09:12:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bidfx",
"github_project": "bidfx-api-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "bidfx-api"
}
JSON
