Docs
View as Markdown

linkedin.article

beta 2 credits needs a pack

LinkedIn Pulse article: title, text, author and counts.

GET /v1/linkedin/article

What you get#

One LinkedIn record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • 2 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
urlstringyes(required)Full URL of the LinkedIn Pulse articlemax 500 chars; must match https://([a-z]{2,3}\.)?linkedin\.com/[A-Za-z0-9\-_%./:()?=&+~@,]{1,400}; trimmed

Request#

curl "https://api.onekey.dev/v1/linkedin/article?url=https%3A%2F%2Fwww.linkedin.com%2Fpulse%2Fexample-article-jane-doe" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real LinkedIn response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "content": {
      "url": "https://www.linkedin.com/in/example-0",
      "title": "Example title 0",
      "text": "Example text 0",
      "createdAt": "2025-03-01T10:00:00Z"
    },
    "author": {
      "displayName": "Example name 0",
      "url": "https://www.linkedin.com/in/example-0"
    },
    "engagement": {
      "likes": 100,
      "comments": 100
    }
  },
  "metadata": {
    "platform": "linkedin",
    "endpoint": "article",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
urlcontent.urlsafeUrl
titlecontent.title-
textcontent.text-
publishedAtcontent.createdAttoIsoDate
author.nameauthor.displayName-
author.urlauthor.urlsafeUrl
reactionCountengagement.likestoNumber
commentCountengagement.commentstoNumber

Caching and freshness#

  • Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
  • Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).