{ "openapi": "3.0.1", "info": { "title": "Gupy Jobs Scraper", "description": "Scrapes live job vacancies from Gupy — Brazil's largest recruitment platform, where thousands of companies host their careers pages (~81,500 open roles). Filter by search term, city, state, workplace type or employer; every row carries the full description, company, location and apply URL.", "version": "0.1", "x-build-id": "FAFA9CswdYfPa7WfF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~gupy-jobs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-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/scrapyx~gupy-jobs-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-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/scrapyx~gupy-jobs-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-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": "Search terms", "type": "array", "description": "One search per entry, each with its own SEARCH_SUMMARY row — e.g. `desenvolvedor`, `enfermeiro`, `analista de dados`. Matches against the job title.\n\nLeave empty to crawl the whole board (~81,500 live vacancies) under whatever location/workplace filters you set.\n\nBecause the API pages through at most 10,000 rows per query, several narrow terms return far more data than one broad one.", "default": [], "items": { "type": "string" } }, "workplaceType": { "title": "Workplace type", "enum": [ "", "remote", "on-site", "hybrid" ], "type": "string", "description": "Remote, on-site or hybrid. An unrecognised value returns a clean zero-result search rather than an error, so anything outside this list is refused before the run starts.", "default": "" }, "city": { "title": "City", "type": "string", "description": "Brazilian city name, accents included — e.g. `São Paulo`, `Belo Horizonte`, `Curitiba`.", "default": "" }, "state": { "title": "State", "type": "string", "description": "Brazilian state. Accepts either the two-letter code (`SP`, `RJ`, `MG`) or the full accented name (`São Paulo`) — the code is translated for you, because Gupy itself only matches the full name and would answer a bare `SP` with zero results.", "default": "" }, "country": { "title": "Country", "type": "string", "description": "Usually `Brasil`. Gupy is Brazil-first but a small share of listings are elsewhere, so this is left free-text rather than forced.", "default": "" }, "companyId": { "title": "Company ID", "minimum": 0, "type": "integer", "description": "Restrict to a single employer, using the `companyId` value that appears on every job row. Handy for tracking one company's hiring over time.", "default": 0 }, "maxItems": { "title": "Max jobs per search term", "minimum": 0, "type": "integer", "description": "Stop after this many jobs per term. Set to 0 for unlimited — note the API itself pages through at most 10,000 rows per query however many matches it reports. Narrow by city, state or a more specific term to reach the rest.", "default": 100 }, "pageSize": { "title": "Rows per request", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many jobs to pull per API call. 100 is the maximum Gupy accepts (it returns HTTP 400 above that) and means fewer requests for the same data.", "default": 100 }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Upper bound on requests in flight at once, across all search terms.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Gupy's API is fully open — no auth, no token, no bot challenge on any TLS profile tested. Residential pinned to Brazil is still the cloud default, since container egress is a different posture than a home connection and this is a Brazil-only job board.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } } }, "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 } } } } } } } } } }