Skip to content

SocQAPI/linkedin-profiles-api

Repository files navigation

LinkedIn Profiles API examples for SocQ

LinkedIn Profiles API API documentation License: MIT Check examples

Retrieve public LinkedIn profiles from /in/{slug} URLs with normalized identity and current role, career history, skills, location, and visible audience counts.

Try LinkedIn Profiles API · Get an API key · Documentation · All SocQ examples

Use cases

  • Contact and candidate enrichment: Add current role, company, location, experience, education, and skills to records linked to known profile URLs.
  • Career-path research: Use structured experience and education sections to examine role progression and professional background.
  • Public profile monitoring: Compare saved profile snapshots to identify changes in position, current company, skills, or visible audience counts.
  • Build role and skill directories: Group selected public profiles by current role, company, location, experience, education, and skills for structured research.

API behavior

  • Submit one or more public LinkedIn profile URLs using the /in/{slug} path.
  • Company pages, posts, feeds, and job URLs are not accepted as profile inputs.
  • Experience, education, skills, location, and audience counts are optional public fields and can be empty.
  • Each result is a point-in-time public snapshot; retain collected_at when comparing profile changes.

All requests use the shared asynchronous flow:

submit -> task_id -> poll task -> read every cursor page -> save results

Quick start

cp .env.example .env
export SOCQ_API_KEY="your-api-key"

Run the complete Node.js workflow:

cd node
npm start

Run the complete Python workflow:

python3 -m pip install -r python/requirements.txt
python3 python/main.py

Both examples load payload.example.json, retry transient API responses, wait for task completion, read every cursor page, and save a normalized public professional-profile dataset for enrichment and research to output/results.json.

Never expose SOCQ_API_KEY in browser code, mobile apps, public repositories, screenshots, fixtures, or logs.

Request

POST https://api.socq.ai/v1/linkedin/profiles
Authorization: Bearer <SOCQ_API_KEY>
Content-Type: application/json
{
  "urls": [
    "https://www.linkedin.com/in/example-profile"
  ]
}

The submit response contains data.task_id. Poll the task endpoint until data.status becomes succeeded or failed, then continue with data.results.next_cursor while data.results.has_more is true.

Complete workflow example

The Node.js and Python programs implement the production-shaped happy path:

  1. Load and validate configuration.
  2. Submit the endpoint-specific payload.
  3. Retry rate-pressure and transient server responses with bounded backoff.
  4. Poll the asynchronous task with a ten-minute application timeout.
  5. Stop cleanly on a failed task and surface the public error message.
  6. Read all cursor pages instead of silently returning only the first page.
  7. Write a stable JSON artifact containing task metadata and normalized records.

Use the synthetic files in fixtures/ for tests and documentation. They do not contain customer, account, or production data.

Production notes

See docs/production-notes.md for validation, retry, timeout, pagination, deduplication, logging, and endpoint-specific guidance.

Responsible use and platform scope

  • Use only publicly accessible LinkedIn profiles, company pages, posts, job listings, and fields supported by the selected endpoint.
  • Do not use the examples to access private member data, restricted pages, login-only surfaces, or authentication controls.
  • SocQ is not an official API of the represented social platform and is not affiliated with or endorsed by that platform.
  • Before production use, assess the laws, platform terms, privacy obligations, and retention requirements that apply to your organization and use case.
  • Collect only the fields needed for a defined purpose, restrict access, set retention periods, and support correction or deletion workflows where required.
  • Platform names and trademarks belong to their respective owners.

This section describes the public-data boundary; it is not legal advice or a guarantee that every use case is permitted in every jurisdiction.

Repository contents

Path Purpose
curl/request.md Copy-paste submit, poll, and pagination requests
node/index.mjs Complete Node.js workflow
python/main.py Complete Python workflow
payload.example.json Safe endpoint-specific request body
fixtures/ Synthetic submit and task response shapes
docs/production-notes.md Production integration guidance

About

Complete cURL, Node.js, and Python examples for SocQ LinkedIn Profiles API.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages