{ "openapi": "3.0.1", "info": { "title": "Upwork Jobs Scraper", "description": "Extract detailed Upwork jobs together with **client history and competition data**. Search by URL or filters, narrow opportunities using budget, applicants, client quality and more, then run searches repeatedly to discover new jobs.", "version": "0.1", "x-build-id": "ehggCMUYhuMhuqfAl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hiddensins~upwork-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hiddensins-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/hiddensins~upwork-jobs-scraper/runs": { "post": { "operationId": "runs-sync-hiddensins-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/hiddensins~upwork-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-hiddensins-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", "properties": { "freelancerProfileUrl": { "title": "Upwork Freelancer Profile URL", "type": "string", "description": "Optional. Paste an Upwork freelancer profile URL. This is the easiest way to get relevant jobs to a profile." }, "searchUrl": { "title": "Upwork Search URL", "type": "string", "description": "Optional. Paste an Upwork search URL. This is the easiest way to reproduce an existing Upwork search." }, "keywords": { "title": "Keywords", "type": "array", "description": "Only return jobs containing at least one of these keywords in the job title or description.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Exclude jobs containing any of these keywords in the title or description.", "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "Only return jobs from the selected Upwork category. You can also enter a custom category." }, "subCategory": { "title": "Subcategory", "type": "string", "description": "Optional. Narrow results to a specific Upwork subcategory." }, "paymentType": { "title": "Payment type", "enum": [ "ANY", "FIXED", "HOURLY" ], "type": "string", "description": "Choose which type of jobs to include.", "default": "ANY" }, "minFixedBudget": { "title": "Minimum fixed budget", "minimum": 0, "type": "integer", "description": "Only return fixed-price jobs with a budget of at least this amount." }, "maxFixedBudget": { "title": "Maximum fixed budget", "minimum": 0, "type": "integer", "description": "Only return fixed-price jobs with a budget up to this amount." }, "minHourlyRate": { "title": "Minimum hourly rate", "minimum": 0, "type": "integer", "description": "Only return hourly jobs where the advertised rate reaches at least this amount." }, "maxHourlyRate": { "title": "Maximum hourly rate", "minimum": 0, "type": "integer", "description": "Only return hourly jobs where the advertised rate does not exceed this amount." }, "engagementDuration": { "title": "Project duration", "type": "array", "description": "Only return jobs matching one or more expected engagement durations.", "items": { "type": "string", "enumSuggestedValues": [ "Less than 1 month", "1 to 3 months", "3 to 6 months", "More than 6 months" ], "enumTitles": [ "Less than 1 month", "1 to 3 months", "3 to 6 months", "More than 6 months" ] } }, "postedWithinHours": { "title": "Posted within", "minimum": 1, "type": "integer", "description": "Only return jobs posted within this many hours." }, "minPositions": { "title": "Minimum positions", "minimum": 1, "type": "integer", "description": "Only return jobs where the client is hiring at least this many people." }, "maxPositions": { "title": "Maximum positions", "minimum": 1, "type": "integer", "description": "Only return jobs where the client is hiring no more than this many people." }, "minApplicants": { "title": "Minimum applicants", "minimum": 0, "type": "integer", "description": "Only return jobs with at least this many applicants." }, "maxApplicants": { "title": "Maximum applicants", "minimum": 0, "type": "integer", "description": "Only return jobs with no more than this many applicants." }, "minInvitationsSent": { "title": "Minimum invitations sent", "minimum": 0, "type": "integer", "description": "Only return jobs where the client has sent at least this many invitations." }, "maxInvitationsSent": { "title": "Maximum invitations sent", "minimum": 0, "type": "integer", "description": "Only return jobs where the client has sent no more than this many invitations." }, "minInvitedToInterview": { "title": "Minimum interviews", "minimum": 0, "type": "integer", "description": "Only return jobs where at least this many applicants have been invited to interview." }, "maxInvitedToInterview": { "title": "Maximum interviews", "minimum": 0, "type": "integer", "description": "Avoid jobs where too many applicants have already been invited to interview." }, "maxUnansweredInvites": { "title": "Maximum unanswered invites", "minimum": 0, "type": "integer", "description": "Only return jobs with no more than this number of unanswered invitations." }, "paymentVerified": { "title": "Payment verified", "type": "boolean", "description": "Only return jobs from clients with a verified payment method.", "default": false }, "phoneVerified": { "title": "Phone verified", "type": "boolean", "description": "Only return jobs from clients with a verified phone number.", "default": false }, "minHireRate": { "title": "Minimum hire rate", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only return jobs from clients with a historical hire rate of at least this percentage." }, "minClientTotalSpent": { "title": "Minimum client spend", "minimum": 0, "type": "integer", "description": "Only return jobs from clients who have spent at least this amount on Upwork." }, "minClientHires": { "title": "Minimum previous hires", "minimum": 0, "type": "integer", "description": "Only return jobs from clients who have previously hired at least this many freelancers." }, "minClientJobsPosted": { "title": "Minimum jobs posted", "minimum": 0, "type": "integer", "description": "Only return jobs from clients who have posted at least this many jobs." }, "minClientOpenJobs": { "title": "Minimum open jobs", "minimum": 0, "type": "integer", "description": "Only return jobs from clients who currently have at least this many open jobs." }, "minClientActiveProjects": { "title": "Minimum active projects", "minimum": 0, "type": "integer", "description": "Only return jobs from clients who currently have at least this many active projects." }, "minClientTotalHours": { "title": "Minimum hours hired", "minimum": 0, "type": "integer", "description": "Only return jobs from clients who have previously hired freelancers for at least this many hours." }, "minAverageHourlyRatePaid": { "title": "Minimum average hourly rate paid", "minimum": 0, "type": "integer", "description": "Only return jobs from clients whose historical average hourly rate paid is at least this amount." }, "clientCountries": { "title": "Client countries", "type": "array", "description": "Only return jobs from clients located in the selected countries. You can also enter custom countries.", "items": { "type": "string", "enumSuggestedValues": [ "United States", "United Kingdom", "Canada", "Australia", "Germany", "France", "Netherlands", "Switzerland", "Sweden", "Norway", "Denmark", "Finland", "Ireland", "New Zealand", "Singapore", "United Arab Emirates" ] } }, "excludeClientCountries": { "title": "Exclude countries", "type": "array", "description": "Exclude jobs from clients located in the selected countries.", "items": { "type": "string" } }, "clientCities": { "title": "Client cities", "type": "array", "description": "Only return jobs from clients located in these cities.", "items": { "type": "string" } }, "hasQuestions": { "title": "Has screening questions", "type": "boolean", "description": "Only return jobs that contain one or more screening questions." }, "hasAttachments": { "title": "Has attachments", "type": "boolean", "description": "Only return jobs that contain one or more attachments." }, "clientIndustry": { "title": "Client industry", "type": "string", "description": "Only return jobs from clients in the selected industry. Availability depends on Upwork providing industry information." }, "onlyNewJobs": { "title": "Only return new jobs", "type": "boolean", "description": "When running the same search repeatedly, return only jobs that have not been returned by a previous run.", "default": false }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of matching jobs to return.", "default": 100 }, "telegramBotToken": { "title": "📱 Telegram Bot Token", "type": "string", "description": "Your Telegram Bot Token." }, "telegramChatId": { "title": "💬 Telegram Chat / Channel ID", "type": "string", "description": "Your Telegram Chat or Channel ID." }, "discordWebhookUrl": { "title": "💬 Discord Webhook URL", "type": "string", "description": "Your Discord Webhook URL." }, "slackWebhookUrl": { "title": "💼 Slack Incoming Webhook URL", "type": "string", "description": "Your Slack Incoming Webhook URL." }, "whatsappPhoneNumberId": { "title": "📱 WhatsApp Phone Number ID", "type": "string", "description": "Your WhatsApp Phone Number ID." }, "whatsappAccessToken": { "title": "🔐 WhatsApp Access Token", "type": "string", "description": "Your WhatsApp Access Token." }, "whatsappRecipient": { "title": "📨 WhatsApp Recipient", "type": "string", "description": "The WhatsApp Recipient phone number." }, "genericWebhookUrl": { "title": "🪝 Generic Webhook URL", "type": "string", "description": "A generic webhook URL to dispatch scraped jobs to." }, "webhookHeaders": { "title": "🪝 Webhook Headers (optional)", "type": "object", "description": "Optional HTTP headers to send with the generic webhook. Specify as JSON object." } } }, "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 } } } } } } } } } }