Quickstart

Get your API key

Create a key in the dashboard. New accounts start with free trial credits — no card required.

export UP2DATA_API_KEY="u2d_live_..."

Keys are secrets. Keep them server-side — never ship them in browser or mobile code.

Enrich your first profile

Send any public LinkedIn URL. The scrape happens live, at request time.

curl -X POST https://api.up2data.ai/v1/profiles/enrich \
  -H "X-API-Key: $UP2DATA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://linkedin.com/in/satyanadella"
  }'

import requests

resp = requests.post(
    "https://api.up2data.ai/v1/profiles/enrich",
    headers={"X-API-Key": UP2DATA_API_KEY},
    json={"url": "https://linkedin.com/in/satyanadella"},
)
profile = resp.json()["data"]
print(profile["full_name"], "—", profile["headline"])

const resp = await fetch("https://api.up2data.ai/v1/profiles/enrich", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.UP2DATA_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://linkedin.com/in/satyanadella" }),
});
const { data, meta } = await resp.json();
console.log(data.full_name, "·", meta.creditsUsed, "credit");

Read the response

Every response carries your data plus billing metadata, so you always know what a call cost:

{
  "data": {
    "full_name": "Satya Nadella",
    "headline": "Chairman and CEO at Microsoft",
    "location": { "city": "Redmond", "country": "United States" },
    "current_company": { "name": "Microsoft" }
  },
  "meta": {
    "creditsUsed": 1,
    "creditsRemaining": 9999,
    "billed": true,
    "reason": "profile_found",
    "requestId": "req_8f2ka91x"
  }
}

If the scrape fails — profile deleted, timeout, whatever — billed is false and the credit stays yours. See Pay-on-success.

Scale it up

Going past a handful of records? Use the async batch endpoint — up to 1,000 items per job, any entity type, delivered to a webhook:

curl -X POST https://api.up2data.ai/v1/batch \
  -H "X-API-Key: $UP2DATA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "type": "profile", "url": "https://linkedin.com/in/a" },
      { "type": "company", "url": "https://linkedin.com/company/acme" }
    ],
    "webhook_url": "https://app.example.com/hooks/up2data"
  }'

The Bulk enrichment guide covers batching, webhooks and polling.

Next steps

Watch for changes with Signals

Job changes, headcount moves, new posts — pushed to your webhook.

Browse the API Reference

Try every endpoint from the interactive playground.

Connect the MCP server

Give Claude, Cursor, or VS Code the full API as tools.

Use the CLI

npx -y up2data login and run the whole API from your shell.

Getting started

CLI & MCP

Concepts

Next steps

Watch for changes with Signals

Browse the API Reference

Connect the MCP server

Use the CLI

​Next steps

Watch for changes with Signals

Browse the API Reference

Connect the MCP server

Use the CLI

Next steps