Skip to main content

WebCrawler API Python SDK

A Python SDK for interacting with the WebCrawlerAPI.

Get your API key at dash.webcrawlerapi.com/access.

Installation

pip install webcrawlerapi

Crawling

from webcrawlerapi import WebCrawlerAPI

client = WebCrawlerAPI(api_key="your_api_key")

job = client.crawl(
    url="https://example.com",
    output_formats=["markdown"],
    items_limit=10,
)

for item in job.job_items:
    if item.status == "done":
        print(item.original_url)
        print(item.content)

Scraping

from webcrawlerapi import WebCrawlerAPI

client = WebCrawlerAPI(api_key="your_api_key")

result = client.scrape(
    url="https://example.com",
    output_formats=["markdown"],
)

if result.success:
    print(result.markdown)
else:
    print(f"Error: {result.error_code} — {result.error_message}")

Documentation

Requirements

  • Python 3.6+
  • requests >= 2.25.0

License

MIT License

Metadata

Release files for webcrawlerapi 2.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for webcrawlerapi 2.1.7
File Size Uploaded Provenance Actions
webcrawlerapi-2.1.7.tar.gz 15.5 kB Without provenance Details for webcrawlerapi-2.1.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for webcrawlerapi 2.1.7
File Interpreter ABI Platform Actions
webcrawlerapi-2.1.7-py3-none-any.whl Python 3 none any Details for webcrawlerapi-2.1.7-py3-none-any.whl

Total release size: 31.7 kB

Release files / webcrawlerapi-2.1.7.tar.gz

Download URL webcrawlerapi-2.1.7.tar.gz
Size 15.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a92fc40d3f065d69a69a6c2ea6543200b93fffa6c0843e7511054b28deae632c
BLAKE2b-256 checksum
How to use checksums
afd3ed8b51a112295dff38c18667348cb8b2ca1dbf41e4a577201fa447f9f78d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / webcrawlerapi-2.1.7-py3-none-any.whl

Download URL webcrawlerapi-2.1.7-py3-none-any.whl
Size 16.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8ce05587d767e0029ae7e94f3c9de21fe2a72f89aba5d1e2a74cf1311decd4a2
BLAKE2b-256 checksum
How to use checksums
884bb58c7705064debc0522918b8adf343ec167d8187cb5a72cfb991c6800536
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for webcrawlerapi 2.1.7

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page