API REFERENCE

Scraper Results

On this page

GET/api/apify/runs/{runId}

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. Use the runId returned from endpoints like Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape to poll for results.

Authentication

See the authentication guide for API key and account access requirements.

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/apify/runs/YOUR_RUN_ID' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Path parameters

runIdstringrequired

The ID of the Apify run to check status for. This is returned when starting a scrape via Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape endpoints.

Responses

200Scraper run status retrieved successfully. Returns status info for in-progress runs, or status info plus data for completed runs.

application/json

oneOf · ApifyScraperInProgressResponse 1

Response when the Apify run is still in progress

statusstringrequired

Current status of the Apify run (e.g., 'RUNNING', 'READY')

dataset_idstringrequirednullable

ID of the dataset that will contain the results when the run completes

oneOf · ApifyScraperCompletedResponse 2

Response when the Apify run has completed successfully

statusstringrequired

Final status of the Apify run (typically 'SUCCEEDED')

dataset_idstringrequired

ID of the dataset containing the results

dataarray<object>required

Array of dataset items returned by the scraper. The structure of each item varies depending on the scraper type.

Item properties

object

Additional properties

Additional keys are allowed.

400Bad request - missing required runId parameter

application/json

statusstring · enumrequired

Status indicating an error occurred

Values: "error"

messagestringrequired

Error message describing what went wrong

500Server error - failed to fetch run status from Apify

application/json

statusstring · enumrequired

Status indicating an error occurred

Values: "error"

messagestringrequired

Error message describing what went wrong

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download social.json

View operation source

json

{
  "description": "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. Use the runId returned from endpoints like Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape to poll for results.",
  "parameters": [
    {
      "name": "runId",
      "in": "path",
      "description": "The ID of the Apify run to check status for. This is returned when starting a scrape via Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape endpoints.",
      "required": true,
      "schema": {
        "type": "string"
      },
      "example": "abc123xyz"
    }
  ],
  "responses": {
    "200": {
      "description": "Scraper run status retrieved successfully. Returns status info for in-progress runs, or status info plus data for completed runs.",
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/ApifyScraperInProgressResponse"
              },
              {
                "$ref": "#/components/schemas/ApifyScraperCompletedResponse"
              }
            ]
          }
        }
      }
    },
    "400": {
      "description": "Bad request - missing required runId parameter",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApifyScraperErrorResponse"
          }
        }
      }
    },
    "500": {
      "description": "Server error - failed to fetch run status from Apify",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApifyScraperErrorResponse"
          }
        }
      }
    }
  }
}