{
  "openapi": "3.0.1",
  "info": {
    "title": "Gupy Jobs Scraper - Brazil Vagas, Details & Employer Contacts",
    "description": "Scrape Gupy jobs in Brazil: title, company, city, state, remote/hybrid, job type, PcD, dates, full text, requirements, benefits, hiring steps, company page, employer emails and CNPJ. Every portal filter, company career sites, links, monitor mode. $0.40 per 1,000 jobs.",
    "version": "0.1",
    "x-build-id": "goFPwVUdQCZYJvgFV"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/topapi~gupy-jobs-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-topapi-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/topapi~gupy-jobs-scraper/runs": {
      "post": {
        "operationId": "runs-sync-topapi-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/topapi~gupy-jobs-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-topapi-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": {
          "searchQueries": {
            "title": "Keywords",
            "type": "array",
            "description": "Job title words, one per line: analista, desenvolvedor, vendedor, enfermeiro, estágio. Each keyword is one Gupy search (Gupy matches job titles, any case and accents). Empty = every job matching the filters below, or the whole portal (about 83,000 open jobs). API aliases: searchTerms, keywords, query, termo.",
            "items": {
              "type": "string"
            }
          },
          "companies": {
            "title": "Companies",
            "type": "array",
            "description": "Company names as Gupy shows them (Itaú Unibanco, Compass UOL, FARM), career-site subdomains (vemproitau, compass, farm) or career-site links (https://farm.gupy.io/). Returns the company's portal jobs plus the jobs only its career site lists. API aliases: companyNames, empresas, subdomains, careerPageUrls.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Links",
            "type": "array",
            "description": "Gupy links: portal searches (https://portal.gupy.io/job-search/term=analista&state=São Paulo&workplaceTypes[]=remote, https://portal.gupy.io/vagas/analista-de-dados), career sites (https://farm.gupy.io/) or single jobs (https://farm.gupy.io/jobs/12848694, https://farm.gupy.io/job/eyJqb2JJZCI6...). The filters below are added to search links. API aliases: searchUrls, jobUrls, urls.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "states": {
            "title": "States",
            "type": "array",
            "description": "Brazilian states by name or code: São Paulo, SP, Minas Gerais, RJ. Accents optional. One search per state. Remote jobs are published without a state, so a state leaves them out. API alias: state.",
            "items": {
              "type": "string"
            }
          },
          "cities": {
            "title": "Cities",
            "type": "array",
            "description": "Cities, any case and accents: sao paulo, Campinas, Belo Horizonte, Recife - PE. Names are matched to the 5,571 IBGE municipalities and sent to Gupy in its spelling. Several cities = jobs in any of them. API alias: city.",
            "items": {
              "type": "string"
            }
          },
          "workplaceTypes": {
            "title": "Workplace type",
            "type": "array",
            "description": "Remote, hybrid, on-site, or several. Empty = all. API aliases: workplaceType, remoteOnly.",
            "items": {
              "type": "string",
              "enum": [
                "remote",
                "hybrid",
                "on-site"
              ],
              "enumTitles": [
                "Remote (Remoto)",
                "Hybrid (Híbrido)",
                "On-site (Presencial)"
              ]
            }
          },
          "jobTypes": {
            "title": "Job type",
            "type": "array",
            "description": "Gupy's job types; several at once. Empty = all. API aliases: jobType, vacancyTypes, contractType (CLT, PJ, estágio, aprendiz...).",
            "items": {
              "type": "string",
              "enum": [
                "vacancy_type_effective",
                "vacancy_type_internship",
                "vacancy_type_apprentice",
                "vacancy_type_trainee",
                "vacancy_type_temporary",
                "vacancy_legal_entity",
                "vacancy_type_talent_pool",
                "vacancy_type_associate",
                "vacancy_type_freelancer",
                "vacancy_type_autonomous",
                "vacancy_type_lecturer",
                "vacancy_type_summer",
                "vacancy_type_volunteer",
                "vacancy_type_outsource",
                "vacancy_type_parter",
                "vacancy_type_intermittent"
              ],
              "enumTitles": [
                "Permanent / CLT (Efetivo)",
                "Internship (Estágio)",
                "Apprentice (Aprendiz)",
                "Trainee",
                "Temporary (Temporário)",
                "Contractor / PJ (Pessoa jurídica)",
                "Talent pool (Banco de talentos)",
                "Associate (Associado)",
                "Freelancer",
                "Self-employed (Autônomo)",
                "Lecturer (Docente)",
                "Summer job",
                "Volunteer (Voluntário)",
                "Outsourced (Terceiro)",
                "Partner (Sócio)",
                "Intermittent (Intermitente)"
              ]
            }
          },
          "pwdOnly": {
            "title": "Open to people with disabilities (PcD) only",
            "type": "boolean",
            "description": "Only jobs the employer opened to PcD candidates (Gupy's own filter). API aliases: pcdOnly, onlyOpenToPwd.",
            "default": false
          },
          "friendlyBadgeOnly": {
            "title": "Companies with Gupy's feedback badge only",
            "type": "boolean",
            "description": "Only companies with Gupy's 'Selo Feedback' (they answer every candidate). API alias: onlyFeedbackCompanies.",
            "default": false
          },
          "sortBy": {
            "title": "Order",
            "enum": [
              "newest",
              "oldest",
              "relevance",
              "company",
              "fewApplications"
            ],
            "type": "string",
            "description": "Gupy's own order. Newest first lets date windows and monitor runs stop early.",
            "default": "newest"
          },
          "postedWithin": {
            "title": "Posted within",
            "enum": [
              "any",
              "24h",
              "3d",
              "7d",
              "14d",
              "30d"
            ],
            "type": "string",
            "description": "Only jobs published in this window (reading stops at the first older job). API alias: postedWithinDays (a number).",
            "default": "any"
          },
          "dateFrom": {
            "title": "Published on or after",
            "type": "string",
            "description": "YYYY-MM-DD. API aliases: postedAfter, sinceDate."
          },
          "dateTo": {
            "title": "Published on or before",
            "type": "string",
            "description": "YYYY-MM-DD. API alias: postedBefore."
          },
          "excludeTalentPool": {
            "title": "Leave out talent-pool postings",
            "type": "boolean",
            "description": "Gupy's 'Banco de talentos' postings collect CVs for future openings (about 13% of the portal).",
            "default": false
          },
          "titleInclude": {
            "title": "Title must contain",
            "type": "array",
            "description": "Keep a job only when its title contains one of these words (any case and accents). API alias: titleKeywords.",
            "items": {
              "type": "string"
            }
          },
          "titleExclude": {
            "title": "Title must not contain",
            "type": "array",
            "description": "Drop jobs whose title contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Exclude words (title or text)",
            "type": "array",
            "description": "Drop jobs whose title or text contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "companyContains": {
            "title": "Company name contains",
            "type": "array",
            "description": "Keep jobs whose company name contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "companyExclude": {
            "title": "Company name excludes",
            "type": "array",
            "description": "Drop jobs whose company name contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "seniorities": {
            "title": "Seniority",
            "type": "array",
            "description": "Seniority read from the title (Júnior, Pleno, Sênior, Especialista, Coordenador...). API alias: experienceLevels.",
            "items": {
              "type": "string",
              "enum": [
                "internship",
                "apprentice",
                "trainee",
                "junior",
                "mid",
                "senior",
                "specialist",
                "coordinator",
                "manager",
                "director"
              ],
              "enumTitles": [
                "Internship (estágio)",
                "Apprentice (aprendiz)",
                "Trainee",
                "Junior",
                "Mid (pleno)",
                "Senior",
                "Specialist",
                "Coordinator / lead",
                "Manager",
                "Director"
              ]
            }
          },
          "locationKeywords": {
            "title": "Location contains",
            "type": "array",
            "description": "Keep jobs whose city, state or workplace label contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "departmentIncludes": {
            "title": "Department contains",
            "type": "array",
            "description": "Keep jobs whose department contains one of these words (departments come from company career sites).",
            "items": {
              "type": "string"
            }
          },
          "minSalary": {
            "title": "Minimum salary (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep jobs whose posted salary reaches this amount. Most Gupy postings publish no salary."
          },
          "withSalaryOnly": {
            "title": "Only jobs that publish a salary",
            "type": "boolean",
            "description": "Keep only jobs whose text gives a salary in R$.",
            "default": false
          },
          "skipIds": {
            "title": "Skip job ids",
            "type": "array",
            "description": "Gupy job ids you already have; never delivered or charged.",
            "items": {
              "type": "string"
            }
          },
          "includeDetails": {
            "title": "Job details",
            "type": "boolean",
            "description": "The full job record from the company's career site: requirements, responsibilities, benefits, hiring steps, full address and ZIP, job code, hiring reason, expiry, quick apply, application questions, video, and the company page (about, website, LinkedIn, Instagram, Facebook, Glassdoor). One request per job; charged as a job-details event per job that gets it.",
            "default": true
          },
          "includeCompanyContacts": {
            "title": "Employer contacts and CNPJ",
            "type": "boolean",
            "description": "Emails, phones and social profiles from the employer's own website (as its Gupy career page lists it), plus the CNPJ the site prints with its Receita Federal record (legal name, size, CNAE activity, status). Charged once per company per run, only when an email is found. API aliases: enrichContacts, enrichEmails.",
            "default": false
          },
          "withEmailOnly": {
            "title": "Only jobs with an employer email",
            "type": "boolean",
            "description": "With employer contacts on: drop jobs whose employer website gave no email (not charged).",
            "default": false
          },
          "descriptionFormat": {
            "title": "Description format",
            "enum": [
              "text",
              "html",
              "markdown",
              "both",
              "all",
              "none"
            ],
            "type": "string",
            "description": "How the posting text comes out. API alias: includeDescription false = none.",
            "default": "text"
          },
          "descriptionMaxLength": {
            "title": "Cut descriptions at (characters)",
            "minimum": 0,
            "type": "integer",
            "description": "0 = full text."
          },
          "trackCompanies": {
            "title": "Track companies",
            "type": "array",
            "description": "Company names, subdomains or career-site links: one row each with open jobs, workplace / job type / seniority / state / city / department mix, newest posting, the company page and, on later runs, the change (new and closed job ids). Charged per company row.",
            "items": {
              "type": "string"
            }
          },
          "mode": {
            "title": "Row type",
            "enum": [
              "jobs",
              "companies"
            ],
            "type": "string",
            "description": "Hiring companies: the keyword / filter search above, read up to 'Jobs scanned', grouped into one row per company (matching jobs, all open jobs on its career site, mixes, company page).",
            "default": "jobs"
          },
          "maxJobsScanned": {
            "title": "Jobs scanned (hiring companies)",
            "minimum": 10,
            "maximum": 100000,
            "type": "integer",
            "description": "How many jobs the search reads before grouping them by company. Scanning is not charged.",
            "default": 1000
          },
          "monitorMode": {
            "title": "Only new jobs",
            "type": "boolean",
            "description": "Remembers the jobs of earlier runs with the same search and monitor name and returns only new ones, newest first. Reading stops at the first page of known jobs; a run with nothing new costs almost nothing and writes nothing. A job delivered earlier without the job details or employer contacts that a later run turns on comes again once with them, as changeType 'details'. API aliases: onlyNew, newOnly, onlyNewJobs.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Separate memories for separate schedules. API aliases: watchName, monitorName, stateName.",
            "default": "gupy-monitor"
          },
          "emitBaseline": {
            "title": "Deliver the current jobs on the first run",
            "type": "boolean",
            "description": "Off = the first run only remembers today's jobs (nothing delivered or charged) and later runs return what is new.",
            "default": true
          },
          "includeUpdated": {
            "title": "Also return changed jobs",
            "type": "boolean",
            "description": "Jobs delivered before whose title, place, type, deadline or text changed come again with changeType 'updated'.",
            "default": false
          },
          "includeRemoved": {
            "title": "Also return removed jobs",
            "type": "boolean",
            "description": "Jobs from earlier runs that left this search come as a short row with changeType 'removed'. Needs a full read of the search on every run.",
            "default": false
          },
          "includeUnchanged": {
            "title": "Also return unchanged jobs",
            "type": "boolean",
            "description": "Return every current job, each marked new, updated, unchanged or details.",
            "default": false
          },
          "resetMonitor": {
            "title": "Forget earlier runs",
            "type": "boolean",
            "description": "Start the monitor memory over.",
            "default": false
          },
          "maxItems": {
            "title": "Max rows",
            "minimum": 0,
            "maximum": 500000,
            "type": "integer",
            "description": "Jobs (or company rows) in total. 0 = no limit. API aliases: maxResults, maxJobs.",
            "default": 50
          },
          "maxItemsPerSearch": {
            "title": "Max rows per search",
            "minimum": 0,
            "type": "integer",
            "description": "Cap for each keyword / state / company search. API alias: maxResultsPerSearch."
          },
          "maxPages": {
            "title": "Max pages per search",
            "minimum": 0,
            "type": "integer",
            "description": "Gupy pages (100 jobs each) per search."
          },
          "splitLargeSearches": {
            "title": "Go past 10,000 jobs per search",
            "type": "boolean",
            "description": "Gupy shows at most 10,000 jobs per search. On: newest-first and oldest-first halves, then the search is split by state, job type, workplace type and city to reach every job.",
            "default": true
          },
          "maxConcurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Job records read at once.",
            "default": 10
          },
          "telegramToken": {
            "title": "Telegram bot token",
            "type": "string",
            "description": "Bot token from @BotFather; with a chat id, each run sends its new jobs there."
          },
          "telegramChatId": {
            "title": "Telegram chat id",
            "type": "string",
            "description": "The chat, group or channel id."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "An incoming-webhook URL."
          },
          "discordWebhookUrl": {
            "title": "Discord webhook URL",
            "type": "string",
            "description": "A channel webhook URL."
          },
          "teamsWebhookUrl": {
            "title": "Microsoft Teams webhook URL",
            "type": "string",
            "description": "An incoming-webhook URL."
          },
          "ntfyTopic": {
            "title": "ntfy topic",
            "type": "string",
            "description": "A topic on ntfy.sh (or your server)."
          },
          "whatsappAccessToken": {
            "title": "WhatsApp Cloud API token",
            "type": "string",
            "description": "With a phone number id and a recipient."
          },
          "whatsappPhoneNumberId": {
            "title": "WhatsApp phone number id",
            "type": "string",
            "description": "Your WhatsApp Business phone number id."
          },
          "whatsappTo": {
            "title": "WhatsApp recipient",
            "type": "string",
            "description": "Number in international format."
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "POST with the new jobs as JSON."
          },
          "notificationLimit": {
            "title": "Jobs per alert",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "How many jobs each alert lists.",
            "default": 10
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed: Gupy answers a direct connection, and the actor moves to the Apify datacenter proxy by itself if Gupy refuses it. Set one only to send everything through your own proxy.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}