Files
linkedin-jobs-api/README.md
2022-06-29 16:29:49 +05:30

3.4 KiB


LinkedIn Jobs API

Features

  • Lightening Fast
  • Minimal
  • 🪶 Lightweight
  • 🔥 Advanced Filters
  • 🤩 Support all Frameworks

How to Install ?

Use npm or yarn to install this npm package

npm i linkedin-jobs-api

or

yarn add linkedin-jobs-api

Include the package

const linkedIn = require('linkedin-jobs-api');

Basic Example:

const linkedIn = require('linkedin-jobs-api');

const queryOptions = {
  keyword: 'software engineer',
  location: 'India',
  dateSincePosted: 'past Week',
  jobType: 'full time',
  remoteFilter: 'remote',
  salary: '100000',
  experienceLevel: 'entry level',
  limit: '10'
};

linkedIn.query(queryOptions).then(response => {
	console.log(response); // An array of Job objects
});

Query Object Parameters

query() accepts a queryOptions object and returns an array of Job objects.

Parameter LinkedIn Default value Description
keyword "" string - The text to search: (i.e. Software Developer)
location "" string - The name of the city: (i.e. Los Angeles)
dateSincePosted "" string - Max range of jobs: past month, past week, 24hr
jobType "" string - Type of position: full time, part time, contract, temporary, volunteer, internship
remoteFilter "" string - Filter telecommuting: on site, remote, hybrid
salary "" string - Minimum Salary: 40000, 60000, 80000, 100000, 120000
experienceLevel "" string - internship, entry level, associate, senior, director, executive
limit "" string - Number of jobs returned: (i.e. '1', '10', '100', etc)
sortBy "" string - recent, relevant

Job Objects

Paramter Description (Default: null)
position string - Position title
company string - Company name
location string - Location of the job
date string - Date the job was posted
salary string - Salary range
jobUrl string - URL of the job page

Contributing

Feel free to contribute!

  1. Fork the repository
  2. Make changes
  3. Submit a pull request