tokenterminal


Nametokenterminal JSON
Version 2.0.0 PyPI version JSON
download
home_pagehttps://github.com/itzmestar/tokenterminal
SummaryUnofficial Token Terminal API client.
upload_time2024-04-28 15:06:28
maintainerNone
docs_urlNone
authorTarique Anwer
requires_pythonNone
licenseApache License 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Token Terminal

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/)
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

-------

### Unofficial [Token Terminal API](https://www.tokenterminal.com/) client in python

For more information, see [Token Terminal API Documentation](https://docs.tokenterminal.com/)

### Installation:

use pip to install:

``` 
pip install tokenterminal
```

-----------

### Authentication:

Pass API key in object initialization.

-----------

### Example usage:

```
from tokenterminal import TokenTerminal

# object initialization
token_terminal = TokenTerminal(key='xxxxx-xxxx-xxxx-xxxx-xxxxxxxx')

# Fetch all data for projects' 
projects_data = token_terminal.get_all_projects()

for project_info in projects_data:
    print(project_info)

# Fetch project's historical metrics

project_metrics = token_terminal.get_historical_metrics('0x')
for metrics in project_metrics:
    print(metrics)

# To retrieve the metric availability for a project.
reponse = token_terminal.get_metric_availability(project_id=project_id)

# To retrieve metric aggregation data for one project.
reponse = token_terminal.get_metric_aggregations(project_id=project_id)

# Get financial statement for a project
reponse = token_terminal.get_financial_statement(
    project_id=project_id, 
    timestamp_granularity='week',
    interval='1m'
    )

# Get list of all available market sectors that are available
reponse = token_terminal.get_market_sectors()

# Get list of all metrics
reponse = token_terminal.get_all_metrics()

# To retrieve metric aggregations for multiple projects.
project_ids = ['aave', 'uniswap']
reponse = token_terminal.get_projects_metric_aggregations(project_ids=project_ids)
```
-------
#### Donate & Help maintain the library

[![Paypal](qrcode.png)](https://www.paypal.com/ncp/payment/KLFNJN7SH39EN)

-------

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/itzmestar/tokenterminal",
    "name": "tokenterminal",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Tarique Anwer",
    "author_email": "itzmetariq@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/10/46/a6593c25cf5a3c37ed405ec3bb062a60dd6318feb6bad396d1c699ac11bd/tokenterminal-2.0.0.tar.gz",
    "platform": null,
    "description": "# Token Terminal\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)\n[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/)\n[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n-------\n\n### Unofficial [Token Terminal API](https://www.tokenterminal.com/) client in python\n\nFor more information, see [Token Terminal API Documentation](https://docs.tokenterminal.com/)\n\n### Installation:\n\nuse pip to install:\n\n``` \npip install tokenterminal\n```\n\n-----------\n\n### Authentication:\n\nPass API key in object initialization.\n\n-----------\n\n### Example usage:\n\n```\nfrom tokenterminal import TokenTerminal\n\n# object initialization\ntoken_terminal = TokenTerminal(key='xxxxx-xxxx-xxxx-xxxx-xxxxxxxx')\n\n# Fetch all data for projects' \nprojects_data = token_terminal.get_all_projects()\n\nfor project_info in projects_data:\n    print(project_info)\n\n# Fetch project's historical metrics\n\nproject_metrics = token_terminal.get_historical_metrics('0x')\nfor metrics in project_metrics:\n    print(metrics)\n\n# To retrieve the metric availability for a project.\nreponse = token_terminal.get_metric_availability(project_id=project_id)\n\n# To retrieve metric aggregation data for one project.\nreponse = token_terminal.get_metric_aggregations(project_id=project_id)\n\n# Get financial statement for a project\nreponse = token_terminal.get_financial_statement(\n    project_id=project_id, \n    timestamp_granularity='week',\n    interval='1m'\n    )\n\n# Get list of all available market sectors that are available\nreponse = token_terminal.get_market_sectors()\n\n# Get list of all metrics\nreponse = token_terminal.get_all_metrics()\n\n# To retrieve metric aggregations for multiple projects.\nproject_ids = ['aave', 'uniswap']\nreponse = token_terminal.get_projects_metric_aggregations(project_ids=project_ids)\n```\n-------\n#### Donate & Help maintain the library\n\n[![Paypal](qrcode.png)](https://www.paypal.com/ncp/payment/KLFNJN7SH39EN)\n\n-------\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "Unofficial Token Terminal API client.",
    "version": "2.0.0",
    "project_urls": {
        "Homepage": "https://github.com/itzmestar/tokenterminal"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1f232b3f0adc677476ed2291d391e706237e60ef3f259e0fc12b957fad4d4094",
                "md5": "e863eb526cf752d9431ec4e1ccd9ed1c",
                "sha256": "e395c4c5bd34c4beb2beb551ec05175ce0a83cda6591e8d66fc66265f88277ec"
            },
            "downloads": -1,
            "filename": "tokenterminal-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e863eb526cf752d9431ec4e1ccd9ed1c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9000,
            "upload_time": "2024-04-28T15:06:27",
            "upload_time_iso_8601": "2024-04-28T15:06:27.672857Z",
            "url": "https://files.pythonhosted.org/packages/1f/23/2b3f0adc677476ed2291d391e706237e60ef3f259e0fc12b957fad4d4094/tokenterminal-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1046a6593c25cf5a3c37ed405ec3bb062a60dd6318feb6bad396d1c699ac11bd",
                "md5": "fce96f180c4bf2398966b7d98e3964a2",
                "sha256": "f3f44fc65e070cc5708f20d8213c0cc9c97a7169369a107d877878c151316a3a"
            },
            "downloads": -1,
            "filename": "tokenterminal-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fce96f180c4bf2398966b7d98e3964a2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9144,
            "upload_time": "2024-04-28T15:06:28",
            "upload_time_iso_8601": "2024-04-28T15:06:28.766126Z",
            "url": "https://files.pythonhosted.org/packages/10/46/a6593c25cf5a3c37ed405ec3bb062a60dd6318feb6bad396d1c699ac11bd/tokenterminal-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-28 15:06:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "itzmestar",
    "github_project": "tokenterminal",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tokenterminal"
}
        
Elapsed time: 0.22508s