Collection Status V4

GET www.hashscraper.com/v4/api/schedule_results/{id}

Returns the progress and metadata of a single data set.

Look up a data set's progress by schedule_result_id. Poll the same ID during collection to monitor progress.

schedule.latest_schedule_result_id is the most recent data set ID for the same scraper. If it differs from the requested ID, a newer collection has been triggered.

Request Parameters

  • Authorization: Header
    HashScraper API key. Send it in the form Bearer <api_key>.
    Example Bearer YOUR_API_KEY
  • id: Integer (path)
    Data set ID to look up. Pass the schedule_result_id from a collection response.
    Example 239758028

Response Fields

  • result: String
    Result of the request.
    Allowed success, error
  • version: String
    API version.
    Example v4
  • request_id: String
    Request trace ID.
    Example req_5a8c1f1c-...
  • elapsed_sec: Float
    Time the server took to produce the response, in seconds (Float).
    Example 0.0089
  • data: Object
    Collection status.
    • schedule_result_id: Integer
      Echo of the data set ID.
    • sr_status: String
      Collection status. Typically one of ready, running, retry, finish/complete, canceling (cancel in progress), canceled (cancel finished). Some legacy data sets may return locale-translated labels (e.g. Korean '완료'/'처리중'/'취소'/'중지' or English Complete/Processing/Cancel/Stop). Clients should match the seven English codes first and fall back to the raw string.
    • data_count: Integer
      Number of results collected so far. Real-time at the time of the call; may increase between polls during collection.
    • created_at: String (ISO 8601)
      Data set creation time (ISO 8601, Asia/Seoul).
    • updated_at: String (ISO 8601)
      Data set last update time (ISO 8601, Asia/Seoul). Updated frequently by the worker during collection, and typically stays constant after completion.
    • param_info: Object
      Snapshot of the parameters used for this collection. Keys are stable (param1~paramN) and each entry contains name (label) and value.
    • union: Boolean | null
      Whether this collection ran in union mode. Union mode appends new results to the scraper's last data set instead of creating a new one, and is controlled by the scraper configuration. Reflects the union value recorded at the time this collection ran.
    • schedule: Object
      Context of the scraper this data set belongs to.
      • id: String
        Scraper ID.
      • name: String
        Scraper name.
      • latest_schedule_result_id: Integer | null
        Most recent data set ID for the same scraper. If different from the requested ID, a newer collection exists.

Error Responses

  • MISSING_API_KEY
    Missing or malformed Authorization header. Send as Authorization: Bearer <api_key>. (HTTP 401)
    {
      "result": "error",
      "version": "v4",
      "request_id": "req_5a8c1f1c-...",
      "code": "MISSING_API_KEY",
      "message": "API key is missing.",
      "elapsed_sec": 0.0008,
      "details": { "hint": "Send `Authorization: Bearer <api_key>` header." }
    }
  • INVALID_API_KEY
    No user matches the provided API key. (HTTP 401)
    {
      "result": "error",
      "version": "v4",
      "request_id": "req_5a8c1f1c-...",
      "code": "INVALID_API_KEY",
      "message": "API key is invalid.",
      "elapsed_sec": 0.0011
    }
  • SCHEDULE_RESULT_NOT_FOUND
    No data set matches the ID, or the caller does not have access. (HTTP 404)
    {
      "result": "error",
      "version": "v4",
      "request_id": "req_5a8c1f1c-...",
      "code": "SCHEDULE_RESULT_NOT_FOUND",
      "message": "ScheduleResult not found.",
      "elapsed_sec": 0.0021,
      "details": { "resource": "schedule_result", "id": "999999" }
    }

Related Guides

Example Request
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
Example Response 200
{
  "result": "success",
  "version": "v4",
  "request_id": "req_5a8c1f1c-9b2d-4e7c-9abf-3f7e0a4d1b21",
  "elapsed_sec": 0.0089,
  "data": {
    "schedule_result_id": 239758028,
    "sr_status": "running",
    "data_count": 42,
    "created_at": "2026-05-06T10:00:00+09:00",
    "updated_at": "2026-05-06T10:01:23+09:00",
    "param_info": {
      "param1": { "name": "키워드", "alias": "keyword", "value": "키성장" },
      "param2": { "name": "정렬",   "alias": "sorting", "value": "추천순" }
    },
    "union": false,
    "schedule": {
      "id": "8f3a7c1e9b5d24f6",
      "name": "네이버 뉴스 검색",
      "latest_schedule_result_id": 239758028
    }
  }
}