API reference
LinkedIn Company Record API
The enriched record for one company: industry, description, type, size band, headcount and its change over a month, quarter and year, followers, founding year, headquarters, revenue and funding where known, and open-role count. Distinct from linkedin/company, which answers what the public page shows.
Endpoint
/v1/linkedin/company-profilelive · proven5 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
handle | no | Company handle (the URL slug) | google |
url | no | Full company URL, instead of the handle | https://www.linkedin.com/company/google |
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. | 1 |
judgments | no | Add bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. | on |
label | no | Set none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. | none |
label_evidence | no | Include exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. | 1 |
exclude | no | Optionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. | engagement_bait |
fit | no | Use goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. | goal |
goal | no | Required with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts. | Find concrete product complaints |
tokens | no | Optional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it. | 4000 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/linkedin/company-profile?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fgoogle" \ -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-profile?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fgoogle",
{ 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-profile?url=https%3A%2F%2Fwww.linkedin.com%2Fcompany%2Fgoogle",
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-profile",
"data": {
"cover": "example",
"description": "example",
"employees": 0,
"employees_range": "example",
"followers": 0,
"handle": "example",
"hq": {
"city": "example",
"country": "example",
"line": "example",
"postal_code": "example",
"region": "example"
},
"id": "example",
"industries": [
"example"
],
"logo": "example",
"name": "example",
"platform": "example",
"specialities": [
"example"
],
"url": "https://example.com/example",
"website": "example"
},
"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: observed response shapes, not an exhaustive field specification. 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 |
|---|---|---|
cover | string | null | Optional cover supplied by this operation. Null means unknown. |
description | string | null | Source description; null or absent means not supplied. |
employees | number | null | Optional employees supplied by this operation. Null means unknown. |
employees_range | string | null | Optional employees range supplied by this operation. Null means unknown. |
followers | number | null | Optional followers supplied by this operation. Null means unknown. |
handle | string | null | Optional handle supplied by this operation. Null means unknown. |
hq | object | null | Optional hq supplied by this operation. Null means unknown. |
hq.city | string | null | Optional city supplied by this operation. Null means unknown. |
hq.country | string | null | Optional country supplied by this operation. Null means unknown. |
hq.line | string | null | Optional line supplied by this operation. Null means unknown. |
hq.postal_code | string | null | Optional postal code supplied by this operation. Null means unknown. |
hq.region | string | null | Optional region supplied by this operation. Null means unknown. |
id | string | null | Source identifier. Preserve the supplied type and exact value. |
industries | array | null | Optional industries supplied by this operation. Null means unknown. |
logo | string | null | Optional logo supplied by this operation. Null means unknown. |
name | string | null | Optional name supplied by this operation. Null means unknown. |
platform | string | null | Optional platform supplied by this operation. Null means unknown. |
specialities | array | null | Optional specialities supplied by this operation. Null means unknown. |
url | string | null | Original source URL when supplied. |
website | string | null | Optional website supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
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