Wire

Pre-built API actions for popular websites — scrape, browse, and extract structured data

Run pre-built automation actions across hundreds of popular websites. Each action handles browser rendering, authentication, and structured data extraction. Jobs are processed asynchronously — submit a task and poll for results.

How It Works

  1. Discover an action — list catalogs or search to find an action_id and its parameter schema
  2. Submit a task — call POST /v1/wire/task with the action_id and your parameters
  3. Poll for results — use the returned job_id to check status and retrieve data

Browse available actions from the Wire dashboard or via the discovery endpoints below.

Endpoints

GET/v1/wire/catalog

List Catalogs — every supported website with its action count

GET/v1/wire/catalog/{slug}

Catalog Details — single catalog plus its full action list & schemas

GET/v1/wire/search

Search Actions — find an action_id by query, catalog, or category

POST/v1/wire/task

Execute Task — run a pre-built action and get a job ID

GET/v1/wire/jobs/{id}

Get Job Status — poll for status and retrieve results

Identities & credentials

An identity is a named account on a website (e.g. "Personal Amazon", "Work Amazon"). Each identity holds one or more credentials (cookies, API keys, etc.) — the encrypted auth data needed to run tasks as that account.

To use multi-auth: list your identities, copy the credential_id you want, pass it as credential_id on POST /v1/wire/task. Identities and credentials are typically created via the Wire dashboard; for credentials-mode catalogs (email/password sign-in), API consumers can also sign in directly with POST /login.

GET/v1/wire/identities

List all your identities (or one by ID) with their credentials inline

POST/v1/wire/login

Single-call credentials-mode sign-in — returns a credential_id ready for /task

Build new actions

Need an action for a site that isn't in the catalog yet? Request a build — Wire generates a scraper from your description, auto-tests it, and publishes it so you can run it with POST /task.

POST/v1/wire/build-request

Request a Build — generate a brand-new action for a site that isn't in the catalog yet

Errors

Common error responses on POST /v1/wire/task:

StatusCodeWhenAction
401AUTH_REQUIREDAction needs auth and you have no credential for this catalogVisit the connect_url in the response to connect your account
401AUTH_EXPIREDThe credential_id exists but its session is no longer valid (cookies expired, token revoked, password changed)Have the user reconnect — GET /identities will show status: "expired" on the credential
403FORBIDDENThe credential_id doesn't belong to you, or belongs to a different catalog than the actionRe-fetch valid credential IDs via GET /v1/wire/identities
402INSUFFICIENT_CREDITSYour account balance can't cover the action's credits_per_callTop up credits or use a smaller-cost action
500EXECUTION_FAILEDTransient submission failure — engine couldn't enqueue the task. Credits are not deductedRetry the request; if it persists, contact support