Skip to main content

wayparam

wayparam on the Snap Store PyPI BlackArch

wayparam is a modern, cross-platform CLI tool to fetch historical URLs from public web archive indexes, filter out “boring” URLs (static assets), and normalize query parameters so you can focus on endpoints that actually matter. Wayback remains the default source, with Common Crawl available as an opt-in provider.

This project is inspired by ParamSpider (same overall goal, completely rewritten with a more robust architecture, modern async I/O, better filtering, and production-friendly output behavior).

OSINT tool: wayparam does not crawl targets. It queries public archive indexes (Wayback and, optionally, Common Crawl).

Convert this example.com into something like this:

...
http://www.example.com/_next/image?q=FUZZ&url=FUZZ&w=FUZZ
https://www.example.com/_Incapsula_Resource?SWJIYLWA=FUZZ
http://www.example.com/?format=FUZZ&retailerId=FUZZ
...

Key features

  • Multi-source archive collection: Wayback CDX (default), Common Crawl CDXJ, or both
  • Async + concurrency for speed on multiple domains
  • Rate limiting (--rps) to be polite with Wayback/CDX
  • Retry + backoff and clearer error messages
  • Lossless CDX pagination with automatic block-mode fallback
  • Historical intelligence: first/last seen, capture counts, status/MIME distributions, parameter prevalence
  • Filters “boring” URLs by:
    • extension blacklist/whitelist
    • optional path regex exclusion
  • Canonicalization & normalization
    • drop fragments
    • normalize host/ports
    • sort parameters
    • mask parameter values (default placeholder: FUZZ)
    • optional tracking parameter removal (utm_*, gclid, fbclid, …)
  • Output:
    • per-domain files (default)
    • stdout streaming for pipelines (--stdout)
    • txt or jsonl output (--format)

Installation

BlackArch Linux

wayparam is officially available in the BlackArch Linux repository.

sudo pacman -S wayparam

On an existing Arch Linux installation with the BlackArch repository enabled, the same package can be installed directly with pacman.

pipx install wayparam     # isolated, keeps the CLI on your PATH
# or
pip install wayparam

Snap (Linux)

sudo snap install wayparam

The snap is strictly confined: it can write only inside your home directory, so run it from a directory under $HOME (or point -o/--outdir there). To also write to mounted media: sudo snap connect wayparam:removable-media.

apt (Debian/Ubuntu/Kali)

A .deb is attached to each GitHub release and installs the wayparam(1) manpage alongside the CLI:

sudo apt install ./wayparam_<version>_all.deb

An apt repository (Launchpad PPA) is not published yet. The Debian packaging lives in debian/; see Packaging & distribution for how it is built and what it would take to publish one.

Web interface (optional)

The interface is a separate, opt-in component: the CLI never depends on it.

sudo apt install wayparam-gui      # separate package; pulls in wayparam
wayparam-gui                       # or: snap run wayparam.gui

It prints a URL containing a one-time token and opens it in your browser:

wayparam UI: http://127.0.0.1:8765/?t=<token>

It binds to loopback only (127.0.0.1 by default), requires that token on every request, and rejects unexpected Host headers — it performs outbound requests on behalf of whoever can reach it, so it is deliberately not reachable from the network. To use it on a remote box, forward the port instead:

ssh -L 8765:127.0.0.1:8765 user@host   # then run wayparam-gui there

Inside the snap, open the printed URL yourself: a confined snap cannot launch the host browser.

From source

python -m venv .venv
# Windows: .venv\Scripts\activate
# macOS/Linux: source .venv/bin/activate
python -m pip install -U pip
pip install -e .

Development install (tests + lint)

pip install -e ".[dev]"

Quick start

1) Single domain (writes to results/)

wayparam -d example.com

2) List of domains

wayparam -l domains.txt

3) Stream to stdout (for piping), no files

wayparam -d example.com --stdout --no-files

4) JSONL output (great for tooling)

wayparam -d example.com --stdout --no-files --format jsonl

5) Include subdomains + be polite to Wayback

wayparam -d example.com --include-subdomains --rps 1 --concurrency 2

6) Customize filtering (extensions + path regex)

wayparam -d example.com --ext-blacklist ".png,.jpg,.css,.js" --exclude-path-regex "^/static/"

7) Query Common Crawl instead of Wayback

wayparam -d example.com --source commoncrawl

8) Combine Wayback + Common Crawl

wayparam -d example.com --source wayback,commoncrawl

The source order is the priority order. Results are deduplicated across providers; in JSONL, source records the provider that found a normalized URL first.

9) Historical endpoint intelligence

wayparam -d example.com --history --stdout --no-files --format jsonl

10) Parameter history or a domain summary

wayparam -d example.com --params
wayparam -d example.com --summary --format jsonl

Historical modes retrieve capture metadata and automatically disable CDX collapse so that first/last seen and capture counts are meaningful. They can therefore transfer substantially more data than a normal URL run; use --from, --to, filters or --max-results to bound the analysis.


How it works (under the hood)

  1. Input parsing

    • -d/--domain for a single host
    • -l/--list for multiple hosts (one per line, supports comments and basic normalization)
  2. Query configured archive providers

    • Wayback remains the default and keeps its lossless auto pagination behavior
    • Common Crawl resolves latest from collinfo.json or uses explicitly pinned crawl IDs
    • Common Crawl walks CDXJ ZipNum pages and serializes/rate-limits requests by default
    • matchType=host is used by default, or matchType=domain with --include-subdomains
    • When several providers are selected, normalized URLs are deduplicated across them in source order
  3. Filter “boring” URLs

    • Drops URLs that look like static assets (by extension), with optional whitelist mode
    • Optional regex filters can exclude paths (e.g., /static/, /assets/, …)
  4. Canonicalize + normalize

    • Removes fragments (#...)

    • Normalizes default ports (:80, :443)

    • Parses query string and:

      • replaces values with a placeholder (default FUZZ)
      • optionally drops tracking parameters
      • sorts parameters for stable output
    • Deduplicates results

  5. Output

    • By default writes per-domain results into results/
    • --stdout streams machine-readable output
    • Diagnostics (hints, logs, stats) go to stderr (safe for pipelines)

Output behavior (important for pipelines)

  • stdout: only results (URLs or JSONL) when --stdout is enabled
  • stderr: logs, errors, hints (VPN/proxy), optional stats, and a live progress line — the progress line is drawn only when stderr is a terminal, so redirecting or piping stderr stays clean

This means you can safely do:

wayparam -d example.com --stdout --no-files | sort -u > urls.txt

Common options

Archive sources

  • --source wayback (default)
  • --source commoncrawl
  • --source wayback,commoncrawl (ordered priority)
  • --cc-index latest or a crawl such as CC-MAIN-2026-39 (repeatable)
  • --cc-page-size 5 (compressed Common Crawl index blocks per page)
  • --cc-rps 1 (Common Crawl request rate; default intentionally conservative)
  • --cc-filter status:200 (repeatable Common Crawl-native CDXJ filter)

See Archive sources for provider behavior and caveats.

Wayback/CDX

  • --include-subdomains
  • --from 2019 / --to 2021 (or full timestamps like 20190101000000)
  • --filter statuscode:200 (repeatable)
  • --no-collapse (more duplicates, more data)
  • --pagination auto|blocks|resume — how to walk a multi-page result. The default auto is lossless: the CDX resumeKey walk drops one URL at each page boundary while collapse is on, so wayparam probes with one request and switches to the block API only when the result actually spans pages.
  • --block-size 100 (CDX index blocks per request in block mode)

Historical analysis

  • --history — aggregate first/last seen, capture counts, status codes and MIME types per normalized URL
  • --params — aggregate endpoint/capture prevalence per query-parameter name
  • --summary — one historical summary record per domain

These views are mutually exclusive. In historical modes, --max-results caps accepted capture rows before aggregation.

Normalization

  • --placeholder X
  • --keep-values (not recommended if you share logs)
  • --drop-tracking / --no-drop-tracking
  • --all-urls (include URLs without query parameters)

Filtering

  • --ext-blacklist ".png,.jpg,.css,.js"
  • --ext-whitelist ".php,.asp,.aspx"
  • --exclude-path-regex "regex" (repeatable)

Performance / network

  • --max-results 500 (global cap on emitted URLs; --limit / --page-size only control the CDX page size)
  • --concurrency 8
  • --rps 1 (recommended when using VPNs / noisy networks)
  • --timeout 30
  • --retries 4
  • --proxy http://127.0.0.1:8080

Troubleshooting: VPN / Proxy issues (Wayback CDX)

If you see errors like “failed after retries” against the CDX endpoint, it often means:

  • the VPN/proxy exit node is blocked or rate-limited by Wayback
  • your VPN does TLS filtering or networking policies that break automated requests

Try:

  • disconnecting VPN/proxy and rerunning
  • switching to a different VPN server
  • lowering --concurrency and setting --rps 1

wayparam will print a human-readable hint in English to stderr when it detects this pattern.


Man page

A manual page is included:

man ./man/wayparam.1

Testing

Install dev dependencies and run:

pip install -e ".[dev]"
pytest -q

The test suite includes httpx-level integration tests using httpx.MockTransport (no network).


License

wayparam is free software released under the GNU General Public License v3 (GPLv3). See the LICENSE file for details.


Acknowledgements

  • Inspired by ParamSpider (same objective: fetch Wayback URLs, filter noise, focus on parameterized endpoints).
  • Thanks to the OSINT / security community for patterns and workflows around URL collection and parameter discovery.

Disclaimer

Use responsibly and lawfully. This tool queries public web archive indexes and does not actively scan targets, but your downstream usage of collected URLs may have legal and ethical implications depending on context.

Metadata

Release files for wayparam 0.6.1

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

Source distribution (sdist)

Source distribution for wayparam 0.6.1
File Size Uploaded
wayparam-0.6.1.tar.gz 75.8 kB Details

Built distribution (wheel)

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

Total release size: 135.9 kB

Release files / wayparam-0.6.1.tar.gz

Download URL wayparam-0.6.1.tar.gz
Size 75.8 kB
Tags Source
SHA-256 checksum
How to use checksums
271f6932c3b29729ecdcbee52ce09bb3fbaa336dd20b49a26f89876ff77353fa
BLAKE2b-256 checksum
How to use checksums
868743c4ba2ab1925ccc3aae744b5093aacba679a5b8c51bedc7f9044c37619d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Sep 21, 2026.

Transparency log

Release files / wayparam-0.6.1-py3-none-any.whl

Download URL wayparam-0.6.1-py3-none-any.whl
Size 60.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6d293ceed110ab76ece3109e00e8aa45b6859088a9ea12ff08295ff4e2ff8cd1
BLAKE2b-256 checksum
How to use checksums
4466716713c194a66663e134e702d53c429c8cf5ecc0680936d7471e4ed49526
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Sep 21, 2026.

Transparency log

Release history Release notifications | RSS feed

1.0.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

This release

0.6.1 This release

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

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