{ "openapi": "3.0.1", "info": { "title": "Upwork Scraper", "description": "Scrape Upwork job listings at scale. Extract titles, descriptions, budgets, skills, client info, and more from search results or individual job pages. Supports multiple modes: fast search scraping, detailed modal extraction, and authenticated scraping for enhanced data.", "version": "0.0", "x-build-id": "FMd0ELGkwZA44NMIf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/the-empire-strikes-back~upwork-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-the-empire-strikes-back-upwork-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/the-empire-strikes-back~upwork-scraper/runs": { "post": { "operationId": "runs-sync-the-empire-strikes-back-upwork-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/the-empire-strikes-back~upwork-scraper/run-sync": { "post": { "operationId": "run-sync-the-empire-strikes-back-upwork-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", "required": [ "mode" ], "properties": { "mode": { "title": "Scraping Mode", "enum": [ "lite", "deep", "lite-login", "deep-login", "post", "agency" ], "type": "string", "description": "Choose the scraping mode. 'lite' = comprehensive search data (fast); 'deep' = search + modal details (slow); 'lite-login'/'deep-login' = authenticated scraping; 'post' = individual job pages; 'agency' = agency profiles.", "default": "lite" }, "searchQuery": { "title": "Search Query", "type": "string", "description": "Keywords to search for (e.g., 'Docker', 'React developer'). Used in Lite, Deep, and Login modes. Leave empty for default Upwork search results." }, "experienceLevel": { "title": "Experience Level", "type": "array", "description": "Filter by required experience level. Select one or more.", "items": { "type": "string", "enum": [ "1", "2", "3" ], "enumTitles": [ "Entry Level", "Intermediate", "Expert" ] } }, "hourlyRateMin": { "title": "Hourly Rate Min ($)", "minimum": 3, "type": "integer", "description": "Minimum hourly rate filter. Min supported value: 3. Only applies to hourly jobs." }, "hourlyRateMax": { "title": "Hourly Rate Max ($)", "minimum": 3, "type": "integer", "description": "Maximum hourly rate filter. Only applies to hourly jobs." }, "fixedPriceMin": { "title": "Fixed Price Min ($)", "minimum": 5, "type": "integer", "description": "Minimum fixed-price budget filter. Min supported value: 5." }, "fixedPriceMax": { "title": "Fixed Price Max ($)", "minimum": 5, "type": "integer", "description": "Maximum fixed-price budget filter." }, "clientHires": { "title": "Client Hires (min)", "minimum": 1, "type": "integer", "description": "Minimum number of past hires by the client." }, "projectDuration": { "title": "Project Duration", "type": "array", "description": "Filter by expected project duration. Select one or more.", "items": { "type": "string", "enum": [ "week", "month", "semester", "ongoing" ], "enumTitles": [ "Less than a week", "Less than a month", "1 to 6 months", "Ongoing" ] } }, "hoursPerWeek": { "title": "Hours per Week", "type": "array", "description": "Filter by weekly commitment (for hourly projects). Select one or more.", "items": { "type": "string", "enum": [ "as_needed", "full_time" ], "enumTitles": [ "As needed (less than 30 hrs/week)", "Full time (30+ hrs/week)" ] } }, "contractToHire": { "title": "Contract to Hire", "type": "boolean", "description": "Only show jobs that may convert to full-time employment.", "default": false }, "targetUrl": { "title": "Target URL(s) (Post mode only)", "type": "string", "description": "Only used in Post mode. Enter one or more Upwork job URLs (one per line). Ignored in all other modes." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy configuration. Residential proxies are required — datacenter IPs are blocked by Cloudflare.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "username": { "title": "Upwork Email", "type": "string", "description": "Only used in Login modes (Lite Login, Deep Login). Ignored in all other modes." }, "password": { "title": "Upwork Password", "type": "string", "description": "Only used in Login modes (Lite Login, Deep Login). Ignored in all other modes." }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of search result pages to scrape. Each page contains up to 50 jobs.", "default": 1 }, "outputLimit": { "title": "Output Limit", "minimum": 0, "type": "integer", "description": "Limit the number of jobs in output. Capped at Max Pages × 50 (e.g., 1 page = max 50 jobs). Set to 0 to suppress stdout output entirely (data still goes to Dataset)." } } }, "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 } } } } } } } } } }