Apify Scraper Results API
Check the status and retrieve results from Apify scraper runs. This endpoint uses the Apify API Client to fetch the current status of a scraper run and its results if available.
Endpoint
GET https://api.recoupable.com/api/apify/scraperParameters
| Name | Type | Required | Description |
|---|---|---|---|
| runId | string | Yes | The ID of the Apify run to check status for |
Request Examples
cURL
curl -X GET "https://api.recoupable.com/api/apify/scraper?runId=abc123xyz" \
-H "Content-Type: application/json"Example Responses
In Progress Response
{
"status": "RUNNING",
"datasetId": "def456uvw"
}Completed Response
{
"status": "SUCCEEDED",
"datasetId": "def456uvw",
"data": [
{
"id": "123456789",
"username": "example_user",
"fullName": "Example User",
"biography": "This is a sample biography",
"followersCount": 1000,
"followsCount": 500,
"profilePicUrl": "https://example.com/profile.jpg"
}
]
}Response Properties
In Progress Response
| Property | Type | Description |
|---|---|---|
| status | string | Current status of the Apify run (e.g., "RUNNING", "SUCCEEDED", "FAILED") |
| datasetId | string | ID of the dataset that will contain the results |
Completed Response
| Property | Type | Description |
|---|---|---|
| status | string | Final status of the Apify run (typically "SUCCEEDED" when complete) |
| datasetId | string | ID of the dataset containing the results |
| data | array | Array of dataset items returned by the scraper. The structure of each item varies by scraper type. |
When the scraper run completes successfully, the data array contains the dataset items from Apify. Its shape depends on the specific scraper (Instagram Profile, Instagram Comments, etc.).
Notes
- This endpoint uses the Apify API Client to fetch run status and results
- To start a new scraper run, use one of these endpoints:
- Instagram Profiles API - Scrape profile information
- Instagram Comments API - Scrape post comments
- Social Scrape API - Kick off a scrape for a specific social profile
- The response format changes based on the run status:
- For in-progress runs: Returns status information
- For completed runs: Returns the raw dataset items
- Rate limits may apply based on Apify's API restrictions
- Results are not real-time and may be subject to Apify's rate limiting
- The dataset items structure varies depending on the type of scraper that was run