Get Collection Status V2

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

Retrieve the progress and metadata of a specific dataset.

Pass the schedule_result_id returned by collect to check that dataset's progress. While a job is running you can poll this endpoint with the same ID to track its progress.

data_count and sr_status reflect the state at the time of the call. While a job is in progress these values change between calls.

latest_schedule_result_id is the most recent dataset ID for the same scraper. If it differs from the requested schedule_result_id, a newer collection was triggered — call again with that ID to see the latest data.

Request Parameters

  • api_key: String
    HashScraper API key
    Example YOUR_API_KEY
  • schedule_result_id: Integer
    ID of the dataset to inspect. Pass the schedule_result_id from the collect response as-is.
    Example YOUR_SCHEDULE_RESULT_ID

Response Fields

  • result: String
    Request outcome.
    Allowed success, error
  • version: String
    API version.
    Example v2
  • collection_status: Object
    Collection status payload.
    • id: Integer
      Dataset ID echoed from the request.
    • sr_status: String
      Current collection state. The values you typically receive are ready (queued), running, retry, finish, canceling (cancel in progress), and canceled (cancel finished). Some legacy datasets may return a Korean label instead.
    • data_count: Integer
      Number of records collected so far. This is a live count at call time and may increase between polls.
    • created_at: String (ISO 8601)
      Dataset creation timestamp (ISO 8601, Asia/Seoul).
    • updated_at: String (ISO 8601)
      Last update timestamp of the dataset (ISO 8601, Asia/Seoul).
    • param_info: Object
      Snapshot of the parameters used for this 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)).
    • no_result: Boolean | null
      Snapshot of the scraper's "no result" handling setting. May be null if the snapshot is missing or unparseable.
    • union: Boolean | null
      Snapshot of the scraper's union-result setting. May likewise be null.
    • latest_schedule_result_id: Integer
      Most recent dataset ID for this scraper. Compare with the requested schedule_result_id to detect whether a newer run exists.
  • elapsed_time: Float
    Server-side processing time (seconds, as a numeric value).
    Example 0.0153

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

Example Request
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
Example Response 200 
{
  "result": "success",
  "version": "v2",
  "collection_status": {
    "id": 13229289,
    "sr_status": "running",
    "data_count": 5,
    "created_at": "2026-04-28T10:32:19.000+09:00",
    "updated_at": "2026-04-28T10:32:52.000+09:00",
    "param_info": {
      "param1(검색할 키워드)": "개발자",
      "param2(최대 수집 개수)": "10"
    },
    "no_result": false,
    "union": false,
    "latest_schedule_result_id": 13229289
  },
  "elapsed_time": 0.0153
}