# pycwatch
[](https://codecov.io/gh/ljnsn/pycwatch)
[](https://pypi.org/project/pycwatch)
[](https://pypi.org/project/pycwatch)
[](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-lib",
"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/f1/eeb39026d3364f35e269c62c2ed7a6c28dca329a63eb9afc77faf2cf68a9/pycwatch_lib-2.1.2.tar.gz",
"platform": null,
"description": "# pycwatch\n\n[](https://codecov.io/gh/ljnsn/pycwatch)\n[](https://pypi.org/project/pycwatch)\n[](https://pypi.org/project/pycwatch)\n[](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": "2.1.2",
"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": "3fd12f3e6992f6f7fb81552d66a7f7662e1627fbaaf2df8fe4d83f4644a6b5be",
"md5": "efd3287de6436555206cca2ef5b44b8c",
"sha256": "3eb20fd963311017900b6e8c06d37fa9adcfee92ab063ac43ea79370a011132e"
},
"downloads": -1,
"filename": "pycwatch_lib-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "efd3287de6436555206cca2ef5b44b8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 10456,
"upload_time": "2023-08-23T22:43:41",
"upload_time_iso_8601": "2023-08-23T22:43:41.518460Z",
"url": "https://files.pythonhosted.org/packages/3f/d1/2f3e6992f6f7fb81552d66a7f7662e1627fbaaf2df8fe4d83f4644a6b5be/pycwatch_lib-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26f1eeb39026d3364f35e269c62c2ed7a6c28dca329a63eb9afc77faf2cf68a9",
"md5": "d273c1ae7671f2079ac27c9f54d9591f",
"sha256": "114ef82a20c34c73beeee80579e21579d0a08d00830aa8776d722aa1ac8e535c"
},
"downloads": -1,
"filename": "pycwatch_lib-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "d273c1ae7671f2079ac27c9f54d9591f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 9948,
"upload_time": "2023-08-23T22:43:42",
"upload_time_iso_8601": "2023-08-23T22:43:42.521779Z",
"url": "https://files.pythonhosted.org/packages/26/f1/eeb39026d3364f35e269c62c2ed7a6c28dca329a63eb9afc77faf2cf68a9/pycwatch_lib-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-23 22:43:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ljnsn",
"github_project": "pycwatch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pycwatch-lib"
}
JSON
