Servers Playground How we check Add a server Log in

ScrapeField

Working · 2.4 s

com.scrapefield/scrapefieldv1.0.0 Domain verified

Google Maps, LinkedIn, Instagram, TikTok and X data as tools. Demo mode needs no key.

Marketing & SEO

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://scrapefield.com/mcp

Authorization (optional)

Bearer sf_live_… from scrapefield.com. Leave it out to try every tool in demo mode, or to ask for a key with the sign_up tool.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

check_sign_up

`pending` until the person approves; then `approved`, with `api_key`, once. Use the key as `Authorization: Bearer …` on the API and on this server.

idstring, required

The `id` sign_up returned.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

ScrapeField MCP server | mcptry

Tools (47)

check_sign_up

`pending` until the person approves; then `approved`, with `api_key`, once. Use the key as `Authorization: Bearer …` on the API and on this server.

Argument	Type	Description
id*	string	The `id` sign_up returned.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The `id` sign_up returned."
    }
  },
  "additionalProperties": false
}

get_instagram_comments

Fetch comments on one Instagram post: username, text, timestamp, like_count, reply_count and parent_id for replies. Use this for social listening and campaign verification. Give exactly one of `url` or `shortcode`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The post URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–50. A page can hold fewer while `next_cursor` is set: read until it is null.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
shortcode	string	The post shortcode.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?instagram\\.com/([A-Za-z0-9._]{1,30}/)?(p|reel|reels|tv)/[A-Za-z0-9_-]{5,40}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The post URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 50,
      "minimum": 1,
      "description": "At most this many results, 1–50. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "shortcode": {
      "type": "string",
      "pattern": "^(?:[A-Za-z0-9_-]{5,40})$",
      "examples": [
        "C1a2B3c4D5e"
      ],
      "maxLength": 2048,
      "description": "The post shortcode."
    }
  },
  "additionalProperties": false
}

get_instagram_hashtag

Fetch recent posts carrying one hashtag, each a full post. Use this for trend and campaign monitoring. Costs 64 credits, cached or not; a failed call is refunded.

Argument	Type	Description
tag*	string	The hashtag, without the leading #.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–24. A page can hold fewer while `next_cursor` is set: read until it is null.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "tag"
  ],
  "properties": {
    "tag": {
      "type": "string",
      "pattern": "^(?:#?[^\\s#/?&]{1,100})$",
      "examples": [
        "sourdough"
      ],
      "maxLength": 2048,
      "description": "The hashtag, without the leading #."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 24,
      "maximum": 24,
      "minimum": 1,
      "description": "At most this many results, 1–24. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

get_instagram_post

Fetch one Instagram post or Reel by its URL or shortcode: caption, media, username, timestamp, like_count, comments_count and view_count. Give exactly one of `url` or `shortcode`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The post URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
shortcode	string	The shortcode from the URL, e.g. `C1a2B3c4D5e`.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?instagram\\.com/([A-Za-z0-9._]{1,30}/)?(p|reel|reels|tv)/[A-Za-z0-9_-]{5,40}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The post URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "shortcode": {
      "type": "string",
      "pattern": "^(?:[A-Za-z0-9_-]{5,40})$",
      "examples": [
        "C1a2B3c4D5e"
      ],
      "maxLength": 2048,
      "description": "The shortcode from the URL, e.g. `C1a2B3c4D5e`."
    }
  },
  "additionalProperties": false
}

get_instagram_posts

Fetch recent posts and Reels by one Instagram account: shortcode, permalink, media_type, caption, timestamp, media_url, carousel children, like_count, comments_count, view_count, hashtags, mentions and the paid-partnership label. Give exactly one of `username` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The profile URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–24. A page can hold fewer while `next_cursor` is set: read until it is null.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
username	string	The username. A leading @ is fine.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?instagram\\.com/[A-Za-z0-9._]{1,30}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The profile URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 24,
      "maximum": 24,
      "minimum": 1,
      "description": "At most this many results, 1–24. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9._]{1,30})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The username. A leading @ is fine."
    }
  },
  "additionalProperties": false
}

get_instagram_profile

Fetch an Instagram account: username, name, biography, bio_links, followers_count, follows_count, media_count, is_verified, is_private, is_business_account, category and the business contact buttons — named as in Instagram's Graph API. Use this for creator discovery and audience sizing. Give exactly one of `username` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The profile URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
username	string	The username. A leading @ is fine.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?instagram\\.com/[A-Za-z0-9._]{1,30}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The profile URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9._]{1,30})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The username. A leading @ is fine."
    }
  },
  "additionalProperties": false
}

get_linkedin_activity

Fetch what one person did recently on other people's posts: with `type=comments`, the comments they wrote and when; with `type=reactions`, the posts they reacted to and how. Each item carries the post, with its author and counts, when they did it, and for a comment its own `comment_url`, which opens the post at that comment. The newest first, up to 100 a page, with `next_cursor` for older ones. Use this for sales signals: who a prospect engages with, and on what. Give exactly one of `url` or `vanity_name`. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The person's public profile URL. A member-id link (`/in/ACoAA…` or `/in/ACwAA…`), as reactions and Sales Navigator give, works too.
type	string	Their comments, or their reactions.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
vanity_name	string	The part after `/in/` in their public URL. A member id (`ACoAA…`) works too.
posted_within	string	Only comments from the last day, week or month. With `type=comments` only.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/in/[^/?#\\s]{3,100}([/?#]\\S*)?)$",
      "examples": [
        "https://www.linkedin.com/in/example"
      ],
      "maxLength": 2048,
      "description": "The person's public profile URL. A member-id link (`/in/ACoAA…` or `/in/ACwAA…`), as reactions and Sales Navigator give, works too."
    },
    "type": {
      "enum": [
        "comments",
        "reactions"
      ],
      "type": "string",
      "default": "comments",
      "description": "Their comments, or their reactions."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "vanity_name": {
      "type": "string",
      "pattern": "^(?:[^/?#\\s]{3,100})$",
      "maxLength": 2048,
      "description": "The part after `/in/` in their public URL. A member id (`ACoAA…`) works too."
    },
    "posted_within": {
      "enum": [
        "day",
        "week",
        "month"
      ],
      "type": "string",
      "description": "Only comments from the last day, week or month. With `type=comments` only."
    }
  },
  "additionalProperties": false
}

get_linkedin_ad

Fetch one ad in full by its id or URL: what linkedin/ads gives, and where it was seen, country by country, with its targeting. Give exactly one of `id` or `url`. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The Ad Library's id for the ad: `id` in linkedin/ads.
url	string	The ad's page in the Ad Library: `https://www.linkedin.com/ad-library/detail/<id>`.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{4,20})$",
      "examples": [
        "1572822563"
      ],
      "maxLength": 2048,
      "description": "The Ad Library's id for the ad: `id` in linkedin/ads."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/ad-library/detail/\\d{4,20}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The ad's page in the Ad Library: `https://www.linkedin.com/ad-library/detail/<id>`."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    }
  },
  "additionalProperties": false
}

get_linkedin_company

Fetch a LinkedIn company page: name, tagline, description, website, industry, company_size, employees_on_linkedin, headquarters, company_type, founded, specialties and follower_count. Use this to enrich a company from its LinkedIn URL. Give exactly one of `url` or `vanity_name`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The company page URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
vanity_name	string	The part after `/company/` in the URL, e.g. `acme-inc`.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s]+([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The company page URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "vanity_name": {
      "type": "string",
      "pattern": "^(?:[^/?#\\s]{2,100})$",
      "examples": [
        "example-co"
      ],
      "maxLength": 2048,
      "description": "The part after `/company/` in the URL, e.g. `acme-inc`."
    }
  },
  "additionalProperties": false
}

get_linkedin_company_people

Fetch the people who list a company as their employer, 25 a page from Sales Navigator, which hides no one: each person's name, location and profile, and their current roles, each with its title, employer and `company_id`, and start month. The same object, and price, as linkedin/people with `source=sales_navigator`. Takes the company's numeric id, `company_id` in linkedin/company. Use this to map a company's team or to find who to contact. Costs 170 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
company_id*	string	LinkedIn's numeric id for the company: `company_id` in linkedin/company.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "company_id"
  ],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "company_id": {
      "type": "string",
      "pattern": "^(?:\\d{1,12})$",
      "examples": [
        "1035"
      ],
      "maxLength": 2048,
      "description": "LinkedIn's numeric id for the company: `company_id` in linkedin/company."
    }
  },
  "additionalProperties": false
}

get_linkedin_employee_stats

Fetch the counts on a company's People tab: where its people live, what they do, where they studied, what they are skilled at, each as a list of names and member counts. Use this to size a team, or to see where a company hires. Give exactly one of `url` or `vanity_name` or `company_id`. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The company page URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
company_id	string	LinkedIn's numeric id for the company: `company_id` in linkedin/company. The fastest of the three.
vanity_name	string	The part after `/company/` in the URL.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s]+([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The company page URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "company_id": {
      "type": "string",
      "pattern": "^(?:\\d{1,12})$",
      "examples": [
        "1035"
      ],
      "maxLength": 2048,
      "description": "LinkedIn's numeric id for the company: `company_id` in linkedin/company. The fastest of the three."
    },
    "vanity_name": {
      "type": "string",
      "pattern": "^(?:[^/?#\\s]{2,100})$",
      "maxLength": 2048,
      "description": "The part after `/company/` in the URL."
    }
  },
  "additionalProperties": false
}

get_linkedin_group

Fetch one group: its name, members, description, rules, when it was made and whether its posts are public. Its posts, by `group_url` on linkedin/posts, are not available yet. Give exactly one of `url` or `id`. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The number in the group's URL.
url	string	The group's URL: `https://www.linkedin.com/groups/<id>/`.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{1,15})$",
      "examples": [
        "1976445"
      ],
      "maxLength": 2048,
      "description": "The number in the group's URL."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/groups/\\d{1,15}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The group's URL: `https://www.linkedin.com/groups/<id>/`."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    }
  },
  "additionalProperties": false
}

get_linkedin_job

Fetch one LinkedIn job posting by its id or URL: title, company, location, employment_type, seniority_level, salary where the posting shows one, and the full description — the fields linkedin/jobs leaves null, and workplace_type, listed_at and easy_apply where the posting shows them. Use it on the job_id of a search result. Give exactly one of `id` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	LinkedIn's numeric id for the posting: `job_id` in a search result, and the number at the end of `/jobs/view/…`.
url	string	The posting's URL, e.g. `https://www.linkedin.com/jobs/view/4468618386/`.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{6,20})$",
      "examples": [
        "4468618386"
      ],
      "maxLength": 2048,
      "description": "LinkedIn's numeric id for the posting: `job_id` in a search result, and the number at the end of `/jobs/view/…`."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/jobs/(view/([^/?#]*-)?\\d{6,20}/?([?#].*)?|[^?#]*\\?(.*&)?currentJobId=\\d{6,20}(&.*)?))$",
      "maxLength": 2048,
      "description": "The posting's URL, e.g. `https://www.linkedin.com/jobs/view/4468618386/`."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    }
  },
  "additionalProperties": false
}

get_linkedin_post

Fetch one post by its URL: its text, images, author, published_at, reaction_count and comment_count. repost_count and the reactions by kind are null: the source gives the total only. Use linkedin/comments for its comments and linkedin/reactions for who reacted. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url*	string	The post's URL: `https://www.linkedin.com/posts/…-activity-<id>-…`, or `https://www.linkedin.com/feed/update/urn:li:activity:<id>`. A link by the share's id works too: `urn:li:ugcPost:<id>`, `urn:li:share:<id>` or `/posts/…-ugcPost-<id>-…`.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(posts/[^/?#\\s]*(?:activity|ugcPost|share)-\\d{16,22}[^/?#\\s]*|feed/update/urn:li:(?:activity|ugcPost|share):\\d{16,22})([/?#]\\S*)?)$",
      "examples": [
        "https://www.linkedin.com/feed/update/urn:li:activity:7243000000000000000"
      ],
      "maxLength": 2048,
      "description": "The post's URL: `https://www.linkedin.com/posts/…-activity-<id>-…`, or `https://www.linkedin.com/feed/update/urn:li:activity:<id>`. A link by the share's id works too: `urn:li:ugcPost:<id>`, `urn:li:share:<id>` or `/posts/…-ugcPost-<id>-…`."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    }
  },
  "additionalProperties": false
}

get_linkedin_post_comments

Fetch the comments on one post, up to 100 a page: each comment's text, author (name, headline, profile), published_at, like_count, reply_count and its own `url`, which opens the post at that comment. With `comment_url`, the replies to one comment. Use this to see who engages with a post and what they say. Give exactly one of `url` or `comment_url`. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The post's URL, as for linkedin/post.
sort	string	Most relevant first, or newest first.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
comment_url	string	A comment's URL, as LinkedIn's "Copy link to comment" gives it: the replies to that comment.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(posts/[^/?#\\s]*(?:activity|ugcPost|share)-\\d{16,22}[^/?#\\s]*|feed/update/urn:li:(?:activity|ugcPost|share):\\d{16,22})([/?#]\\S*)?)$",
      "examples": [
        "https://www.linkedin.com/feed/update/urn:li:activity:7243000000000000000"
      ],
      "maxLength": 2048,
      "description": "The post's URL, as for linkedin/post."
    },
    "sort": {
      "enum": [
        "relevance",
        "newest"
      ],
      "type": "string",
      "description": "Most relevant first, or newest first."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "comment_url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/feed/update/urn:li:(activity|ugcPost|share):\\d{16,22}/?\\?(\\S*&)?commentUrn=\\S+)$",
      "examples": [
        "https://www.linkedin.com/feed/update/urn:li:activity:7243000000000000000?commentUrn=urn%3Ali%3Acomment%3A%28activity%3A7243000000000000000%2C7243000000000000001%29"
      ],
      "maxLength": 2048,
      "description": "A comment's URL, as LinkedIn's \"Copy link to comment\" gives it: the replies to that comment."
    }
  },
  "additionalProperties": false
}

get_linkedin_post_reactions

Fetch who reacted to one post, up to 100 a page: each person's or company page's name, headline and link, and which reaction. With `comment_url`, who reacted to one comment. LinkedIn lists people who react by member id, so `actor.url` is usually a member-id link (`/in/ACoAA…`) with `vanity_name` null; linkedin/profile takes it. Give exactly one of `url` or `comment_url`. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The post's URL, as for linkedin/post.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
comment_url	string	A comment's URL: who reacted to that comment.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(posts/[^/?#\\s]*(?:activity|ugcPost|share)-\\d{16,22}[^/?#\\s]*|feed/update/urn:li:(?:activity|ugcPost|share):\\d{16,22})([/?#]\\S*)?)$",
      "examples": [
        "https://www.linkedin.com/feed/update/urn:li:activity:7243000000000000000"
      ],
      "maxLength": 2048,
      "description": "The post's URL, as for linkedin/post."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "comment_url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/feed/update/urn:li:(activity|ugcPost|share):\\d{16,22}/?\\?(\\S*&)?commentUrn=\\S+)$",
      "examples": [
        "https://www.linkedin.com/feed/update/urn:li:activity:7243000000000000000?commentUrn=urn%3Ali%3Acomment%3A%28activity%3A7243000000000000000%2C7243000000000000001%29"
      ],
      "maxLength": 2048,
      "description": "A comment's URL: who reacted to that comment."
    }
  },
  "additionalProperties": false
}

get_linkedin_posts

Fetch recent posts by one person or company, or with `query` every public post with those words: text, images, video, document or article, and published_at. A person's posts also carry reaction_count (with the breakdown by kind), comment_count and repost_count; a company's carry the text and the date, with the counts null, at a much lower price. For the counts on one of them, call linkedin/post. Give exactly one of `url` or `company_url` or `query`. Costs 7 credits (3 with `company_url`), cached or not; a failed call is refunded.

Argument	Type	Description
url	string	A person's public profile URL. Their latest posts, on one page.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–100. A page can hold fewer while `next_cursor` is set: read until it is null.
query	string	Words in the post: every public post that has them, newest first.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
company_url	string	A company page URL. Up to 7 pages of 10.
posted_within	string	Only posts from the last day, week or month.

Input schema (JSON)

get_linkedin_profile

Fetch a LinkedIn profile: full_name, headline, about, location, follower_count, connection_count, current_company, experience, education and skills. With `detail=with_email`, also look for their work email, each address checked with its mail server. Use this to enrich a person from their profile URL. Give exactly one of `url` or `vanity_name`. Costs 11 credits (7 for `detail=main`, 33 for `detail=with_email`), cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The public profile URL, e.g. `https://www.linkedin.com/in/someone`. A member-id URL (`/in/ACoAA…` or `/in/ACwAA…`), as reactions and Sales Navigator give, works too.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
detail	string	`main` is the profile as LinkedIn first shows it, without opening a section: up to 5 positions, 2 schools and 2 skills, for less. `with_email` is the whole profile and a search for their work email, in `emails`, for more.
vanity_name	string	The part after `/in/` in the public URL, e.g. `someone`. A member id (`ACoAA…`) works too.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/in/[^/?#\\s]{3,100}([/?#]\\S*)?)$",
      "examples": [
        "https://www.linkedin.com/in/example"
      ],
      "maxLength": 2048,
      "description": "The public profile URL, e.g. `https://www.linkedin.com/in/someone`. A member-id URL (`/in/ACoAA…` or `/in/ACwAA…`), as reactions and Sales Navigator give, works too."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "detail": {
      "enum": [
        "full",
        "main",
        "with_email"
      ],
      "type": "string",
      "default": "full",
      "description": "`main` is the profile as LinkedIn first shows it, without opening a section: up to 5 positions, 2 schools and 2 skills, for less. `with_email` is the whole profile and a search for their work email, in `emails`, for more."
    },
    "vanity_name": {
      "type": "string",
      "pattern": "^(?:[^/?#\\s]{3,100})$",
      "maxLength": 2048,
      "description": "The part after `/in/` in the public URL, e.g. `someone`. A member id (`ACoAA…`) works too."
    }
  },
  "additionalProperties": false
}

get_place

Fetch one Google Maps listing in full: name, categories, formatted_address, location, rating, user_ratings_total, rating_distribution, price_level, phone numbers, website, opening_hours, the About tab and business_status. popular_times is in the object, and null where the source does not give it. Accepts a Google place_id — from a search, the Places API or anywhere else — or a Google Maps URL. Give exactly one of `place_id` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
language	string	Two-letter language code for localised text, e.g. `en`, `de`.
place_id	string	Google's place ID, e.g. from a search result or the Places API.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:https?://((www|maps)\\.)?google\\.[a-z]{2,3}(\\.[a-z]{2})?/maps\\S*(place_id[:=]|query_place_id=|!1s0x[0-9a-fA-F]+:0x)\\S*)$",
      "maxLength": 2048,
      "description": "The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "language": {
      "type": "string",
      "default": "en",
      "pattern": "^(?:[A-Za-z]{2}(-[A-Za-z]{2})?)$",
      "maxLength": 2048,
      "description": "Two-letter language code for localised text, e.g. `en`, `de`."
    },
    "place_id": {
      "type": "string",
      "pattern": "^(?:[A-Za-z0-9_-]{10,1000})$",
      "examples": [
        "ChIJN1t_tDeuEmsRUsoyG83frY4"
      ],
      "maxLength": 2048,
      "description": "Google's place ID, e.g. from a search result or the Places API."
    }
  },
  "additionalProperties": false
}

get_place_photos

Fetch the photos on one place's listing, as URLs on Google's CDN; we do not rehost images. Dimensions and uploader are in the object, and null where the source does not give them. Give exactly one of `place_id` or `url`. Costs 4 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–20. A page can hold fewer while `next_cursor` is set: read until it is null.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
place_id	string	Google's place ID.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:https?://((www|maps)\\.)?google\\.[a-z]{2,3}(\\.[a-z]{2})?/maps\\S*(place_id[:=]|query_place_id=|!1s0x[0-9a-fA-F]+:0x)\\S*)$",
      "maxLength": 2048,
      "description": "The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 20,
      "minimum": 1,
      "description": "At most this many results, 1–20. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "place_id": {
      "type": "string",
      "pattern": "^(?:[A-Za-z0-9_-]{10,1000})$",
      "examples": [
        "ChIJN1t_tDeuEmsRUsoyG83frY4"
      ],
      "maxLength": 2048,
      "description": "Google's place ID."
    }
  },
  "additionalProperties": false
}

get_place_posts

Fetch the updates the owner posted on one place's listing, newest first: the text, the day, an image and where it links, such as an offer or an event. Use this to watch what a competitor announces. Give exactly one of `place_id` or `url`. Costs 4 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
place_id	string	Google's place ID.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:https?://((www|maps)\\.)?google\\.[a-z]{2,3}(\\.[a-z]{2})?/maps\\S*(place_id[:=]|query_place_id=|!1s0x[0-9a-fA-F]+:0x)\\S*)$",
      "maxLength": 2048,
      "description": "The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "place_id": {
      "type": "string",
      "pattern": "^(?:[A-Za-z0-9_-]{10,1000})$",
      "examples": [
        "ChIJN1t_tDeuEmsRUsoyG83frY4"
      ],
      "maxLength": 2048,
      "description": "Google's place ID."
    }
  },
  "additionalProperties": false
}

get_place_reviews

Fetch Google reviews for one place: rating, text, language, publish_time, the author (with their Local Guide badge and review count), photos and the owner_response where there is one. The first page has up to 8 reviews, and each page after it up to 20. Use this for review monitoring and sentiment work. Give exactly one of `place_id` or `url`. Costs 6 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to.
sort	string	Order of the reviews.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–20. A page can hold fewer while `next_cursor` is set: read until it is null.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
place_id	string	Google's place ID.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:https?://((www|maps)\\.)?google\\.[a-z]{2,3}(\\.[a-z]{2})?/maps\\S*(place_id[:=]|query_place_id=|!1s0x[0-9a-fA-F]+:0x)\\S*)$",
      "maxLength": 2048,
      "description": "The full URL of the place on Google Maps, which carries its id. A short maps.app.goo.gl link does not, so open it and copy the address it leads to."
    },
    "sort": {
      "enum": [
        "relevance",
        "newest",
        "highest",
        "lowest"
      ],
      "type": "string",
      "default": "relevance",
      "description": "Order of the reviews."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 20,
      "minimum": 1,
      "description": "At most this many results, 1–20. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "place_id": {
      "type": "string",
      "pattern": "^(?:[A-Za-z0-9_-]{10,1000})$",
      "examples": [
        "ChIJN1t_tDeuEmsRUsoyG83frY4"
      ],
      "maxLength": 2048,
      "description": "Google's place ID."
    }
  },
  "additionalProperties": false
}

get_tiktok_comments

Fetch comments on one TikTok video: username, text, create_time, like_count, reply_count and parent_comment_id for replies. Give exactly one of `url` or `id`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The numeric video id.
url	string	The video URL, `https://www.tiktok.com/@…/video/…`. A short `vm.tiktok.com` link is not read: open it, and copy the address it leads to.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–50. A page can hold fewer while `next_cursor` is set: read until it is null.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{8,25})$",
      "examples": [
        "7301234567890123456"
      ],
      "maxLength": 2048,
      "description": "The numeric video id."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?tiktok\\.com/@[A-Za-z0-9._]{1,24}/video/\\d{8,25}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The video URL, `https://www.tiktok.com/@…/video/…`. A short `vm.tiktok.com` link is not read: open it, and copy the address it leads to."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 50,
      "minimum": 1,
      "description": "At most this many results, 1–50. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

get_tiktok_followers

Fetch an account's followers, newest first, or with `type=following` the accounts it follows: each a profile with its follower and video counts, about 50 a page. Use this to see who an audience is, or who a creator watches. Give exactly one of `username` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The profile URL.
type	string	Who follows the account, or whom it follows.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
username	string	The username. A leading @ is fine.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?tiktok\\.com/@[A-Za-z0-9._]{2,24}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The profile URL."
    },
    "type": {
      "enum": [
        "followers",
        "following"
      ],
      "type": "string",
      "default": "followers",
      "description": "Who follows the account, or whom it follows."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9._]{2,24})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The username. A leading @ is fine."
    }
  },
  "additionalProperties": false
}

get_tiktok_profile

Fetch a TikTok account: username, display_name, bio_description, bio_url, is_verified, follower_count, following_count, likes_count and video_count — named as in TikTok's own APIs. Use this for creator discovery and audience sizing. Give exactly one of `username` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The profile URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
username	string	The username. A leading @ is fine.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?tiktok\\.com/@[A-Za-z0-9._]{2,24}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The profile URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9._]{2,24})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The username. A leading @ is fine."
    }
  },
  "additionalProperties": false
}

get_tiktok_trending

Fetch the videos TikTok's trending feed shows in one country now, each a full video. One page, which changes from call to call. Use this to see what is spreading. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
region	string	Two-letter country code, e.g. `US`, `GB`, `DE`.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "region": {
      "type": "string",
      "default": "US",
      "pattern": "^(?:[A-Za-z]{2})$",
      "examples": [
        "US"
      ],
      "maxLength": 2048,
      "description": "Two-letter country code, e.g. `US`, `GB`, `DE`."
    }
  },
  "additionalProperties": false
}

get_tiktok_video

Fetch one TikTok video by URL or id: video_description, username, create_time, duration, the counts, the sound and whether duets and stitches are allowed. Give exactly one of `url` or `id`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The numeric video id.
url	string	The video URL, `https://www.tiktok.com/@…/video/…`. A short `vm.tiktok.com` link is not read: open it, and copy the address it leads to.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{8,25})$",
      "examples": [
        "7301234567890123456"
      ],
      "maxLength": 2048,
      "description": "The numeric video id."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?tiktok\\.com/@[A-Za-z0-9._]{1,24}/video/\\d{8,25}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The video URL, `https://www.tiktok.com/@…/video/…`. A short `vm.tiktok.com` link is not read: open it, and copy the address it leads to."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    }
  },
  "additionalProperties": false
}

get_tiktok_videos

Fetch recent videos by one TikTok account: video_description, create_time, duration, cover_image_url, view_count, like_count, comment_count, share_count, favorites_count, hashtag_names and the sound. Give exactly one of `username` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The profile URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–30. A page can hold fewer while `next_cursor` is set: read until it is null.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
username	string	The username. A leading @ is fine.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|m)\\.)?tiktok\\.com/@[A-Za-z0-9._]{2,24}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The profile URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 30,
      "maximum": 30,
      "minimum": 1,
      "description": "At most this many results, 1–30. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9._]{2,24})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The username. A leading @ is fine."
    }
  },
  "additionalProperties": false
}

get_x_community

Fetch one community: its name, description, member_count, created_at, join_policy, rules and creator. `x/posts` with `community_url` gives its posts. Give exactly one of `url` or `id`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The number in its URL.
url	string	The community's URL, `https://x.com/i/communities/<id>`.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{5,25})$",
      "examples": [
        "1926186499399139650"
      ],
      "maxLength": 2048,
      "description": "The number in its URL."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/i/communities/\\d{5,25}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The community's URL, `https://x.com/i/communities/<id>`."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    }
  },
  "additionalProperties": false
}

get_x_followers

Fetch an account's followers, about 70 a page, or with `type=following` the accounts it follows: each an account, with its counts and bio. Use this to see who an audience is. Give exactly one of `username` or `url`. Costs 13 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The profile URL.
type	string	Who follows the account, or whom it follows.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
username	string	The username. A leading @ is fine.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/[A-Za-z0-9_]{1,15}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The profile URL."
    },
    "type": {
      "enum": [
        "followers",
        "following"
      ],
      "type": "string",
      "default": "followers",
      "description": "Who follows the account, or whom it follows."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9_]{1,15})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The username. A leading @ is fine."
    }
  },
  "additionalProperties": false
}

get_x_post

Fetch one post by its URL or id: its text, author, created_at, public_metrics with views, media, hashtags and mentions, and the post it replies to or quotes. Give exactly one of `url` or `id`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The number after /status/ in its URL.
url	string	The post's URL, `https://x.com/<username>/status/<id>`.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{5,25})$",
      "examples": [
        "1930652241230168143"
      ],
      "maxLength": 2048,
      "description": "The number after /status/ in its URL."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/[A-Za-z0-9_]{1,15}/status(es)?/\\d{5,25}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The post's URL, `https://x.com/<username>/status/<id>`."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    }
  },
  "additionalProperties": false
}

get_x_posts

Fetch an account's newest posts, about 20 a page with `next_cursor` for older ones; or, with `community_url`, the latest posts in a community, one window. Each post has its text, created_at, public_metrics (likes, reposts, replies, quotes, bookmarks, views), media, hashtags and mentions. Give exactly one of `username` or `url` or `community_url`. Costs 13 credits (3 with `community_url`), cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The account's profile URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
username	string	The account's username. A leading @ is fine.
community_url	string	A community's URL, `https://x.com/i/communities/<id>`: its latest posts.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/[A-Za-z0-9_]{1,15}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The account's profile URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9_]{1,15})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The account's username. A leading @ is fine."
    },
    "community_url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/i/communities/\\d{5,25}([/?#]\\S*)?)$",
      "examples": [
        "https://x.com/i/communities/1471580197908586507"
      ],
      "maxLength": 2048,
      "description": "A community's URL, `https://x.com/i/communities/<id>`: its latest posts."
    }
  },
  "additionalProperties": false
}

get_x_profile

Fetch an X account: username, name, description, location, the link in the profile, verified, created_at, and public_metrics (followers_count, following_count, tweet_count and more) — named as in X's own API v2. Use this to size an account or enrich a handle. Give exactly one of `username` or `url`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
url	string	The profile URL, on x.com or twitter.com.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
username	string	The username. A leading @ is fine.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/[A-Za-z0-9_]{1,15}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The profile URL, on x.com or twitter.com."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "username": {
      "type": "string",
      "pattern": "^(?:@?[A-Za-z0-9_]{1,15})$",
      "examples": [
        "nasa"
      ],
      "maxLength": 2048,
      "description": "The username. A leading @ is fine."
    }
  },
  "additionalProperties": false
}

get_x_replies

Fetch the replies to one post, about 30 a page: each is a post, with its author, text, likes and replies, and `referenced_tweets` naming the post it answers. Give exactly one of `url` or `id`. Costs 13 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The post's id.
url	string	The post's URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{5,25})$",
      "examples": [
        "1930652241230168143"
      ],
      "maxLength": 2048,
      "description": "The post's id."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/[A-Za-z0-9_]{1,15}/status(es)?/\\d{5,25}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The post's URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

get_x_retweeters

Fetch the accounts that reposted one post, about 20 a page, each with its counts and bio. X's API calls this "retweeted by". Give exactly one of `url` or `id`. Costs 13 credits, cached or not; a failed call is refunded.

Argument	Type	Description
id	string	The post's id.
url	string	The post's URL.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^(?:\\d{5,25})$",
      "examples": [
        "1930652241230168143"
      ],
      "maxLength": 2048,
      "description": "The post's id."
    },
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?((www|mobile)\\.)?(x|twitter)\\.com/[A-Za-z0-9_]{1,15}/status(es)?/\\d{5,25}([/?#]\\S*)?)$",
      "maxLength": 2048,
      "description": "The post's URL."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

search_instagram_accounts

Find Instagram accounts by a keyword: each account's username, name and link, the most relevant first, one page. The search answers from a search index, so it gives no counts: call `instagram/profile` with a username for the whole account. Use this to find creators and brands when you do not have a username. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–50. A page can hold fewer while `next_cursor` is set: read until it is null.
query*	string	Words to search for, e.g. "sourdough bakery".

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 25,
      "maximum": 50,
      "minimum": 1,
      "description": "At most this many results, 1–50. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "query": {
      "type": "string",
      "examples": [
        "ferrari"
      ],
      "maxLength": 2048,
      "description": "Words to search for, e.g. \"sourdough bakery\"."
    }
  },
  "additionalProperties": false
}

search_linkedin_ads

Search the ads LinkedIn shows in its public Ad Library, by advertiser, by words in the ad or by company id, optionally by country and date: each ad's advertiser, format, headline, text, image or video, call to action, where it leads, when it ran, its impressions range and its targeting, about 25 a page. Use this to watch what a competitor advertises. Give exactly one of `advertiser` or `company_id` or `query`. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
query	string	Words in the ad.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
end_date	string	Only ads shown on or before this day, `YYYY-MM-DD`, before today. With `start_date`.
countries	string	Only ads shown in these countries: two-letter codes, comma-separated, e.g. `US,GB`.
advertiser	string	The advertiser's name, as the library searches it. It matches loosely: a person whose name contains it can appear.
company_id	string	LinkedIn's numeric id for the company, `company_id` in linkedin/company: that company's ads only.

search_linkedin_companies

Find companies by name or keywords, place and size, up to 50 a page. Each result has the company's id, page, industry, place and followers; linkedin/company gives the whole page, and linkedin/employees its people. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
query*	string	Words in the company's name.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
location	string	A place name, e.g. "Berlin".
company_size	string	Only companies of these sizes, as LinkedIn bands them: `1-10`, `11-50`, `51-200`, `201-500`, `501-1000`, `1001-5000`, `5001-10000`, `10001+`. Several, comma-separated.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "query": {
      "type": "string",
      "examples": [
        "coffee roasters"
      ],
      "maxLength": 2048,
      "description": "Words in the company's name."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "location": {
      "type": "string",
      "maxLength": 2048,
      "description": "A place name, e.g. \"Berlin\"."
    },
    "company_size": {
      "type": "string",
      "pattern": "^(?:(1-10|11-50|51-200|201-500|501-1000|1001-5000|5001-10000|10001\\+)(,(1-10|11-50|51-200|201-500|501-1000|1001-5000|5001-10000|10001\\+))*)$",
      "maxLength": 2048,
      "description": "Only companies of these sizes, as LinkedIn bands them: `1-10`, `11-50`, `51-200`, `201-500`, `501-1000`, `1001-5000`, `5001-10000`, `10001+`. Several, comma-separated."
    }
  },
  "additionalProperties": false
}

search_linkedin_groups

Find groups by keywords: each one's name, URL, members and summary, 10 a page. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
query*	string	Words to search for.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "query": {
      "type": "string",
      "examples": [
        "data engineering"
      ],
      "maxLength": 2048,
      "description": "Words to search for."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

search_linkedin_jobs

Search LinkedIn job postings by keyword and location, with LinkedIn's own filters. Returns each posting's title, company, location, listed_at, URL, and workplace_type and easy_apply where the list shows them. employment_type, seniority_level, salary and description are null: linkedin/job gives them. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
sort	string	Most relevant first, or newest first.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–25. A page can hold fewer while `next_cursor` is set: read until it is null.
query*	string	Job title or keywords, e.g. "backend engineer".
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
location	string	Place name, e.g. "Berlin" or "United States".
company_id	string	Only one company's roles: `company_id` in linkedin/company.
easy_apply	boolean	Only roles that take applications on LinkedIn.

search_linkedin_people

Find people by name, title, company, school or place. With `source=public` (the default), LinkedIn's own people search: it finds people well by name, but hides many other results as "LinkedIn Member", and those are left out. With `source=sales_navigator`, Sales Navigator's lead search: every match, with each person's current roles, at a higher price. 10 a page, or 25 with Sales Navigator. A page takes about 3 seconds, or about 5 with Sales Navigator, and now and then up to 25. Give at least one of `query`, `first_name`, `last_name`, `title`, `current_company`, `past_company`, `school` or `location`. Use linkedin/profile on a result for the whole profile. Costs 7 credits (170 for `source=sales_navigator`), cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
query	string	Words to search for, as in LinkedIn's search box.
title	string	Words in their current title, e.g. "head of data".
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
school	string	Where they studied: a school page URL or its id. Several, comma-separated.
source	string	`public` is LinkedIn's people search; `sales_navigator` is Sales Navigator's lead search, which hides no one and gives current roles, at a higher price.

search_linkedin_services

Find people who list a service on their profile, by what they offer and where: "web design" in "California". LinkedIn hides no one in this search, so it finds people that `linkedin/people` hides. Each result is a person, with their headline and place, 10 a page. Costs 7 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
query*	string	The service, e.g. "web design" or "bookkeeping".
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
location	string	A place name, e.g. "California".

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "query": {
      "type": "string",
      "examples": [
        "web design"
      ],
      "maxLength": 2048,
      "description": "The service, e.g. \"web design\" or \"bookkeeping\"."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "location": {
      "type": "string",
      "maxLength": 2048,
      "description": "A place name, e.g. \"California\"."
    }
  },
  "additionalProperties": false
}

search_places

Find businesses and places on Google Maps by a text query, optionally around a point. Each result is the full listing: place_id, name, categories, formatted_address, location, rating and user_ratings_total, phone, website, opening_hours and business_status — named as in Google's Places API. Use this to build a list of businesses in an area; use google-maps/place when you already have a place_id. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
lat	number	Latitude of the point to search around.
lng	number	Longitude of the point to search around.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–20. A page can hold fewer while `next_cursor` is set: read until it is null.
query*	string	What to search for, e.g. "coffee shops in Brooklyn" or "dentist".
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.
country	string	Two-letter country code to bias results, e.g. `us`.
language	string

search_tiktok

Search TikTok by keyword. Returns videos by default; `type=user` returns accounts and `type=hashtag` returns hashtags. Use this for trend research and creator discovery when you do not already have a username. Costs 3 credits (13 for `type=hashtag`), cached or not; a failed call is refunded.

Argument	Type	Description
type	string	What kind of result to return.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
limit	integer	At most this many results, 1–30. A page can hold fewer while `next_cursor` is set: read until it is null.
query*	string	What to search for.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "type": {
      "enum": [
        "video",
        "user",
        "hashtag"
      ],
      "type": "string",
      "default": "video",
      "description": "What kind of result to return."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 30,
      "maximum": 30,
      "minimum": 1,
      "description": "At most this many results, 1–30. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "query": {
      "type": "string",
      "examples": [
        "sourdough starter"
      ],
      "maxLength": 2048,
      "description": "What to search for."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

search_tiktok_ads

Search the ads in TikTok's public Ad Library by keyword: each ad's advertiser, title, industry, when it first and last ran, its video or images, the audience range and impressions, about 12 a page. TikTok's library holds ads shown in Europe. Use this to watch what a brand or a category advertises. Costs 3 credits, cached or not; a failed call is refunded.

Argument	Type	Description
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
query*	string	A brand, an advertiser or words in the ad.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "query": {
      "type": "string",
      "examples": [
        "nike"
      ],
      "maxLength": 2048,
      "description": "A brand, an advertiser or words in the ad."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

search_x

Search X as its own search box does, newest first, about 20 a page; X's search operators work inside `query` (`from:nasa`, `since:2026-09-01`, `lang:en`). `type=user` finds accounts instead. Use this to follow a topic, a brand or a campaign. Costs 13 credits, cached or not; a failed call is refunded.

Argument	Type	Description
type	string	Posts, or accounts.
fresh	boolean	Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it.
query*	string	Words, a phrase, or X's search operators.
cursor	string	The `meta.next_cursor` from the previous page. Omit for the first page.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "type": {
      "enum": [
        "post",
        "user"
      ],
      "type": "string",
      "default": "post",
      "description": "Posts, or accounts."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "query": {
      "type": "string",
      "examples": [
        "nasa artemis"
      ],
      "maxLength": 2048,
      "description": "Words, a phrase, or X's search operators."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    }
  },
  "additionalProperties": false
}

sign_up

Ask for a ScrapeField API key for the person you work for. We email them a link; they sign in and type the code this returns, and only then is a key made. Show them `user_code` and tell them to check their email. Then call check_sign_up with `id` every few seconds until it is approved: the key comes once, in that answer. Keep `id` secret. An account an agent starts has no free credits: they buy a pack. Use this only when your person asked you to set ScrapeField up.

Argument	Type	Description
agent	string	What you are called, as the person knows you, e.g. "Claude Code". Shown to them in the email.
email*	string	The email address of the person you work for. The account is theirs.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "agent": {
      "type": "string",
      "maxLength": 60,
      "description": "What you are called, as the person knows you, e.g. \"Claude Code\". Shown to them in the email."
    },
    "email": {
      "type": "string",
      "description": "The email address of the person you work for. The account is theirs."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "required": [],
  "properties": {
    "url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/in/[^/?#\\s]{3,100}([/?#]\\S*)?)$",
      "examples": [
        "https://www.linkedin.com/in/example-person"
      ],
      "maxLength": 2048,
      "description": "A person's public profile URL. Their latest posts, on one page."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 20,
      "maximum": 100,
      "minimum": 1,
      "description": "At most this many results, 1–100. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "query": {
      "type": "string",
      "examples": [
        "electric cars"
      ],
      "maxLength": 2048,
      "description": "Words in the post: every public post that has them, newest first."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "company_url": {
      "type": "string",
      "pattern": "^(?:(https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s]+([/?#]\\S*)?)$",
      "examples": [
        "https://www.linkedin.com/company/example-co"
      ],
      "maxLength": 2048,
      "description": "A company page URL. Up to 7 pages of 10."
    },
    "posted_within": {
      "enum": [
        "day",
        "week",
        "month"
      ],
      "type": "string",
      "description": "Only posts from the last day, week or month."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "sort": {
      "enum": [
        "relevance",
        "newest"
      ],
      "type": "string",
      "description": "Most relevant first, or newest first."
    },
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "limit": {
      "type": "integer",
      "default": 25,
      "maximum": 25,
      "minimum": 1,
      "description": "At most this many results, 1–25. A page can hold fewer while `next_cursor` is set: read until it is null."
    },
    "query": {
      "type": "string",
      "examples": [
        "backend engineer"
      ],
      "maxLength": 2048,
      "description": "Job title or keywords, e.g. \"backend engineer\"."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "location": {
      "type": "string",
      "maxLength": 2048,
      "description": "Place name, e.g. \"Berlin\" or \"United States\"."
    },
    "company_id": {
      "type": "string",
      "pattern": "^(?:\\d{1,12})$",
      "maxLength": 2048,
      "description": "Only one company's roles: `company_id` in linkedin/company."
    },
    "easy_apply": {
      "type": "boolean",
      "description": "Only roles that take applications on LinkedIn."
    },
    "posted_within": {
      "enum": [
        "day",
        "week",
        "month"
      ],
      "type": "string",
      "description": "Only roles posted in the last day, week or month."
    },
    "workplace_type": {
      "enum": [
        "on-site",
        "hybrid",
        "remote"
      ],
      "type": "string",
      "description": "Only roles of this kind, as LinkedIn's filter names them."
    },
    "employment_type": {
      "enum": [
        "full-time",
        "part-time",
        "contract",
        "temporary",
        "internship"
      ],
      "type": "string",
      "description": "Only roles of this kind."
    },
    "experience_level": {
      "enum": [
        "internship",
        "entry",
        "associate",
        "mid-senior",
        "director",
        "executive"
      ],
      "type": "string",
      "description": "Only roles at this level, as LinkedIn's filter names them."
    }
  },
  "additionalProperties": false
}

Input schema (JSON)

{
  "type": "object",
  "required": [],
  "properties": {
    "fresh": {
      "type": "boolean",
      "default": false,
      "description": "Skip the cache and fetch now. Charged normally. Not available on trial credits — buy any pack to unlock it."
    },
    "query": {
      "type": "string",
      "examples": [
        "data engineer"
      ],
      "maxLength": 2048,
      "description": "Words to search for, as in LinkedIn's search box."
    },
    "title": {
      "type": "string",
      "maxLength": 2048,
      "description": "Words in their current title, e.g. \"head of data\"."
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "description": "The `meta.next_cursor` from the previous page. Omit for the first page."
    },
    "school": {
      "type": "string",
      "pattern": "^(?:((https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s,]+([/?#][^\\s,]*)?|\\d{1,12})(,((https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s,]+([/?#][^\\s,]*)?|\\d{1,12}))*)$",
      "maxLength": 2048,
      "description": "Where they studied: a school page URL or its id. Several, comma-separated."
    },
    "source": {
      "enum": [
        "public",
        "sales_navigator"
      ],
      "type": "string",
      "default": "public",
      "description": "`public` is LinkedIn's people search; `sales_navigator` is Sales Navigator's lead search, which hides no one and gives current roles, at a higher price."
    },
    "location": {
      "type": "string",
      "maxLength": 2048,
      "description": "A place name, e.g. \"Berlin\" or \"Germany\"."
    },
    "last_name": {
      "type": "string",
      "maxLength": 2048,
      "description": "Their last name, as their profile gives it."
    },
    "first_name": {
      "type": "string",
      "maxLength": 2048,
      "description": "Their first name, as their profile gives it."
    },
    "past_company": {
      "type": "string",
      "pattern": "^(?:((https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s,]+([/?#][^\\s,]*)?|\\d{1,12})(,((https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s,]+([/?#][^\\s,]*)?|\\d{1,12}))*)$",
      "maxLength": 2048,
      "description": "Where they worked before, as `current_company`."
    },
    "current_company": {
      "type": "string",
      "pattern": "^(?:((https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s,]+([/?#][^\\s,]*)?|\\d{1,12})(,((https?://)?([a-z]{1,3}\\.)?linkedin\\.com/(company|school|showcase)/[^/?#\\s,]+([/?#][^\\s,]*)?|\\d{1,12}))*)$",
      "maxLength": 2048,
      "description": "Where they work now: a company page URL or `company_id`. Several, comma-separated."
    }
  },
  "additionalProperties": false
}