{ "openapi": "3.0.1", "info": { "title": "Gupy Jobs Scraper", "description": "Job openings (vagas) from Gupy's Brazilian job portal with company, location, contract type such as CLT or PJ and the full description. Search by job title, state and city; searches above Gupy's limit of 10,000 results are split by state.", "version": "0.1", "x-build-id": "vBvNPvAlS5AtTO39p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deriverge~gupy-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deriverge-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/deriverge~gupy-jobs-scraper/runs": { "post": { "operationId": "runs-sync-deriverge-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/deriverge~gupy-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-deriverge-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": { "keywords": { "title": "Keywords", "type": "array", "description": "What to search for, in Portuguese, as in the Gupy search box: a job title or skill, for example \"vendedor\", \"analista de dados\" or \"enfermeiro\". Gupy matches it against job titles. Each keyword is its own search. Leave empty for all jobs.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Only jobs in these Brazilian states. Each state is its own search. Leave empty for all of Brazil.", "items": { "type": "string", "enum": [ "Acre", "Alagoas", "Amapá", "Amazonas", "Bahia", "Ceará", "Distrito Federal", "Espírito Santo", "Goiás", "Maranhão", "Mato Grosso", "Mato Grosso do Sul", "Minas Gerais", "Pará", "Paraíba", "Paraná", "Pernambuco", "Piauí", "Rio de Janeiro", "Rio Grande do Norte", "Rio Grande do Sul", "Rondônia", "Roraima", "Santa Catarina", "São Paulo", "Sergipe", "Tocantins" ] } }, "cities": { "title": "Cities", "type": "array", "description": "Only jobs in these cities, for example São Paulo, Rio de Janeiro, Belo Horizonte or Curitiba. Each city is its own search.", "items": { "type": "string" } }, "workplace": { "title": "Workplace", "type": "array", "description": "Only jobs with these workplace types. Leave empty for all.", "items": { "type": "string", "enum": [ "remote", "hybrid", "on-site" ], "enumTitles": [ "Remote", "Hybrid", "On-site" ] } }, "jobTypes": { "title": "Contract types", "type": "array", "description": "Only jobs with these contract types, for example CLT, PJ, internships or apprenticeships. Leave empty for all.", "items": { "type": "string", "enum": [ "vacancy_type_effective", "vacancy_legal_entity", "vacancy_type_temporary", "vacancy_type_internship", "vacancy_type_apprentice", "vacancy_type_trainee", "vacancy_type_talent_pool", "vacancy_type_freelancer", "vacancy_type_autonomous", "vacancy_type_associate", "vacancy_type_lecturer", "vacancy_type_summer" ], "enumTitles": [ "Permanent (CLT)", "Contractor (PJ)", "Temporary", "Internship (estágio)", "Apprentice (jovem aprendiz)", "Trainee", "Talent pool", "Freelancer", "Self-employed", "Associate", "Lecturer", "Summer job" ] } }, "disabilityFriendlyOnly": { "title": "Only jobs open to people with disabilities", "type": "boolean", "description": "Keep only jobs that Gupy labels Vaga também para PcD (also open to people with disabilities). In October 2026 about 4 in 5 Gupy jobs carried the label.", "default": false }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop jobs whose title or company contains any of these.", "items": { "type": "string" } }, "newOnly": { "title": "Return only jobs new since the last run", "type": "boolean", "description": "Keeps a snapshot per watch name (or per saved task) and returns only jobs that were not there before. Schedule it daily for a job alert.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Name of the snapshot used by the new-only mode, for example \"vendas-sp\". Runs from a saved task get one automatically." }, "maxItems": { "title": "Maximum jobs", "minimum": 1, "type": "integer", "description": "Hard cap on returned jobs. Gupy lists more than 80,000 jobs; searches larger than 10,000 are split by state automatically when you ask for more. When the cap is smaller than the results, every search gets an equal share.", "default": 1000 } } }, "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 } } } } } } } } } }