{"id":13585611,"url":"https://github.com/Corfucinas/crypto-candlesticks","last_synced_at":"2025-04-07T10:31:17.882Z","repository":{"id":36976768,"uuid":"277593872","full_name":"Corfucinas/crypto-candlesticks","owner":"Corfucinas","description":"Download candlestick data fast \u0026 easy for analysis","archived":false,"fork":false,"pushed_at":"2024-05-13T03:24:34.000Z","size":6826,"stargazers_count":39,"open_issues_count":12,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-29T22:28:46.394Z","etag":null,"topics":["bitcoin","bitfinex","candlesticks","crypto-candlesticks","cryptocurrency","cryptocurrency-candlesticks-data","data","download","historical-prices","ohlcv","prices","python"],"latest_commit_sha":null,"homepage":"https://crypto-candlesticks.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Corfucinas.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-06T16:29:45.000Z","updated_at":"2024-08-01T16:31:34.820Z","dependencies_parsed_at":"2023-10-10T13:40:04.983Z","dependency_job_id":"abaffb30-7bd4-4ff7-8a10-b8da956a3d75","html_url":"https://github.com/Corfucinas/crypto-candlesticks","commit_stats":{"total_commits":502,"total_committers":7,"mean_commits":71.71428571428571,"dds":0.452191235059761,"last_synced_commit":"fd41a433d5dcdd451261e9ae8d58697a528bbdbf"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corfucinas%2Fcrypto-candlesticks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corfucinas%2Fcrypto-candlesticks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corfucinas%2Fcrypto-candlesticks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Corfucinas%2Fcrypto-candlesticks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Corfucinas","download_url":"https://codeload.github.com/Corfucinas/crypto-candlesticks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247636245,"owners_count":20970889,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","bitfinex","candlesticks","crypto-candlesticks","cryptocurrency","cryptocurrency-candlesticks-data","data","download","historical-prices","ohlcv","prices","python"],"created_at":"2024-08-01T15:05:02.498Z","updated_at":"2025-04-07T10:31:17.426Z","avatar_url":"https://github.com/Corfucinas.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# crypto-candlesticks 📈\n\n[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)\n![Tests](https://github.com/Corfucinas/crypto-candlesticks/workflows/Tests/badge.svg)\n![Codecov](https://github.com/Corfucinas/crypto-candlesticks/workflows/Codecov/badge.svg)\n[![Documentation Status](https://readthedocs.org/projects/crypto-candlesticks/badge/?version=latest)](https://crypto-candlesticks.readthedocs.io/en/latest/?badge=latest)\n[![Security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n![PyPI - License](https://img.shields.io/pypi/l/crypto_candlesticks)\n[![PyPI](https://img.shields.io/pypi/v/crypto-candlesticks.svg)](https://pypi.org/project/crypto-candlesticks/)\n[![Python Version](https://img.shields.io/pypi/pyversions/crypto-candlesticks.svg)](https://pypi.org/project/crypto-candlesticks/)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![Downloads](https://pepy.tech/badge/crypto-candlesticks)](https://pepy.tech/project/crypto-candlesticks)\n\n![gif-animation](https://raw.githubusercontent.com/Corfucinas/crypto-candlesticks/master/media/animation.gif)\n\n---\n\nThe goal behind this project is to facilitate downloading cryptocurrency candlestick data fast \u0026 simple.\nCurrently only the [Bitfinex](https://www.bitfinex.com/) exchange is supported with more to come in future releases.\n\nThe command-line interface is built using [Click](https://click.palletsprojects.com/en/7.x/), which is intuitive and will prompt you for the commands.\n\nOnce the data is downloaded, it will be converted and stored in a `.csv, .sqlite3 and .pickle` file for convenient analysis.\nThe data will include the `Open, High, Low, Close` of the candles and the `volume` during the `interval` and its `timestamp`.\n\nSee [documentation](https://crypto-candlesticks.readthedocs.io/, \"project-documentation\") and [Github repository](https://github.com/Corfucinas/crypto-candlesticks/, \"project-repository\") for more information.\n\n## Installation\n\nTo install the Crypto-candlesticks project,\nrun this command in your terminal:\n\n```bash\n   pip install crypto-candlesticks\n```\n\nOr if you are using [Poetry](https://python-poetry.org/)\n\n```bash\n    poetry add crypto-candlesticks\n```\n\n## Usage\n\ncrypto-candlesticks can be used the following way:\n\n```bash\n    $ crypto-candlesticks\n    \"Welcome, what data do you wish to download?\"\n```\n\nWhich will prompt the following:\n\n```text\n    Cryptocurrency symbol to download (ie. BTC, ETH, LTC):\n    Base pair:\n    Interval to download the candlestick data:\n    Date to start downloading the data (ie. YYYY-MM-DD):\n    Date up to the data will be downloaded (ie. YYYY-MM-DD):\n```\n\nOr you can pass the arguments yourself and skip the prompt:\n\n```text\n   crypto-candlesticks [OPTIONS]\n\n   Available options:\n\n   -s \u003csymbol\u003e, --symbol \u003csymbol\u003e\n\n   The ticker you wish to download,\n   currently, only data from the Bitfinex exchange\n   is supported.\n   (e.g. [BTC|ETH|LTC] etc.)\n\n   -b \u003cbase currency\u003e, --base_currency \u003cbase currency\u003e\n\n    The base pair for the ticker.\n    (e.g. [USD|USDT|EUR|CNHT|GBP|JPY|DAI|BTC|EOS|ETH|XCHF|USTF0])\n\n   -i \u003cinterval\u003e, --interval \u003cinterval\u003e\n\n    The interval for each bar.\n    (e.g. [1m|5m|15m|30m|1h|3h|6h|12h|1D|7D|14D|1M])\n\n   -sd \u003cstart date\u003e, --start_date \u003cstart date\u003e\n\n    YYYY, MM, DD from which the candlestick data\n    will start.\n    (e.g. [2018-01-01])\n\n   -ed \u003cend date\u003e, --end date \u003cend date\u003e\n\n    YYYY, MM, DD up to which the candlestick\n    data will be downloaded.\n    (e.g. [2020-01-01])\n\n   --help\n\n   Display a short usage message and exit.\n```\n\n## Example output for CSV\n\n| Open     | Close     | High   | Low       | Volume    | Ticker  | Date       | Time     |\n| -------- | --------- | ------ | --------- | --------- | ------- | ---------- | -------- |\n| 7203     | 7201      | 7203.7 | 7200.1    | 9.404174  | BTC/USD | 12/31/2019 | 16:00:00 |\n| 7201     | 7223.6    | 7223.6 | 7201      | 7.9037398 | BTC/USD | 12/31/2019 | 16:01:00 |\n| 7224.4   | 7225      | 7225.5 | 7224.4    | 0.4799298 | BTC/USD | 12/31/2019 | 16:02:00 |\n| 7224.981 | 7225.9    | 7225.9 | 7224.981  | 0.9294573 | BTC/USD | 12/31/2019 | 16:03:00 |\n| 7225.862 | 7225.7295 | 7225.9 | 7225.7295 | 0.2913202 | BTC/USD | 12/31/2019 | 16:04:00 |\n| 7225.7   | 7225.8673 | 7225.9 | 7225.2973 | 1.0319704 | BTC/USD | 12/31/2019 | 16:05:00 |\n\n## Example output for SQL (the timestamp is shown in milliseconds)\n\n| ID  | Timestamp       | Open          | Close         | High          | Low           | Volume     | Ticker | Interval |\n| --- | --------------- | ------------- | ------------- | ------------- | ------------- | ---------- | ------ | -------- |\n| 1   | 1577868000000.0 | 7205.7        | 7205.8        | 7205.8        | 7205.7        | 0.07137942 | BTCUSD | 1m       |\n| 2   | 1577867940000.0 | 7205.70155305 | 7205.8        | 7205.8        | 7205.70155305 | 0.035      | BTCUSD | 1m       |\n| 3   | 1577867880000.0 | 7205.7        | 7205.70155305 | 7205.70155305 | 7205.7        | 0.025      | BTCUSD | 1m       |\n| 4   | 1577867820000.0 | 7205.75299748 | 7205.75299748 | 7205.75299748 | 7205.7        | 0.075      | BTCUSD | 1m       |\n| 5   | 1577867760000.0 | 7205.75299748 | 7205.2        | 7206.3        | 7205.2        | 0.005      | BTCUSD | 1m       |\n| 6   | 1577867700000.0 | 7205.2        | 7205.2        | 7205.2        | 7205.2        | 4.5802     | BTCUSD | 1m       |\n\n## Contributing\n\nFeel free to open an [issue](https://github.com/Corfucinas/crypto-candlesticks/issues/new, \"new-issue\") or [pull request](https://github.com/Corfucinas/crypto-candlesticks/pulls, \"new-pull-request\") on Github.\n\n## License\n\n[GPL-3.0-or-later](https://www.gnu.org/licenses/gpl-3.0.txt, \"license\")\n\n## Buy me a coffee\n\nETH: 0x06Acb31587a96808158BdEd07e53668d8ce94cFE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCorfucinas%2Fcrypto-candlesticks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCorfucinas%2Fcrypto-candlesticks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCorfucinas%2Fcrypto-candlesticks/lists"}