Requests

Request Results

Allows you to fetch responses from requests created with async API endpoints. You can fetch responses before the expiration time by request ID, or use webhooks to get the data once it's ready.

Request status can be Pending, Success, or Failure. Each response is available for 4 hours after a request has been completed. Once the response is expired the status will be Pending again.

get/requests/{requestId}

Request

  • Base URL: https://api.outscraper.cloud
  • URL: https://api.outscraper.cloud/requests/{requestId}
  • Auth: API key in header X-API-KEY

Path parameters

requestIdstring required

Request ID provided by API endpoints at ["id"]. Example: 32692d16-725c-4e66-b013-95e80e873b7e

Query parameters

flatboolean

The parameter allows you to return flat results. All the results from queries will be combined in one array.

convertFileResultboolean

The parameter allows you to return only the link to the file result (&convertFileResult=false) without converting it to a JSON array.

Works only for UI tasks where results are stored in files.

Response

The response contains the status of the request and data in case the request is finished.

Changes

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