Node.js/TypeScript client for fetching data from LinkedIn for free.
npm install linkedin-api-tsThe apiKey is not an API key issued by LinkedIn — LinkedIn does not give those out. It is a base64 encoding of your own LinkedIn session cookies (li_at and JSESSIONID), which is what the library sends with every request to authenticate as you.
- Log in to linkedin.com in your browser (use an incognito window for a longer-lived session — cookies can last up to 1 year)
- Open DevTools (
F12orCmd+Shift+I) - Go to Application → Cookies →
https://www.linkedin.com - Copy the values of:
li_at— your session tokenJSESSIONID— your CSRF token (remove surrounding quotes if present)
import { encodeApiKey } from 'linkedin-api-ts';
const apiKey = encodeApiKey({
li_at: 'your_li_at_value',
JSESSIONID: 'your_jsessionid_value',
});
console.log(apiKey); // Use this as your API keyOr encode manually:
echo -n '{"li_at":"your_li_at_value","JSESSIONID":"your_jsessionid_value"}' | base64import { LinkedIn } from 'linkedin-api-ts';
const linkedin = new LinkedIn({ apiKey: 'BASE64_ENCODED_API_KEY' });
// Verify your session is valid
const isValid = await linkedin.auth.verify();
console.log('Session valid:', isValid);
// Fetch a profile
const profile = await linkedin.profile.details('williamhgates');
console.log(profile.fullName); // "Bill Gates"
console.log(profile.headline); // "Co-chair, Bill & Melinda Gates Foundation"
console.log(profile.experiences); // Work history
console.log(profile.education); // Education history
console.log(profile.skills); // Skills with endorsement counts
console.log(profile.projects); // Personal/professional projects
console.log(profile.publications); // Published works
// Get raw Voyager API response
console.log(profile.raw);
// Serialize to JSON
console.log(profile.toJSON());const results = await linkedin.search.people('software engineer', {
start: 0, // Pagination offset (default: 0)
});
console.log(results.total); // Total matching people
console.log(results.results.length); // Results in this page
for (const person of results.results) {
console.log(person.fullName); // "John Doe"
console.log(person.headline); // "Software Engineer at Google"
console.log(person.location); // "San Francisco Bay Area"
console.log(person.username); // "johndoe"
console.log(person.profileUrl); // "https://www.linkedin.com/in/johndoe"
console.log(person.profilePicture); // URL or null
}
// Pagination
const page2 = await linkedin.search.people('software engineer', { start: 10 });
// Raw response & serialization
console.log(results.raw); // Raw Voyager API response
console.log(results.toJSON()); // JSON-serializableRotate session cookies without creating a new client:
linkedin.apiKey = 'NEW_BASE64_KEY';profile.toJSON() returns structured data like this:
{
"username": "williamhgates",
"firstName": "Bill",
"lastName": "Gates",
"fullName": "Bill Gates",
"headline": "Co-chair, Bill & Melinda Gates Foundation",
"location": "Seattle, Washington, United States",
"profilePicture": "https://media.licdn.com/dms/image/...",
"summary": "Co-chair of the Bill & Melinda Gates Foundation. Founder of Breakthrough Energy...",
"url": "https://www.linkedin.com/in/williamhgates",
"experiences": [
{
"title": "Co-chair",
"company": "Bill & Melinda Gates Foundation",
"location": "Seattle, Washington, United States",
"startDate": "2000-01",
"endDate": null,
"description": null,
"employmentType": "Full-time"
},
{
"title": "Founder",
"company": "Breakthrough Energy",
"location": null,
"startDate": "2015-01",
"endDate": null,
"description": null,
"employmentType": null
}
],
"education": [
{
"school": "Harvard University",
"degree": null,
"field": null,
"startDate": "1973",
"endDate": "1975"
}
],
"skills": [
{ "name": "Public Speaking", "endorsementCount": 99 },
{ "name": "Entrepreneurship", "endorsementCount": 99 },
{ "name": "Strategic Planning", "endorsementCount": 82 }
],
"certifications": [],
"languages": [{ "name": "English", "proficiency": "Native or bilingual" }],
"projects": [],
"publications": []
}const linkedin = new LinkedIn({
apiKey: 'BASE64_ENCODED_API_KEY', // Required for authenticated access
proxyUrl: 'http://proxy:8080', // HTTP/HTTPS/SOCKS4/SOCKS5 proxy URL
timeout: 10000, // Request timeout in ms (default: 10000)
delay: 200, // Delay between requests in ms (default: 200)
maxRetries: 3, // Retry attempts on failure (default: 3)
logging: false, // Enable debug logging (default: false)
errorHandler: customErrorHandler, // Custom error handler (see below)
});import type { IErrorHandler } from 'linkedin-api-ts';
const errorHandler: IErrorHandler = {
handle(error: Error): void {
// Your custom error handling logic
console.error('LinkedIn API error:', error.message);
},
};The results.toJSON() method returns an ISearchResult object:
{
results: IPersonResult[];
total: number; // Total matching people
start: number; // Pagination offset
count: number; // Page size
}Each IPersonResult:
{
fullName: string;
headline: string | null;
location: string | null;
profilePicture: string | null;
profileUrl: string;
username: string | null;
}The profile.toJSON() method returns an IProfile object:
{
username: string;
firstName: string;
lastName: string;
fullName: string;
headline: string | null;
location: string | null;
profilePicture: string | null; // URL
summary: string | null;
url: string; // LinkedIn profile URL
experiences: IExperience[];
education: IEducation[];
skills: ISkill[];
certifications: ICertification[];
languages: ILanguage[];
projects: IProject[];
publications: IPublication[];
}Nested types
interface IExperience {
title: string;
company: string;
location: string | null;
startDate: string | null;
endDate: string | null;
description: string | null;
employmentType: string | null;
}
interface IEducation {
school: string;
degree: string | null;
field: string | null;
startDate: string | null;
endDate: string | null;
}
interface ISkill {
name: string;
endorsementCount: number;
}
interface ICertification {
name: string;
authority: string | null;
startDate: string | null;
endDate: string | null;
}
interface ILanguage {
name: string;
proficiency: string | null;
}
interface IProject {
title: string;
description: string | null;
url: string | null;
startDate: string | null;
endDate: string | null;
}
interface IPublication {
name: string;
description: string | null;
url: string | null;
publisher: string | null;
publishedOn: string | null;
}The library throws specific errors you can catch:
import { SessionExpiredError, RateLimitError, ProfileNotFoundError } from 'linkedin-api-ts';
// Works for both profile and search calls
try {
const profile = await linkedin.profile.details('username');
} catch (error) {
if (error instanceof SessionExpiredError) {
// Session cookie has expired — get a new li_at cookie
} else if (error instanceof RateLimitError) {
// Too many requests — back off and retry later
} else if (error instanceof ProfileNotFoundError) {
// Username doesn't exist
}
}LinkedIn enforces rate limits on API usage. The library includes built-in request delays and retry logic, but you should still be mindful of how many requests you make. Excessive usage may result in your account being temporarily or permanently restricted. See LinkedIn's Commercial Use Limit for more details.
Your li_at and JSESSIONID cookies are equivalent to a logged-in LinkedIn session — treat them like passwords. Never commit them, never log them in plain text, and rotate them if you suspect they have leaked.
If you find a vulnerability in how this library handles credentials or request data, please report it privately via GitHub Security Advisories instead of opening a public issue.
- Browser extension ("LinkedIn Auth Helper") — one-click
apiKeygeneration for non-programmers - CLI tool
- Company page scraping
- Job search
MIT — This project is not affiliated with or endorsed by LinkedIn. Using your account's session cookies may risk account restriction. Use responsibly.