# PyToros
Download leveraged token data from [Toros Finance](https://toros.finance/).
[](https://github.com/dhruvan2006/pytoros)
[](https://codecov.io/github/dhruvan2006/pytoros)
[](https://github.com/dhruvan2006/pytoros)
[](https://github.com/dhruvan2006/pytoros)
## Installation
```bash
pip install pytoros
```
## Usage
```python
import pytoros as toros
token = Token("ARB:BTCBULL3X")
history = token.history()
print(history)
```
## API Documentation
### Token Class
#### `Token(ticker: str)`
- **Parameters**:
- `ticker` (str): The token's identifier (e.g., `ARB:BTCBULL3X`).
- **Description**:
Initializes the Token object for fetching data.
#### `history(period: str = "1y", interval: str = "1d")`
- **Parameters**:
- `period` (str): Time range for historical data. Options: `1d`, `1w`, `1m`, `1y` (default: `1y`).
- `interval` (str): Time interval between data points. Options: `1h`, `4h`, `1d`, `1w` (default: `1d`).
- **Returns**:
A `pandas.DataFrame` containing historical price data with the following columns:
- `Date`: Timestamp of the data point.
- `Open`: Opening price.
- `Close`: Closing price.
- `High`: Highest price during the interval.
- `Low`: Lowest price during the interval.
Raw data
{
"_id": null,
"home_page": null,
"name": "pytoros",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "leverage, toros, crypto",
"author": null,
"author_email": "Mohammed Faheem <mohdfaheem.1205@gmail.com>, Dhruvan Gnanadhandayuthapani <dhruvan2006@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ab/6e/3d5862b6fc75e84ee0cc485b34d2b5c008b7713973b76e739b2e48c0fefd/pytoros-0.1.4.tar.gz",
"platform": null,
"description": "# PyToros\n\nDownload leveraged token data from [Toros Finance](https://toros.finance/).\n\n[](https://github.com/dhruvan2006/pytoros)\n[](https://codecov.io/github/dhruvan2006/pytoros)\n[](https://github.com/dhruvan2006/pytoros)\n[](https://github.com/dhruvan2006/pytoros)\n\n## Installation\n```bash\npip install pytoros\n```\n\n## Usage\n```python\nimport pytoros as toros\n\ntoken = Token(\"ARB:BTCBULL3X\")\nhistory = token.history()\nprint(history)\n```\n\n## API Documentation\n\n### Token Class\n\n#### `Token(ticker: str)`\n- **Parameters**:\n - `ticker` (str): The token's identifier (e.g., `ARB:BTCBULL3X`).\n- **Description**:\n Initializes the Token object for fetching data.\n\n#### `history(period: str = \"1y\", interval: str = \"1d\")`\n- **Parameters**:\n - `period` (str): Time range for historical data. Options: `1d`, `1w`, `1m`, `1y` (default: `1y`).\n - `interval` (str): Time interval between data points. Options: `1h`, `4h`, `1d`, `1w` (default: `1d`).\n- **Returns**:\n A `pandas.DataFrame` containing historical price data with the following columns:\n - `Date`: Timestamp of the data point.\n - `Open`: Opening price.\n - `Close`: Closing price.\n - `High`: Highest price during the interval.\n - `Low`: Lowest price during the interval.\n",
"bugtrack_url": null,
"license": null,
"summary": "Download leveraged token data from Toros Finance.",
"version": "0.1.4",
"project_urls": {
"source": "https://github.com/dhruvan2006/pytoros"
},
"split_keywords": [
"leverage",
" toros",
" crypto"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4becc033230a7afa1427f92b4ed374e85fd4f51ef6fb249518ecd7bd880714d",
"md5": "6de2395201e36ca771fed6201a1d7c70",
"sha256": "0616b1ad27586c7bb2a91c58284f94a7c4d4324cd78a071883c9126f47ce3af9"
},
"downloads": -1,
"filename": "pytoros-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6de2395201e36ca771fed6201a1d7c70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4608,
"upload_time": "2024-12-08T12:35:26",
"upload_time_iso_8601": "2024-12-08T12:35:26.536319Z",
"url": "https://files.pythonhosted.org/packages/f4/be/cc033230a7afa1427f92b4ed374e85fd4f51ef6fb249518ecd7bd880714d/pytoros-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab6e3d5862b6fc75e84ee0cc485b34d2b5c008b7713973b76e739b2e48c0fefd",
"md5": "6e8dc783bef31acca28f611cd6ca76a3",
"sha256": "8ff622106b6aa51e628490142b2030fc27388b1134c4da7a9b0507247c5fd2c8"
},
"downloads": -1,
"filename": "pytoros-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "6e8dc783bef31acca28f611cd6ca76a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5057,
"upload_time": "2024-12-08T12:35:28",
"upload_time_iso_8601": "2024-12-08T12:35:28.505154Z",
"url": "https://files.pythonhosted.org/packages/ab/6e/3d5862b6fc75e84ee0cc485b34d2b5c008b7713973b76e739b2e48c0fefd/pytoros-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-08 12:35:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dhruvan2006",
"github_project": "pytoros",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "beautifulsoup4",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.8.30"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"2.1.3"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.2.3"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2024.2"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"75.6.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "soupsieve",
"specs": [
[
"==",
"2.6"
]
]
},
{
"name": "tzdata",
"specs": [
[
"==",
"2024.2"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.3"
]
]
}
],
"lcname": "pytoros"
}
JSON
