# Indeed Job Scraper API Feel free to open issues to suggest new features or report bugs! Welcome to the **Indeed Job Scraper**! 🚀 Extract detailed job listing data from Indeed seamlessly and build your own job market analytics, databases, or even automate your job searches. Designed for ease-of-use and power, this tool will supercharge your data needs! 🔍 Here’s a **final** version with a friendly instruction line at the top, showing users how to open and close the details sections: --- ## 📦 **What Can You Extract?** > **Tip**: Click on the arrow (▶) or the heading to expand/collapse each section. The detailed version is available at the bottom of this page.

🚀 Job Essentials

- **title** (e.g., `"Remote Customer Support Representative"`) - **isRemote** (`true` / `false`) - **jobType** (e.g., `["Full-time", "Remote"]`) - **age** (e.g., `"Just posted"`, `"1 day ago"`) - **postedToday** (`true` / `false`) - **datePublished** (e.g., `"2025-02-24"`)

🏢 Company Info

- **companyName** (e.g., `"American Heart Association"`) - **companyUrl** (e.g., `"https://www.indeed.com/cmp/American-Heart-Association"`) - **companyLogoUrl** (logo image link) - **companyHeaderUrl** (header/banner image link) - **rating** (`{"rating": 3.9, "count": 885}`) - **emails** (e.g., `["hr@heart.jobs"]`) - **companyAddresses** (e.g., `["Dallas, TX"]`) - **companyNumEmployees** (e.g., `"1,001 to 5,000"`) - **companyRevenue** (e.g., `"$500M to $1B (USD)"`) - **companyIndustry** (e.g., `"ASSOCIATION"`) - **companyDescription** (full write-up) - **companyFounded** (e.g., `{"year": 1924}`) - **companyBriefDescription** (short overview) - **companyLinks** (socials, custom links, website, etc.) - **companyCeo** (e.g., `{"name": "Nancy A. Brown", "photoUrl": "...", "startDate": null}`)

📍 Location & Geodata

- **countryCode**, **country** - **city**, **postalCode** - **formattedAddressShort**, **formattedAddressLong** - **latitude**, **longitude** - **streetAddress**, **fullAddress**

💰 Compensation & Benefits

- **salary** (object with `salaryText`, `salaryType`, `salaryMin`, `salaryMax`, `salaryCurrency`, etc.) - **benefits** (e.g., `["Health insurance", "Paid time off"]`) - **socialInsurance** (e.g., `["Health insurance"]`)

📃 Description & Requirements

- **descriptionText** (plain text) - **descriptionHtml** (HTML version) - **occupation** (e.g., `["Customer Support & Client Services"]`) - **attributes** (keywords/tags, e.g., `["Bilingual", "Microsoft Word"]`) - **requirements** (array of `label` + `requirementSeverity`) - **shiftAndSchedule** (e.g., `["Monday to Friday"]`) - **workingSystem** (on-site, hybrid, remote)

📝 Application & Hiring Details

- **jobUrl** (Indeed listing link) - **applyUrl** (direct application link) - **hiringDemand** (e.g., `{"isUrgentHire": true, "isHighVolumeHiring": false}`) - **organicApplyStarts** - **numOfCandidates** - **expired** (`true` / `false`)

🌐 Language & Locale

- **language** (e.g., `"en"`) - **locale** (e.g., `"en_US"`)

🔎 Scraping Metadata

- **jobKey** (unique job identifier) - **source** (where the listing came from) - **scrapingInfo** (e.g., `{"page": 12, "index": 3}`)

--- By using collapsible sections and grouping fields by theme, your users can **quickly scan** through each category without endless scrolling. Adjust the labels and structure as needed for your documentation. --- ## 1. Overview When calling the `POST` endpoint on RapidAPI (e.g., `POST /api/job`), supply your **search parameters** inside a root JSON object. Within that object, you can include a `scraper` field that defines how the scraper should run. (You can optionally include a `webhook` field if you want callback functionality.) ```jsonc { "scraper": { // Fields described below }, "webhook": { "url": "https://webhook.io", "headers": [ { "key": "Authorization", "value": "Bearer token" } ] }, } ``` --- ## 2. `scraper` Object Fields Below are the **available fields** in the `scraper` object. Only `query` is strictly required. All other fields are optional. | Field | Type | Default | Description | Valid Values | | :---------- | :------ | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------- | | **maxRows** | number | `20` | Maximum number of jobs to retrieve. | Any positive integer. Example: `50`. | | **query** | string | (No default) | **Required.** The keyword(s), job title, or company name to search for. | Example: `"data analyst"`, `"Google"`, `"remote developer"`. | | **location**| string | `"Paris"` | The geographic location to filter jobs by (e.g., city, state). | Example: `"New York, NY"`. | | **jobType** | string | `"fulltime"` | Filter by job type. | Must be one of: `fulltime`, `parttime`, `contract`, `internship`, `temporary`, `commission`. | | **level** | string | `"entry_level"` | Filter by job seniority level. | Must be one of: `entry_level`, `mid_level`, `senior_level`. | | **radius** | string | `"5"` | The search radius (in miles) around the specified location. | Must be one of: `5`, `10`, `15`, `25`, `50`, `100`. | | **sort** | string | `"relevance"` | Sort order for the results. | Must be one of: `relevance`, `date`. | | **fromDays**| string | `"1"` | Include jobs posted within the last X days. | Must be one of: `1`, `3`, `7`, `14`. | | **remote** | string | `"remote"` | Filter for remote or hybrid roles. | Must be one of: `remote`, `hybrid`. | | **country** | string | `"us"` | The country code to filter jobs in. | Example: `"us"`, `"uk"`, `"fr"`, etc. Full list of country is available at bottom | --- ## 3. Example Request Body Here’s a full example showing how you might send a request body to the RapidAPI endpoint. You can mix and match fields as needed: ```json { "scraper": { "query": "data analyst", "location": "New York, NY", "maxRows": 50, "radius": "25", "jobType": "fulltime", "level": "mid_level", "sort": "date", "fromDays": "7", "remote": "remote", "country": "us" } } ``` (For detailled types you can check our Swagger Documentation) ### Explanation: - **query**: Searching for “data analyst”. - **location**: Restricting to jobs in “New York, NY”. - **maxRows**: Requesting up to 50 job results. - **radius**: 25 miles/km around the specified location. - **jobType**: Only want full-time roles. - **level**: Prefer mid-level experience listings. - **sort**: Sorting results by posting date (newest first). - **fromDays**: Only include jobs posted in the last 7 days. - **remote**: Must be remote positions. - **country**: United States job listings. --- ## 4. Parsing the Response Successful responses typically include an array or object with **job listings**. Each listing may contain (For detailled types you can check our Swagger Documentation schema ScraperResultDto): ```json [ { "title": "Remote Customer Support Representative, Professional Services", "isRemote": true, "jobType": ["Full-time", "Remote"], "companyName": "American Heart Association", "companyUrl": "https://www.indeed.com/cmp/American-Heart-Association", "companyLogoUrl": "https://d2q79iu7y748jz.cloudfront.net/s/_squarelogo/256x256/2b22f028a31bec649682434b83dd2804", "campanyHeaderUrl": "https://d2q79iu7y748jz.cloudfront.net/s/_headerimage/1960x400/1cf333dc972583d2e1c9df18c4f23d5e", "rating": { "rating": 3.9, "count": 885, }, "emails": ["hr@heart.jobs"], "companyAddresses": ["Dallas, TX"], "companyNumEmployees": "1,001 to 5,000", "companyRevenue": "$500M to $1B (USD)", "companyIndustry": "ASSOCIATION", "companyDescription": "The American Heart Association is a relentless force for a world of longer, healthier lives. Through collaboration ...", "companyFounded": { "year": 1924 }, "companyBriefDescription": "The American Heart Association is the nation’s oldest, largest voluntary organization devoted to ...", "companyLinks": { "facebook": "https://www.facebook.com/theahalife", "instagram": "https://www.instagram.com/theahalife", "twitter": "", "customLinks": [ { "name": "AHA Careers Site", "url": "https://heart.jobs/" } ], "corporateWebsite": "http://www.heart.org" }, "companyCeo": { "name": "Nancy A. Brown", "photoUrl": "https://d2q79iu7y748jz.cloudfront.net/s/_ceophoto/512x512/c79ae9f355378e5e78738e1ac5e7fee7", "startDate": null }, "location": { "countryCode": "US", "country": "United States", "city": "Dallas", "formattedAddressShort": "Dallas, TX", "formattedAddressLong": " Dallas, Texas 75231-4596, US", "postalCode": "75231", "latitude": 32.814034, "longitude": -96.815, "streetAddress": "7272 Greenville Ave.", "fullAddress": "7272 Greenville Ave. Dallas, Texas 75231-4596, US" }, "benefits": ["Health insurance", "Paid time off", "Retirement plan"], "occupation": [ "Customer Support & Client Services Occupations", "Sales, Retail & Customer Support Occupations" ], "socialInsurance": ["Health insurance"], "attributes": [ "Bilingual", "Microsoft Word", "Spanish", "Wellness program", "Microsoft Outlook", "Hourly pay" ], "requirements": [ { "label": "Engineering", "requirementSeverity": "REQUIRED" }, { "label": "Ability to lift 50 pounds", "requirementSeverity": "PREFERRED" }, { "label": "Associate's degree", "requirementSeverity": "PREFERRED" } ], "shiftAndSchedule": ["Monday to Friday"], "workingSystem": [], "attributes": [], "descriptionText": "Provide tier I technical support for inbound calls and emails...", "descriptionHtml": "

Provide tier I technical support for inbound calls and emails

", "salary": { "salaryText": "$20 - $22 an hour", "salaryType": "hourly", "salaryMax": 350, "salaryMin": 250, "salarySource": "EXTRACTION", "salaryCurrency": "USD" }, "age": "Just posted", "postedToday": true, "datePublished": "2025-02-24", "hiringDemand": { "isUrgentHire": true, "isHighVolumeHiring": false }, "organicApplyStarts": 11, "numOfCandidates": 3, "expired": false, "scrapingInfo": { "page": 12, // Page number where the job has been scraped "index": 3 // Job index in page }, "source": "American Heart Association", "jobUrl": "https://www.indeed.com/viewjob?jk=6ae7e4ae7ac60636", "applyUrl": "https://rr.jobsyn.org/9ECBB26665F341FCA3EAB747075CAA9B1554", "jobKey": "1e6e49448374145b", "language": "en", "locale": "en_US" }, { MORE JOBS ...} ] ``` --- ## 5. Additional Features - **Webhook**: If you also include a `webhook` object in the root JSON, the scraper can POST results to your specified URL upon completion. - **Pagination**: The scraper automatically handles multi-page results, but keep an eye on `maxRows` to limit your total returns. --- ## 6. Further Assistance - **Documentation & Support**: Use your RapidAPI dashboard or contact us directly via the RapidAPI platform. - **Common Errors**: Ensure required fields are present (`query`), your field values are valid (e.g., `jobType` in the correct set), and your `x-rapidapi-key` is correct. --- ### Country Code Mapping | Code | Description | |------|-------------| | ar | 🇦🇷 Argentina (AR) - ar.indeed.com | | au | 🇦🇺 Australia (AU) - au.indeed.com | | at | 🇦🇹 Austria (AT) - at.indeed.com | | bh | 🇧🇭 Bahrain (BH) - bh.indeed.com | | be | 🇧🇪 Belgium (BE) - be.indeed.com | | br | 🇧🇷 Brazil (BR) - br.indeed.com | | ca | 🇨🇦 Canada (CA) - ca.indeed.com | | cl | 🇨🇱 Chile (CL) - cl.indeed.com | | cn | 🇨🇳 China (CN) - cn.indeed.com | | co | 🇨🇴 Colombia (CO) - co.indeed.com | | cz | 🇨🇿 Czech Republic (CZ) - cz.indeed.com | | dk | 🇩🇰 Denmark (DK) - dk.indeed.com | | fi | 🇫🇮 Finland (FI) - fi.indeed.com | | fr | 🇫🇷 France (FR) - fr.indeed.com | | de | 🇩🇪 Germany (DE) - de.indeed.com | | gr | 🇬🇷 Greece (GR) - gr.indeed.com | | hk | 🇭🇰 Hong Kong (HK) - hk.indeed.com | | hu | 🇭🇺 Hungary (HU) - hu.indeed.com | | in | 🇮🇳 India (IN) - in.indeed.com | | id | 🇮🇩 Indonesia (ID) - id.indeed.com | | ie | 🇮🇪 Ireland (IE) - ie.indeed.com | | il | 🇮🇱 Israel (IL) - il.indeed.com | | it | 🇮🇹 Italy (IT) - it.indeed.com | | jp | 🇯🇵 Japan (JP) - jp.indeed.com | | kw | 🇰🇼 Kuwait (KW) - kw.indeed.com | | lu | 🇱🇺 Luxembourg (LU) - lu.indeed.com | | my | 🇲🇾 Malaysia (MY) - my.indeed.com | | mx | 🇲🇽 Mexico (MX) - mx.indeed.com | | ma | 🇲🇦 Morocco (MA) - ma.indeed.com | | nl | 🇳🇱 Netherlands (NL) - nl.indeed.com | | nz | 🇳🇿 New Zealand (NZ) - nz.indeed.com | | no | 🇳🇴 Norway (NO) - no.indeed.com | | om | 🇴🇲 Oman (OM) - om.indeed.com | | pe | 🇵🇪 Peru (PE) - pe.indeed.com | | ph | 🇵🇭 Philippines (PH) - ph.indeed.com | | pl | 🇵🇱 Poland (PL) - pl.indeed.com | | pt | 🇵🇹 Portugal (PT) - pt.indeed.com | | qa | 🇶🇦 Qatar (QA) - qa.indeed.com | | ro | 🇷🇴 Romania (RO) - ro.indeed.com | | ru | 🇷🇺 Russia (RU) - ru.indeed.com | | sa | 🇸🇦 Saudi Arabia (SA) - sa.indeed.com | | sg | 🇸🇬 Singapore (SG) - sg.indeed.com | | za | 🇿🇦 South Africa (ZA) - za.indeed.com | | kr | 🇰🇷 South Korea (KR) - kr.indeed.com | | es | 🇪🇸 Spain (ES) - es.indeed.com | | se | 🇸🇪 Sweden (SE) - se.indeed.com | | ch | 🇨🇭 Switzerland (CH) - ch.indeed.com | | tw | 🇹🇼 Taiwan (TW) - tw.indeed.com | | tr | 🇹🇷 Turkey (TR) - tr.indeed.com | | ua | 🇺🇦 Ukraine (UA) - ua.indeed.com | | ae | 🇦🇪 United Arab Emirates (AE) - ae.indeed.com | | uk | 🇬🇧 United Kingdom (UK) - uk.indeed.com | | us | 🇺🇸 United States (US) - www.indeed.com | | ve | 🇻🇪 Venezuela (VE) - ve.indeed.com | | vn | 🇻🇳 Vietnam (VN) - vn.indeed.com | ### Happy Scraping! Your Indeed job data is now just a few lines of code away. Use the **custom input** described in this README to fine-tune exactly which jobs you want to fetch. --- # ⬇️ 📦 **What Can You Extract?** (Detailled) ⬇️ ## 🚀 Job Essentials - **title** Example: `"Remote Customer Support Representative, Professional Services"` - **isRemote** Boolean: `true` / `false` - **jobType** Example: `["Full-time", "Remote"]` - **age** Example: `"Just posted"`, `"1 day ago"`, etc. - **postedToday** Boolean: `true` / `false` - **datePublished** Example: `"2025-02-24"` --- ### 🏢 Company Info - **companyName** Example: `"American Heart Association"` - **companyUrl** Example: `"https://www.indeed.com/cmp/American-Heart-Association"` - **companyLogoUrl** Direct link to the company's logo - **companyHeaderUrl** Image or banner link shown on the company profile - **rating** Object containing rating info, e.g.: ```json { "rating": 3.9, "count": 885 } ``` - **emails** Array of any emails found (e.g., `["hr@heart.jobs"]`) - **companyAddresses** E.g., `["Dallas, TX"]` - **companyNumEmployees** Example: `"1,001 to 5,000"` - **companyRevenue** Example: `"$500M to $1B (USD)"` - **companyIndustry** Example: `"ASSOCIATION"` - **companyDescription** Full text describing the company - **companyFounded** Object with founding year: ```json { "year": 1924 } ``` - **companyBriefDescription** Shorter summary of the company - **companyLinks** Social media links, official site, custom links, e.g.: ```json { "facebook": "https://facebook.com/... ", "instagram": "https://instagram.com/... ", "twitter": "", "customLinks": [ { "name": "AHA Careers Site", "url": "https://heart.jobs/" } ], "corporateWebsite": "http://www.heart.org" } ``` - **companyCeo** Object describing CEO (name, photo, etc.): ```json { "name": "Nancy A. Brown", "photoUrl": "https://...", "startDate": null } ``` --- ### 📍 Location & Geodata Most of these fields will be under a `location` object, for instance: - **countryCode** (e.g., `"US"`) - **country** (e.g., `"United States"`) - **city** (e.g., `"Dallas"`) - **postalCode** (e.g., `"75231"`) - **latitude** (e.g., `32.814034`) - **longitude** (e.g., `-96.815`) - **streetAddress** (e.g., `"7272 Greenville Ave."`) - **formattedAddressShort** (e.g., `"Dallas, TX"`) - **formattedAddressLong** (e.g., `"Dallas, Texas 75231-4596, US"`) - **fullAddress** (combined street, city, state, postal code, etc.) --- ### 💰 Compensation & Benefits - **salary** An object containing detailed pay data: ```json { "salaryText": "$20 - $22 an hour", "salaryType": "hourly", "salaryMax": 350, "salaryMin": 250, "salarySource": "EXTRACTION", "salaryCurrency": "USD" } ``` - **benefits** Example: `["Health insurance", "Paid time off", "Retirement plan"]` - **socialInsurance** Example: `["Health insurance"]` --- ### 📃 Description & Requirements - **descriptionText** Plain-text version of the job description - **descriptionHtml** HTML-rich version of the job description - **occupation** Example: `["Customer Support & Client Services Occupations"]` - **attributes** E.g., `["Bilingual", "Microsoft Word", "Wellness program"]` - **requirements** Array with `label` + `requirementSeverity`: ```json [ { "label": "Engineering", "requirementSeverity": "REQUIRED" }, { "label": "Ability to lift 50 pounds", "requirementSeverity": "PREFERRED" } ] ``` - **shiftAndSchedule** Example: `["Monday to Friday"]` - **workingSystem** Example: `["Remote", "On-site", "Hybrid"]` --- ### 📝 Application & Hiring Details - **jobUrl** Indeed listing link (e.g., `"https://www.indeed.com/viewjob?jk=... "`) - **applyUrl** Direct link for applying to the job (when available) - **hiringDemand** Indicates urgency or volume: ```json { "isUrgentHire": true, "isHighVolumeHiring": false } ``` - **organicApplyStarts** Number of users who initiated an application - **numOfCandidates** Approximate number of applicants - **expired** Boolean indicating if the job is no longer active --- ### 🌐 Language & Locale - **language** (e.g., `"en"`) - **locale** (e.g., `"en_US"`) --- ### 🔎 Scraping Metadata - **jobKey** Unique identifier for the job post (e.g., `"1e6e49448374145b"`) - **source** Where the listing originated (e.g., `"American Heart Association"`) - **scrapingInfo** Object containing: ```json { "page": 12, // Page number of the scraped listing "index": 3 // Position of the job in that page } ``` ---