{"id":13815196,"url":"https://github.com/pcko1/bscscan-python","last_synced_at":"2025-12-14T13:53:58.168Z","repository":{"id":48198634,"uuid":"340319392","full_name":"pcko1/bscscan-python","owner":"pcko1","description":"The most popular asynchronous Python API for BscScan (Binance Smart Chain Explorer), available via PyPI.","archived":false,"fork":false,"pushed_at":"2024-06-23T10:52:14.000Z","size":18079,"stargazers_count":298,"open_issues_count":0,"forks_count":104,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-19T10:18:07.502Z","etag":null,"topics":["asyncio","binance","binance-smart-chain","blockchain","blockchain-explorer","bsc","python"],"latest_commit_sha":null,"homepage":"https://bscscan-python.pankotsias.com/","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/pcko1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"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},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["0xD9D6E8C16686536E3C81124639e975AdF2468197"]}},"created_at":"2021-02-19T09:26:31.000Z","updated_at":"2025-04-18T21:35:26.000Z","dependencies_parsed_at":"2022-09-26T20:11:53.505Z","dependency_job_id":"08a453c4-34a4-4d4a-8ad4-803f7bda21de","html_url":"https://github.com/pcko1/bscscan-python","commit_stats":{"total_commits":166,"total_committers":8,"mean_commits":20.75,"dds":0.0662650602409639,"last_synced_commit":"fcfc30cb7d1a4ff2a4f2de30606f35698675cbc7"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcko1%2Fbscscan-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcko1%2Fbscscan-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcko1%2Fbscscan-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcko1%2Fbscscan-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pcko1","download_url":"https://codeload.github.com/pcko1/bscscan-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254295998,"owners_count":22047184,"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":["asyncio","binance","binance-smart-chain","blockchain","blockchain-explorer","bsc","python"],"created_at":"2024-08-04T04:03:07.234Z","updated_at":"2025-12-14T13:53:53.101Z","avatar_url":"https://github.com/pcko1.png","language":"Python","funding_links":["0xD9D6E8C16686536E3C81124639e975AdF2468197"],"categories":["Python"],"sub_categories":[],"readme":"# bscscan-python\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/pcko1/bscscan-python\" alt=\"build\"\u003e\n        \u003cimg src=\"https://github.com/pcko1/bscscan-python/workflows/build/badge.svg\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"https://codecov.io/gh/pcko1/bscscan-python\" alt=\"codecov\"\u003e\n        \u003cimg src=\"https://codecov.io/gh/pcko1/bscscan-python/branch/master/graph/badge.svg\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"https://app.codacy.com/gh/pcko1/bscscan-python?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=pcko1/bscscan-python\u0026utm_campaign=Badge_Grade\" alt=\"code-quality\"\u003e\n        \u003cimg src=\"https://api.codacy.com/project/badge/Grade/a39faec4c53e45cda03c92d216278c65\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"https://codeclimate.com/github/pcko1/bscscan-python\" alt=\"tech-debt\"\u003e\n        \u003cimg src=\"https://img.shields.io/codeclimate/tech-debt/pcko1/bscscan-python\" /\u003e\u003c/a\u003e\n\n  \u003ca href=\"https://codeclimate.com/github/pcko1/bscscan-python/maintainability\" alt=\"maintainability\"\u003e\n        \u003cimg src=\"https://api.codeclimate.com/v1/badges/b9fefb77fed228a664d2/maintainability\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"https://www.codefactor.io/repository/github/pcko1/bscscan-python\" alt=\"code-factor\"\u003e\n        \u003cimg src=\"https://www.codefactor.io/repository/github/pcko1/bscscan-python/badge\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://badge.fury.io/py/bscscan-python\" alt=\"pypi\"\u003e\n        \u003cimg src=\"https://badge.fury.io/py/bscscan-python.svg\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"\" alt=\"pypi-downloads\"\u003e\n        \u003cimg src=\"https://img.shields.io/pypi/dm/bscscan-python\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"\" alt=\"license\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/pcko1/bscscan-python\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"https://www.python.org/downloads/release/python-385/\" alt=\"python-version\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/python-3.8-blue.svg\" /\u003e\u003c/a\u003e\n  \n  \u003ca href=\"https://zenodo.org/badge/latestdoi/340319392\" alt=\"DOI\"\u003e\n        \u003cimg src=\"https://zenodo.org/badge/340319392.svg\" /\u003e\u003c/a\u003e  \n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  A complete Python API for \u003ca href=\"https://bscscan.com/\"\u003eBscScan.com\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Powered by \u003ca href=\"https://bscscan.com/apis\"\u003eBscScan.com APIs\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Available on \u003ca href=\"https://pypi.org/project/bscscan-python/\"\u003ePyPI\u003c/a\u003e \n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  :book: Read the official documentation here :book:\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  👇\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://bscscan-python.pankotsias.com/\" alt=\"docs\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/docs-passing-brightgreen\" /\u003e\u003c/a\u003e \n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003eA fork of the \u003ca href=\"https://github.com/pcko1/etherscan-python\"\u003eetherscan-python\u003c/a\u003e package.\u003c/i\u003e\n\u003c/p\u003e\n\n\n\n## Endpoints\n\nThe following endpoints are provided:\n\n\u003cdetails\u003e\u003csummary\u003eAccounts \u003ca href=\"https://bscscan.com/apis#accounts\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n\n* `get_bnb_balance`\n* `get_bnb_balance_multiple`\n* `get_normal_txs_by_address`\n* `get_normal_txs_by_address_paginated`\n* `get_internal_txs_by_address`\n* `get_internal_txs_by_address_paginated`\n* `get_internal_txs_by_txhash`\n* `get_internal_txs_by_block_range_paginated`\n* `get_bep20_token_transfer_events_by_address`\n* `get_bep20_token_transfer_events_by_contract_address_paginated`\n* `get_bep20_token_transfer_events_by_address_and_contract_paginated`\n* `get_bep721_token_transfer_events_by_address`\n* `get_bep721_token_transfer_events_by_contract_address_paginated`\n* `get_bep721_token_transfer_events_by_address_and_contract_paginated`\n* `get_validated_blocks_by_address`\n* `get_validated_blocks_by_address_paginated`\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eContracts \u003ca href=\"https://bscscan.com/apis#contracts\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n  \n* `get_contract_abi`\n* `get_contract_source_code`\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eTransactions \u003ca href=\"https://bscscan.com/apis#transactions\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n  \n* `get_tx_receipt_status`\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eBlocks \u003ca href=\"https://bscscan.com/apis#blocks\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n  \n* `get_block_reward_by_block_number`\n* `get_est_block_countdown_time_by_block_number`\n* `get_block_number_by_timestamp`\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eGETH/Parity Proxy \u003ca href=\"https://bscscan.com/apis#proxy\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n\n* `get_proxy_block_number`\n* `get_proxy_block_by_number`\n* `get_proxy_block_transaction_count_by_number`\n* `get_proxy_transaction_by_hash`\n* `get_proxy_transaction_by_block_number_and_index`\n* `get_proxy_transaction_count`\n* `get_proxy_transaction_receipt`\n* `get_proxy_call`\n* `get_proxy_code_at`\n* `get_proxy_storage_position_at`\n* `get_proxy_gas_price`\n* `get_proxy_est_gas`\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eTokens \u003ca href=\"https://bscscan.com/apis#tokens\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n  \n* `get_total_supply_by_contract_address`\n* `get_circulating_supply_by_contract_address`\n* `get_acc_balance_by_token_contract_address`\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\u003csummary\u003eStats \u003ca href=\"https://bscscan.com/apis#stats\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n  \n* `get_total_bnb_supply`\n* `get_validators_list`\n\n\u003c/details\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003eLogs \u003ca href=\"https://bscscan.com/apis#logs\"\u003e(source)\u003c/a\u003e\u003c/summary\u003e\n\u003cp\u003e\n  \n* `get_logs`\n\n\u003c/details\u003e\n\n*If you think that a newly-added method is missing, kindly open an [issue](https://github.com/pcko1/bscscan-python/issues) as a feature request and I will do my best to add it.*\n\n## Installation\n\nBefore proceeding, you should register an account on [BscScan.com](https://bscscan.com/) and [generate a personal API key](https://bscscan.com/myapikey) to use. \n\nInstall from source:\n\n``` bash\npip install git+https://github.com/pcko1/bscscan-python.git@stable\n```\n\nAlternatively, install from [PyPI](https://pypi.org/project/bscscan-python/):\n\n```bash\npip install bscscan-python\n```\n\n## Unit tests\n\nIn `bash`, test that everything looks OK on your end using your `YOUR_API_KEY` (without quotation marks):\n\n``` bash\nbash run_tests.sh YOUR_API_KEY\n````\n\nNote: This will install the `coverage` package in your activated `python` environment.\n\n## Usage\nIn `python`, create a client with your personal [BscScan.com](https://bscscan.com/) API key:\n\n``` python\nimport asyncio\nfrom bscscan import BscScan\n\nYOUR_API_KEY = \"...\"\n\nasync def main():\n  async with BscScan(YOUR_API_KEY) as bsc:\n    print(await bsc.get_bnb_balance(address=\"0x0000000000000000000000000000000000001004\"))\n\nif __name__ == \"__main__\":\n  asyncio.run(main())\n\n\u003e '167195709084498025431541166'\n```\n\n## Examples\n\nDetailed examples (arguments and results) for all methods may be found in the [official documentation](https://bscscan-python.pankotsias.com/bscscan.modules.html). [![Documentation Status](https://img.shields.io/badge/docs-passing-brightgreen)](https://bscscan-python.pankotsias.com/)\n\n\n## Issues\n\nFor problems regarding installing or using the package please open an [issue](https://github.com/pcko1/bscscan-python/issues). Kindly avoid disclosing potentially sensitive information such as your API keys or your wallet addresses.\n\n## Cite\n\nKotsias, P. C., pcko1/bscscan-python: v1.0.0. *https://github.com/pcko1/bscscan-python (2021)*. doi:10.5281/zenodo.4781726\n\nor in ```bibtex```:\n\n```bibtex\n@misc{Kotsias2020,\n  author = {Kotsias, P.C.},\n  title = {pcko1/bscscan-python},\n  year = {2021},\n  publisher = {Zenodo},\n  url = {https://github.com/pcko1/bscscan-python},\n  doi = {10.5281/zenodo.4781726}\n}\n```\n\nFeel free to leave a :star: if you found this package useful.\n\n___\n\nPowered by [Bscscan.com APIs](https://bscscan.com/apis).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpcko1%2Fbscscan-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpcko1%2Fbscscan-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpcko1%2Fbscscan-python/lists"}