Tools

Get Project

Get detailed information about a specific ParseHub scraping project. Returns project metadata, configuration, and a list of recent runs with their statuses. Call list_projects to discover authorized project tokens.

Run Project

Start a new scraping run for a ParseHub project on the cloud. You can optionally override the starting URL, template, or pass a custom value for parameterized scraping. The run will begin with status "initialized" and progress to "running", then "complete" or "error".

Delete Run

Delete a scraping run and all its extracted data. If the run is still in progress, it will be cancelled first. This action is irreversible.

Cancel Run

Cancel a running scraping job. The run status will change to "cancelled" and any data extracted so far will remain available for download.

Export Run Data

Prepare a downloadable JSON or CSV file containing the extracted data from a ParseHub run. Discover run tokens with get_project or run_project.

Get Run Data

Retrieve the extracted JSON data and a downloadable JSON file from a ready scraping run. Provide a run token, or set useLastReady with a project token to use the most recent run with available data.

Get Run

Get the current status and details of a specific scraping run. Use this to check whether a run is still in progress, has completed, or encountered an error.

List Projects

List all scraping projects in your ParseHub account. Returns project metadata including titles, default URLs, templates, and recent run information. Supports pagination for accounts with many projects.