API reference
LinkedIn Company Page API
A company's public LinkedIn page: industry, size, headquarters, follower and employee counts.
Endpoint
/v1/linkedin/companylive · proven5 creditsParameters
Query parameters
Useful optional inputs
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
url | no | Company LinkedIn URL. Supply either this or domain; do not combine them. | https://www.linkedin.com/company/nasa/ |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
domain | no | Alternative to a company URL: discover a bounded set of indexed LinkedIn company pages, then verify an exact returned website hostname. Existing price and limits apply. Ambiguous, missing or unverified matches abstain; this is not exhaustive company search or proof of domain ownership. | microsoft.com |
Examples
Make the request
curl "https://www.monocrawl.com/v1/linkedin/company?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fnasa%2F" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/linkedin/company?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fnasa%2F",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/linkedin/company?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fnasa%2F",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "linkedin",
"endpoint": "/v1/linkedin/company",
"data": {
"id": "12345",
"name": "Example Company",
"handle": "example-company",
"size": "11-50",
"followers": 1200
},
"credits_used": 5,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: reviewed response shaper. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
name | string | null | Company name. |
handle | string | null | Public company identifier. |
url | string | null | Original source URL when supplied. |
description | string | null | Company description. |
website | string | null | Original source URL when supplied. |
industry | string | null | Primary reported industry. |
size | string | null | Source employee range, not an exact count. |
founded | number | null | Founding year. |
followers | number | null | Followers reported by the source; null or absent is unknown, not zero. |
employees_count | number | null | Reported employees reported by the source; null or absent is unknown, not zero. |
headquarters | string | null | Readable headquarters location. |
domain_lookup | object | Nested response fields; optional unless explicitly documented. |
domain_lookup.domain | string | null | Requested website hostname. |
domain_lookup.status | string | null | verified on success; unverified on failure. |
domain_lookup.match | string | null | exact_website_domain means the returned company website matched; not domain ownership. |
domain_lookup.candidates_found | number | null | Indexed candidate URLs reported by the source; null or absent is unknown, not zero. |
domain_lookup.candidates_checked | number | null | Checked URLs, at most three reported by the source; null or absent is unknown, not zero. |
domain_lookup.candidates_omitted | number | null | Indexed URLs not checked reported by the source; null or absent is unknown, not zero. |
domain_lookup.exact_matches | number | null | Distinct source company IDs with a verified website match reported by the source; null or absent is unknown, not zero. |
domain_lookup.exact_match_pages | number | null | Verified matching URLs before native-ID grouping reported by the source; null or absent is unknown, not zero. |
domain_lookup.verified_candidates | array | Nested response fields; optional unless explicitly documented. |
domain_lookup.verified_candidates[].id | string | null | Source identifier. Preserve its exact string value; do not convert large IDs to numbers. |
domain_lookup.verified_candidates[].name | string | null | Source company name, capped at 300 characters. |
domain_lookup.verified_candidates[].url | string | null | Original source URL when supplied. |
domain_lookup.verified_candidates[].website | string | null | Original source URL when supplied. |
domain_lookup.verified_candidates[].matched_urls | array | Checked aliases joined only by an identical native company ID. |
_warnings | array | Collection limitations or component warnings. Read before interpreting coverage. |
Domain lookup checks a bounded indexed sample. Distinct company IDs sharing a website remain ambiguous; error.details.domain_lookup retains verified_candidates for inspection.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference