Skip to content
ScrapeField

Documentation

The ScrapeField API

45 endpoints over five platforms, each returning that platform’s data in its own documented shape, with a published credit cost per call. Every page here is generated from the definition the API runs on, so it cannot fall out of date. Which ones answer right now is on the status page.

How it works

  • Every read is a GET to https://api.scrapefield.com/v1 with query parameters, and every answer is JSON.
  • You authenticate with a key in the Authorization header. Authentication
  • A call costs the credits published for its endpoint, cached or not. A call we fail costs nothing and is refunded automatically. Credits and billing
  • A new account gets 2,000 credits to try it, once its email address is confirmed.

You can try any endpoint before you have an account: add demo=true and it answers with one fixed sample in the real shape, the same whatever you ask, for free.

const params = new URLSearchParams({
  "username": "ferrari",
  "demo": "true"
});

const res = await fetch(`https://api.scrapefield.com/v1/tiktok/profile?${params}`);

const { data, meta } = await res.json();
console.log(data, meta.credits_charged);

Start here

The API, by platform

LinkedIn

18 endpoints

Profiles, people and company search, posts with their comments and reactions, jobs and the Ad Library, named the way LinkedIn prints them.

GET /v1/linkedin/profile

Get a LinkedIn profile

linkedin_profile7–33 credits
GET /v1/linkedin/company

Get a LinkedIn company page

linkedin_company3 credits
GET /v1/linkedin/employee-stats

Count a company's people on LinkedIn

linkedin_employee_stats7 credits
GET /v1/linkedin/employees

Get the people at a company, from LinkedIn

linkedin_lead[]170 credits
GET /v1/linkedin/people

Search people on LinkedIn

linkedin_member[]7–170 credits
GET /v1/linkedin/services

Find people who offer services on LinkedIn

linkedin_member[]7 credits
GET /v1/linkedin/companies

Search companies on LinkedIn

linkedin_company_result[]7 credits
GET /v1/linkedin/posts

Get or search LinkedIn posts

linkedin_post[]3–7 credits
GET /v1/linkedin/post

Get one LinkedIn post

linkedin_post3 credits
GET /v1/linkedin/comments

Get the comments on a LinkedIn post

linkedin_comment[]7 credits
GET /v1/linkedin/reactions

Get who reacted to a LinkedIn post

linkedin_reaction[]7 credits
GET /v1/linkedin/activity

Get a person's LinkedIn comments and reactions

linkedin_activity[]7 credits
GET /v1/linkedin/jobs

Search LinkedIn job postings

linkedin_job[]3 credits
GET /v1/linkedin/job

Get one LinkedIn job posting in full

linkedin_job3 credits
GET /v1/linkedin/ads

Search LinkedIn's Ad Library

linkedin_ad[]3 credits
GET /v1/linkedin/ad

Get one ad from LinkedIn's Ad Library

linkedin_ad7 credits
GET /v1/linkedin/group

Get one LinkedIn group

linkedin_group7 credits
GET /v1/linkedin/groups

Search LinkedIn groups

linkedin_group[]7 credits

For machines

  • OpenAPI spec: complete, with x-credits on every operation.
  • llms.txt and llms-full.txt: the API as a table of contents, and all of it in one fetch.
  • Any page as Markdown: add .md to its address, like /docs.md.