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
GETtohttps://api.scrapefield.com/v1with query parameters, and every answer is JSON. - You authenticate with a key in the
Authorizationheader. 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
Google Maps
5 endpointsPlaces, details, reviews, photos and the owner's posts. Build a list of businesses in an area, or watch what people say about one.
GET /v1/google-maps/placesSearch Google Maps for businesses and places
GET /v1/google-maps/placeGet one Google Maps place in full
GET /v1/google-maps/reviewsGet the reviews of a Google Maps place
GET /v1/google-maps/photosGet the photos of a Google Maps place
GET /v1/google-maps/postsGet an owner's posts on a Google Maps place
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/profileGet a LinkedIn profile
GET /v1/linkedin/companyGet a LinkedIn company page
GET /v1/linkedin/employee-statsCount a company's people on LinkedIn
GET /v1/linkedin/employeesGet the people at a company, from LinkedIn
GET /v1/linkedin/peopleSearch people on LinkedIn
GET /v1/linkedin/servicesFind people who offer services on LinkedIn
GET /v1/linkedin/companiesSearch companies on LinkedIn
GET /v1/linkedin/postsGet or search LinkedIn posts
GET /v1/linkedin/postGet one LinkedIn post
GET /v1/linkedin/commentsGet the comments on a LinkedIn post
GET /v1/linkedin/reactionsGet who reacted to a LinkedIn post
GET /v1/linkedin/activityGet a person's LinkedIn comments and reactions
GET /v1/linkedin/jobsSearch LinkedIn job postings
GET /v1/linkedin/jobGet one LinkedIn job posting in full
GET /v1/linkedin/adsSearch LinkedIn's Ad Library
GET /v1/linkedin/adGet one ad from LinkedIn's Ad Library
GET /v1/linkedin/groupGet one LinkedIn group
GET /v1/linkedin/groupsSearch LinkedIn groups
Profiles, account search, posts, comments and hashtags. Creator discovery and campaign verification.
GET /v1/instagram/profileGet an Instagram profile
GET /v1/instagram/postsGet recent posts from an Instagram profile
GET /v1/instagram/postGet one Instagram post
GET /v1/instagram/commentsGet the comments on an Instagram post
GET /v1/instagram/hashtagGet recent posts for an Instagram hashtag
GET /v1/instagram/searchSearch Instagram accounts
TikTok
8 endpointsProfiles, followers, videos, comments, search, the trending feed and the Ad Library. Trend research and creator discovery.
GET /v1/tiktok/profileGet a TikTok profile
GET /v1/tiktok/followersGet a TikTok account's followers or following
GET /v1/tiktok/videosGet recent videos from a TikTok profile
GET /v1/tiktok/videoGet one TikTok video
GET /v1/tiktok/commentsGet the comments on a TikTok video
GET /v1/tiktok/searchSearch TikTok
GET /v1/tiktok/trendingGet the videos trending on TikTok in a country
GET /v1/tiktok/adsSearch TikTok's Ad Library
X
8 endpointsProfiles, posts, replies, reposters, followers, communities and X's own search. Brand monitoring and audience research.
GET /v1/x/profileGet an X profile
GET /v1/x/postsGet an X account's or community's posts
GET /v1/x/postGet one post from X
GET /v1/x/repliesGet the replies to an X post
GET /v1/x/retweetersGet who reposted an X post
GET /v1/x/followersGet an X account's followers or following
GET /v1/x/searchSearch X
GET /v1/x/communityGet an X community
For machines
- OpenAPI spec: complete, with
x-creditson 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
.mdto its address, like /docs.md.