Tools

Facebook tools

Pages, posts, groups, comments and transcripts.

Public Facebook data. Each call costs what the data provider charges for it, and the cost line under each tool below gives the number. A question Facebook cannot answer has no tool, rather than a tool that returns nothing.

ToolWhat it doesCost
facebook_get_profileGet a Facebook pageFrom 1 credit
facebook_get_postsGet a page's postsFrom 1 credit
facebook_get_postGet a Facebook postFrom 1 credit
facebook_get_commentsGet a post's commentsFrom 1 credit
facebook_get_group_postsGet a group's postsFrom 1 credit
facebook_get_transcriptGet a video's transcriptFrom 1 credit

#Get a Facebook page

facebook_get_profile

One Facebook page: its followers, its category, its address and its website.

Use when: checking a business page is real and current, reading its category and contact details.

Not for: its posts, use facebook_get_posts. Its ads, use ads_get_advertiser_ads with platform facebook.

Returns: Record. platform, kind, id, handle, name, url, bio, verified, followers, following, posts_count, likes, views, location, website, employees, industry, created_at. A field the platform does not publish is null. kind is company, because these are pages rather than people.

Cost: 1 credit. Cached 24 hours.

ParameterDefault and notes
handle or urlhandle: a page name; url: the full page URL; give one

Also takes provider, max_credits, dry_run: see common parameters.

JSON
{
  "url": "https://www.facebook.com/gymshark"
}

#Get a page's posts

facebook_get_posts

The posts on one Facebook page, newest first.

Use when: watching what a business page publishes, judging cadence and reactions.

Not for: a group's posts, use facebook_get_group_posts. One post in full, use facebook_get_post.

Returns: List, one page per call. rows[]: platform, id, url, author, author_name, created_at, text (cut at 2000 characters), likes, comments, shares, views, media, duration_s, is_ad. A number the platform does not publish is null. Facebook publishes no share count, so shares is null.

Cost: 1 credit per page. Cached 6 hours.

ParameterDefault and notes
handle or urlhandle: a page name; url: the full page URL; give one

Also takes cursor, provider, max_credits, dry_run: see common parameters.

JSON
{
  "url": "https://www.facebook.com/gymshark"
}

#Get a Facebook post

facebook_get_post

One Facebook post with its reactions, comments, shares and views.

Use when: a row is worth the detail, or you have a URL and nothing else.

Not for: the comments themselves, use facebook_get_comments. What is said in a video, use facebook_get_transcript.

Returns: Record. rows[]: platform, id, url, author, author_name, created_at, text (cut at 2000 characters), likes, comments, shares, views, media, duration_s, is_ad. A number the platform does not publish is null.

Cost: 1 credit. Cached 6 hours.

ParameterDefault and notes
urlRequired, the post or reel URL

Also takes provider, max_credits, dry_run: see common parameters.

JSON
{
  "url": "https://www.facebook.com/reel/1535656380759655"
}

#Get a post's comments

facebook_get_comments

The comments on one Facebook post.

Use when: reading what people replied to a page or a group post.

Not for: the post itself, use facebook_get_post. Comments across many posts, which Facebook does not offer.

Returns: List, one page per call. rows[]: platform, id, post_id, author, created_at, text (cut at 2000 characters), likes, replies, depth. meta.cursor pages the next set.

Cost: 1 credit per page. Cached 6 hours.

ParameterDefault and notes
urlRequired

Also takes cursor, provider, max_credits, dry_run: see common parameters.

JSON
{
  "url": "https://www.facebook.com/reel/1535656380759655"
}

#Get a group's posts

facebook_get_group_posts

The posts in one Facebook group, newest first.

Use when: watching a community you sell into, the way reddit_get_new_posts watches a subreddit.

Not for: a page's own posts, use facebook_get_posts. A complete window since a moment, which Facebook does not offer: page with the cursor and dedupe on id.

Returns: List, one page per call. rows[]: platform, id, url, author, author_name, created_at, text (cut at 2000 characters), likes, comments, shares, views, media, duration_s, is_ad. A number the platform does not publish is null. meta.cursor pages the next set.

Cost: 1 credit per page. Cached 6 hours.

ParameterDefault and notes
urlRequired, the group URL

Also takes cursor, provider, max_credits, dry_run: see common parameters.

JSON
{
  "url": "https://www.facebook.com/groups/742354120555345"
}

#Get a video's transcript

facebook_get_transcript

What is said out loud in one Facebook video or reel, as text.

Use when: reading a video without watching it, pulling the claims out of a page's ad or clip.

Not for: the post's text, which facebook_get_post already returns.

Returns: Record. platform, url, language, text (the full transcript, uncut). NoData when the post carries no speech.

Cost: 1 credit. Cached 30 days.

ParameterDefault and notes
urlRequired
languageOptional

Also takes provider, max_credits, dry_run: see common parameters.

JSON
{
  "url": "https://www.facebook.com/reel/1535656380759655"
}