# ScrapeField

> One API for Google Maps, LinkedIn, Instagram, TikTok and X. One key, each platform's data in its own documented shape, a published credit cost per endpoint, usage-based billing with no plans or tiers, and failed calls refunded automatically.

Base URL: `https://api.scrapefield.com/v1`. Auth: `Authorization: Bearer sf_live_…`. Every read is a GET with query parameters.
Responses are `{ "data": …, "meta": { request_id, credits_charged, credits_remaining, cached, fetched_at, next_cursor } }`; a demo answer adds `demo: true` and a `note`.
Errors are `{ "error": { type, code, message, docs, request_id } }`. Branch on `code`; it is stable.
Pagination is cursor-only: pass `meta.next_cursor` back as `cursor`, until it is `null`. A page holds at most `limit` rows, sometimes fewer; an endpoint without `limit` has a fixed page size, given in its description. A cursor lasts as long as the answer is cached (hours): after that it is refused with `invalid_cursor`, and you start again from the first page.
Identifiers are checked against the form they take (an id, a username, a URL on the platform's own site) before anything is charged, and text is at most 2,048 characters: a value that fails is refused with `invalid_parameter`, free.
Each platform's objects are named the way the platform names them: Google Maps after Google's Places API, Instagram after the Graph API, TikTok after TikTok's own APIs, X after its API v2, LinkedIn after the words on its pages. Every documented key is always present.
A field is `null` when the platform does not show it — never 0.
Try any endpoint with no key by adding `?demo=true`: it returns one fixed answer, the same whatever you ask, in the identical shape, charges nothing, and needs no account. Its `meta.note` says what the answer is about and what a live call costs.

## Endpoints

### Google Maps

- [GET /v1/google-maps/places](https://scrapefield.com/docs/google-maps/places.md) — Search Google Maps for businesses and places. 3 credits. Requires: query.
- [GET /v1/google-maps/place](https://scrapefield.com/docs/google-maps/place.md) — Get one Google Maps place in full. 3 credits. Requires: one of place_id|url.
- [GET /v1/google-maps/reviews](https://scrapefield.com/docs/google-maps/reviews.md) — Get the reviews of a Google Maps place. 6 credits. Requires: one of place_id|url.
- [GET /v1/google-maps/photos](https://scrapefield.com/docs/google-maps/photos.md) — Get the photos of a Google Maps place. 4 credits. Requires: one of place_id|url.
- [GET /v1/google-maps/posts](https://scrapefield.com/docs/google-maps/posts.md) — Get an owner's posts on a Google Maps place. 4 credits. Requires: one of place_id|url.

### LinkedIn

- [GET /v1/linkedin/profile](https://scrapefield.com/docs/linkedin/profile.md) — Get a LinkedIn profile. 11 credits (7 for `detail=main`, 33 for `detail=with_email`). Requires: one of url|vanity_name.
- [GET /v1/linkedin/company](https://scrapefield.com/docs/linkedin/company.md) — Get a LinkedIn company page. 3 credits. Requires: one of url|vanity_name.
- [GET /v1/linkedin/employee-stats](https://scrapefield.com/docs/linkedin/employee-stats.md) — Count a company's people on LinkedIn. 7 credits. Requires: one of url|vanity_name|company_id.
- [GET /v1/linkedin/employees](https://scrapefield.com/docs/linkedin/employees.md) — Get the people at a company, from LinkedIn. 170 credits. Requires: company_id.
- [GET /v1/linkedin/people](https://scrapefield.com/docs/linkedin/people.md) — Search people on LinkedIn. 7 credits (170 for `source=sales_navigator`).
- [GET /v1/linkedin/services](https://scrapefield.com/docs/linkedin/services.md) — Find people who offer services on LinkedIn. 7 credits. Requires: query.
- [GET /v1/linkedin/companies](https://scrapefield.com/docs/linkedin/companies.md) — Search companies on LinkedIn. 7 credits. Requires: query.
- [GET /v1/linkedin/posts](https://scrapefield.com/docs/linkedin/posts.md) — Get or search LinkedIn posts. 7 credits (3 with `company_url`). Requires: one of url|company_url|query.
- [GET /v1/linkedin/post](https://scrapefield.com/docs/linkedin/post.md) — Get one LinkedIn post. 3 credits. Requires: url.
- [GET /v1/linkedin/comments](https://scrapefield.com/docs/linkedin/comments.md) — Get the comments on a LinkedIn post. 7 credits. Requires: one of url|comment_url.
- [GET /v1/linkedin/reactions](https://scrapefield.com/docs/linkedin/reactions.md) — Get who reacted to a LinkedIn post. 7 credits. Requires: one of url|comment_url.
- [GET /v1/linkedin/activity](https://scrapefield.com/docs/linkedin/activity.md) — Get a person's LinkedIn comments and reactions. 7 credits. Requires: one of url|vanity_name.
- [GET /v1/linkedin/jobs](https://scrapefield.com/docs/linkedin/jobs.md) — Search LinkedIn job postings. 3 credits. Requires: query.
- [GET /v1/linkedin/job](https://scrapefield.com/docs/linkedin/job.md) — Get one LinkedIn job posting in full. 3 credits. Requires: one of id|url.
- [GET /v1/linkedin/ads](https://scrapefield.com/docs/linkedin/ads.md) — Search LinkedIn's Ad Library. 3 credits. Requires: one of advertiser|company_id|query.
- [GET /v1/linkedin/ad](https://scrapefield.com/docs/linkedin/ad.md) — Get one ad from LinkedIn's Ad Library. 7 credits. Requires: one of id|url.
- [GET /v1/linkedin/group](https://scrapefield.com/docs/linkedin/group.md) — Get one LinkedIn group. 7 credits. Requires: one of url|id.
- [GET /v1/linkedin/groups](https://scrapefield.com/docs/linkedin/groups.md) — Search LinkedIn groups. 7 credits. Requires: query.

### Instagram

- [GET /v1/instagram/profile](https://scrapefield.com/docs/instagram/profile.md) — Get an Instagram profile. 3 credits. Requires: one of username|url.
- [GET /v1/instagram/posts](https://scrapefield.com/docs/instagram/posts.md) — Get recent posts from an Instagram profile. 3 credits. Requires: one of username|url.
- [GET /v1/instagram/post](https://scrapefield.com/docs/instagram/post.md) — Get one Instagram post. 3 credits. Requires: one of url|shortcode.
- [GET /v1/instagram/comments](https://scrapefield.com/docs/instagram/comments.md) — Get the comments on an Instagram post. 3 credits. Requires: one of url|shortcode.
- [GET /v1/instagram/hashtag](https://scrapefield.com/docs/instagram/hashtag.md) — Get recent posts for an Instagram hashtag. 64 credits. Requires: tag.
- [GET /v1/instagram/search](https://scrapefield.com/docs/instagram/search.md) — Search Instagram accounts. 3 credits. Requires: query.

### TikTok

- [GET /v1/tiktok/profile](https://scrapefield.com/docs/tiktok/profile.md) — Get a TikTok profile. 3 credits. Requires: one of username|url.
- [GET /v1/tiktok/followers](https://scrapefield.com/docs/tiktok/followers.md) — Get a TikTok account's followers or following. 3 credits. Requires: one of username|url.
- [GET /v1/tiktok/videos](https://scrapefield.com/docs/tiktok/videos.md) — Get recent videos from a TikTok profile. 3 credits. Requires: one of username|url.
- [GET /v1/tiktok/video](https://scrapefield.com/docs/tiktok/video.md) — Get one TikTok video. 3 credits. Requires: one of url|id.
- [GET /v1/tiktok/comments](https://scrapefield.com/docs/tiktok/comments.md) — Get the comments on a TikTok video. 3 credits. Requires: one of url|id.
- [GET /v1/tiktok/search](https://scrapefield.com/docs/tiktok/search.md) — Search TikTok. 3 credits (13 for `type=hashtag`). Requires: query.
- [GET /v1/tiktok/trending](https://scrapefield.com/docs/tiktok/trending.md) — Get the videos trending on TikTok in a country. 3 credits.
- [GET /v1/tiktok/ads](https://scrapefield.com/docs/tiktok/ads.md) — Search TikTok's Ad Library. 3 credits. Requires: query.

### X

- [GET /v1/x/profile](https://scrapefield.com/docs/x/profile.md) — Get an X profile. 3 credits. Requires: one of username|url.
- [GET /v1/x/posts](https://scrapefield.com/docs/x/posts.md) — Get an X account's or community's posts. 13 credits (3 with `community_url`). Requires: one of username|url|community_url.
- [GET /v1/x/post](https://scrapefield.com/docs/x/post.md) — Get one post from X. 3 credits. Requires: one of url|id.
- [GET /v1/x/replies](https://scrapefield.com/docs/x/replies.md) — Get the replies to an X post. 13 credits. Requires: one of url|id.
- [GET /v1/x/retweeters](https://scrapefield.com/docs/x/retweeters.md) — Get who reposted an X post. 13 credits. Requires: one of url|id.
- [GET /v1/x/followers](https://scrapefield.com/docs/x/followers.md) — Get an X account's followers or following. 13 credits. Requires: one of username|url.
- [GET /v1/x/search](https://scrapefield.com/docs/x/search.md) — Search X. 13 credits. Requires: query.
- [GET /v1/x/community](https://scrapefield.com/docs/x/community.md) — Get an X community. 3 credits. Requires: one of url|id.

## Also

- [OpenAPI spec](https://api.scrapefield.com/v1/openapi.json) — every data endpoint, with `x-credits` on each
- [Full documentation as one file](https://scrapefield.com/llms-full.txt)
- [MCP server](https://scrapefield.com/mcp) — the same endpoints as tools, with a no-key demo mode
- [Agent skill](https://scrapefield.com/skill.md) — when to reach for this API and what the traps are; drop it in as a Claude Skill or a Cursor rule
- [Docs index](https://scrapefield.com/docs.md) — every page on this site is also served as Markdown: add `.md` to any URL
- [Sign up from an agent](https://scrapefield.com/docs/authentication.md) — `POST /v1/signup` with the person's email: they approve with a code you show them, and you get a key once; over MCP, `sign_up`
- [Errors](https://scrapefield.com/docs/errors.md) — every code, when it happens and what to do
- [Pricing](https://scrapefield.com/pricing.md) — the credit table
- [Status](https://scrapefield.com/status) — success rate and latency per endpoint, from real traffic
- [Which endpoints answer right now](https://api.scrapefield.com/v1/status) — `GET /v1/status`, and `available` on each entry of `GET /v1/endpoints`: this file lists every endpoint we sell, and one can be down for a while