Skip to content
Last updated
GEThttps://api.aitronos.com/v1/scrape/jobs/{job_id}/progress

Get detailed progress information for a scraping job, including completion status and reason.

NameTypeRequiredDescription
AuthorizationstringYesBearer token authentication

Path Parameters

ParameterTypeRequiredDescription
job_idstringYesJob identifier

Response

Status: 200 OK

FieldTypeDescription
job_idstringUnique job identifier
statusstring"pending", "processing", "completed", "failed", "cancelled"
urlstringThe scraped URL
current_pageintegerCurrent page being processed
total_pages_scrapedintegerTotal pages scraped so far
total_properties_foundintegerTotal items extracted
progress_percentagenumberCompletion percentage (0-100)
pagination_completebooleanWhether pagination finished
completion_reasonstring|nullWhy the job completed (see below)
created_atstringJob creation timestamp
completed_atstring|nullJob completion timestamp
processing_timenumber|nullTotal processing time in seconds
running_timenumber|nullCurrent running time (while processing)
error_messagestring|nullError details if failed

Completion Reason Values

ValueDescription
doneJob completed successfully - all requested pages/items were scraped
timeoutJob stopped due to reaching the configured timeout limit. Partial results may be available
errorJob failed due to an error (check error_message for details)
nullJob is still processing (status is "pending" or "processing")

Usage Notes

  • When completion_reason is "timeout", check total_properties_found to see how many items were scraped before timeout
  • Timeout is configurable via options.timeout when creating a job (default: 300s, max: 1800s)
  • For depth scraping jobs, a timeout means some detail pages may not have been scraped
Bash
curl -X GET https://api.aitronos.com/v1/scrape/jobs/job_abc123/progress \
  -H "X-API-Key: $FREDDY_API_KEY"

Response 200 OK

{
  "success": true,
  "data": {
    "job_id": "job_abc123",
    "status": "completed",
    "url": "https://example.com/listings",
    "current_page": 1,
    "total_pages_scraped": 1,
    "total_properties_found": 13,
    "progress_percentage": 100.0,
    "pagination_complete": true,
    "completion_reason": "timeout",
    "created_at": "2026-01-12T07:19:20.123456+00:00",
    "completed_at": "2026-01-12T07:20:26.789012+00:00",
    "processing_time": 60.03,
    "running_time": null,
    "error_message": null
  }
}