Cancel a Collection V2

POST https://www.hashscraper.com/api/cancel_collect Content-Type: application/json; version=2

Send a cancellation signal to an in-progress collection.

The worker does not stop immediately — it picks up the signal on its next polling cycle and winds the current job down.

Right after the response, the dataset's sr_status becomes canceling, and once all jobs have wound down it becomes canceled (since 2026-09-27; previously it stayed at canceling). Use collect_status to monitor the cancellation.

Calling this on a dataset that has already ended (finish, canceled, etc.) returns success and changes nothing — the collected results and the status stay as they are (since 2026-09-27; previously the status was overwritten to canceling).

Request Parameters

api_key: String

HashScraper API key

Example YOUR_API_KEY
schedule_result_id: Integer

ID of the dataset to cancel. Pass the value returned by collect as-is.

Example YOUR_SCHEDULE_RESULT_ID

Response Fields

result: String

Request outcome.

Allowed success, error
version: String

API version.

Example v2
cancel_info: Object
Details about the cancellation request.
- schedule_result_id: Integer
  
  Dataset ID echoed from the request.
- schedule_id: String
  
  Identifier of the scraper that owns this dataset. The value is read from the server.
- param_info: Object
  
  Snapshot of the parameters from the original collection. Only param1~param5 that were enabled are included, and keys carry the scraper's parameter labels (e.g. param1(keyword)). When the scraper has no label configured, the label slot may be empty (param1()) or a placeholder (param1(param1)).
elapsed_time: Float

Server-side processing time (seconds, as a numeric value).

Example 0.0234

Error Responses

schedule_result_id missing

Required parameter schedule_result_id was not provided.

{
  "result": "error",
  "version": "v2",
  "message": "`schedule_result_id` parameter is required"
}

Schedule result not found

No dataset matches the provided schedule_result_id, or it is not accessible.

{
  "result": "error",
  "version": "v2",
  "message": "schedule_result(id: YOUR_SCHEDULE_RESULT_ID) not found"
}

Related Guides

{
  "result": "success",
  "version": "v2",
  "cancel_info": {
    "schedule_result_id": 13229289,
    "schedule_id": "사람인_채용공고_수집_1697441449957",
    "param_info": {
      "param1(검색할 키워드)": "개발자",
      "param2(최대 수집 개수)": "10"
    }
  },
  "elapsed_time": 0.0234
}