TheDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/Amaculus/screaming-frog-api/llms.txt
Use this file to discover all available pages before exploring further.
Crawl.load() method detects your crawl source automatically from the path or ID you provide. You can also call the specific from_* constructors directly when you need explicit control.
Supported sources
| Source | Example path | Loader | Backend options |
|---|---|---|---|
| CSV export folder | ./exports/ | Crawl.from_exports() | CSV only |
| DB-mode archive | ./crawl.dbseospider | Crawl.from_derby() | DuckDB (default), Derby |
| Screaming Frog project | ./crawl.seospider | Crawl.from_seospider() | DuckDB (default), Derby, CSV |
| DuckDB analytics cache | ./crawl.duckdb | Crawl.from_duckdb() | DuckDB only |
| SQLite database | ./crawl.db | Crawl.from_database() | SQLite only |
| Live DB crawl ID | UUID string | Crawl.from_db_id() | DuckDB (default), Derby, CSV |
Which format should you use?
CSV exports
You have already exported tabs from the Screaming Frog UI. Simplest setup, no Java required, no raw SQL.
.dbseospider
You have a packaged DB-mode crawl archive. Full tab coverage, raw SQL, DuckDB analytics. Requires Java.
.seospider
You have a Screaming Frog project file. Auto-converts to DB mode via the CLI. Requires Screaming Frog CLI.
DB crawl ID
You want to query a crawl that is stored locally in Screaming Frog’s
ProjectInstanceData directory.Quick examples
Common options
These options apply across Derby-backed loaders (.dbseospider, .seospider, DB crawl IDs).
materialize_dbseospider
When True (default for .seospider loads), the loader packs a .dbseospider archive next to your crawl file so subsequent loads can skip the CLI conversion step.
dbseospider_overwrite
Controls whether an existing .dbseospider cache is replaced. Defaults to True for .seospider loads.
csv_fallback and csv_fallback_profile
Derby loads automatically fall back to CLI CSV exports for tabs or columns that are not yet mapped in Derby. Set csv_fallback=False to disable this, or set csv_fallback_profile="kitchen_sink" (the default) to use the bundled full-export list.
duckdb_if_exists
Controls whether the DuckDB cache is rebuilt. Defaults to "auto", which rebuilds only when the Derby source has changed.
Derby loads require a Java runtime. If
java is not on your PATH, set JAVA_HOME to your JRE/JDK directory. Screaming Frog’s bundled JRE is detected automatically on Windows.