{"id":13829111,"url":"https://github.com/BoTreeConsultingTeam/crypto_compare","last_synced_at":"2025-07-09T09:32:48.757Z","repository":{"id":52695559,"uuid":"101787975","full_name":"BoTreeConsultingTeam/crypto_compare","owner":"BoTreeConsultingTeam","description":"CryptoCompare.com API client for Python","archived":false,"fork":false,"pushed_at":"2021-04-20T20:03:02.000Z","size":173,"stargazers_count":27,"open_issues_count":3,"forks_count":7,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-09-30T09:08:29.559Z","etag":null,"topics":["crypto","cryptocompare","cryptocurrency","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BoTreeConsultingTeam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-29T17:26:17.000Z","updated_at":"2024-09-05T11:36:49.000Z","dependencies_parsed_at":"2022-08-22T06:40:38.073Z","dependency_job_id":null,"html_url":"https://github.com/BoTreeConsultingTeam/crypto_compare","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoTreeConsultingTeam%2Fcrypto_compare","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoTreeConsultingTeam%2Fcrypto_compare/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoTreeConsultingTeam%2Fcrypto_compare/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BoTreeConsultingTeam%2Fcrypto_compare/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BoTreeConsultingTeam","download_url":"https://codeload.github.com/BoTreeConsultingTeam/crypto_compare/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225533010,"owners_count":17484179,"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":["crypto","cryptocompare","cryptocurrency","python"],"created_at":"2024-08-04T10:00:19.756Z","updated_at":"2024-11-20T10:30:30.857Z","avatar_url":"https://github.com/BoTreeConsultingTeam.png","language":"Python","funding_links":[],"categories":["Awesome CryptoCompare [![Awesome](https://github.com/CryptoCompareLTD/awesome-cryptocompare/blob/master/awesomecc.svg)](https://github.com/sindresorhus/awesome)"],"sub_categories":["Python"],"readme":"# crypto_compare\n\nCryptoCompare.com API client for Python\n\n[![Maintainability](https://api.codeclimate.com/v1/badges/09a6441289ca3d983dfe/maintainability)](https://codeclimate.com/github/BoTreeConsultingTeam/crypto_compare/maintainability)\n\n## Folder/code structure\n\nThe code is written such that all the methods are available as instance methods in `Client` class, but grouped them in diff. modules under `apis` module to keep the code readable. All these module methods are imported inside the class `Client`.\n\n```\n|_ crypto_compare\n|__ client.py -- This is the main client class which has all the public methods\n|__ apis\n|___ average.py - methods for average APIs\n|___ coin.py - methods for coin APIs\n|___ helper.py - helper methods\n|___ histo.py - methods for histo APIs\n|___ mining.py - methods for mining APIs\n|___ price.py - methods for pricing APIs\n|___ subs.py - methods for subs APIs\n|___ top.py - methods for top data APIs\n|___ uncategorized.py - other API methods\n\n\n```\n\n## Usage\n\n1. Install it using pip\n\n``` shell\npip install crypto_compare\n\n```\n2. Use it as following\n``` python\n\nimport crypto_compare\n\ncrypto_compare_client = crypto_compare.Client() #Create an instance and call any public API method!\ncrypto_compare_client.coin_list()\ncrypto_compare_client.coin_snapshot('BTC', 'USD')\n\n```\n\n## API docs\n\n### Coin methods\n1. `coin_list()`\n2. `coin_snapshot_full_by_id(coin_id)`\n3. `coin_snapshot(fsym, tsym)`\n\n### Price methods\n4. `price(**kwargs) - fsym and tsyms are mandatory as named arguments`\n5. `price_multi(**kwargs) - fsyms and tsyms are mandatory as named arguments`\n6. `price_multifull(**kwargs) - fsyms and tsyms are mandatory as named arguments`\n7. `price_historical(**kwargs) - fsym and tsyms are mandatory as named arguments`\n\n### Average methods\n8. `generate_avg(**kwargs) - fsym, tsym and markets are mandatory as named arguments`\n9. `day_avg(**kwargs) - fsym and tsym are mandatory as named arguments`\n\n### Subs methods\n10. `subs_watchlist(**kwargs) - fsyms and tsym are mandatory as named arguments`\n11. `subs(**kwargs) - fsym is mandatory as named argument`\n\n### Top Data methods\n12. `top_exchanges(**kwargs) - fsym and tsym are mandatory as named arguments`\n13. `top_volumes(**kwargs) - tsym is mandatory as named argument`\n14. `top_pairs(**kwargs) - fsym and tsym are mandatory as named arguments`\n\n### Histo methods\n15. `histo_day(**kwargs) - fsym and tsym are mandatory as named arguments`\n16. `histo_hour(**kwargs) - tsym is mandatory as named argument`\n17. `histo_minute(**kwargs) - fsym and tsym are mandatory as named arguments`\n\n### Mining methods\n18. `mining_contracts()`\n19. `mining_equipment()`\n\n### Other methods\n20. `all_exchanges(**kwargs)`\n21. `social_stats(coin_id)`\n\n## ToDo\n\n1. Add tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBoTreeConsultingTeam%2Fcrypto_compare","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBoTreeConsultingTeam%2Fcrypto_compare","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBoTreeConsultingTeam%2Fcrypto_compare/lists"}