{ "openapi": "3.0.1", "info": { "title": "Indeed Scraper", "description": "Scrapes Indeed job listings by search query, location, and filters, with optional full job details.", "version": "1.0", "x-build-id": "D5BcfeshTFgoiHfxF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/anyxsolutions~indeed-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-anyxsolutions-indeed-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/anyxsolutions~indeed-scraper/runs": { "post": { "operationId": "runs-sync-anyxsolutions-indeed-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/anyxsolutions~indeed-scraper/run-sync": { "post": { "operationId": "run-sync-anyxsolutions-indeed-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "startUrls": { "title": "Search URLs", "type": "array", "description": "One or more Indeed job search URLs to scrape, for example https://www.indeed.com/jobs?q=software+engineer&l=New+York. Leave empty to search using the query and location fields instead.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "query": { "title": "Query", "type": "string", "description": "Job title or keywords to search for, for example \"software engineer\". Used when no search URL is provided, or as a fallback for URLs that omit a query." }, "location": { "title": "Location", "type": "string", "description": "Geographic location to search jobs in, for example \"New York\" or \"Remote\". Used when no search URL is provided, or as a fallback for URLs that omit a location." }, "datePosted": { "title": "Date posted", "enum": [ "any", "past-24h", "past-3-days", "past-week", "past-2-weeks" ], "type": "string", "description": "Filter results by how recently the job was posted.", "default": "any" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "recent" ], "type": "string", "description": "Order in which matching jobs are returned.", "default": "relevance" }, "radius": { "title": "Search radius (miles)", "minimum": 0, "type": "integer", "description": "Distance from the location to include jobs from, in miles." }, "scrapeJobDetails": { "title": "Scrape job details", "type": "boolean", "description": "When enabled, each job is opened on Indeed to collect the full job description. Indeed protects individual job pages far more aggressively than search pages, so detail requests are slower and a share of them will be blocked; jobs whose detail page cannot be fetched are still returned with the search-card fields. Leave this off for fast, complete listings and turn it on only when you need full descriptions.", "default": false }, "maxItems": { "title": "Maximum jobs per search", "minimum": 1, "type": "integer", "description": "Maximum number of jobs to collect for each search URL or query/location search. The scraper paginates through Indeed's result pages until this limit is reached or there are no more results.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings used for requests. Indeed uses aggressive anti-bot protection, so running with Apify residential proxies is strongly recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }