{ "openapi": "3.0.1", "info": { "title": "Gupy Jobs Scraper | Brazil Jobs with Descriptions (Gupy Portal)", "description": "$0.80 per 1,000 jobs, description included | Scrape Gupy (portal.gupy.io), the job portal of Brazil's largest ATS: title, company, city, state, remote/hybrid/on-site, job type (CLT, estágio, PJ), PcD, deadline, full description. Keyword, state and city search, newest first, only-new mode. No login.", "version": "0.1", "x-build-id": "l8wBahBE95qlkBAbq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_daemon~gupy-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_daemon-gupy-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/data_daemon~gupy-jobs-scraper/runs": { "post": { "operationId": "runs-sync-data_daemon-gupy-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/data_daemon~gupy-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-data_daemon-gupy-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": { "searchTerms": { "title": "Keywords (optional)", "type": "array", "description": "Optional. Gupy matches them against job titles and descriptions, e.g. `analista de dados`, `python`, `vendedor`, `enfermeiro`. Each keyword is one search. Leave empty to get every job on the portal, newest first (about 2,700 new jobs a day in late October 2026).", "default": [], "items": { "type": "string" } }, "states": { "title": "States (optional)", "type": "array", "description": "Brazilian states, e.g. `São Paulo`, `Minas Gerais`, `Rio de Janeiro`, `Paraná`. Accent-less names (`Sao Paulo`) and two-letter codes (`SP`, `MG`, `RJ`) work too and are mapped to Gupy's spelling. Each state is one search (combined with every keyword). Applied by Gupy before anything is downloaded.", "default": [], "items": { "type": "string" } }, "cities": { "title": "Cities (optional)", "type": "array", "description": "City names, e.g. `São Paulo`, `Curitiba`, `Belo Horizonte`. Each city is one search (combined with every keyword). Applied by Gupy before anything is downloaded.", "default": [], "items": { "type": "string" } }, "workplaceTypes": { "title": "Workplace", "type": "array", "description": "Only jobs with these workplace types (checked on each job; on 30 Oct 2026 about 96% of the newest jobs were on-site). Empty = any.", "items": { "type": "string", "enum": [ "remote", "hybrid", "on-site" ], "enumTitles": [ "Remote (home office)", "Hybrid", "On-site" ] }, "default": [] }, "jobTypes": { "title": "Job type", "type": "array", "description": "Only these Gupy vacancy types (checked on each job). Empty = any. `effective` is a regular (CLT) job; `legal_entity` is a PJ contract.", "items": { "type": "string", "enum": [ "effective", "internship", "apprentice", "temporary", "legal_entity", "freelancer", "autonomous", "lecturer", "associate", "talent_pool", "volunteer" ], "enumTitles": [ "Effective (CLT)", "Internship (estágio)", "Apprentice (jovem aprendiz)", "Temporary", "Legal entity (PJ)", "Freelancer", "Autonomous", "Lecturer / professor", "Associate", "Talent pool (banco de talentos)", "Volunteer" ] }, "default": [] }, "pwdOnly": { "title": "Only jobs open to people with disabilities (PcD)", "type": "boolean", "description": "Only jobs the employer marked as open to people with disabilities (`acceptsPwd`).", "default": false }, "postedWithinDays": { "title": "Posted within the last N days", "minimum": 0, "type": "integer", "description": "Only jobs published on Gupy in the last N days (e.g. 1 for a daily feed, 7 for weekly). Jobs come newest first, so the search stops at the first page of older jobs. 0 or empty = any date." }, "locations": { "title": "Location words (optional)", "type": "array", "description": "Only jobs whose city or state contains one of these words (accent-insensitive), e.g. `Campinas`, `Paraná`. `remote` matches remote jobs. Unlike `states` and `cities`, this is checked after download; use it to combine a keyword search with several places in one run.", "default": [], "items": { "type": "string" } }, "includeDescription": { "title": "Include the description", "type": "boolean", "description": "Full job description as plain text (`description`). It costs the same either way; turn it off for smaller files.", "default": true }, "maxResultsPerSearch": { "title": "Max jobs per search", "minimum": 0, "type": "integer", "description": "Cap for each keyword × place search. Newest jobs come first. 0 = no cap (the portal lists its newest 10,000 jobs, about six days of postings on 30 Oct 2026).", "default": 50 }, "maxResults": { "title": "Max jobs in total", "minimum": 0, "type": "integer", "description": "Stop after this many saved jobs. 0 or empty = no total cap (the run's maximum cost still applies)." }, "onlyNewSinceLastRun": { "title": "Only new jobs since the last run", "type": "boolean", "description": "For schedules: remember delivered job ids (in a named key-value store in your account) and save only jobs that earlier runs with the same settings did not deliver. Skipped jobs are not charged.", "default": false }, "stateName": { "title": "Memory name (optional)", "type": "string", "description": "Name of the only-new memory. Empty = derived from the keywords, places and filters. Give two schedules the same name to share one memory." }, "skipIds": { "title": "Job ids to skip", "type": "array", "description": "Gupy job ids you already have (the `id` field). They are neither saved nor charged.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed: the Gupy portal answers Apify servers directly. Use a proxy only if requests start failing.", "default": { "useApifyProxy": false } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }