pycwatch


Namepycwatch JSON
Version 1.1.4 PyPI version JSON
download
home_pagehttps://github.com/ljnsn/pycwatch
SummaryA client library for the Cryptowatch Rest API.
upload_time2023-08-20 12:45:43
maintainer
docs_urlNone
authorljnsn
requires_python>=3.7,<4.0
licenseMIT
keywords cryptocurrency crypto prices cryptowatch
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pycwatch

[![Coverage](https://img.shields.io/codecov/c/github/ljnsn/pycwatch?color=%2334D058)](https://codecov.io/gh/ljnsn/pycwatch)
[![Package version](https://img.shields.io/pypi/v/pycwatch?color=%2334D058&label=pypi%20package)](https://pypi.org/project/pycwatch)
[![Python versions](https://img.shields.io/pypi/pyversions/pycwatch.svg)](https://pypi.org/project/pycwatch)
[![Black style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

The `pycwatch` library provides access to the [Cryptowatch API](https://docs.cryptowat.ch/rest-api/) and implements all resources of the REST API.

## Installation

Either install from pypi or clone this repository and install locally.

```fish
pip install pycwatch
```

## Quick Start

See the [cryptowat.ch docs](https://docs.cryptowat.ch/rest-api) for available endpoints.

```python
from pycwatch import CryptoWatchClient

# create api client
client = CryptoWatchClient()

# get list of available assets
assets = client.list_assets()
# get some price info
exchange, pair = "binance", "btceur"
price = client.get_market_price(exchange, pair)
```

If you have an account at [cryptowat.ch](https://cryptowat.ch), you can either set your key as an environment variable or in the code.

```bash
export CRYPTO_WATCH_KEY="my-awesome-key"
```

or

```python
from pycwatch import CryptoWatchClient

api_key = "my-awesome-key"
client = CryptoWatchClient(api_key)
```

Note that anonymous users are limited to 10 Cryptowatch Credits worth of API calls per 24-hour period.
See <https://docs.cryptowat.ch/rest-api/rate-limit#api-request-pricing-structure> for more information.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ljnsn/pycwatch",
    "name": "pycwatch",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "cryptocurrency,crypto,prices,cryptowatch",
    "author": "ljnsn",
    "author_email": "82611987+ljnsn@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/26/62/fdfc589f23355178e824677eb3a92de73ca57c0853e61d294cb05e340ea8/pycwatch-1.1.4.tar.gz",
    "platform": null,
    "description": "# pycwatch\n\n[![Coverage](https://img.shields.io/codecov/c/github/ljnsn/pycwatch?color=%2334D058)](https://codecov.io/gh/ljnsn/pycwatch)\n[![Package version](https://img.shields.io/pypi/v/pycwatch?color=%2334D058&label=pypi%20package)](https://pypi.org/project/pycwatch)\n[![Python versions](https://img.shields.io/pypi/pyversions/pycwatch.svg)](https://pypi.org/project/pycwatch)\n[![Black style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nThe `pycwatch` library provides access to the [Cryptowatch API](https://docs.cryptowat.ch/rest-api/) and implements all resources of the REST API.\n\n## Installation\n\nEither install from pypi or clone this repository and install locally.\n\n```fish\npip install pycwatch\n```\n\n## Quick Start\n\nSee the [cryptowat.ch docs](https://docs.cryptowat.ch/rest-api) for available endpoints.\n\n```python\nfrom pycwatch import CryptoWatchClient\n\n# create api client\nclient = CryptoWatchClient()\n\n# get list of available assets\nassets = client.list_assets()\n# get some price info\nexchange, pair = \"binance\", \"btceur\"\nprice = client.get_market_price(exchange, pair)\n```\n\nIf you have an account at [cryptowat.ch](https://cryptowat.ch), you can either set your key as an environment variable or in the code.\n\n```bash\nexport CRYPTO_WATCH_KEY=\"my-awesome-key\"\n```\n\nor\n\n```python\nfrom pycwatch import CryptoWatchClient\n\napi_key = \"my-awesome-key\"\nclient = CryptoWatchClient(api_key)\n```\n\nNote that anonymous users are limited to 10 Cryptowatch Credits worth of API calls per 24-hour period.\nSee <https://docs.cryptowat.ch/rest-api/rate-limit#api-request-pricing-structure> for more information.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A client library for the Cryptowatch Rest API.",
    "version": "1.1.4",
    "project_urls": {
        "Homepage": "https://github.com/ljnsn/pycwatch",
        "Repository": "https://github.com/ljnsn/pycwatch"
    },
    "split_keywords": [
        "cryptocurrency",
        "crypto",
        "prices",
        "cryptowatch"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3cb6fb3a32de84370517ddc6e2d471bfc0da89ad66571c3ae0a4eb5857435aeb",
                "md5": "871ce34a81da4a671d9872cb4def941b",
                "sha256": "00e5dbfd1b32cf8df8b0803bec1bd5dbbc2ec8f9cca3ac87257eb9050ab39d85"
            },
            "downloads": -1,
            "filename": "pycwatch-1.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "871ce34a81da4a671d9872cb4def941b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 10752,
            "upload_time": "2023-08-20T12:45:41",
            "upload_time_iso_8601": "2023-08-20T12:45:41.292150Z",
            "url": "https://files.pythonhosted.org/packages/3c/b6/fb3a32de84370517ddc6e2d471bfc0da89ad66571c3ae0a4eb5857435aeb/pycwatch-1.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2662fdfc589f23355178e824677eb3a92de73ca57c0853e61d294cb05e340ea8",
                "md5": "6cf673d958740926a7dd189f31fed98c",
                "sha256": "d4f2ea6683a25c4eea51d6f055d7b79f6f0d20c8d544e626d9843b0a415d6d58"
            },
            "downloads": -1,
            "filename": "pycwatch-1.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "6cf673d958740926a7dd189f31fed98c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 10546,
            "upload_time": "2023-08-20T12:45:43",
            "upload_time_iso_8601": "2023-08-20T12:45:43.007466Z",
            "url": "https://files.pythonhosted.org/packages/26/62/fdfc589f23355178e824677eb3a92de73ca57c0853e61d294cb05e340ea8/pycwatch-1.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-20 12:45:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ljnsn",
    "github_project": "pycwatch",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pycwatch"
}
        
Elapsed time: 2.53411s