{ "openapi": "3.0.1", "info": { "title": "Upwork Jobs & Freelancer Scraper - API & Data Export", "description": "Scrape Upwork jobs and freelancers into structured datasets. Pull job listings, full job detail with client spend and hire-rate intelligence, freelancer profiles, JSS and badges. Bulk export to JSON, CSV and Excel for lead generation, recruiting, bid research and market analysis.", "version": "1.0", "x-build-id": "e9BYtjQrembRtUrDU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~upwork-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-upwork-jobs-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/sian.agency~upwork-jobs-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-upwork-jobs-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/sian.agency~upwork-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-upwork-jobs-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": [ "operation" ], "properties": { "operation": { "title": "šŸŽÆ Operation ā€” what do you want to do?", "enum": [ "searchJobs", "jobDetail", "searchFreelancers", "freelancerProfile" ], "type": "string", "description": "šŸŽÆ **PICK ONE OPERATION PER RUN.** Each run produces one clean dataset matching the chosen mode.\n\n- **šŸ”Ž Search Jobs** ā€” find open jobs by keyword; title, budget, type, skills, posted date & link (paginated)\n- **šŸ“‘ Job Detail** ā€” full record for a job URL, including **client intelligence**: total spend, hire rate, payment-verified status, applicant & invite counts\n- **šŸ‘„ Search Freelancers** ā€” find freelancers by keyword; title, location, hourly rate, JSS, badge & skills (paginated)\n- **šŸ‘¤ Freelancer Profile** ā€” full profile for a freelancer URL, including stats, portfolios & skills\n\nšŸ’” **TIP:** Run **Search Jobs** to discover URLs, then feed those URLs into **Job Detail** for the client-intelligence enrichment.", "default": "searchJobs" }, "queries": { "title": "šŸ”¢ Search terms (Search operations)", "type": "array", "description": "šŸ”¢ **Keywords to search.** Used by **Search Jobs** and **Search Freelancers** ā€” each term is searched and its results are saved to the dataset.\n\nExamples: `python developer`, `shopify expert`, `react native`, `seo specialist`.\n\nAdd as many terms as you like.\n\nāš ļø **Ignored** for the **Job Detail** and **Freelancer Profile** operations (which use the URLs field below).", "default": [ "python developer" ], "items": { "type": "string" } }, "urls": { "title": "šŸ”— Job or freelancer URLs (Detail operations)", "type": "array", "description": "šŸ”— **Upwork URLs to enrich.** Used by **Job Detail** (job URLs) and **Freelancer Profile** (freelancer URLs).\n\n- Job URL example: `https://www.upwork.com/jobs/~021234567890123456789`\n- Freelancer URL example: `https://upwork.com/freelancers/~01abcdef0123456789`\n\nThe job & freelancer URLs returned by the Search operations are ready to paste here.\n\nāš ļø **Ignored** for the Search operations (which use the search terms above).", "default": [], "items": { "type": "string" } }, "maxPages": { "title": "šŸ“„ Max pages to fetch (Search operations)", "minimum": 1, "maximum": 50, "type": "integer", "description": "šŸ“„ **Applies to Search Jobs and Search Freelancers** ā€” ~10 results per page, per term. Detail operations ignore this.\n\nšŸ’” Start small (1ā€“3 pages) to preview, then scale up. āš ļø Hard cap: 50 pages.", "default": 3 } } }, "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 } } } } } } } } } }