Skip to main content
New to Corsair? See API access, authentication, and error handling.

Projects

get

projects.get Get one project with its last run, last ready run and the 20 most recent runs. Risk: read
Input Output

getLastReadyData

projects.getLastReadyData Get the extracted data of the most recent run of a project that has data ready. Risk: read
Input Output: Record<string, any> \| any[] \| string

list

projects.list List the scraping projects on the ParseHub account, 20 at a time. Risk: read
Input Omit offset, limit or include_options to take the service default. include_options is sent as 1 or 0. Output

run

projects.run Start a run of a project on the ParseHub cloud. Returns the new run; poll runs.get until data_ready. Risk: destructive
Input start_value_override is sent as a JSON string. send_email: true emails the account owner when the run ends. The operation is destructive because it starts a cloud run against the plan’s quota and can send that email. Output

Runs

cancel

runs.cancel Cancel a running run. Data extracted so far stays available. Risk: destructive
Input Output

delete

runs.delete Delete a run and its data, cancelling it first if it is running. Risk: destructive
Input Output

get

runs.get Get one run: status, data_ready, page count and timing. Risk: read
Input Output

getData

runs.getData Get the data a run extracted, as JSON or CSV. Risk: read
Input Output: Record<string, any> \| any[] \| string