scrape-do-python
A Python SDK for the Scrape.do web-scraping proxy API, built on httpx and pydantic v2
Quickstart
Install
pip install scrape-do-python
Make a Request
from scrape_do import ScrapeDoClient
# API token is pulled from `SCRAPE_DO_API_KEY`
# (override with `api_token=...`)
with ScrapeDoClient() as client:
response = client.get(
"https://example.com",
super=True,
render=True,
return_json=True,
screenshot=True,
)
response.raise_for_status()
print(response.target_status_code) # 200
print(response.remaining_credits) # 300000.0
response.screenshots[0].to_file("page.png")
Features
| Sync & Async | Sync and Async clients for both API Gateway and Proxy Mode |
| Async API Support | Submit, poll, and fetch jobs against q.scrape.do with the Async API Client |
| Parameter Validation | Every request parameter is validated locally by the RequestParameters pydantic model |
| Typed Responses | ScrapeDoResponse exposes response fields as pydantic models for easy access |
| Browser Automation | Build playWithBrowser sequences from typed Browser Action Models |
| Session Management | Use a custom session_validator function to track proxy rotations when using the session_id parameter
|
| Native Event Hooks | Provide custom request / response / retry / poll hooks that fire at the logical execution boundary |
| Automatic Retries | All clients implement automatic retries on transient gateway/network errors with a customisable Backoff Strategy |
Help
| Documentation | Full API Reference |
| Examples | Curated Usage Examples |
| Roadmap | What's Planned |
| Changelog | What's Already Shipped |
Contributing
Pull Requests, bug reports, and feature requests are all welcome
See
CONTRIBUTINGfor local setup, test commands, and PR conventions
1 maintainer
Release files for scrape-do-python 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| scrape_do_python-0.3.1.tar.gz | 123.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scrape_do_python-0.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 268.7 kB
Release files / scrape_do_python-0.3.1.tar.gz
| Download URL | scrape_do_python-0.3.1.tar.gz |
|---|---|
| Size | 123.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fbeb2a6b109815f803b4188846caedeea3ba1f286bd016f48a7eb5a041e67770
|
|
BLAKE2b-256 checksum How to use checksums |
f3800f54271d34029cdc7dadcc485ec177f03e595d3f0ca41a7cd8ce82ddbf86
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 26, 2026.
Transparency logRelease files / scrape_do_python-0.3.1-py3-none-any.whl
| Download URL | scrape_do_python-0.3.1-py3-none-any.whl |
|---|---|
| Size | 145.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f252564baa011a9bbdbd353edb57c0bee248e0ef23bbc35ac81e25f582c30220
|
|
BLAKE2b-256 checksum How to use checksums |
3881313e9fa814df2c6845e71edc34b8b951fa2e205ed80f01d5ad4052f13afa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 26, 2026.
Transparency log
