Skip to main content

WebExtrator CLI

A command-line tool for web rendering and extraction via AceDataCloud.

Get your Ace Data Cloud API key

  1. Open Ace Data Cloud → Applications. Sign in, or register an account first.
  2. Find General application. If it has not been created, choose Initialize General Application. A general key can use the services available to your account; a dedicated application's key is limited to its service. Check the required service/model access and current pricing.
  3. Copy the API Key from the application card, or open Keys / Manage Keys → Create to create a separate key for this integration. Give it a recognizable name so you can revoke or rotate it independently.
  4. When creating a key, review Expiration Time, Set Usage Limitation, and Allowed APIs. Enable only the restrictions you need, allow the operations you will call, then click Create and copy the token from the key list. Task lookup does not grant permission to submit a generation. Confirm the application's balance can cover your first request; any trial allowance is whatever your account currently displays.
  5. Copy only the token value, without quotation marks, spaces, or Bearer . An API Key / API Token field expects this raw value; only a manually configured HTTP Authorization header needs the Bearer prefix. A platform-... account-management token cannot replace a generation API key.

Copy an application API key or open Manage Keys

Create a separately named key with optional restrictions

Save the key in the client's credential store or the environment variable shown below. Never put it in a prompt, shared workflow, screenshot, or Git commit. If authentication fails, check the full copied value, application/service access, expiration, usage limit, and balance before creating another key.

Installation

pip install webextrator-cli

Quick Start

export ACEDATACLOUD_API_TOKEN=your_token

webextrator extract https://www.amazon.com/dp/B0C1234567
webextrator render https://example.com
webextrator tasks retrieve --id <task-id>

Commands

Command Description
webextrator extract <url> Extract structured content from a web page
webextrator render <url> Render a web page and return the HTML
webextrator tasks retrieve Retrieve a single task by ID or trace ID
webextrator tasks batch Retrieve multiple tasks at once
webextrator config Show current configuration

Browser and cache options

Both extract and render default to the server's load wait condition. Use --wait-until networkidle only when needed. --timeout is a positive integer navigation timeout in seconds (server default: 30); --delay is a nonnegative integer number of extra seconds.

--cookies accepts a JSON array; every cookie needs string name, value and domain fields. Optional fields include path, expires, httpOnly, secure and sameSite (Strict, Lax, None). Use only cookies you are authorized to send, and avoid putting sensitive values in shared shell history.

--bypass-cache skips cache reads but still allows writes. The default cache lifetime is 3600 seconds; --cache-ttl-seconds 0 disables writes for that result.

webextrator render https://example.com --timeout 30 --delay 0 \
  --bypass-cache --cache-ttl-seconds 0 --json
webextrator extract https://example.com \
  --cookies '[{"name":"locale","value":"en","domain":"example.com"}]' --json

Global Options

--token TEXT    API token (or set ACEDATACLOUD_API_TOKEN env var)
--version       Show version
--help          Show help message

Configuration

Set environment variables or use a .env file:

ACEDATACLOUD_API_TOKEN=your_token
ACEDATACLOUD_API_BASE_URL=https://api.acedata.cloud
WEBEXTRATOR_REQUEST_TIMEOUT=60

License

MIT

Metadata

Release files for webextrator-cli 2026.11.1.0

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

Source distribution (sdist)

Source distribution for webextrator-cli 2026.11.1.0
File Size Uploaded Provenance Actions
webextrator_cli-2026.11.1.0.tar.gz 12.1 kB Without provenance Details for webextrator_cli-2026.11.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for webextrator-cli 2026.11.1.0
File Interpreter ABI Platform Actions
webextrator_cli-2026.11.1.0-py3-none-any.whl Python 3 none any Details for webextrator_cli-2026.11.1.0-py3-none-any.whl

Total release size: 26.3 kB

Release files / webextrator_cli-2026.11.1.0.tar.gz

Download URL webextrator_cli-2026.11.1.0.tar.gz
Size 12.1 kB
Tags Source
SHA-256 checksum
How to use checksums
264a4dfefe1aab9a4bed128eda8dd333664b1ac1b00948a51be56212bb528fd9
BLAKE2b-256 checksum
How to use checksums
5b4214dffb5f34726467c2f753295f72f8a155123475d2c00ac65d51cb99be9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release files / webextrator_cli-2026.11.1.0-py3-none-any.whl

Download URL webextrator_cli-2026.11.1.0-py3-none-any.whl
Size 14.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
33c9061bb937a7501498d80e35e4a038b394dccf651c6d94d44cb06b603507e2
BLAKE2b-256 checksum
How to use checksums
b02ff5eedcbc60110cb9af61b770831f8435e72744541402fadef4d4ea62fdd0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Security for webextrator-cli 2026.11.1.0

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