SimpleCrawl
A typed client for the firecrawl-simple self-hosted API.
Installation
pip install firecrawl-simple-client
Quick Start
Synchronous Usage
export FIRECRAWL_URL_BASE="url"
from simplecrawl import Client
# Initialize client
client = Client(base_url="some-url", ) # defaults to https://api.firecrawl.dev/v1 as base URL if not found in environment
# Scrape a single page
result = client.scrape("https://example.com")
print(result.markdown)
print(result.metadata.title)
# Crawl multiple pages
job = client.crawl(
"https://example.com",
include_paths=["/blog/*"],
max_depth=2,
limit=10
)
Async Usage
import asyncio
from simplecrawl import AsyncClient
async def main():
async with AsyncClient(token="your-api-token") as client:
result = await client.scrape("https://example.com")
print(result.markdown)
asyncio.run(main())
Features
- Synchronous and asynchronous clients
- Single page scraping
- Multi-page crawling
- URL discovery/mapping
- Content format options (Markdown, HTML, Links, etc.)
- Customizable scraping options
Documentation
For detailed examples, check out the examples folder.
License
This project is licensed under the MIT License - see the LICENSE file for details.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file firecrawl_simple_client-0.1.3.tar.gz.
File metadata
- Download URL: firecrawl_simple_client-0.1.3.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e4252b0f641b4cdc1aed66fca766dba96743252e2b35abad2e7bae4080ea23d7
|
|
| MD5 |
8c5c20e7e56bbe55d9b2d49e1f557216
|
|
| BLAKE2b-256 |
36ca11fcbe6aa2a6a7eedcc730a635a6c097524d4b9e063edf8ab95e9a415305
|
Provenance
The following attestation bundles were made for firecrawl_simple_client-0.1.3.tar.gz:
Publisher:
release.yml on darinkishore/simplecrawl
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
firecrawl_simple_client-0.1.3.tar.gz -
Subject digest:
e4252b0f641b4cdc1aed66fca766dba96743252e2b35abad2e7bae4080ea23d7 - Sigstore transparency entry: 149003298
- Sigstore integration time:
-
Permalink:
darinkishore/simplecrawl@f611018de2497edfc5fb759534609b439257bad9 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/darinkishore
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@f611018de2497edfc5fb759534609b439257bad9 -
Trigger Event:
push
-
Statement type:
File details
Details for the file firecrawl_simple_client-0.1.3-py3-none-any.whl.
File metadata
- Download URL: firecrawl_simple_client-0.1.3-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8f52f2ad3982e456f5391e4e9445f06bdbdf189bcda915636a5c46f8a4962e69
|
|
| MD5 |
0baeb8664d2fab68c5683bcd00ab5436
|
|
| BLAKE2b-256 |
86ff04ea4d7e9ba9396a58239656da2b780867d74a42943e100e621a4ecebb02
|
Provenance
The following attestation bundles were made for firecrawl_simple_client-0.1.3-py3-none-any.whl:
Publisher:
release.yml on darinkishore/simplecrawl
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
firecrawl_simple_client-0.1.3-py3-none-any.whl -
Subject digest:
8f52f2ad3982e456f5391e4e9445f06bdbdf189bcda915636a5c46f8a4962e69 - Sigstore transparency entry: 149003299
- Sigstore integration time:
-
Permalink:
darinkishore/simplecrawl@f611018de2497edfc5fb759534609b439257bad9 -
Branch / Tag:
refs/tags/v0.1.3 - Owner: https://github.com/darinkishore
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@f611018de2497edfc5fb759534609b439257bad9 -
Trigger Event:
push
-
Statement type:
