Quickstart

Install

cargo install --locked tovuk

Other package channels use the same native Rust binary:

npm install -g tovuk
pipx install tovuk
brew tap tovuk/tovuk https://github.com/tovuk/tovuk
brew install tovuk

Run a Request

export TOVUK_OUTPUT=json
tovuk login
tovuk account show
tovuk api-key list
tovuk api-key create "Production scraper"
tovuk api-key revoke api_key_0123456789abcdef01234567
tovuk pricing
tovuk usage
tovuk scraper list
tovuk scraper health
tovuk scraper show tiktok
tovuk request create tiktok '{"operation":"search","query":"rust programming","limit":100}'
tovuk request create google-maps '{"searchTerms":["coffee shops"],"locationQuery":"Seattle, WA","limit":25}'
tovuk request create amazon '{"operation":"search","query":"mechanical keyboard","limit":25}'

Copy the returned request.id, then poll and fetch records:

tovuk request show request_123
tovuk request results request_123 --limit 1000

Use --cursor <nextCursor> with tovuk request list and tovuk request results to continue request and stored-result pagination. Cancel queued or running work when needed:

tovuk request cancel request_123

Public Input Only

Scraper requests are public data only. Use public URLs, public search terms, public profile handles, public place ids, or public identifiers only. Do not send cookies, passwords, account tokens, private session data, private account content, private repository credentials, or proxy URLs.

Billing

Requests require paid billing. If creation returns payment_required, create a hosted checkout session:

tovuk billing checkout plus --json

For invoices, payment methods, or subscription changes:

tovuk billing portal --json

Scraper API

Account and Operations

Install

Run a Request

Public Input Only

Billing

​Install

​Run a Request

​Public Input Only

​Billing

Install

Run a Request

Public Input Only

Billing