{"id":37070068,"url":"https://github.com/gitcoinco/python-api-client","last_synced_at":"2026-01-14T08:04:13.077Z","repository":{"id":50204526,"uuid":"134011654","full_name":"gitcoinco/python-api-client","owner":"gitcoinco","description":"Python API Client","archived":true,"fork":false,"pushed_at":"2022-12-08T02:21:22.000Z","size":54,"stargazers_count":21,"open_issues_count":6,"forks_count":11,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-12-08T02:48:56.160Z","etag":null,"topics":["api","api-client","bounties","bounty","gitcoin","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gitcoinco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-18T23:03:24.000Z","updated_at":"2025-09-21T02:18:13.000Z","dependencies_parsed_at":"2023-01-24T09:31:03.882Z","dependency_job_id":null,"html_url":"https://github.com/gitcoinco/python-api-client","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/gitcoinco/python-api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fpython-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fpython-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fpython-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fpython-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gitcoinco","download_url":"https://codeload.github.com/gitcoinco/python-api-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gitcoinco%2Fpython-api-client/sbom","scorecard":{"id":428006,"data":{"date":"2025-08-11","repo":{"name":"github.com/gitcoinco/python-api-client","commit":"462c3e4ac8a18dffd333fb1a9297bab4fe04a026"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 1/11 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 0.1.0 not signed: https://api.github.com/repos/gitcoinco/python-api-client/releases/12434803","Warn: release artifact 0.0.1 not signed: https://api.github.com/repos/gitcoinco/python-api-client/releases/12433952","Warn: release artifact 0.1.0 does not have provenance: https://api.github.com/repos/gitcoinco/python-api-client/releases/12434803","Warn: release artifact 0.0.1 does not have provenance: https://api.github.com/repos/gitcoinco/python-api-client/releases/12433952"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":0,"reason":"17 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2022-42986 / GHSA-43fp-rhv2-5gv8","Warn: Project is vulnerable to: PYSEC-2023-135 / GHSA-xqr8-7jwr-rhp7","Warn: Project is vulnerable to: PYSEC-2024-60 / GHSA-jjg7-2v4v-x38h","Warn: Project is vulnerable to: PYSEC-2020-92 / GHSA-hj5v-574p-mj7c","Warn: Project is vulnerable to: PYSEC-2022-42969","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: PYSEC-2023-212 / GHSA-g4mx-q9vg-27p4","Warn: Project is vulnerable to: PYSEC-2023-207 / GHSA-gwvm-45gx-3cf8","Warn: Project is vulnerable to: PYSEC-2019-133 / GHSA-mh33-7rrq-662w","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v","Warn: Project is vulnerable to: PYSEC-2019-132 / GHSA-r64q-w8jr-g9qp","Warn: Project is vulnerable to: PYSEC-2023-192 / GHSA-v845-jxx5-vc9f","Warn: Project is vulnerable to: PYSEC-2020-148 / GHSA-wqvq-5m8c-6g24","Warn: Project is vulnerable to: PYSEC-2021-108"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 21 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T02:40:28.284Z","repository_id":50204526,"created_at":"2025-08-19T02:40:28.285Z","updated_at":"2025-08-19T02:40:28.285Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28413527,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T05:26:33.345Z","status":"ssl_error","status_checked_at":"2026-01-14T05:21:57.251Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["api","api-client","bounties","bounty","gitcoin","python"],"created_at":"2026-01-14T08:04:12.292Z","updated_at":"2026-01-14T08:04:13.064Z","avatar_url":"https://github.com/gitcoinco.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gitcoin Python API Client\n\n[![Build Status](https://travis-ci.com/gitcoinco/python-api-client.svg?branch=master)](https://travis-ci.com/gitcoinco/python-api-client)\n\nThis Python package provides the `bounties` endpoint of the Gitcoin API, which allows you to:\n\n- list all bounties\n- list all bounties which meet certain conditions (i.e. filter them)\n- retrieve a single bounty by it's primary key\n\n## Install via pypi\n\n```bash\npip install gitcoin\n```\n\n## Usage Examples\n\n### List all bounties\n\n```python\nfrom gitcoin import Gitcoin\napi = Gitcoin()\nall_bounties = api.bounties.all()\n```\n\n### List all open bounties\n\n```python\nfrom gitcoin import Gitcoin\napi = Gitcoin()\nopen_bounties = api.bounties.filter(is_open=True).all()\n```\n\n### List all open \"Beginner\" bounties\n\n```python\nfrom gitcoin import Gitcoin\napi = Gitcoin()\nbounties_api = api.bounties\nbounties_api.filter(is_open=True)\nbounties_api.filter(experience_level='Beginner')\nopen_beginner_bounties = bounties_api.all()\n```\n\nThe example above has been reformatted for easier reading. A [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface#Python) is also available. Please scroll the following code block all the way to the end to see the whole line:\n\n```python\nfrom gitcoin import Gitcoin\napi = Gitcoin()\nopen_beginner_bounties = api.bounties.filter(is_open=True, experience_level='Beginner').all()\n```\n\n### List all open bounties marked for either \"Beginner\" OR \"Intermediate\" experience level\n\nFor some filter conditions, multiple different values can be given, which results in a logical `OR` for that condition:\n\n```python\nfrom gitcoin import Gitcoin\napi = Gitcoin()\nbounties_api = api.bounties\nbounties_api.filter(is_open=True)\nbounties_api.filter(experience_level='Beginner')\nbounties_api.filter(experience_level='Intermediate')\nopen_beginner_and_intermediate_bounties = bounties_api.all()\n```\n\nThe example above has been reformatted for easier reading. A [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface#Python) is also available. Please scroll the following code block all the way to the end to see the whole line:\n\n```python\nfrom gitcoin import Gitcoin\napi = Gitcoin()\nopen_beginner_and_intermediate_bounties = api.bounties.filter(is_open=True).filter(experience_level='Beginner').filter(experience_level='Intermediate').all()\n```\n\n## API\n\n### Instantiation\n\n1. Create a `Gitcoin()` API root object:\n```python\nfrom gitcoin import Gitcoin\napi = Gitcoin()\n```\n2. The `bounties` API endpoint is accessible as a property of the API root object:\n```python\nbounties_endpoint = api.bounties\n```\nEach access to the `bounties` property results in a new `Endpoint` object with no filter conditions or any other parameters (like sorting) set. If you want to keep a specific set of filter conditions, simply store the `Endpoint` object in a variable instead of referring to the `bounties` property of the root object.\n\n### `bounties.filter(**kwargs)`\n\nLimit the list of bounties returned by either `get_page()` or `all()` to those bounties meeting the filter condition(s). For some filter conditions, multiple different values can be given, which results in a logical `OR` for that condition.\n\nThe condition name is the name of the keyword argument, and the condition value is the value of the keyword argument:\n\n```python\nopen_bounties = api.bounties.filter(is_open=True).all()\n```\n\nConditions with different names can be given in one `filter()` call:\n\n```python\nopen_beginner bounties = api.bounties.filter(is_open=True, experience_level='Beginner').all()\n```\n\nOr if preferred, they can also be given in separate `filter()` calls:\n\n```python\nopen_beginner bounties = api.bounties.filter(is_open=True).filter(experience_level='Beginner').all()\n```\n\nGiving multiple values for the same filter condition has to be done in separate calls to `filter()`:\n\n```python\nbeginner_and_intermediate_bounties = api.bounties.filter(experience_level='Beginner').filter(experience_level='Intermediate').all()\n```\n\nFor the following filter conditions, multiple values can be given to achieve a logical `OR`:\n\n- `experience_level (str)`\n- `project_length (str)`\n- `bounty_type (str)`\n- `bounty_owner_address (str)`\n- `bounty_owner_github_username (str)`\n- `idx_status (str)`\n- `network (str)`\n- `standard_bounties_id (int)`\n- `github_url (str)`\n- `raw_data (str)`\n\nThe following filter conditions are **single value**, in other words, multiple values result in the last value overwriting all earlier values:\n\n- `pk__gt (int)`\n- `started (str)`\n- `is_open (bool)`\n- `fulfiller_github_username (str)`\n- `interested_github_username (str)`\n\n`filter()` returns the `Endpoint` object itself to enable a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface#Python).\n\n### `bounties.order_by(sort)`\n\nDetermine the order of the bounties returned by either `get_page()` or `all()`. The `sort` argument is a `string` containing a DB field name to sort by. It can also have an optional \"-\" prefix for reversing the direction. Choose from these field names:\n\n- `accepted`\n- `balance`\n- `bounty_owner_address`\n- `bounty_owner_email`\n- `bounty_owner_github_username`\n- `bounty_owner_name`\n- `bounty_type`\n- `canceled_on`\n- `contract_address`\n- `current_bounty`\n- `experience_level`\n- `expires_date`\n- `fulfillment_accepted_on`\n- `fulfillment_started_on`\n- `fulfillment_submitted_on`\n- `github_comments`\n- `github_url`\n- `idx_experience_level`\n- `idx_project_length`\n- `idx_status`\n- `interested`\n- `interested_comment`\n- `is_open`\n- `issue_description`\n- `last_comment_date`\n- `metadata`\n- `network`\n- `num_fulfillments`\n- `override_status`\n- `privacy_preferences`\n- `project_length`\n- `raw_data`\n- `snooze_warnings_for_days`\n- `standard_bounties_id`\n- `submissions_comment`\n- `title`\n- `token_address`\n- `token_name`\n- `token_value_in_usdt`\n- `token_value_time_peg`\n- `_val_usd_db`\n- `value_in_eth`\n- `value_in_token`\n- `value_in_usdt`\n- `value_in_usdt_now`\n- `value_true`\n- `web3_created`\n- `web3_type`\n\n`order_by()` returns the `Endpoint` object itself to enable a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface#Python).\n\n### `bounties.get_page(number=1, per_page=25)`\n\nReturns one page of the (potentially `filter()`ed) `list` of bounties with the given 1-based index `number (int)`. The page size can be set with `per_page (int)`. Each bounty is a `dict`, basically the direct output of [`requests`' `.json()`](http://docs.python-requests.org/en/master/user/quickstart/#json-response-content) call.\n\n### `bounties.all()`\n\nReturns the complete (potentially `filter()`ed) `list` of bounties. Each bounty is a `dict`, basically the direct output of [`requests`' `.json()`](http://docs.python-requests.org/en/master/user/quickstart/#json-response-content) call.\n\n### `bounties.get(primary_key)`\n\nReturns one (1) bounty as specified by `primary_key (int)`. It is returned as a `dict`, basically the direct output of [`requests`' `.json()`](http://docs.python-requests.org/en/master/user/quickstart/#json-response-content) call.\n\n-------------------------\n\n## Todo\n\n- [x] Add base gitcoin.Gitcoin client\n- [x] Add `bounties` api filter\n  - [x] Implement all filter fields present in `gitcoinco/web/app/dashboard/router.py`\n- [ ] Add `universe` api filter\n  - [ ] Implement all filter fields present in `gitcoinco/web/app/external_bounties/router.py`\n- [x] Add sorting/order_by\n- [x] Add pagination (page/limit)\n- [ ] Add travis-ci.com project and twine/pypi credentials.\n- [ ] Add codecov.io project.\n- [ ] Cut first release (Tag github release, push changes, and let CI deploy to pypi)\n- [ ] Maintain +90% coverage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitcoinco%2Fpython-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitcoinco%2Fpython-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitcoinco%2Fpython-api-client/lists"}