Poll async lookup job status

get/v1/lookup/status/{jobId}

Request

  • Base URL: https://api.opensosdata.com
  • URL: https://api.opensosdata.com/v1/lookup/status/{jobId}
  • Auth: API key in header x-api-key

Path parameters

jobIdstring required

Job ID returned in the 202 response

Response

Job status (pending, processing, or complete)

successboolean
status'pending' | 'processing' | 'complete' | 'failed'
messagestring
pollIntervalinteger
costnumber
errorstring

Present when status is failed

Example response

{
  "result": {
    "success": true,
    "cost": 0.0314,
    "state_scraper_version": "3.0"
  },
  "pollInterval": 3000,
  "cost": 0.0314
}

Changes

No recorded changes to this operation across all 1 revision of this API.