The unofficial Python client for the AlphaSquared API
Project description
AlphaSquared Python Client
This is an unofficial Python client for the AlphaSquared API. It allows users to interact with the API to retrieve asset information, strategy values, and hypothetical data for cryptocurrency trading.
Features
- Easy-to-use Python wrapper for the AlphaSquared API
- Supports authentication using API tokens
- Implements rate limiting to comply with API usage rules
- Provides methods to retrieve asset information, strategy values, and hypothetical data
- Includes error handling and logging functionality
Installation
Install the package using pip:
pip install alphasquared-py
Authentication
To use the AlphaSquared API, you need to obtain an API token from your AlphaSquared account dashboard. Once you have your token, you can authenticate as follows:
from alphasquared import AlphaSquared
api = AlphaSquared("YOUR_API_TOKEN")
Usage
Retrieving Asset Information
btc_info = api.get_asset_info("BTC")
print(btc_info)
Getting Strategy Values
strategy_values = api.get_strategy_values("My Custom Strat")
print(strategy_values)
Fetching Hypothetical Data
eth_hypotheticals = api.get_hypotheticals("ETH")
print(eth_hypotheticals)
Error Handling
The client includes built-in error handling. You can check for errors in the API responses:
result = api.get_asset_info("INVALID_ASSET")
if api.has_error(result):
print("An error occurred:", result["error"])
Rate Limiting
The client automatically handles rate limiting to ensure compliance with the API's usage rules (6 requests per minute).
Documentation
For more information about the AlphaSquared API, consult the official API documentation.
License
This project is licensed under the MIT License. See the LICENSE file for more information.
Disclaimer
This project is not affiliated with, maintained, or endorsed by AlphaSquared. Use this software at your own risk. Trading cryptocurrencies carries a risk of financial loss. The developers of this software are not responsible for any financial losses or damages incurred while using this software.
Support
For any issues, questions, or assistance, please open an issue on the GitHub repository or contact AlphaSquared support at admin@alphasquared.io.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for alphasquared_py-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4e966f60d2146700dc3a8f75389ab754838413c5e6d32aa3452e24472c7bf74 |
|
MD5 | 356065e8b58a749870fccdc25d470d35 |
|
BLAKE2b-256 | 7dc20b88c9ee50d2bc29f4730c63a990a15af2c3c1fc1eb31d00918ed556eae6 |