# API reference

Every endpoint of the API. Account and management endpoints are documented by hand; every data API has a page generated from the live catalog.

All endpoints live at `https://api.primaryapi.com` and speak JSON. Authenticate with `Authorization: Bearer pa_live_…` or `X-API-Key: pa_live_…` ([Authentication](/docs/authentication)). Errors always have the shape `{ code, error, requestId }` ([Errors](/docs/errors)).

## Account and management endpoints

| Area | Endpoints | Page |
|---|---|---|
| Run and quote | `POST /v1/run/{sku}`, `POST /v1/quote/{sku}` | [Run and quote](/docs/api-reference/run) |
| Requests and results | `GET /v1/requests`, `GET /v1/requests/{id}`, `GET /v1/results/{id}` | [Requests and results](/docs/api-reference/requests) |
| API keys | `GET`/`POST /v1/api-keys`, `GET`/`PATCH`/`DELETE /v1/api-keys/{id}`, `POST /v1/api-keys/{id}/rotate`, `GET /v1/api-keys/{id}/usage` | [API keys](/docs/api-reference/keys) |
| Balance and billing | `GET /v1/balance`, `GET /v1/billing/ledger`, `GET /v1/billing/orders`, `GET /v1/billing/packs`, `POST /v1/billing/checkout`, `GET /v1/workspace` | [Balance and billing](/docs/api-reference/balance) |
| Usage | `GET /v1/usage` | [Usage](/docs/api-reference/usage) |
| Monitors | `GET`/`POST /v1/monitors`, `GET`/`PATCH`/`DELETE /v1/monitors/{id}`, `GET /v1/monitors/by-custom-id/{customId}`, `POST /v1/monitors/{id}/run`, `POST /v1/monitors/{id}/test`, `GET /v1/monitors/{id}/runs`, `GET /v1/monitors/{id}/deliveries`, `POST /v1/monitors/{id}/deliveries/{deliveryId}/redeliver` | [Monitors](/docs/monitors) |
| Webhook signing secret | `GET /v1/webhooks/secret`, `POST /v1/webhooks/secret/rotate` | [Webhooks](/docs/webhooks#the-signing-secret) |
| Catalog and status | `GET /v1/apis`, `GET /v1/apis/{sku}`, `GET /v1/catalog`, `GET /v1/categories`, `GET /v1/platforms`, `GET /openapi.json`, `GET /v1/status`, `GET /v1/status/apis`, `GET /health`, `GET /ready` | [Catalog and status](/docs/api-reference/catalog) |
| Agents | `POST /agent/signup`, `GET /v1/agent/claim/{token}`, `POST /v1/agent/claim/{token}/approve` | [Agents](/docs/api-reference/agents) |
| Feedback | `POST /v1/feedback`, `POST /v1/bug-reports`, `POST /v1/api-requests` | [Feedback](/docs/api-reference/feedback) |
| MCP | `POST /mcp` | [MCP server](/docs/mcp-server) |

## Who can call what

| Endpoint | No key | `run` key | `view` key | `full` key | Dashboard session |
|---|---|---|---|---|---|
| Catalog, status, OpenAPI, health | yes | yes | yes | yes | yes |
| `POST /agent/signup`, `POST /v1/api-requests` | yes | yes | yes | yes | yes |
| `POST /v1/run/{sku}`, `POST /v1/quote/{sku}` | — | yes | — | yes | yes |
| `GET /v1/requests`, `/v1/requests/{id}`, `/v1/results/{id}` | — | yes | yes | yes | yes |
| `GET /v1/balance`, `/v1/usage`, `/v1/billing/ledger`, `/v1/billing/orders`, `/v1/workspace` | — | — | yes | yes | yes |
| `/v1/api-keys/**` | — | — | — | yes | yes |
| `GET /v1/monitors/**` (monitors, runs, deliveries) | — | yes | yes | yes | yes |
| `POST`/`PATCH`/`DELETE /v1/monitors/**` | — | its own monitors | — | yes | owners, admins, developers |
| `/v1/webhooks/secret`, `/v1/webhooks/secret/rotate` | — | — | — | yes | owners, admins |
| `POST /v1/feedback`, `POST /v1/bug-reports` | — | yes | yes | yes | yes |
| `POST /v1/billing/checkout`, `/v1/agent/claim/**`, `POST /v1/workspace/restricted-terms` | — | — | — | — | yes |

## Data APIs

Every data API is called with `POST /v1/run/{sku}` and documented on its own page: input fields, output fields, prices, measured reliability, example request and response, and the errors to handle. The pages are generated from the same catalog the gateway runs on, grouped by category and platform. The catalog currently lists **200 APIs** across 31 platforms in 10 categories.

### Social

- [bluesky.post](https://primaryapi.com/docs/api-reference/bluesky/post): One public Bluesky post by URL: text, author, like, reply, repost and quote counts, media and creation time. 1 credit per call.
- [bluesky.profile](https://primaryapi.com/docs/api-reference/bluesky/profile): Public Bluesky profile for one handle or DID: display name, bio, avatar, follower, following and post counts. 1 credit per call.
- [bluesky.user_posts](https://primaryapi.com/docs/api-reference/bluesky/user_posts): Recent posts from one Bluesky account, newest first, with engagement counts, media and cursor pagination. 1 credit per call.
- [hackernews.profile](https://primaryapi.com/docs/api-reference/hackernews/profile): A Hacker News user's public profile: karma, about text and account creation date. 1 credit per call.
- [hackernews.search](https://primaryapi.com/docs/api-reference/hackernews/search): Full-text search of Hacker News stories and comments with title, link, author, points and comment count. 1 credit per call.
- [hackernews.story](https://primaryapi.com/docs/api-reference/hackernews/story): One Hacker News story or item by id: title, link, author, points, comment count and timestamp. 1 credit per call.
- [hackernews.story_comments](https://primaryapi.com/docs/api-reference/hackernews/story_comments): Every comment of a Hacker News story, flattened depth-first with parent ids, authors, timestamps and depth. 1 credit per call.
- [instagram.basic_profile](https://primaryapi.com/docs/api-reference/instagram/basic_profile): Core public profile fields (username, counts, bio, verification) for an Instagram account when you already hold its numeric user id. 1 credit per call.
- [instagram.comment_replies](https://primaryapi.com/docs/api-reference/instagram/comment_replies): Replies to one comment on a public Instagram post or reel, paged by cursor, with text, author and like counts. 1 credit per call.
- [instagram.hashtag_recent_posts](https://primaryapi.com/docs/api-reference/instagram/hashtag_recent_posts): Newest Instagram posts under a hashtag, read from its live chronological feed, for monitoring a tag as posts appear. 1 credit per call.
- [instagram.highlight_detail](https://primaryapi.com/docs/api-reference/instagram/highlight_detail): Every story item of one Instagram highlight by id: photo and video URLs, sizes, durations and timestamps. 1 credit per call.
- [instagram.media_transcript](https://primaryapi.com/docs/api-reference/instagram/media_transcript): Spoken-audio transcript of a public Instagram reel or video post by URL, one entry per video in the post. 3 credits per call.
- [instagram.post](https://primaryapi.com/docs/api-reference/instagram/post): One public Instagram post or reel by URL: owner, caption, like, comment and play counts, media URLs and audio. 1 credit per call.
- [instagram.post_comments](https://primaryapi.com/docs/api-reference/instagram/post_comments): Comments on a public Instagram post or reel by URL, one page per call, with text, author, likes and reply counts. 1 credit per call.
- [instagram.profile](https://primaryapi.com/docs/api-reference/instagram/profile): Public profile of one Instagram account by handle: bio and links, follower, following and post counts, verification and business flags. 1 credit per call.
- [instagram.profile_contact](https://primaryapi.com/docs/api-reference/instagram/profile_contact): Contact email and phone number an Instagram creator or business publishes on its profile, including the address behind the Email and Call buttons. 1 credit per call.
- [instagram.search_profiles](https://primaryapi.com/docs/api-reference/instagram/search_profiles): Find public Instagram profiles matching a keyword (name, handle or bio words) with handle, name, verified and private flags. 1 credit per call.
- [instagram.reel_transcript](https://primaryapi.com/docs/api-reference/instagram/reel_transcript): Speech transcript of a public Instagram reel or video post with timed segments, billed per started audio minute. 4.38 credits per result.
- [instagram.reels_search](https://primaryapi.com/docs/api-reference/instagram/reels_search): Search Instagram Reels by keyword through Instagram's own reels search, with views, likes, comments, caption and creator. 1 credit per call.
- [instagram.web_reels_search](https://primaryapi.com/docs/api-reference/instagram/web_reels_search): Search Instagram Reels through a web search index with an optional recency window and numbered pages (pages 1-11 of about 10 reels). 1 credit per call.
- [instagram.search](https://primaryapi.com/docs/api-reference/instagram/search): Keyword search over Instagram users, hashtags or places with names, counts and links. 1 credit per call.
- [instagram.similar_profiles](https://primaryapi.com/docs/api-reference/instagram/similar_profiles): Accounts Instagram recommends as similar to a public profile, with handle, display name, verified flag and avatar. 1 credit per call.
- [instagram.stories_thin](https://primaryapi.com/docs/api-reference/instagram/stories_thin): Lightweight list of a public account's live stories: media URL, permalink, owner and posting time only. 3 credits per call.
- [instagram.stories_full](https://primaryapi.com/docs/api-reference/instagram/stories_full): Currently live stories of a public Instagram account with media URLs, type, dimensions, posting time and 24-hour expiry. 3 credits per call.
- [instagram.tagged_posts](https://primaryapi.com/docs/api-reference/instagram/tagged_posts): Posts in which a public Instagram account is tagged, newest first, with the posting author, caption and engagement counts. 1 credit per call.
- [instagram.user_highlights](https://primaryapi.com/docs/api-reference/instagram/user_highlights): Story highlight reels of a public Instagram account by handle: ids, titles, cover images and owner. 3 credits per call.
- [instagram.user_posts](https://primaryapi.com/docs/api-reference/instagram/user_posts): Recent feed posts of a public Instagram account by handle (about 12 per page) with caption, likes, comments, views, media and cursor pagination. 1 credit per call.
- [instagram.user_reels](https://primaryapi.com/docs/api-reference/instagram/user_reels): Reels of a public Instagram account by handle or user id with plays, likes, comments and caption, with cursor pagination. 1 credit per call.
- [instagram.hashtag_analytics](https://primaryapi.com/docs/api-reference/instagram/hashtag_analytics): Total public post count for an Instagram hashtag, plus related tags when the source returns them. Planned.
- [instagram.search_hashtag](https://primaryapi.com/docs/api-reference/instagram/search_hashtag): Posts under a hashtag from a web search index, filterable by date window and media type. Planned.
- [instagram.location_posts](https://primaryapi.com/docs/api-reference/instagram/location_posts): Public posts tagged at an Instagram location id, ranked or most recent, with cursor pagination. Planned.
- [instagram.search_locations](https://primaryapi.com/docs/api-reference/instagram/search_locations): Search Instagram places by keyword and return each place id, name, address and coordinates. Planned.
- [instagram.embed](https://primaryapi.com/docs/api-reference/instagram/embed): Public embed HTML document for an Instagram profile handle. Planned.
- [instagram.search_profiles_contact](https://primaryapi.com/docs/api-reference/instagram/search_profiles_contact): Keyword profile search that also returns each hit's country, join month, public email and phone, billed per profile returned. Planned.
- [instagram.audio_reels](https://primaryapi.com/docs/api-reference/instagram/audio_reels): Reels that use a given Instagram audio track, by audio id. Planned.
- [instagram.search_followers](https://primaryapi.com/docs/api-reference/instagram/search_followers): Search within a public account's followers by name or username using Instagram's own follower search. Planned.
- [instagram.search_following](https://primaryapi.com/docs/api-reference/instagram/search_following): Search within the accounts a public user follows by name or username using Instagram search. Planned.
- [instagram.trending_reels](https://primaryapi.com/docs/api-reference/instagram/trending_reels): Recently popular Instagram reels, up to 12 per call, with caption, creator and engagement counts. Planned.
- [instagram.user_reposts](https://primaryapi.com/docs/api-reference/instagram/user_reposts): Posts a public Instagram account has reposted to its feed, by numeric user id, with cursor pagination. Planned.
- [linkinbio.lookup](https://primaryapi.com/docs/api-reference/linkinbio/lookup): Resolve a creator's link-in-bio page (Linktree, Komi, Pillar, Lnk.bio, Linkme) into its title, socials, contact email and every link. 1 credit per call.
- [naver.blog_search](https://primaryapi.com/docs/api-reference/naver/blog_search): Search Korean Naver blog posts by keyword: title, excerpt, blogger, post URL and publish date. Planned.
- [nextdoor.business](https://primaryapi.com/docs/api-reference/nextdoor/business): One Nextdoor business page by slug: name, categories, address, phone, website and favourite count. Planned.
- [nextdoor.search](https://primaryapi.com/docs/api-reference/nextdoor/search): Find local businesses listed on Nextdoor by city and trade category, with address and contact details. Planned.
- [pinterest.search](https://primaryapi.com/docs/api-reference/pinterest/search): Search Pinterest pins by keyword and get titles, images, pinner and destination links, with cursor pagination. 2 credits per call.
- [reddit.post](https://primaryapi.com/docs/api-reference/reddit/post): One Reddit post by URL: title, body, author, subreddit, score, upvote ratio, comment count and flags. 2 credits per call.
- [reddit.post_comments](https://primaryapi.com/docs/api-reference/reddit/post_comments): Comments of a Reddit post by URL, flattened depth-first with parent ids, scores and timestamps, cursor paged. 2 credits per call.
- [reddit.search](https://primaryapi.com/docs/api-reference/reddit/search): Search Reddit posts across all subreddits by query, with sort order and time window, cursor paged. 2 credits per call.
- [reddit.subreddit_details](https://primaryapi.com/docs/api-reference/reddit/subreddit_details): Metadata of one subreddit: description, icon, creation date, weekly active users and advertiser category. 2 credits per call.
- [reddit.subreddit_posts](https://primaryapi.com/docs/api-reference/reddit/subreddit_posts): Posts of one subreddit listing (hot, new or top with a time window), cursor paged. 2 credits per call.
- [reddit.subreddit_search](https://primaryapi.com/docs/api-reference/reddit/subreddit_search): Search posts inside one subreddit by query, sort order and time window, cursor paged. 2 credits per call.
- [reddit.trending_posts](https://primaryapi.com/docs/api-reference/reddit/trending_posts): Currently popular posts across Reddit (the r/popular feed), cursor paged. 2 credits per call.
- [reddit.user_posts](https://primaryapi.com/docs/api-reference/reddit/user_posts): Posts submitted by one Reddit user, sorted by new, top, hot or controversial, cursor paged. 2 credits per call.
- [reddit.search_accounts](https://primaryapi.com/docs/api-reference/reddit/search_accounts): Find Reddit communities (subreddits) or users by keyword. Planned.
- [reddit.post_transcript](https://primaryapi.com/docs/api-reference/reddit/post_transcript): Spoken-word transcript of a Reddit video post, from its post URL or v.redd.it link. Planned.
- [reddit.user_comments](https://primaryapi.com/docs/api-reference/reddit/user_comments): Comments written by a Reddit user, with the parent post title and subreddit, cursor paged. Planned.
- [rednote.note](https://primaryapi.com/docs/api-reference/rednote/note): One RedNote (Xiaohongshu) note by id: title, text, cover, author, engagement counts, location and timestamps. 7 credits per call.
- [rednote.note_comments](https://primaryapi.com/docs/api-reference/rednote/note_comments): Top-level comments of a RedNote (Xiaohongshu) note with author, likes, reply counts and timestamps, cursor paged. 13 credits per call.
- [rednote.profile](https://primaryapi.com/docs/api-reference/rednote/profile): RedNote (Xiaohongshu) creator profile by user id: nickname, RedNote number, bio, follower, like and note counts. 7 credits per call.
- [rednote.search](https://primaryapi.com/docs/api-reference/rednote/search): Search RedNote (Xiaohongshu) notes by keyword, sorted by relevance, popularity or time, cursor paged. 13 credits per call.
- [rednote.user_notes](https://primaryapi.com/docs/api-reference/rednote/user_notes): Notes posted by a RedNote (Xiaohongshu) user, with cover, engagement counts and timestamps, cursor-paged. 13 credits per call.
- [rednote.search_users](https://primaryapi.com/docs/api-reference/rednote/search_users): Search RedNote (Xiaohongshu) users by keyword and get normalised user records with RedNote number, bio and verification. 13 credits per call.
- [snapchat.profile](https://primaryapi.com/docs/api-reference/snapchat/profile): Public Snapchat profile by username: display name, bio, subscriber count, category, website and curated story highlights. 1 credit per call.
- [social.post_lookup](https://primaryapi.com/docs/api-reference/social/post_lookup): Paste a public post URL from X, Reddit, Hacker News, Weibo, RedNote or Zhihu and get that post through the matching platform API. 1 credit per call.
- [social.profile_check](https://primaryapi.com/docs/api-reference/social/profile_check): Check whether a handle exists on Facebook, Threads or Snapchat and get its public profile; a miss means the profile was not found. 2 credits per call.
- [social.search](https://primaryapi.com/docs/api-reference/social/search): Find accounts and communities on Reddit, X / Twitter or RedNote by keyword through one composite endpoint. Planned.
- [social.search_video](https://primaryapi.com/docs/api-reference/social/search_video): Keyword in, matching public accounts out (handle, name, description, followers, profile URL) on YouTube, TikTok or Instagram. Planned.
- [substack.posts](https://primaryapi.com/docs/api-reference/substack/posts): Recent posts of any Substack publication (or one post by URL): metadata, paywall status, engagement, author and the article body as HTML, Markdown and text. 1 credit per call.
- [telegram.channel](https://primaryapi.com/docs/api-reference/telegram/channel): Public Telegram channel profile: title, description, avatar, verified badge, subscriber count and media counters. 1 credit per call.
- [telegram.channel_posts](https://primaryapi.com/docs/api-reference/telegram/channel_posts): Latest public posts of a Telegram channel with text, time, views, reactions, media and link previews; pages back by cursor. 1 credit per call.
- [telegram.post](https://primaryapi.com/docs/api-reference/telegram/post): One public Telegram channel post by its t.me link: text, time, views, reactions, media and link preview. 1 credit per call.
- [threads.post](https://primaryapi.com/docs/api-reference/threads/post): One Threads post by URL: text, author, timestamp and like, reply, repost and quote counts. 2 credits per call.
- [threads.search](https://primaryapi.com/docs/api-reference/threads/search): Search public Threads posts by keyword or hashtag, optionally within a date range; up to 10 posts per call with engagement counts. 2 credits per call.
- [threads.profile](https://primaryapi.com/docs/api-reference/threads/profile): Public Threads profile by username: bio, follower count, verification, privacy flag, picture and bio links. 2 credits per call.
- [threads.user_posts](https://primaryapi.com/docs/api-reference/threads/user_posts): The latest public posts of a Threads user (about 20-30 are visible) with text, timestamps, engagement counts and URLs. 2 credits per call.
- [threads.search_users](https://primaryapi.com/docs/api-reference/threads/search_users): Search Threads accounts by name or username and get handle, display name, verification and profile picture. 2 credits per call.
- [truthsocial.post](https://primaryapi.com/docs/api-reference/truthsocial/post): One public Truth Social post by URL: text, author, like, comment and ReTruth counts, media and timestamp. 2 credits per call.
- [truthsocial.profile](https://primaryapi.com/docs/api-reference/truthsocial/profile): Public Truth Social account profile by handle: display name, bio, follower, following and post counts, verification. 2 credits per call.
- [truthsocial.user_posts](https://primaryapi.com/docs/api-reference/truthsocial/user_posts): Recent posts of a public Truth Social account, newest first, with engagement counts and media, paged by cursor. 2 credits per call.
- [twitter.tweet_transcript](https://primaryapi.com/docs/api-reference/twitter/tweet_transcript): Spoken-word transcript of a public X / Twitter video post, from its URL. 3 credits per call.
- [twitter.community](https://primaryapi.com/docs/api-reference/twitter/community): Public details of an X (Twitter) Community by URL: name, description, member count, join policy, creator and rules. 1 credit per call.
- [twitter.community_tweets](https://primaryapi.com/docs/api-reference/twitter/community_tweets): Recent posts in an X (Twitter) Community by URL, with author and engagement counts, newest first. 2 credits per call.
- [twitter.followers](https://primaryapi.com/docs/api-reference/twitter/followers): Follower list of a public X (Twitter) account with bio, counts and avatar per follower, cursor-paged up to 200 per page. 2 credits per call.
- [twitter.following](https://primaryapi.com/docs/api-reference/twitter/following): Accounts a public X (Twitter) user follows, with bio, counts and avatar per account, cursor-paged. 2 credits per call.
- [twitter.tweet](https://primaryapi.com/docs/api-reference/twitter/tweet): One public X (Twitter) post by URL: full text, author, media and engagement counts (likes, reposts, replies, quotes, bookmarks, views). 1 credit per call.
- [twitter.replies](https://primaryapi.com/docs/api-reference/twitter/replies): Replies to a public X (Twitter) post as structured records with author, text and engagement, cursor-paged about 20 per page. 2 credits per call.
- [twitter.profile](https://primaryapi.com/docs/api-reference/twitter/profile): Public X (Twitter) profile for one handle: bio, follower and post counts, verification, links and pinned posts. 1 credit per call.
- [twitter.user_posts](https://primaryapi.com/docs/api-reference/twitter/user_posts): Posts-tab timeline of a public X account: pinned post first, then newest posts, about 20 per page with cursor paging. 2 credits per call.
- [twitter.search_users](https://primaryapi.com/docs/api-reference/twitter/search_users): Search X (Twitter) accounts by keyword (the People tab) and get profile records with follower, following and post counts. 2 credits per call.
- [twitter.search_communities](https://primaryapi.com/docs/api-reference/twitter/search_communities): Search X (Twitter) Communities by keyword: id, name, topic and member count. Planned.
- [youtube.channel](https://primaryapi.com/docs/api-reference/youtube/channel): YouTube channel profile and stats by handle or channel id: subscribers, video and view counts, description and links. 1 credit per call.
- [youtube.channel_lives](https://primaryapi.com/docs/api-reference/youtube/channel_lives): Live and past live streams from a YouTube channel’s Live tab: title, views, length and publish label, with cursor pages. 2 credits per call.
- [youtube.channel_public_email](https://primaryapi.com/docs/api-reference/youtube/channel_public_email): Email address a creator wrote in a YouTube channel's public description or About links (never the hidden View email address button). 1 credit per call.
- [youtube.search_channels](https://primaryapi.com/docs/api-reference/youtube/search_channels): Keyword search returning YouTube channels (handle, name, description snippet, subscriber count, URL, avatar) with cursor pagination. 2 credits per call.
- [youtube.channel_shorts](https://primaryapi.com/docs/api-reference/youtube/channel_shorts): Shorts published by a YouTube channel (title, views, likes, duration, publish time), newest or most popular first, with cursor pagination. 2 credits per call.
- [youtube.channel_videos](https://primaryapi.com/docs/api-reference/youtube/channel_videos): Long-form videos uploaded by a YouTube channel (title, views, length, publish time), newest or most popular first, with cursor pagination. 1 credit per call.
- [youtube.search_hashtag](https://primaryapi.com/docs/api-reference/youtube/search_hashtag): Videos tagged with a YouTube hashtag (title, channel, views, length, publish time), with cursor pagination. 2 credits per call.
- [youtube.search](https://primaryapi.com/docs/api-reference/youtube/search): Keyword search over YouTube videos with relevance or popularity sorting, upload-date filters and cursor pagination. 2 credits per call.
- [youtube.search_shorts](https://primaryapi.com/docs/api-reference/youtube/search_shorts): Keyword search restricted to YouTube Shorts (title, views, channel, URL) with sorting, upload-date filters and cursor pagination. 2 credits per call.
- [youtube.video](https://primaryapi.com/docs/api-reference/youtube/video): Metadata for one YouTube video or Short by URL or ID: title, description, channel, views, likes, comment count, duration, publish date, tags and category. 2 credits per call.
- [youtube.video_comments](https://primaryapi.com/docs/api-reference/youtube/video_comments): Top-level comments on a YouTube video or Short (text, author, likes, reply count, publish time), top or newest first, with cursor pagination. 2 credits per call.
- [youtube.video_transcript](https://primaryapi.com/docs/api-reference/youtube/video_transcript): Existing captions of a YouTube video or Short as plain text plus timed segments, by URL or ID (no speech-to-text; videos without captions are a free miss). 2 credits per call.
- [youtube.video_transcript_full](https://primaryapi.com/docs/api-reference/youtube/video_transcript_full): Transcript of a YouTube video or Short with timed segments, whether the captions are creator-written or speech recognition, and the video metadata in one response. 3 credits per call.
- [youtube.channel_community_posts](https://primaryapi.com/docs/api-reference/youtube/channel_community_posts): Posts from a YouTube channel's Posts (community) tab: text, images, like count and publish time, with cursor pagination. Planned.
- [youtube.channel_contact](https://primaryapi.com/docs/api-reference/youtube/channel_contact): Business inquiry email a creator publishes behind the signed-in, CAPTCHA-gated "View email address" button on the About page. Planned.
- [youtube.channel_playlists](https://primaryapi.com/docs/api-reference/youtube/channel_playlists): Playlists on a YouTube channel's Playlists tab (ID, title, video count, thumbnail) with cursor pagination. Planned.
- [youtube.comment_replies](https://primaryapi.com/docs/api-reference/youtube/comment_replies): Replies to one YouTube comment, fetched with the replies token from youtube.video_comments, with cursor pagination. Planned.
- [youtube.community_post](https://primaryapi.com/docs/api-reference/youtube/community_post): One YouTube community post by URL: text, images, likes, publish time, channel and any attached video. Planned.
- [youtube.playlist](https://primaryapi.com/docs/api-reference/youtube/playlist): Videos in a YouTube playlist (title, length, channel per video) plus the playlist title, owner and total video count. Planned.
- [youtube.trending_shorts](https://primaryapi.com/docs/api-reference/youtube/trending_shorts): About 48 currently trending YouTube Shorts per call (title, channel, views, likes, duration); every call returns a fresh batch. Planned.
- [youtube.video_sponsors](https://primaryapi.com/docs/api-reference/youtube/video_sponsors): Paid-promotion flag of a YouTube video plus inferred sponsors (name, website, confidence) from its description, links and transcript. Planned.
- [zhihu.answer](https://primaryapi.com/docs/api-reference/zhihu/answer): One public Zhihu answer by id: full text, excerpt, author, parent question and timestamps. 2 credits per call.
- [zhihu.search_articles](https://primaryapi.com/docs/api-reference/zhihu/search_articles): Search public Zhihu articles by keyword, sorted by relevance, upvotes or date, with author and engagement data. 2 credits per call.
- [zhihu.question](https://primaryapi.com/docs/api-reference/zhihu/question): One public Zhihu question by id: title, description and answer, comment, follower and view counts. 2 credits per call.

### Search & SEO

- [maps.search_nearby](https://primaryapi.com/docs/api-reference/maps/search_nearby): Search Google Maps around exact coordinates and zoom and get one viewport of up to 20 places with the address split into street, city, state, postal code and country. 2 credits per call.
- [maps.search](https://primaryapi.com/docs/api-reference/maps/search): Search Google Maps for places matching a query in a free-text location and get up to 20 normalised places with rating, address, phone, website and coordinates. 2 credits per call.

### Knowledge & Data

- [bank.lookup](https://primaryapi.com/docs/api-reference/bank/lookup): Look up an FDIC-insured US bank by certificate number or name: status, charter, regulator, branches, assets, deposits and holding company. 1 credit per call.
- [github.repository](https://primaryapi.com/docs/api-reference/github/repository): Metadata of one public GitHub repository: stars, forks, watchers, language, license, topics and timestamps. 1 credit per call.
- [github.trending_repositories](https://primaryapi.com/docs/api-reference/github/trending_repositories): Repositories on GitHub Trending for a language and window, with rank, stars, stars gained and description. 1 credit per call.
- [github.user](https://primaryapi.com/docs/api-reference/github/user): Public profile of a GitHub user or organization: name, bio, company, location, followers and repository counts. 1 credit per call.
- [github.user_repositories](https://primaryapi.com/docs/api-reference/github/user_repositories): A GitHub user's or organization's public repositories with stars, forks, language and dates, sortable and paged. 1 credit per call.
- [github.trending_developers](https://primaryapi.com/docs/api-reference/github/trending_developers): Trending GitHub developers for a language and time range, with each developer’s most popular repository. Planned.
- [github.user_activity](https://primaryapi.com/docs/api-reference/github/user_activity): Monthly summary of a GitHub user’s public contributions (commits, pull requests and issues) for a given year. Planned.

### Video

- [video.transcript](https://primaryapi.com/docs/api-reference/video/transcript): One public video or post URL in, its transcript out, for YouTube, TikTok, Facebook, Instagram, X / Twitter, LinkedIn; billed only when a transcript is found. 2 credits per call.

### E-commerce

- [tiktok-shop.user_showcase](https://primaryapi.com/docs/api-reference/tiktok-shop/user_showcase): The TikTok Shop products a creator promotes in their profile showcase, with price, discount, rating and units sold. 3 credits per call.
- [tiktok-shop.product](https://primaryapi.com/docs/api-reference/tiktok-shop/product): Full detail of one TikTok Shop product page: title, images, price and discount, rating, units sold, seller and variants. 2 credits per call.
- [tiktok-shop.product_reviews](https://primaryapi.com/docs/api-reference/tiktok-shop/product_reviews): Customer reviews of a TikTok Shop product, page by page: rating, text, photos, variant, country and verified-purchase flag. 2 credits per call.
- [tiktok-shop.search](https://primaryapi.com/docs/api-reference/tiktok-shop/search): TikTok Shop products matching a keyword in one country store, with price, discount, rating, units sold and seller. 2 credits per call.
- [tiktok-shop.shop_products](https://primaryapi.com/docs/api-reference/tiktok-shop/shop_products): Products listed by one TikTok Shop store, with price, discount, rating and units sold per product plus store-level stats. 2 credits per call.
- [tiktok-shop.categories](https://primaryapi.com/docs/api-reference/tiktok-shop/categories): The TikTok Shop category tree for a market: top-level categories with ids, names and images, each with its children. Planned.
- [tiktok-shop.creator](https://primaryapi.com/docs/api-reference/tiktok-shop/creator): Affiliate performance of a TikTok Shop creator: GMV range, promoted products, audience demographics and engagement. Planned.

### Validation

- [email.auth_check](https://primaryapi.com/docs/api-reference/email/auth_check): Grades a domain's MX, SPF (counting the 10-lookup limit), DMARC, DKIM and BIMI records, says whether the domain can be spoofed and lists fixes. 1 credit per call.
- [email.verify](https://primaryapi.com/docs/api-reference/email/verify): Deliverability verdict (good, risky or bad) for one email address, with catch-all, disposable, role and free-provider signals and a confidence score. 1 credit per call.
- [phone.intelligence](https://primaryapi.com/docs/api-reference/phone/intelligence): Validates a phone number and returns its E.164, national and international formats, country, calling code and line type. 1 credit per call.
- [phone.number_type](https://primaryapi.com/docs/api-reference/phone/number_type): Classifies a phone number as mobile, landline, VoIP, toll-free, premium-rate and so on from numbering-plan data, with a validity check. 1 credit per call.

### Compliance & Records

- [sanctions.screen](https://primaryapi.com/docs/api-reference/sanctions/screen): Screen a person, company or vessel name against the US Consolidated Screening List (Treasury, Commerce and State lists) and get clear, possible match or match, with list, programs and country for every hit. 1 credit per call.

### Web Intelligence

- [ads.library_lookup](https://primaryapi.com/docs/api-reference/ads/library_lookup): Advertiser name in, the first page of that advertiser's Meta Ad Library ads out (creative text, media, active flag, run dates, landing URL). 4 credits per call.
- [facebook.ad_details_full](https://primaryapi.com/docs/api-reference/facebook/ad_details_full): One Meta Ad Library ad with its full creative: every carousel card or version, image and video URL, headline, body and CTA. 2 credits per call.
- [facebook.ad_details](https://primaryapi.com/docs/api-reference/facebook/ad_details): One Meta Ad Library ad by id or URL: advertiser, creative text, call to action, platforms, run dates and media. 2 credits per call.
- [facebook.search_companies](https://primaryapi.com/docs/api-reference/facebook/search_companies): Find Meta Ad Library advertisers by name and get their page ids, category, verification and linked Instagram account. 2 credits per call.
- [facebook.ads_search](https://primaryapi.com/docs/api-reference/facebook/ads_search): Search the Meta Ad Library by keyword with country, status, media, date and sort filters; returns matching ads with cursor pagination. 1 credit per call.
- [facebook.company_ads](https://primaryapi.com/docs/api-reference/facebook/company_ads): The ads one advertiser runs in the Meta Ad Library, by Ad Library page id or company name, with filters and cursor pagination. 2 credits per call.
- [facebook.event_details](https://primaryapi.com/docs/api-reference/facebook/event_details): Full details of one public Facebook event by id or URL: schedule, venue with coordinates, hosts, description and attendance. 2 credits per call.
- [facebook.events](https://primaryapi.com/docs/api-reference/facebook/events): Public Facebook events for a city or place from its events-explore URL: name, date, venue and going / interested counts. 2 credits per call.
- [facebook.events_search](https://primaryapi.com/docs/api-reference/facebook/events_search): Keyword search over public Facebook events returning name, schedule, venue, price range and attendance counts. 2 credits per call.
- [facebook.group_posts](https://primaryapi.com/docs/api-reference/facebook/group_posts): Recent posts of a public Facebook group by URL, with sort order and cursor pagination: text, author, reaction and comment counts. 2 credits per call.
- [facebook.marketplace_item](https://primaryapi.com/docs/api-reference/facebook/marketplace_item): Full details of one Facebook Marketplace listing by id or URL: title, description, price, location, photos, condition and status. 2 credits per call.
- [facebook.marketplace](https://primaryapi.com/docs/api-reference/facebook/marketplace): Search Facebook Marketplace listings by keyword near a latitude/longitude with price, condition, delivery, recency and availability filters. 2 credits per call.
- [facebook.page_contact](https://primaryapi.com/docs/api-reference/facebook/page_contact): Public contact details of a Facebook page (email, phone, website, address, price range, rating) by URL, handle or page id. 2 credits per call.
- [facebook.profile_events](https://primaryapi.com/docs/api-reference/facebook/profile_events): Events hosted by a public Facebook page by URL: name, start time, venue, city, host and status, with cursor pagination. 2 credits per call.
- [facebook.page_lookup](https://primaryapi.com/docs/api-reference/facebook/page_lookup): Resolve a brand or page name to up to 7 matching Facebook pages with id, URL, picture and verified flag. 2 credits per call.
- [facebook.photos](https://primaryapi.com/docs/api-reference/facebook/photos): Recent photos of a public Facebook page by URL: image URL, thumbnail, size, caption and photo id, with cursor pagination. 2 credits per call.
- [facebook.profile_posts](https://primaryapi.com/docs/api-reference/facebook/profile_posts): Recent public posts of a Facebook page by URL or page id, with cursor pagination: text, time, reactions, comments and media. 2 credits per call.
- [facebook.profile](https://primaryapi.com/docs/api-reference/facebook/profile): Public profile of a Facebook page by URL or handle: name, category, intro, followers, likes, website and Ad Library page id. 2 credits per call.
- [facebook.profile_reels](https://primaryapi.com/docs/api-reference/facebook/profile_reels): Reels of a public Facebook page by URL with cursor pagination: caption, view count, thumbnail, video URL and permalink. 2 credits per call.
- [facebook.search_pages](https://primaryapi.com/docs/api-reference/facebook/search_pages): Search Facebook pages by keyword, optionally near a place, and get page profiles with category, followers and contact fields. 6.25 credits per result.
- [facebook.post](https://primaryapi.com/docs/api-reference/facebook/post): One public Facebook post or reel by URL: text, author, likes, comments, shares, views, video URL and duration. 2 credits per call.
- [facebook.post_comments](https://primaryapi.com/docs/api-reference/facebook/post_comments): Top-level comments of a public Facebook post or reel with cursor pagination: text, author, reactions and reply count. 2 credits per call.
- [facebook.search_posts](https://primaryapi.com/docs/api-reference/facebook/search_posts): Keyword search over public Facebook posts, optionally by date range and place, with post text, author and engagement counts. 3.24 credits per result.
- [facebook.post_transcript](https://primaryapi.com/docs/api-reference/facebook/post_transcript): Spoken-word transcript of a public Facebook video post or reel by URL (native captions first, AI for clips up to 2 minutes). 2 credits per call.
- [facebook.followers](https://primaryapi.com/docs/api-reference/facebook/followers): List the public followers of a Facebook page or profile, or the accounts it follows, as id, name, URL and picture. Planned.
- [tiktok.ad_library_ad](https://primaryapi.com/docs/api-reference/tiktok/ad_library_ad): Full details of one TikTok ad by id or URL: brand, ad text, objective, countries, CTR and spend bucket, engagement, landing page and video. 2 credits per call.
- [tiktok.ad_library_search](https://primaryapi.com/docs/api-reference/tiktok/ad_library_search): Search TikTok's public Ads Library (Commercial Content Library) by keyword or advertiser: advertiser, format, run dates, audience band, library link and video. 3 credits per call.
- [tiktok.ad_transparency_search](https://primaryapi.com/docs/api-reference/tiktok/ad_transparency_search): Search TikTok's EU Commercial Content Library (ad transparency) by keyword, optionally narrowed to one advertiser id, region and sort order. 3 credits per call.
- [tiktok.audience_demographics](https://primaryapi.com/docs/api-reference/tiktok/audience_demographics): Where a TikTok creator's followers are located: follower count and percentage share per country, by handle. 62 credits per call.
- [tiktok.comment_replies](https://primaryapi.com/docs/api-reference/tiktok/comment_replies): Replies to one TikTok comment, with text, likes, language and replier details, paginated by cursor. 2 credits per call.
- [tiktok.followers](https://primaryapi.com/docs/api-reference/tiktok/followers): Page of accounts that follow a public TikTok profile, with each follower’s handle, name, bio and counts. 2 credits per call.
- [tiktok.following](https://primaryapi.com/docs/api-reference/tiktok/following): Page of accounts a public TikTok profile follows, with each account’s handle, display name, bio and counts. 2 credits per call.
- [tiktok.search_hashtag](https://primaryapi.com/docs/api-reference/tiktok/search_hashtag): TikTok videos posted under a hashtag, as TikTok ranks them, with captions, authors and engagement counts. 3 credits per call.
- [tiktok.hashtag_videos](https://primaryapi.com/docs/api-reference/tiktok/hashtag_videos): Recent TikTok videos posted under a hashtag, with caption, creator, sound and view, like, comment and share counts. 3 credits per call.
- [tiktok.search_keyword](https://primaryapi.com/docs/api-reference/tiktok/search_keyword): TikTok videos matching a keyword, sortable by relevance, likes or date and filterable by posting window. 2 credits per call.
- [tiktok.live](https://primaryapi.com/docs/api-reference/tiktok/live): Whether a TikTok creator is live right now and, if so, the live room title, viewers, entries and start time, by handle. 2 credits per call.
- [tiktok.photos](https://primaryapi.com/docs/api-reference/tiktok/photos): Every image of a public TikTok photo-mode (slideshow) post, in order, with the caption, author and engagement counts. 2 credits per call.
- [tiktok.playlist_videos](https://primaryapi.com/docs/api-reference/tiktok/playlist_videos): Videos inside one public TikTok playlist (collection), in playlist order, with view, like and comment counts. 2 credits per call.
- [tiktok.profile](https://primaryapi.com/docs/api-reference/tiktok/profile): Public profile of one TikTok account: bio, follower, like and video counts, verification, link in bio and stable ids. 2 credits per call.
- [tiktok.profile_contact](https://primaryapi.com/docs/api-reference/tiktok/profile_contact): Public contact emails of a TikTok creator, read from the bio and the linked website, each labelled with its source. 3 credits per call.
- [tiktok.profile_region](https://primaryapi.com/docs/api-reference/tiktok/profile_region): Country code TikTok associates with an account, looked up by handle. 2 credits per call.
- [tiktok.profile_reposts](https://primaryapi.com/docs/api-reference/tiktok/profile_reposts): Videos a public TikTok account has reposted to its profile, with the original creator and engagement counts. 2 credits per call.
- [tiktok.profile_videos](https://primaryapi.com/docs/api-reference/tiktok/profile_videos): One page of the public videos a TikTok account has posted, newest or most popular first, with engagement counts. 2 credits per call.
- [tiktok.search_suggestions](https://primaryapi.com/docs/api-reference/tiktok/search_suggestions): Search terms TikTok suggests for a seed keyword, with language and relative weight: what users type around a topic. 2 credits per call.
- [tiktok.song](https://primaryapi.com/docs/api-reference/tiktok/song): Details of a TikTok sound by clip id: title, artist, album, duration, cover art and how many videos use it. 2 credits per call.
- [tiktok.song_videos](https://primaryapi.com/docs/api-reference/tiktok/song_videos): One page of TikTok videos that use a given sound, with captions, authors and engagement counts. 2 credits per call.
- [tiktok.top_ads_search](https://primaryapi.com/docs/api-reference/tiktok/top_ads_search): Search TikTok Creative Center top-performing video ads by brand or product keyword, with objective, period and performance filters. 2 credits per call.
- [tiktok.search_top](https://primaryapi.com/docs/api-reference/tiktok/search_top): Results of TikTok's "Top" search tab for a keyword: videos and photo carousels with captions and engagement counts. 2 credits per call.
- [tiktok.trending_feed](https://primaryapi.com/docs/api-reference/tiktok/trending_feed): A fresh sample of TikTok's For You feed as served from one country, with caption, author and engagement per video. 3 credits per call.
- [tiktok.trending_hashtags](https://primaryapi.com/docs/api-reference/tiktok/trending_hashtags): TikTok Creative Center's trending hashtag board for one market and industry, with post counts, views and a daily popularity curve. 2 credits per call.
- [tiktok.search_users](https://primaryapi.com/docs/api-reference/tiktok/search_users): TikTok accounts matching a name or keyword, with handles, ids, follower counts and linked profiles. 2 credits per call.
- [tiktok.video](https://primaryapi.com/docs/api-reference/tiktok/video): Caption, author, sound, engagement counts and a playable media URL for one public TikTok video or photo post. 1 credit per call.
- [tiktok.video_comments](https://primaryapi.com/docs/api-reference/tiktok/video_comments): Top-level comments on a public TikTok video or photo post, with author, likes and reply counts, page by page. 2 credits per call.
- [tiktok.video_download](https://primaryapi.com/docs/api-reference/tiktok/video_download): Direct media links for a public TikTok video: the no-watermark MP4, the watermarked MP4 and the cover, with size and duration. 1 credit per call.
- [tiktok.video_transcript](https://primaryapi.com/docs/api-reference/tiktok/video_transcript): The caption track TikTok already has for a public video, flattened to plain text with timed segments when available. 2 credits per call.
- [tiktok.video_transcript_full](https://primaryapi.com/docs/api-reference/tiktok/video_transcript_full): Speech-to-text transcript of a public TikTok video with timed segments and optional word timings, billed per started audio minute. 3 credits per call.
- [tiktok.search_photos](https://primaryapi.com/docs/api-reference/tiktok/search_photos): Search TikTok photo-mode (slideshow) posts by keyword, with every image of each post and its engagement counts. Planned.
- [tiktok.profile_playlists](https://primaryapi.com/docs/api-reference/tiktok/profile_playlists): The playlists a TikTok creator has published on their profile, with name, video count and cover image. Planned.
- [tiktok.user_stories](https://primaryapi.com/docs/api-reference/tiktok/user_stories): A TikTok creator's currently active public stories: video or photo links, posting and expiry times and engagement counts. Planned.

### Audio

- [spotify.album](https://primaryapi.com/docs/api-reference/spotify/album): A Spotify album by URL or ID with its tracklist, per-track play counts, album total, label and release date. 5 credits per call.
- [spotify.artist](https://primaryapi.com/docs/api-reference/spotify/artist): A Spotify artist by URL or ID: followers, monthly listeners, world rank, top cities, top tracks with play counts and releases. 2 credits per call.
- [spotify.play_count](https://primaryapi.com/docs/api-reference/spotify/play_count): Lifetime stream counts for a Spotify track, every track of an album, or an artist's top tracks, from one URL. 1.13 credits per result.
- [spotify.podcast](https://primaryapi.com/docs/api-reference/spotify/podcast): A Spotify podcast show by URL or ID: name, publisher, description, artwork, episode count and languages. 2 credits per call.
- [spotify.track](https://primaryapi.com/docs/api-reference/spotify/track): One Spotify track by URL or ID: lifetime play count, popularity, duration, artists and album details. 2 credits per call.

### Web Scraping

- [linktree.profile](https://primaryapi.com/docs/api-reference/linktree/profile): Public Linktree page by URL: title, bio, avatar, contact e-mail, linked social accounts and every link with its destination. 1 credit per call.

Missing an API you need? [Ask for it](/docs/api-reference/feedback#post-v1api-requests); the request takes a minute and needs no account.
