## Blockhouse SDK API Package
This is a Python SDK package that is used for various functionality from the Blockhouse API. The package is published on PyPI and can be installed using pip.
## Table of Contents
1. Features
2. Usage
3. Available Functions
4. License
5. Contributing
6. Support
7. Changelog
## Features
- Fetch trade data from the Blockhouse API and send them to our kafka topic.
## Usage
Get the API key from the Blockhouse API and install the package using pip:
```bash
pip install blockhouse
```
Using as a Python Library
```python
from blockhouse import Transfer
client = Transfer(api_key="your_api_key_here")
send = client.send_file(local_file_path="test123.txt", bucket_name="blockhouse-sdk")
print(send)
trades = client.trades_data()
print(trades)
```
Sending SOR data to the Blockhouse API
```python
from blockhouse import TradeClient
client = TradeClient("your_api_key_here")
res = client.send_trade(
order_id="12345",
symbol="AAPL",
quantity=100,
side="buy",
price=150.50,
order_type="limit",
)
print(res)
```
## Available Functions:
- TransferData: Fetch trade data from the Blockhouse API and send them to our kafka topic.
## License
This project is licensed under the MIT License. See the LICENSE file for more details.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
## Support
If you encounter any issues or have questions, feel free to open email us.
## Changelog
Version 1.0.9
- Added the ability to send files to the Blockhouse API.
- Added the ability to fetch trade data from the Blockhouse API.
- Added the ability to send SOR data to the Blockhouse API and create FIX messages.
Raw data
{
"_id": null,
"home_page": null,
"name": "blockhouse",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, blockhouse, sdk, stock, market, trading, algotrading, finance, financial, stocks, market, data, api, wrapper",
"author": "Blockhouse Labs",
"author_email": "<mail@blockhouse.com>",
"download_url": "https://files.pythonhosted.org/packages/d3/d1/44cb072621f604322c7c49ceed1c83c23d3f62b81fe465b1a7a6f77c09ff/blockhouse-1.0.16.tar.gz",
"platform": null,
"description": "\r\n## Blockhouse SDK API Package\r\r\n\r\r\nThis is a Python SDK package that is used for various functionality from the Blockhouse API. The package is published on PyPI and can be installed using pip.\r\r\n\r\r\n## Table of Contents\r\r\n\r\r\n1. Features\r\r\n2. Usage\r\r\n3. Available Functions\r\r\n4. License\r\r\n5. Contributing\r\r\n6. Support\r\r\n7. Changelog\r\r\n\r\r\n## Features\r\r\n\r\r\n- Fetch trade data from the Blockhouse API and send them to our kafka topic.\r\r\n\r\r\n## Usage\r\r\n\r\r\nGet the API key from the Blockhouse API and install the package using pip:\r\r\n\r\r\n```bash\r\r\npip install blockhouse\r\r\n```\r\r\n\r\r\nUsing as a Python Library\r\r\n\r\r\n```python\r\r\nfrom blockhouse import Transfer\r\r\n\r\r\nclient = Transfer(api_key=\"your_api_key_here\")\r\r\n\r\r\nsend = client.send_file(local_file_path=\"test123.txt\", bucket_name=\"blockhouse-sdk\")\r\r\n\r\r\nprint(send)\r\r\n\r\r\ntrades = client.trades_data()\r\r\n\r\r\nprint(trades)\r\r\n```\r\r\n\r\r\nSending SOR data to the Blockhouse API\r\r\n\r\r\n```python\r\r\nfrom blockhouse import TradeClient\r\r\n\r\r\nclient = TradeClient(\"your_api_key_here\")\r\r\nres = client.send_trade(\r\r\n order_id=\"12345\",\r\r\n symbol=\"AAPL\",\r\r\n quantity=100,\r\r\n side=\"buy\",\r\r\n price=150.50,\r\r\n order_type=\"limit\",\r\r\n)\r\r\nprint(res)\r\r\n```\r\r\n\r\r\n## Available Functions:\r\r\n\r\r\n- TransferData: Fetch trade data from the Blockhouse API and send them to our kafka topic.\r\r\n\r\r\n## License\r\r\n\r\r\nThis project is licensed under the MIT License. See the LICENSE file for more details.\r\r\n\r\r\n## Contributing\r\r\n\r\r\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\r\r\n\r\r\n## Support\r\r\n\r\r\nIf you encounter any issues or have questions, feel free to open email us.\r\r\n\r\r\n## Changelog\r\r\n\r\r\nVersion 1.0.9\r\r\n\r\r\n- Added the ability to send files to the Blockhouse API.\r\r\n- Added the ability to fetch trade data from the Blockhouse API.\r\r\n- Added the ability to send SOR data to the Blockhouse API and create FIX messages.\r\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Blockhouse SDK",
"version": "1.0.16",
"project_urls": null,
"split_keywords": [
"python",
" blockhouse",
" sdk",
" stock",
" market",
" trading",
" algotrading",
" finance",
" financial",
" stocks",
" market",
" data",
" api",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b71f7b3d6a014f810a31b88d79665e6950102f8be15b8d753242eb6e17c5bc6",
"md5": "242e41cefdc3c14595a02284187e4636",
"sha256": "4f6662d7efbefeece87132ee80845f5ad2c4699634ea349dc3eb41b9d71ed80c"
},
"downloads": -1,
"filename": "blockhouse-1.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "242e41cefdc3c14595a02284187e4636",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8335,
"upload_time": "2025-01-31T18:53:23",
"upload_time_iso_8601": "2025-01-31T18:53:23.230225Z",
"url": "https://files.pythonhosted.org/packages/6b/71/f7b3d6a014f810a31b88d79665e6950102f8be15b8d753242eb6e17c5bc6/blockhouse-1.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3d144cb072621f604322c7c49ceed1c83c23d3f62b81fe465b1a7a6f77c09ff",
"md5": "4855f788b9ef9c853094667c87a88849",
"sha256": "015511fcda2a3514687bb36670cffa3b72d775dfca9df742def9741acc1bc92d"
},
"downloads": -1,
"filename": "blockhouse-1.0.16.tar.gz",
"has_sig": false,
"md5_digest": "4855f788b9ef9c853094667c87a88849",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6633,
"upload_time": "2025-01-31T18:53:25",
"upload_time_iso_8601": "2025-01-31T18:53:25.104019Z",
"url": "https://files.pythonhosted.org/packages/d3/d1/44cb072621f604322c7c49ceed1c83c23d3f62b81fe465b1a7a6f77c09ff/blockhouse-1.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-31 18:53:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "blockhouse"
}
JSON