![\"People](\"https://www.peopledatalabs.com/images/logos/company-logo.png\"){kind=logo}
\n\n\n
\nJavaScript client with TypeScript support for the People Data Labs API.\n
\n\n\n\n#\n\nThis is a simple JavaScript client library to access the various API endpoints provided by [People Data Labs](https://www.peopledatalabs.com/).\n\nThis library bundles up PDL API requests into simple function calls, making it easy to integrate into your projects. You can use the various [API endpoints](#endpoints) to access up-to-date, real-world data from our massive [Person](https://docs.peopledatalabs.com/docs/stats) and [Company](https://docs.peopledatalabs.com/docs/company-stats) Datasets. \n\n## ✨ Features\n\n- Supports all People Data Labs API endpoints\n- Built-in Typescript support\n\n## Table of Contents\n\n- [🔧 Installation](#installation)\n- [🚀 Usage](#usage)\n- [🌐 Endpoints](#endpoints)\n- [📘 Documentation](#documentation)\n - [Special Note about Search API Support](#special-note)\n - [Upgrading to v6.X.X](#upgrading-to-v6)\n - [Upgrading to v5.X.X](#upgrading-to-v5)\n\n## 🔧 Installation \n\n1. Pull the package from the npm repository:\n\n```bash\nyarn add peopledatalabs\n```\n\nor\n\n```bash\nnpm i peopledatalabs\n```\n\n2. If you get a error while running a typescript project, add `\"esModuleInterop\": true` to your tsconfig\n\n3. Sign up for a [free PDL API key](https://www.peopledatalabs.com/signup)\n\n## 🚀 Usage \n\nFirst, create the PDLJS client:\n\n```js\nimport PDLJS from 'peopledatalabs';\n\nconst PDLJSClient = new PDLJS({ apiKey: 'YOUR API KEY' })\n```\n\nThen, send requests to any PDL API Endpoint:\n\n**Using Person APIs**\n\n```js\n// By Enrichment\ntry {\n const response = await PDLJSClient.person.enrichment({ phone: '4155688415' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// By Preview Enrichment\ntry {\n const response = await PDLJSClient.person.enrichmentPreview({ phone: '4155688415' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// By Bulk Enrichment\nconst bulkEnrichmentRecords = {\n requests: [\n {\n params: {\n profile: ['linkedin.com/in/seanthorne'],\n },\n },\n {\n params: {\n profile: ['linkedin.com/in/randrewn'],\n },\n },\n ],\n};\n\ntry {\n const response = await PDLJSClient.person.bulk.enrichment(bulkEnrichmentRecords);\n\n console.log(response.items);\n} catch (error) {\n console.log(error);\n}\n\n// By Search (SQL)\nconst sqlQuery = \"SELECT * FROM person WHERE location_country='mexico' AND job_title_role='health'AND phone_numbers IS NOT NULL;\"\n\ntry {\n const response = await PDLJSClient.person.search.sql({ searchQuery: sqlQuery, size: 10 });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n// By Search (Elasticsearch)\nconst esQuery = {\n query: {\n bool: {\n must:[\n { term: { location_country: 'mexico' } },\n { term: { job_title_role: 'health' } },\n { exists: { field: 'phone_numbers' } }\n ]\n }\n }\n}\n\ntry {\n const response = await PDLJSClient.person.search.elastic({ searchQuery: esQuery, size: 10 });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n// By Fuzzy Enrichment\ntry {\n const response = await PDLJSClient.person.identify({ name: 'sean thorne' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// By Changelog\nconst personChangelogLookup = {\n currentVersion: '31.2',\n originVersion: '32.0',\n type: 'updated',\n}\n\ntry {\n const response = await PDLJSClient.person.changelog(personChangelogLookup);\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n```\n\n**Using Company APIs**\n\n```js\n// By Enrichment\ntry {\n const response = await PDLJSClient.company.enrichment({ website: 'peopledatalabs.com' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// By Bulk Enrichment\nconst bulkEnrichmentRecords = {\n requests: [\n {\n params: {\n profile: 'linkedin.com/in/peopledatalabs',\n },\n },\n {\n params: {\n profile: 'linkedin.com/in/apple',\n },\n },\n ],\n};\n\ntry {\n const response = await PDLJSClient.company.bulk.enrichment(bulkEnrichmentRecords);\n\n console.log(response.items);\n} catch (error) {\n console.log(error);\n}\n\n// By Search (SQL)\nconst sqlQuery = \"SELECT * FROM company WHERE tags='big data' AND industry='financial services' AND location.country='united states';\"\n\ntry {\n const response = await PDLJSClient.company.search.sql({ searchQuery: sqlQuery, size: 10 });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n// By Search (Elasticsearch)\nconst esQuery = {\n query: {\n bool: {\n must:[\n { term: { tags: 'big data' } },\n { term: { industry: 'financial services' } },\n { term: { location_country: 'united states' } }\n ]\n }\n }\n}\n\ntry {\n const response = await PDLJSClient.company.search.elastic({ searchQuery: esQuery, size: 10 });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n```\n\n**Using Autocomplete API**\n\n```js\n// Get Autocomplete Suggestions\ntry {\n const response = await PDLJSClient.autocomplete({ field: 'title', text: 'full', size: 10 });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n```\n\n**Using Cleaner APIs**\n\n```js\n// Clean Raw Company Strings\ntry {\n const response = await PDLJSClient.company.cleaner({ name: 'peOple DaTa LabS' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// Clean Raw Location Strings\ntry {\n const response = await PDLJSClient.location.cleaner({ location: '455 Market Street, San Francisco, California 94105, US' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// Clean Raw School Strings\ntry {\n const response = await PDLJSClient.school.cleaner({ name: 'university of oregon' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n```\n\n**Using Job Title Enrichment API**\n\n```js\n// Enrich a Job Title\ntry {\n const response = await PDLJSClient.jobTitle({ jobTitle: 'software engineer' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n```\n\n**Using Job Posting Search API**\n\n```js\n// By Search (Elasticsearch query)\nconst esQuery = {\n query: {\n bool: {\n must: [\n { term: { title_role: 'engineering' } },\n { term: { remote_work_policy: 'remote' } },\n ],\n },\n },\n}\n\ntry {\n const response = await PDLJSClient.jobPosting.search({ ...esQuery, size: 10 });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n// By Search (field parameters)\ntry {\n const response = await PDLJSClient.jobPosting.search({\n title_role: 'engineering',\n remote_work_policy: 'remote',\n is_active: true,\n size: 10,\n });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n```\n\n**Using IP Enrichment API**\n\n```js\n// Enrich an IP Address\ntry {\n const response = await PDLJSClient.ip({ ip: '72.212.42.228' });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n```\n\n**Using Sandbox APIs**\n\n```js\n// By Person Enrichment\ntry {\n const response = await PDLJSClient.person.enrichment({\n email: 'reneewillis74@aol.com',\n sandbox: true,\n });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// By Person Search (SQL)\ntry {\n const response = await PDLJSClient.person.search.sql({\n searchQuery: \"SELECT * FROM person WHERE location_country='united states';\",\n size: 10,\n sandbox: true,\n });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n// By Person Search (Elasticsearch)\nconst esQuery = {\n query: {\n bool: {\n must:[\n { term: { location_country: 'united states' } }\n ]\n }\n }\n}\n\ntry {\n const response = await PDLJSClient.person.search.elastic({ searchQuery: esQuery, size: 10, sandbox: true });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n// By Person Fuzzy Enrichment\ntry {\n const response = PDLJSClient.person.identify({ email: 'reneewillis74@aol.com', sandbox: true });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// By Company Enrichment\ntry {\n const response = await PDLJSClient.company.enrichment({ website: 'kohlerinteriors.com', sandbox: true });\n\n console.log(response);\n} catch (error) {\n console.log(error);\n}\n\n// By Company Search (SQL)\nconst sqlQuery = \"SELECT * FROM company WHERE tags='hotel consultant' AND industry='hospitality';\"\n\ntry {\n const response = await PDLJSClient.company.search.sql({ searchQuery: sqlQuery, size: 10, sandbox: true });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n\n// By Company Search (Elasticsearch)\nconst esQuery = {\n query: {\n bool: {\n must:[\n { term: { tags: 'hotel consultant' } },\n { term: { industry: 'hospitality' } }\n ]\n }\n }\n}\n\ntry {\n const response = await PDLJSClient.company.search.elastic({ searchQuery: esQuery, size: 10, sandbox: true });\n\n console.log(response.total);\n} catch (error) {\n console.log(error);\n}\n```\n\n## 🌐 Endpoints \n\n**Person Endpoints**\n| API Endpoint | PDLJS Function |\n|-|-|\n| [Person Enrichment API](https://docs.peopledatalabs.com/docs/enrichment-api) | `PDLJS.person.enrichment({ ...params })` |\n| [Person Preview Enrichment API](https://docs.peopledatalabs.com/docs/preview-enrichment-api) | `PDLJS.person.enrichmentPreview({ ...params })` |\n| [Person Bulk Person Enrichment API](https://docs.peopledatalabs.com/docs/bulk-enrichment-api) | `PDLJS.person.bulk.enrichment({ ...records })` |\n| [Person Search API](https://docs.peopledatalabs.com/docs/search-api) | SQL: `PDLJS.person.search.sql({ ...params })`![\"Repo](\"https://img.shields.io/badge/repo%20status-Active-limegreen\"){kind=icon}
\n ![\"People](\"https://img.shields.io/npm/v/peopledatalabs.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen\")
\n ![\"Tests](\"https://github.com/peopledatalabs/peopledatalabs-js/actions/workflows/test.yaml/badge.svg\"){kind=icon}
\n