AI agents: this page is for people. Read https://agentmarket.fluxapay.xyz/marketplace/apis/anyapi/skills.md for every endpoint, its price, and how to call it with a FluxA API key (no account with AnyAPI needed).
AnyAPIVerified
AnyAPI: 480+ scraping and data APIs behind one listing with normalized JSON and automatic provider…
AnyAPI: 480+ scraping and data APIs behind one listing with normalized JSON and automatic provider failover. Social data (Instagram, TikTok, LinkedIn, X, YouTube, Facebook, Reddit, Threads, Douyin, RedNote, Weibo), Google search, Maps, news and SEO (keywords, backlinks, rankings), Amazon/eBay/TikTok Shop commerce, company and people search, email finding and verification, travel, finance and web-page-to-Markdown. Priced at AnyAPI's own per-request USD prices.
Ask your agent, for example
Copy one and give it to Claude Code, Codex or any agent:
Your agent will ask for your FluxA API key.
Endpoints 489All 489 healthy
https://router.fluxapay.xyz/api/anyapiCopy base URLGet the referring pages linking to a domain or URL, each with the source page, anchor text, linking domain rating, and page title. $0.00501 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
mode | string | Optional | Match scope: "exact" for the given URL only, or "subdomains" to include the domain and its subdomains. One of: exact, subdomains. Default "subdomains". |
url | string | Required | The domain or page URL to find backlinks for (e.g. "ahrefs.com"). |
Get related keyword suggestions for any seed term, each with an Ahrefs difficulty and search-volume bucket. $0.00501 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Two-letter country code that scopes the suggestions (e.g. us, gb, de). Default "us". |
keyword | string | Required | The seed keyword to expand into related suggestions (e.g. "coffee"). |
Get the Ahrefs keyword-difficulty metrics for any search term: the difficulty score (0-100) and the number of referring domains a page needs to rank in the top 10 - as normalized JSON. $0.00501 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Two-letter country code that scopes volume and difficulty (e.g. us, gb, de). Default "us". |
keyword | string | Required | The search term to analyze (e.g. "seo tools"). |
Get an SEO authority overview for any domain or URL: Domain Rating, total backlinks, and referring domains - as normalized JSON. For the keywords a domain ranks for, use seo.ranked_keywords. $0.00501 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
mode | string | Optional | Analysis scope: subdomains covers the whole domain, exact matches only the given URL. One of: exact, subdomains. Default "subdomains". |
url | string | Required | The domain or page URL to analyze (e.g. ahrefs.com). |
Get the Ahrefs organic traffic overview for any domain or URL: monthly traffic estimate and value, the top 5 keywords it already ranks for with position and traffic, top pages, traffic by country, and a monthly traffic history - as normalized JSON. For a domain's full ranked-keyword list with search volume and difficulty, use seo.ranked_keywords. $0.00501 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
mode | string | Optional | Analysis scope: subdomains covers the domain and its subdomains, domain covers the root domain only, prefix covers every page under the given path, exact matches only the given URL. One of: exact, subdomains, prefix, domain. Default "subdomains". |
url | string | Required | The domain or page URL to analyze (e.g. ahrefs.com). |
Search Airbnb listings by location and dates with optional price, beds/bedrooms/bathrooms, and guest-party filters and get results (name, total-stay price label, rating, host) as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.01108 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult guests (e.g. 2). |
checkIn | string | Optional | Check-in date in YYYY-MM-DD format (e.g. 2026-07-01). |
checkOut | string | Optional | Check-out date in YYYY-MM-DD format (e.g. 2026-07-05). |
children | integer | Optional | Number of child guests (e.g. 1). |
currency | string | Optional | Currency code for prices (e.g. EUR). Default "USD". |
infants | integer | Optional | Number of infant guests (e.g. 1). |
location | string | Required | Location to search listings in (e.g. London). |
minBathrooms | integer | Optional | Minimum number of bathrooms (e.g. 2). |
minBedrooms | integer | Optional | Minimum number of bedrooms (e.g. 2). |
minBeds | integer | Optional | Minimum number of beds (e.g. 2). |
pets | integer | Optional | Number of pets; only pet-friendly listings are returned when set (e.g. 1). |
priceMax | integer | Optional | Maximum search price in the selected currency (e.g. 300). |
priceMin | integer | Optional | Minimum search price in the selected currency (e.g. 50). |
Search Alibaba by keyword and get up to 25 wholesale listings (title, price range, minimum order, and supplier) in one normalized response. Returns up to 10 results per call (page with cursor/page where offered). $0.0077 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Keywords to search for on Alibaba (e.g. "bluetooth speaker wholesale"). |
Look up one AliExpress product by id and get its price, original price, rating, reviews count, images, options, variants with stock, specifications, store, ship-from country and delivery estimate in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Ship-to country as a 2-letter ISO code, e.g. US or DE. It changes prices, stock and the delivery estimate. Default "US". |
currency | string | Optional | Price currency as a 3-letter ISO code, e.g. USD or EUR. Default "USD". |
productId | string | Required | AliExpress product id, the number in the product URL (https://www.aliexpress.com/item/<id>.html), e.g. 3256807039224587. The AliExpress Search SKU returns it as productId. |
Get one page of buyer reviews for an AliExpress product by id, with rating, text, buyer country, date, bought variant and photos for each review, plus the product's total reviews, average rating and star distribution, in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based page of 20 reviews in AliExpress's default order. Each page is billed as one request. Default 1. |
productId | string | Required | AliExpress product id, the number in the product URL (https://www.aliexpress.com/item/<id>.html), e.g. 3256807039224587. The AliExpress Search SKU returns it as productId. |
Search AliExpress by keyword with optional sort, price-range, page, ship-to country and currency, and get title, price, original price, units sold and image for each product in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Ship-to country as a 2-letter ISO code, e.g. US or DE. It changes prices, availability and delivery estimates. Default "US". |
currency | string | Optional | Price currency as a 3-letter ISO code, e.g. USD or EUR. Default "USD". |
maxPrice | number | Optional | Optional maximum product price, in the requested currency. |
minPrice | number | Optional | Optional minimum product price, in the requested currency. |
page | integer | Optional | 1-based results page of about 60 products; AliExpress serves no results past page 60. Each page is billed as one request. Default 1. Max 60. |
query | string | Required | Search keywords, e.g. "wireless earbuds". |
sort | string | Optional | Result order: best_match (AliExpress relevance, the default), best_seller (most orders first), price_low, or price_high. One of: best_match, best_seller, price_low, price_high. Default "best_match". |
Look up to 10 Amazon products in one call by ASIN (title, brand, price, ratings, images, and attributes) as normalized JSON. $0.0033 per asin, up to 10 per call. $0.0033 per call (per asin).
$0.0033 per asin; one per item in asins (max 10, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
amazonDomain | string | Optional | Amazon marketplace domain to fetch products from (e.g. amazon.com, amazon.de, amazon.co.uk). Default "amazon.com". |
asins | array | Required | Up to 10 Amazon ASINs to look up (e.g. ["B0CHX1W1XY", "B09G9FPHY6"]). Max 10 items. Example: ["B09G9FPHY6"] Max 10 per call; extras are dropped. |
limit | integer | Optional | Maximum number of results to return (1-10, default 10). You are billed per result returned, so a lower limit costs less. Max 10. |
List the top-ranked products of any Amazon Best Sellers category (rank, title, price, and rating) in one normalized request. $0.00105 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Default 20. Max 20. |
url | string | Required | Amazon Best Sellers category URL (e.g. https://www.amazon.com/Best-Sellers-Electronics/zgbs/electronics). |
List today's Amazon deals for one marketplace and get ASIN, title, deal price, list price, discount, deal type, badge and image for each deal in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
region | string | Optional | Amazon marketplace to read, as its domain (e.g. amazon.co.uk); omit it for amazon.com. |
List every offer for one Amazon product by ASIN or product URL, the Buy Box first and then the other sellers, and get price, condition, seller name and ID, seller rating, Prime, delivery estimate and fulfillment for each in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based page of the other sellers' offers, about 10 a page; page 1 also carries the Buy Box. Each page is billed as one request. Default 1. |
product | string | Required | Amazon product ASIN (e.g. B006MIWDCC) or a product link on one of the marketplaces listed under region, such as https://www.amazon.co.uk/dp/<ASIN>, with the ASIN after /dp/, /gp/product/ or /product-reviews/. A link without an ASIN, such as a search results page (/s?k=...), or a link to another... |
region | string | Optional | Amazon marketplace the product ASIN belongs to (e.g. amazon.co.uk); a product URL sets it from its own domain. |
Fetch full Amazon product details (title, brand, price when in stock, images, ratings, review count, variants, and attributes) from a product URL. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full Amazon product URL (e.g. https://www.amazon.com/dp/B0CX23V2ZK). |
Pull customer reviews for any Amazon product by ASIN or URL: rating, title, text, date, and verified-purchase badge. $0.016 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
endDate | string | Optional | Only return reviews on or before this date, inclusive, in YYYY-MM-DD format (e.g. 2026-06-30). |
keyword | string | Optional | Only return reviews whose title or text contains this keyword, case-insensitively (e.g. battery). |
limit | integer | Optional | Maximum number of results to return (1-50, default 50). Default 50. Max 50. |
product | string | Required | Amazon product ASIN (e.g. B07CMS5Q6P) or a product link on one of the marketplaces listed under region, such as https://www.amazon.co.uk/dp/<ASIN>, with the ASIN after /dp/, /gp/product/ or /product-reviews/. A link without an ASIN, such as a search results page (/s?k=...), or a link to another... |
ratings | array | Optional | Only return reviews whose star rating is in this set (e.g. ["5", "4"] for 4 and 5 star reviews); omit for all ratings. One of: 1, 2, 3, 4, 5. |
region | string | Optional | Amazon marketplace domain the product ASIN belongs to (e.g. amazon.co.uk). |
sort | string | Optional | Review sort order: most helpful first or most recent first (e.g. recent). One of: helpful, recent. |
startDate | string | Optional | Only return reviews on or after this date, inclusive, in YYYY-MM-DD format (e.g. 2026-01-01). |
verifiedOnly | boolean | Optional | Set true to return only verified-purchase reviews (e.g. true). |
Search Amazon from any search or category URL and get up to 20 matching products (title, price, rating, and thumbnail) in one normalized response. $0.00075 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Default 20. Max 20. |
url | string | Required | Amazon search or category URL. For U.S. URLs, include page to select an Amazon results page; limit caps that page. Supported keyword, category, price, brand, rating and Prime selectors and standard Amazon sort orders are preserved. Unsupported selectors are rejected. |
Look up one Amazon seller by seller ID and get its name, star rating, positive feedback percentage, feedback counts for the last 30 days, 90 days, 12 months and lifetime, and its registered business name and address in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
region | string | Optional | Amazon marketplace to read, as its domain (e.g. amazon.co.uk); omit it for amazon.com. |
sellerId | string | Required | Amazon seller ID, the value after seller= in a seller page URL (https://www.amazon.com/sp?seller=<id>), e.g. A11V4PRB7HXYNG. |
List one Amazon seller's storefront by seller ID, a page at a time, and get ASIN, title, price, list price, rating, reviews count, image, coupon and sponsored, Prime, best seller and Amazon's Choice flags for each product in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based page of the seller's storefront. Each page is billed as one request. Default 1. |
region | string | Optional | Amazon marketplace to read, as its domain (e.g. amazon.co.uk); omit it for amazon.com. |
sellerId | string | Required | Amazon seller ID, the value after seller= in a seller page URL (https://www.amazon.com/sp?seller=<id>), e.g. A11V4PRB7HXYNG. |
Get an iOS app's App Store listing by app ID, in any storefront country: title, developer, rating, price, version, description, screenshots, and more. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
appId | string | Required | Numeric App Store app ID, the digits at the end of the app's store URL without the 'id' prefix (e.g. 310633997). |
country | string | Optional | Two-letter App Store storefront country code to read the listing from (e.g. gb); price and currency follow that storefront. Default "us". |
Get App Store reviews for any iOS app by app ID, in any storefront country: ratings, titles, and review text. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
appId | string | Required | Numeric App Store app ID, the digits at the end of the app's store URL without the 'id' prefix (e.g. 310633997). |
country | string | Optional | Two-letter App Store storefront country code to read reviews from. Default "us". |
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of reviews. |
limit | integer | Optional | Reviews to fetch (1-100, default 100). Sources that page return one full page of reviews (up to 20 or 50, depending on the source), newest first, with a nextCursor for the next page, and `limit` does not shrink that page; sources that cannot page return up to `limit` reviews in one call with no... Max 100. |
Search the App Store for iOS apps by keyword, in any storefront country: app ID, title, developer, rating, ratings count, price, version, and more for each result. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Two-letter App Store storefront country code to search (e.g. gb); results, prices, and currency follow that storefront. Default "us". |
limit | integer | Optional | Maximum number of apps to return (1-50, default 50). Default 50. Max 50. |
query | string | Required | Search keywords, as typed into the App Store search box (e.g. budget tracker). |
Fetch an ASOS product by URL from any of its 11 country stores and get title, price, brand, colour, description, images, and per-size stock in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | ASOS product page URL, e.g. https://www.asos.com/pullbear/pullbear-casual-trainers-in-white/prd/211299341, or the short form https://www.asos.com/prd/211299341. The store is read from the URL path (/us/, /au/, /de/ and so on; none means the UK store), and prices come back in that store's currency. |
Search ASOS by keyword in any of its 11 country stores with optional sort, price-range, and page filters and get title, price, brand, and colour for each product in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | ASOS country store to search, which also sets the price currency (gb GBP, us USD, au AUD, de/fr/it/es/nl EUR, se SEK, dk DKK, pl PLN); defaults to gb, the UK store. Product ids and URLs are store-specific. One of: gb, us, au, de, fr, it, es, nl, se, dk, pl. Default "gb". |
maxPrice | number | Optional | Optional maximum product price, in the store's currency. |
minPrice | number | Optional | Optional minimum product price, in the store's currency. |
page | integer | Optional | 1-based results page of 48 products. Each page is billed as one request. Default 1. Max 200. |
query | string | Required | Search keywords, e.g. "white sneakers" or "summer dress". |
sort | string | Optional | Result sort order; omit for ASOS's recommended order (e.g. new for newest arrivals first). One of: best_match, new, price_low, price_high. |
Fetch a BestBuy.com product by URL and get title, price, brand, model, UPC, rating, description, and images in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Best Buy product page URL that carries the numeric Best Buy SKU, either the .../sku/6376564 form the Best Buy Search SKU returns or the older .../6376564.p?skuId=6376564 form. |
Pull a page of 10 customer reviews for any BestBuy.com product by URL, newest first or by relevance, helpfulness, or rating: rating, title, text, date, reviewer, and verified-purchase badge. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based page of 10 reviews; Best Buy serves at most 1000 pages. Each page is billed as one request; keep url and sort the same while walking pages. Default 1. Max 1000. |
sort | string | Optional | Review order: recent (newest first, the default), oldest, relevancy, helpful, rating_high, or rating_low (e.g. helpful). One of: recent, oldest, relevancy, helpful, rating_high, rating_low. Default "recent". |
url | string | Required | Best Buy product page URL that carries the numeric Best Buy SKU, either the .../sku/6376564 form the Best Buy Search SKU returns or the older .../6376564.p?skuId=6376564 form. |
Search BestBuy.com by keyword with optional sort, price-range, and page filters and get title, price, rating, and brand for each product in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
maxPrice | number | Optional | Optional maximum product price in USD. |
minPrice | number | Optional | Optional minimum product price in USD. |
page | integer | Optional | 1-based results page of about 18 to 24 products; Best Buy serves no products past page 100. Each page is billed as one request. Page sizes differ between sources, so deduplicate on sku. Default 1. Max 100. |
query | string | Required | Search keywords, e.g. "airpods" or "65 inch tv". |
sort | string | Optional | Result sort order; omit for Best Buy's own relevance order (e.g. price_low sorts by lowest price first). One of: best_match, best_seller, price_low, price_high, rating_high, new. |
Ask Microsoft Copilot (the AI answer in Bing) a question and get its web-grounded answer with the sources it cites as clean JSON - for tracking how Copilot answers and which sites it cites. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
prompt | string | Required | The question or prompt for Microsoft Copilot to answer using Bing web search. |
Run a Bing web search and get the ranked organic results (title, URL, snippet, position, display URL, domain) plus Bing's related searches as clean JSON. Returns up to 10 results per call; pick the country Bing searches from. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | ISO-3166 alpha-2 country Bing searches from, e.g. US, GB, DE. Bing ranks and localizes results for that country and its main language. Common countries are served by every source; a country only some sources cover is served by those, and one no source covers is refused with no charge. Default "US". |
limit | integer | Optional | Maximum number of organic results to return (1-10, default 10). Bing serves about 10 organic results per page, and some queries carry fewer. Default 10. Max 10. |
query | string | Required | The Bing search query. |
Get a single Bluesky post by URL - text, author handle, like, reply, and repost counts as clean JSON. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Bluesky post URL, e.g. "https://bsky.app/profile/bsky.app/post/3l6oveex3ii2l". |
Get a Bluesky user's public profile by handle - display name, bio, follower and post counts as clean JSON. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Bluesky handle, e.g. "bsky.app" or "jay.bsky.team". |
List a Bluesky account's recent posts (text, author handle, like, reply, and repost counts) by handle as clean JSON. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Bluesky handle, e.g. "bsky.app" or "jay.bsky.team". |
Search Booking.com stays by destination and dates with optional guest and room occupancy and get hotel results (name, price, review score, location) as normalized JSON. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult guests (e.g. 2). |
checkIn | string | Optional | Check-in date in YYYY-MM-DD format (e.g. 2026-07-01). Defaults to tomorrow. |
checkOut | string | Optional | Check-out date in YYYY-MM-DD format (e.g. 2026-07-05). Defaults to the day after check-in. |
children | integer | Optional | Number of child guests (e.g. 1). |
currency | string | Optional | Currency code for prices (e.g. EUR). Default "USD". |
limit | integer | Optional | Maximum number of hotels to return (1-20, default 20). Some sources bill per result returned, so a lower limit can cost less. Max 20. |
query | string | Required | Destination city to search for stays in (e.g. Paris). |
rooms | integer | Optional | Number of rooms to book (e.g. 1). |
Run a Brave web search and get the ranked organic results (title, URL, snippet, position, display URL, domain) as clean JSON. Brave answers from its own independent index. Returns up to 20 results per call, with related searches and video results where the source has them; page deeper with page and pick the country Brave searches from. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | ISO-3166 alpha-2 country Brave searches from, e.g. US, GB, DE. Brave ranks and localizes results for that country. Only the countries Brave offers are accepted; US is served by every source and the others by the sources that can target them. Default "US". |
limit | integer | Optional | Maximum number of organic results to return (1-20, default 20). Brave serves about 20 organic results per page, and some queries carry fewer. Default 20. Max 20. |
page | integer | Optional | Which page of Brave results to return, starting at 1 (up to 10); a page holds about 20 results. Each page is billed as one request. Pages after the first are served only for country US, by the one source that continues each page exactly where the last ended. A limit below the page size drops the... Default 1. Max 10. |
query | string | Required | The Brave search query. |
Pull Capterra software reviews for any product: overall and sub-ratings, pros and cons, reviewer job title, company size, and industry as clean JSON. Returns up to 25 results per call (page with cursor/page where offered). $0.02475 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
product | string | Required | Capterra product URL, for example https://www.capterra.com/p/135003/Slack/. Capterra identifies a product by both its numeric id and its slug, so the full URL is required. |
sortBy | string | Optional | Sort order for the returned reviews: newest first, most complete first, or highest or lowest rated first. One of: recent, complete, highest, lowest. Default "recent". |
Ask ChatGPT a web-grounded question and receive an answer with source citations. ChatGPT composes each answer per request, so the same prompt returns different wording and a different source set. $0.0018 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | ISO-3166 alpha-2 country to ask from, e.g. US, GB, DE. ChatGPT localizes both the pages it retrieves and the answer it writes, so this is the difference between what a US buyer and a UK buyer are told. Default "US". |
prompt | string | Required | Question or research prompt for ChatGPT to answer using web search. |
requireAds | boolean | Optional | Serve only from a source that can return sponsored placements shown with the answer. One source currently qualifies, so the request cannot fall back when it is unavailable. Default false. |
requireEntities | boolean | Optional | Serve only from a source that can return brands and other named entities recognized in the answer. One source currently qualifies, so the request cannot fall back when it is unavailable. Default false. |
requirePlaces | boolean | Optional | Serve only from a source that can return places shown with the answer. Leaving this off still returns places whenever the source that answered can. Turning it on selects the single source that guarantees them, which costs more and has nothing to fall back to if it is unavailable. Default false. |
requireShoppingCards | boolean | Optional | Serve only from a source that can return shopping cards shown with the answer. Leaving this off still returns shopping cards whenever the source that answered can. Turning it on selects the single source that guarantees them, which costs more and has nothing to fall back to if it is unavailable. Default false. |
webSearch | string | Optional | Whether to insist ChatGPT browses the web. force instructs it to search and is the default; auto lets ChatGPT decide, which is cheaper and answers from memory roughly half the time. Check webSearchTriggered for what actually happened - an answer written without a search is not web-grounded. One of: force, auto. Default "force". |
Get the current top cryptocurrencies from CoinMarketCap (rank, price, market cap, volume, and 24h change) as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0198 per call.
Enrich one company into firmographics, funding, revenue estimate, headcount history, web traffic, social following, offices, technologies and open jobs from a domain, a LinkedIn company URL, or an Aviato company id. $0.18 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Aviato company id, as any Aviato SKU's companyId output returns it. |
domain | string | Optional | Company website domain, e.g. posthog.com. A full URL works too; only its host is sent. |
linkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/posthog. |
Get one company's financing and ownership status, latest deal, total funding, investor and acquisition counts, revenue estimate and every funding round from a domain, a LinkedIn company URL, or an Aviato company id. $0.12 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Aviato company id, as any Aviato SKU's companyId output returns it. |
domain | string | Optional | Company website domain, e.g. posthog.com. A full URL works too; only its host is sent. |
linkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/posthog. |
List the founders of one company with their LinkedIn, X (Twitter) and Crunchbase profiles and an Aviato person id for Person Enrichment - Aviato, from a domain, a LinkedIn company URL, or an Aviato company id. $0.012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Aviato company id, as any Aviato SKU's companyId output returns it. |
domain | string | Optional | Company website domain, e.g. posthog.com. A full URL works too; only its host is sent. |
linkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/posthog. |
List one company's funding rounds with stage, date, amount raised, valuation where known, and the firms and individuals that led or joined each round, from a domain, a LinkedIn company URL, or an Aviato company id. $0.012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Aviato company id, as any Aviato SKU's companyId output returns it. |
domain | string | Optional | Company website domain, e.g. posthog.com. A full URL works too; only its host is sent. |
linkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/posthog. |
Get one company's LinkedIn, X (Twitter) and Facebook following, its weekly to yearly follower growth and the follower history behind it from a domain, a LinkedIn company URL, or an Aviato company id. $0.06 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Aviato company id, as any Aviato SKU's companyId output returns it. |
domain | string | Optional | Company website domain, e.g. posthog.com. A full URL works too; only its host is sent. |
linkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/posthog. |
Get one company's estimated monthly website visits, visit growth, traffic sources, top visitor countries and monthly visit history from a domain, a LinkedIn company URL, or an Aviato company id. $0.036 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Aviato company id, as any Aviato SKU's companyId output returns it. |
domain | string | Optional | Company website domain, e.g. posthog.com. A full URL works too; only its host is sent. |
linkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/posthog. |
Enrich a company by domain, name, LinkedIn URL, or Crustdata identifier. $0.096 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Optional | |
companyId | string | Optional | |
companyLinkedinUrl | string | Optional | |
companyName | string | Optional | |
exactMatch | boolean | Optional | |
fields | array | Optional |
Enrich one company from a domain or a company name into Data Legion's premium firmographics: industry, size, founding year, office locations, stock tickers and social profiles, plus headcount, hiring, attrition, growth and turnover, workforce breakdowns by seniority, function and tenure, and monthly headcount history. $0.04806 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Optional | Company website domain, e.g. hubspot.com. The strongest identifier. Send either domain or name, not both. |
minConfidence | string | Optional | Lowest match confidence that still counts as found. Omit it for Data Legion's default. One of: high, moderate, low. |
name | string | Optional | Company name, for when you have no domain. A domain matches more reliably. |
required | string | Optional | Fields a match must have, as a Data Legion expression over its snake_case field names combined with AND, OR and parentheses, e.g. linkedin_url AND founded. A match without them counts as not found. |
Enrich one company into firmographics, industry classification, headcount, revenue band and social profiles from a domain, a company name, or a Lusha company id. $0.084 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | string | Optional | Company name to look up when you have no domain. |
companyId | string | Optional | Lusha's own company identifier, as returned by this SKU's companyId output. |
domain | string | Optional | Company domain, e.g. posthog.com. Send the bare domain, without a scheme or www. |
Enrich one company into firmographics, funding history, NAICS and SIC classification, and People Data Labs' headcount growth, tenure and churn series from a domain or a company name. $0.12 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
dataInclude | string | Optional | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; it does not reduce what the call costs. |
domain | string | Optional | Company website domain, e.g. posthog.com. The strongest identifier. |
includeIfMatched | boolean | Optional | Report which of the sent identifiers actually matched. |
minLikelihood | integer | Optional | Minimum People Data Labs likelihood score a match must reach to count as found. Max 10. |
name | string | Optional | Company name, for when you have no domain. |
required | string | Optional | People Data Labs boolean expression over top-level fields that a match must satisfy, e.g. website and industry. |
titlecase | boolean | Optional | Return text in title case instead of People Data Labs' lowercase default. |
Enrich one company into firmographics, funding history, technology stack, open roles and headquarters contact details from a website, a company name, or a LinkedIn page. $0.066 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Prospeo's own company identifier, as returned by this SKU's companyId output. |
companyLinkedinUrl | string | Optional | Company LinkedIn page URL. |
companyName | string | Optional | Company name, for when you have no domain. |
companyWebsite | string | Optional | Company domain, e.g. stripe.com. The most reliable identifier. |
Resolve one company from its domain, LinkedIn company page, Crustdata company id, or name to its Crustdata id, primary domain, LinkedIn page, and basic profile. Identify a company for $1 per 1,000 requests before paying to enrich it. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Optional | Company website domain without a scheme or path, e.g. stripe.com. Send exactly one of companyDomain, companyLinkedinUrl, companyId, or companyName. |
companyId | integer | Optional | Crustdata company id, as returned in companyId by this or another Crustdata v3 endpoint. |
companyLinkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/stripe. |
companyName | string | Optional | Full company name, including any legal suffix. A name match is a best guess; confirm it against the returned domain or LinkedIn page before relying on it. |
exactMatch | boolean | Optional | Require an exact match on the identifier instead of letting Crustdata decide. Leave unset for automatic matching. |
Search companies by name, lookalike domains, account filters, and saved-list filters. Returns up to 10 results per call (page with cursor/page where offered). $0.024 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
account | object | Optional | AI Ark account filter expression. Nested generic any/all filter objects are accepted as documented by the source and are not further constrained. |
lists | object | Optional | AI Ark saved-list filter expression. |
lookalikeDomains | array | Optional | Domains whose company characteristics should guide the search. Max 5 items. |
name | string | Optional | Company-name search text. |
page | integer | Optional | Zero-based result page. Default 0. |
Search Aviato's company database by name, headquarters location, industry and headcount, up to 250 companies per page for one flat price. Aviato allows 10 searches a minute and 300 an hour across all callers. $0.003 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
city | string | Optional | Headquarters city, e.g. San Francisco. |
country | string | Optional | Headquarters country, e.g. United States. |
industries | array | Optional | Aviato industry labels, any of which matches, e.g. ["Software & SaaS"]. Company Enrichment - Aviato shows a company's labels. Example: ["Software & SaaS"] |
limit | integer | Optional | Companies per page. A page costs the same at any size. Default 100. Max 250. |
maxHeadcount | integer | Optional | Largest current employee count. |
minHeadcount | integer | Optional | Smallest current employee count. |
offset | integer | Optional | Companies to skip before this page, for paging. At most 10000. Default 0. Max 10000. |
query | string | Optional | Words in the company name, matched by full-text search. |
region | string | Optional | Headquarters state or region, e.g. California. |
Search companies by structured filters with cursor pagination. Returns up to 10 results per call (page with cursor/page where offered). $0.0156 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | |
fields | array | Optional | Response groups to return. Omit for the default set: basic_info, headcount, funding, revenue, locations, social_profiles, taxonomy, followers and metadata. |
filters | object | Required | Crustdata company-search filter expression. A condition is {"field": <field>, "type": <operator>, "value": <match>}; a group is {"op": "and"|"or", "conditions": [<condition or group>, ...]}. Pass one condition or one group. Operators: = != < =< > => in not_in (.) (fuzzy text) [.] (exact token).... Example: {"field": "basic_info.primary_domain", "type": "=", "value": "posthog.com"} |
sorts | array | Optional | Sort directives applied in order, each {"field": <field>, "order": "asc"|"desc"}. Sortable fields include basic_info.name, basic_info.year_founded, headcount.total, funding.total_investment_usd, funding.last_fundraise_date, revenue.estimated.lower_bound_usd and followers.count. |
Search companies by structured filters with cursor pagination. Returns up to 10 results per call (page with cursor/page where offered). $0.48 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | |
fields | array | Optional | |
filters | array | Required | Crustdata company-database filter expression. A leaf condition is {"filter_type": <column>, "type": <operator>, "value": <match>}; a group is {"op": "and"|"or", "conditions": [<leaf>, ...]}. Pass a single leaf, an array of leaves, or a group. See the example for a domain lookup. Example: [{"filter_type": "company_website_domain", "type": "(.)", "value": "posthog.com"}] |
sorts | array | Optional |
Build an account list from FullEnrich by name, domain, industry, specialty, ownership type, headcount, founding year and headquarters, with full firmographics and every office on each row. Billed per company returned. $0.0252 per keyword, one per call. $0.0252 per call (per keyword).
$0.0252 per keyword; one per item in keywords (max 1, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyIds | array | Optional | Filter by FullEnrich company id. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
cursor | string | Optional | Cursor from a previous response's nextCursor. Works at any depth, including past the 10000 offset ceiling. |
domains | array | Optional | Filter by company domain, e.g. stripe.com. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. Example: [{"exact_match": true, "value": "stripe.com"}] |
foundedYears | array | Optional | Filter by founding year. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
headcounts | array | Optional | Filter by employee headcount band. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
headquartersLocations | array | Optional | Filter by headquarters city, region or country. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
industries | array | Optional | Filter by company industry, e.g. Software Development. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
keywords | array | Optional | Filter by words in the company description. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. Max 1 per call; extras are dropped. |
limit | integer | Optional | Rows to return on this page, up to FullEnrich's maximum of 100. Every row returned is billed. Default 10. Max 100. |
linkedinUrls | array | Optional | Filter by company LinkedIn URL. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
names | array | Optional | Filter by company name. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
offset | integer | Optional | Rows to skip. FullEnrich caps offset at 10000; past that, page with cursor. Default 0. |
specialties | array | Optional | Filter by company specialty. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
types | array | Optional | Filter by ownership type, e.g. Public Company, Privately Held, Nonprofit. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
Search People Data Labs' company dataset with SQL or an Elasticsearch query and get the full firmographic record back, including funding history and the headcount growth, tenure and churn series. Billed per company returned. Returns up to 10 results per call (page with cursor/page where offered). $1.2 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
dataInclude | string | Optional | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; billing still follows companies returned. |
query | object | Optional | Elasticsearch-style query over the People Data Labs company dataset, e.g. {"bool": {"must": [{"term": {"website": "posthog.com"}}]}}. Send this or sql, never both. |
sql | string | Optional | People Data Labs SQL, in the form SELECT * FROM company WHERE ... . String literals take single quotes, only SELECT * is supported, and field names must be real People Data Labs company fields including nested subfields such as location.country. Do not include a LIMIT clause; People Data Labs... |
titlecase | boolean | Optional | Return text in title case instead of People Data Labs' lowercase default. |
Build an account list from Prospeo by industry, headcount, revenue, location, technology, funding and hiring activity. One flat price per page of 25. $0.066 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | object | Optional | Filter by company names or websites, e.g. {"names": {"include": ["Stripe"]}, "websites": {"include": ["stripe.com"]}}. Example: {"websites": {"include": ["stripe.com"]}} |
companyAttributes | object | Optional | Filter by company characteristics, e.g. B2B, has pricing, has a free trial. |
companyEmailProvider | array | Optional | Filter by the company's email MX provider. |
companyFounded | object | Optional | Filter by founding year range. |
companyFunding | object | Optional | Filter by funding stage or amount raised. |
companyHeadcountByDepartment | array | Optional | Filter by headcount within a department. |
companyHeadcountCustom | object | Optional | Filter by a custom employee count range. |
companyHeadcountGrowth | object | Optional | Filter by headcount growth. |
companyHeadcountRange | array | Optional | Filter by Prospeo's predefined employee count bands. |
companyIndustry | object | Optional | Filter by company industry. |
companyJobPostingHiringFor | array | Optional | Filter by the roles the company is currently hiring for. |
companyJobPostingQuantity | object | Optional | Filter by how many roles the company has open. |
companyKeywords | object | Optional | Filter by keywords found in company data. |
companyLocationSearch | object | Optional | Filter by company headquarters location. |
companyNaics | object | Optional | Filter by NAICS codes. |
companyRevenue | object | Optional | Filter by revenue range. |
companySics | object | Optional | Filter by SIC codes. |
companyTechnology | object | Optional | Filter by technologies the company uses. |
companyType | string | Optional | Filter by ownership type. One of: Private, Public, Non Profit, Other. |
page | integer | Optional | Page number, one-based. Prospeo returns 25 results per page and charges one flat price per page. Default 1. |
Find companies by name, domain, industry, headcount, revenue, services, or location, and get back their site, LinkedIn, and contact details. Billed per company returned. Returns up to 10 results per call (page with cursor/page where offered). $0.072 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
city | object | Optional | Filter on city name. |
companyDomain | object | Optional | Filter on company website domain. Include only; exclude is rejected upstream. |
companyName | object | Optional | Filter on company name. |
country | object | Optional | Filter on ISO 3166-1 alpha-2 country code, e.g. "US". Example: {"include": ["US"]} |
employeeCount | object | Optional | Filter on headcount band. Note these bands differ from the employeeCount string returned on a result. Example: {"include": ["20 - 99"]} |
homePageText | object | Optional | Filter on words found in the company home page text. |
includeFullText | boolean | Optional | Return the full home page text on each company instead of a snippet. |
industry | object | Optional | Filter on industry label. Values must match the QuickEnrich industry vocabulary exactly, e.g. "IT Services and IT Consulting". |
linkedinBio | object | Optional | Filter on words found in the company LinkedIn bio. |
page | integer | Optional | One-based result page. Default 1. |
revenue | object | Optional | Filter on revenue band. |
services | object | Optional | Filter on the services a company lists. |
Build an account list from TheirStack by the technologies, keywords and buying-intent topics a company mentions in its job posts, plus headcount, revenue, funding, industry and location. Billed per company returned. Returns up to 25 results per call (page with cursor/page where offered). $4.98 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyCountryCodeNot | array | Optional | Return companies whose HQ country code is not any of the ones passed here, case sensitive. Pass ISO2 country codes. |
companyCountryCodeOr | array | Optional | Return companies whose HQ country code is any of the ones passed here, case sensitive. Pass ISO2 country codes. |
companyDescriptionPatternAccentInsensitive | boolean | Optional | Set to True to make company description searches accent insensitive. For example, "á" will match "a" as well. |
companyDescriptionPatternNot | array | Optional | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. |
companyDescriptionPatternOr | array | Optional | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. |
companyDomainNot | array | Optional | Only return companies that don't match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). |
companyDomainOr | array | Optional | Only return companies that match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). This filter acts as an OR filter, so if you pass more than one company domain, it will return companies that match any of the domains. Example: ["posthog.com"] |
companyIdOr | array | Optional | Only return companies that match these IDs exactly. This filter acts as an OR filter, so if you pass more than one company ID, it will return companies that match any of the IDs. |
companyInvestorsOr | array | Optional | Investors of the company |
companyInvestorsPartialMatchOr | array | Optional | Investors of the company. Will return companies for which any of their investors contains any of the substrings passed here. For example, if you pass 'andree', all funds that match it (like 'Andreessen Horowitz', 'Andreessen Horowitz LLC', etc). |
companyKeywordSlugAnd | array | Optional | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
companyKeywordSlugNot | array | Optional | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
companyKeywordSlugOr | array | Optional | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
companyLinkedinUrlExists | boolean | Optional | (Use `property_exists_or / property_exists_and` instead) Only return companies with a LinkedIn URL |
companyLinkedinUrlOr | array | Optional | Return companies whose LinkedIn URL matches any of the slugs passed here. Can also pass full LinkedIn company URLs. |
companyListIdNot | array | Optional | Return companies that don't belong to any of the company lists passed here |
companyListIdOr | array | Optional | Return companies that belong to any of the company lists passed here |
companyLocationPatternOr | array | Optional | Return companies whose city matches any of the patterns passed here. Case insensitive. For example, if you pass 'san francisco', it will return companies whose city is 'San Francisco', 'San Francisco Bay Area', etc. |
companyNameCaseInsensitiveOr | array | Optional | Only return companies that match these names exactly, case-insensitively. |
companyNameNot | array | Optional | Only return companies that don't match these names exactly, case-sensitively. |
companyNameOr | array | Optional | Only return companies that match these names exactly, case-sensitively. This filter acts as an OR filter, so if you pass more than one company name, it will return companies that match any of the names. |
companyNamePartialMatchNot | array | Optional | Company names. Will return companies whose name doesn't contain any of the the substrings passed here, case-insensitively. For example, if you pass 'google', it will exclude 'Google', 'Google LLC', 'Google Inc', etc. |
companyNamePartialMatchOr | array | Optional | Company names. Will return companies whose name contain any of the the substrings passed here, case-insensitively. For example, if you pass "google", it will return "Google", "Google LLC", "Google Inc", etc. |
companyTagsOr | array | Optional | Return companies that match any of these keywords |
companyTechnologySlugAnd | array | Optional | Will return jobs from companies that that have mentioned all of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_and instead. |
companyTechnologySlugNot | array | Optional | Will return jobs from companies that that haven't mentioned any of these technologies in their jobs. Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_not instead. |
companyTechnologySlugOr | array | Optional | Will return jobs from companies that that have mentioned any of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_or instead. |
companyType | string | Optional | Filter by company type. |
expandTechnologySlugs | array | Optional | Specify technology slugs to include detailed technology usage information for each company. The response will include a 'technologies_found' field containing metrics like confidence score, ranking, and job count for each specified technology. Note: If a technology is not listed for a company, it... |
fundingStageOr | array | Optional | Funding stages of companies returned. Possible values: ['angel', 'convertible_note', 'debt_financing', 'equity_crowdfunding', 'other', 'private_equity', 'seed', 'series_a', 'series_b', 'series_c', 'series_d', 'series_e', 'series_f', 'series_g', 'series_h', 'venture_round_not_specified',... |
includeTotalResults | boolean | Optional | When enabled, calculates and returns `total_results` and `total_companies` fields in the response. WARNING: This significantly slows down responses as it requires reading the entire dataset. Recommended usage: enable only for the initial request to get totals, then disable for subsequent... |
industryIdNot | array | Optional | Industry ids to exclude. You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries |
industryIdOr | array | Optional | Industry codes. You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries |
industryNot | array | Optional | Names of industries, case-insensitive. Results will exclude companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_not field instead. |
industryOr | array | Optional | Names of industries, case-insensitive. Results will only include companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_or field instead. |
jobFilters | object | Optional | |
keywordSlugAnd | array | Optional | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
keywordSlugNot | array | Optional | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
keywordSlugOr | array | Optional | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
lastFundingRoundDateGte | string | Optional | Only return companies whose last funding round date is after or on this date. Format: 'YYYY-MM-DD' |
lastFundingRoundDateLte | string | Optional | Only return companies whose last funding round date is before or on this date. Format: 'YYYY-MM-DD' |
maxEmployeeCount | integer | Optional | Maximum number of employees in a company |
maxEmployeeCountOrNull | integer | Optional | Maximum number of employees in a company. If we don't have company size information, we will return it as well. |
maxFundingUsd | integer | Optional | Maximum company funding, in USD |
maxRevenueUsd | integer | Optional | Maximum company revenue, in USD |
minEmployeeCount | integer | Optional | Minimum number of employees in a company |
minEmployeeCountOrNull | integer | Optional | Minimum number of employees in a company. If we don't have company size information, we will return it as well. |
minFundingUsd | integer | Optional | Minimum company funding, in USD |
minRevenueUsd | integer | Optional | Minimum company revenue, in USD |
offset | integer | Optional | Number of results to skip. Required for offset-based pagination. |
onlyYcCompanies | boolean | Optional | Only return YC companies |
orderBy | array | Optional | List of column objects. You can pass several columns to order by, in order of priority. Only `field` is required, `desc` is True by default |
page | integer | Optional | Page number. Required when using page-based pagination. |
propertyExistsAnd | array | Optional | Return companies that have all of these fields not null. For example, if you pass ['domain', 'linkedin_url'], it will return companies that have both domain AND linkedin_url set. |
propertyExistsOr | array | Optional | Return companies that have any of these fields not null. For example, if you pass ['domain', 'linkedin_url'], it will return companies that have a domain OR a linkedin_url set. |
techFilters | object | Optional | Filter by technologies and buying intent topics detected for the company |
technologySlugAnd | array | Optional | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
technologySlugNot | array | Optional | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
technologySlugOr | array | Optional | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
Get US Congress members' financial disclosures and stock trades (member, ticker, transaction type, amount range, and dates), filterable by member, ticker, or date range. Results come newest filing first (by reportedUtc, not tradedUtc), so a recent filing can list trades made years earlier. Returns up to 10 results per call (page with cursor/page where offered). $0.0192 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
endDate | string | Optional | Latest transaction date to include, inclusive, in YYYY-MM-DD format (e.g. 2026-06-01). |
firstName | string | Optional | Filter by the congressional member's first name, case-insensitive partial match (e.g. Nancy). |
lastName | string | Optional | Filter by the congressional member's last name, case-insensitive partial match (e.g. Pelosi). |
startDate | string | Optional | Earliest transaction date to include, inclusive, in YYYY-MM-DD format (e.g. 2026-01-01). |
ticker | string | Optional | Filter to transactions involving this stock ticker symbol (e.g. NVDA). |
Find one person's work and personal email addresses from a LinkedIn profile URL or an Aviato person id. Billed only when an email is found. $0.096 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
linkedinUrl | string | Optional | LinkedIn profile URL, e.g. https://www.linkedin.com/in/satyanadella. |
personId | string | Optional | Aviato person id, as any Aviato SKU's personId output returns it. |
Find one person's business emails, personal emails, and phone numbers from a LinkedIn profile URL or a business email, with a deliverability status on every email. Billed only when the person is found. $0.24 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Optional | The person's business email address. |
linkedinUrl | string | Optional | LinkedIn profile URL, e.g. https://www.linkedin.com/in/satyanadella. Send exactly one of linkedinUrl or email. |
Look up a public Douyin profile by sec_user_id and return normalized profile statistics. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
secUserId | string | Required | Douyin sec_user_id for the public account. |
Search public Douyin videos by keyword with sorting, time, duration, and content filters. $0.012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
backtrace | string | Optional | Backtrace token returned by the previous page. |
cursor | string | Optional | Pagination cursor: pass the previous response's nextCursor; omit for the first page. A raw integer cursor is still accepted. |
duration | string | Optional | Duration filter in minutes: any, under 1, 1 to 5, or over 5. One of: 0, 0-1, 1-5, 5-10000. Default "0". |
publishedWithin | integer | Optional | Publication window in days. Use the canonical JSON integer 0 for any time, 1 for one day, 7 for seven days, or 180 for 180 days; legacy numeric strings remain accepted. One of: 0, 1, 7, 180, 0, 1, 7, 180. Default 0. |
query | string | Required | Keyword to search for. |
searchId | string | Optional | Search ID returned by the previous page. |
sort | string | Optional | Sort order: relevance (Douyin's comprehensive ranking), most-liked, date-posted. One of: relevance, most-liked, date-posted. Default "relevance". |
List public posts from a Douyin user with normalized engagement data and pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor: pass the previous response's nextCursor; omit for the first page. A raw integer cursor is still accepted. |
limit | integer | Optional | Requested page size. Values up to 20 are recommended. Default 20. |
secUserId | string | Required | Douyin sec_user_id for the public account. |
sort | string | Optional | Post order: newest, most-popular. One of: newest, most-popular. Default "newest". |
Fetch a public Douyin video by share URL with normalized author and engagement data. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Public Douyin video share URL. |
List public comments on a Douyin video with author and engagement data. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor: pass the previous response's nextCursor; omit for the first page. A raw integer cursor is still accepted. |
videoId | string | Required | Douyin aweme_id for the video. |
Run a DuckDuckGo web search and get the ranked organic results (title, URL, snippet, position, display URL, domain) as clean JSON, ads left out. Returns up to 10 results per call; page deeper with page and pick the country DuckDuckGo searches from. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | ISO-3166 alpha-2 country DuckDuckGo searches from, e.g. US, GB, DE: DuckDuckGo's region for that country in its main language (Belgium in Dutch, Canada and the US in English, Switzerland in German, Spain in Spanish). Only the countries DuckDuckGo offers are accepted; every country is served by... Default "US". |
limit | integer | Optional | Maximum number of organic results to return (1-10, default 10). DuckDuckGo serves about 10 organic results per page, and some queries carry fewer. Default 10. Max 10. |
page | integer | Optional | Which page of 10 results to return, starting at 1: page 2 returns results 11-20. Each page is billed as one request. Pages after the first are served only for country US, GB or DE, by the one source that continues each page exactly where the last ended. DuckDuckGo can repeat a result from the... Default 1. |
query | string | Required | The DuckDuckGo search query. |
Fetch one eBay listing by URL and get the full offer record: price, condition, shipping, item location, seller feedback, quantity, watchers, and live auction state (bid count and end time). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full eBay listing URL (e.g. https://www.ebay.com/itm/133576802017). The marketplace is taken from the host, so an ebay.co.uk or ebay.de URL returns that site's listing and currency. Item ids come back on every row of ebay.search and ebay.sold_listings. |
Fetch one eBay listing by URL with the complete item-specifics table the seller filled in (MPN, model, capacity, compatibility and every other per-category attribute), the seller's full description, every listing image, and the seller's feedback record. $0.0018 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full eBay listing URL (e.g. https://www.ebay.com/itm/133576802017). Works on ended and sold listings as well as live ones, so it composes with ebay.sold_listings: pull the comps cheaply, then enrich the few you care about. |
Search eBay active listings by keyword with optional price-range, item-condition, listing-type, and sort filters and get title, price, condition, shipping, and seller in one normalized response. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
condition | array | Optional | Filter by one or more item conditions; omit for all conditions (e.g. ["new", "open_box"]). One of: new, open_box, refurbished, used, for_parts. |
limit | integer | Optional | Maximum number of results to return (1 to 25, default 25). Max 25. |
listingType | string | Optional | Restrict to a listing format; omit or use all for both (e.g. buy_it_now for fixed-price only). One of: all, auction, buy_it_now. |
maxPrice | integer | Optional | Optional maximum item price in USD. |
minPrice | integer | Optional | Optional minimum item price in USD. |
query | string | Required | Search keywords, e.g. "nintendo switch" or "vintage levis 501". |
sort | string | Optional | Result sort order; omit for eBay's Best Match (e.g. price_low sorts by lowest price plus shipping first). One of: best_match, ending_soonest, newly_listed, price_low, price_high. |
Retrieve recently sold eBay listings for any keyword with optional price-range, condition, category, sold-date, and sort filters, page by page (sold price, sale date, condition, seller, item details); ideal for pricing research. $0.003 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categoryId | string | Optional | Optional numeric eBay category id to search within (e.g. 9355 for Cell Phones & Smartphones, 9394 for Cell Phone Accessories). |
condition | string | Optional | Item condition filter (e.g. used). One of: any, new, used. Default "any". |
endDate | string | Optional | Only return listings sold on or before this date, inclusive, in YYYY-MM-DD format (e.g. 2026-09-15). This bound is applied to each page after it is fetched, so a page can hold fewer than limit listings, or none, while hasMore is still true: keep requesting the next page until hasMore is false. |
freeShipping | boolean | Optional | Not supported by the current sources: only false (no filter) is accepted; true is refused without charge. |
limit | integer | Optional | Maximum number of results to return (1-60, default 60). Default 60. Max 60. |
listingType | string | Optional | Restrict to a listing format; omit or use all for both (e.g. auction for auction sales only). One of: all, auction, buy_it_now. |
maxPrice | number | Optional | Optional maximum sold price in the site currency (e.g. 500). |
minPrice | number | Optional | Optional minimum sold price in the site currency (e.g. 200). |
page | integer | Optional | 1-based results page. Use with hasMore in the output to paginate, and keep query, filters, and limit the same while walking pages, because limit sets the page size. Default 1. |
query | string | Required | Search keyword for sold items (e.g. iphone 13 pro). |
returnsAccepted | boolean | Optional | Not supported by the current sources: only false (no filter) is accepted; true is refused without charge. |
seller | string | Optional | Not supported by the current sources: a request that sets it is refused without charge. |
site | string | Optional | eBay country site to search. Sold-listing coverage is currently US only. One of: ebay.com. Default "ebay.com". |
sort | string | Optional | Result sort order; omitted means ended_recently (e.g. price_high sorts by highest sold price plus shipping first). One of: ended_recently, price_low, price_high. |
startDate | string | Optional | Only return listings sold on or after this date, inclusive, in YYYY-MM-DD format (e.g. 2026-09-01). |
Retrieve recently sold eBay listings for any keyword with the sold price, sale date, condition, format, bids, and whether a Best Offer was accepted, without seller details; the lighter sibling of eBay Sold Listings for price comps. $0.003 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
condition | string | Optional | Item condition filter (e.g. used). One of: any, new, used. Default "any". |
limit | integer | Optional | Maximum number of results to return (1-60, default 25). Default 25. Max 60. |
listingType | string | Optional | Restrict to a listing format; omit or use all for both (e.g. auction for auction sales only). One of: all, auction, buy_it_now. |
maxPrice | number | Optional | Optional maximum sold price in the site currency (e.g. 500). |
minPrice | number | Optional | Optional minimum sold price in the site currency (e.g. 200). |
query | string | Required | Search keyword for sold items (e.g. iphone 13 pro). |
site | string | Optional | eBay country site to search. Sold-listing coverage is currently US only. One of: ebay.com. Default "ebay.com". |
sort | string | Optional | Result sort order; omitted means ended_recently (e.g. price_high sorts by highest sold price plus shipping first). One of: ended_recently, price_low, price_high. |
Find a professional email from a person's name and company domain or company name. $0.0312 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Optional | Company domain without a path. |
companyName | string | Optional | Company name when the domain is unavailable. |
firstName | string | Required | Person's first name. |
lastName | string | Required | Person's last name. |
Count how many contacts a company domain has, split by personal and generic mailboxes and broken down by department and seniority. Scope a domain for $1 per 1,000 requests before paying per contact. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Required | Company domain without a scheme or path, e.g. stripe.com. |
type | string | Optional | Count only personal mailboxes belonging to a named person, or only generic ones such as info@ and support@. One of: personal, generic. |
Find named contacts and their work email addresses at a company domain, filtered by job title, seniority or department. Priced per returned contact, so limit is the cost control. $0.025 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
department | string | Optional | Restrict to one department. One of: executive, it, finance, management, sales, legal, support, hr, marketing, communication, education, design, health, operations. |
domain | string | Required | Company domain without a scheme or path, e.g. stripe.com. |
jobTitle | string | Optional | One job-title keyword to match, e.g. editor. A single keyword only: a comma-separated list is not supported and only its last entry would apply. |
limit | integer | Optional | Maximum contacts to return in this response. Every returned contact is billed, so this is the cost control. Default 3. Max 100. |
offset | integer | Optional | Number of contacts to skip before this page begins. |
requiredField | string | Optional | Only return contacts that carry this field. One of: full_name, position, phone_number. |
seniority | string | Optional | Restrict to one seniority level. One of: junior, senior, executive. |
type | string | Optional | Restrict to personal mailboxes belonging to a named person, or to generic ones such as info@ and support@. One of: personal, generic. |
Find a professional email from a person and company through the durable Request lifecycle. Async: if the response is 202 with a request id, poll GET /requests/{id}. $0.0168 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domainOrCompany | string | Required | |
firstname | string | Optional | |
lastname | string | Optional |
Find a work email from a LinkedIn profile, or from a company domain plus a name. Coverage is strongest for small and local businesses and thin for large technology employers. $0.0072 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Optional | Company website domain, normalized upstream (example.com or https://example.com both work). |
firstName | string | Optional | Person's first name. |
lastName | string | Optional | Person's last name. |
linkedinUrl | string | Optional | LinkedIn profile URL. Provide this, or companyDomain with firstName and lastName. |
Find a person's work email at a company domain from their name, with ZeroBounce's confidence in the guess. $0.6552 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Required | Company domain to search, e.g. hubspot.com. |
firstName | string | Optional | First name of the person to find. |
lastName | string | Optional | Last name of the person to find. |
middleName | string | Optional | Middle name, when the company's address format uses one. |
Read the email address format a company domain uses, with every alternative format ZeroBounce has seen and how confident it is in each. Use it to build addresses for a whole account at once. $0.6552 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Required | Company domain to inspect, e.g. hubspot.com. |
Validate an email address and return its deliverability verdict and mailbox signals. $0.0144 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Required | Email address to validate. |
Verify an email address, including catch-all handling. Completion uses the durable Request lifecycle; a negative verdict is a successful result. Async: if the response is 202 with a request id, poll GET /requests/{id}. $0.0072 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
disableCatchallVerify | boolean | Optional | |
email | string | Required | |
mode | string | Optional | One of: regular, deepverify. |
Verify an email address. A valid negative verdict is a successful, billable result. $0.0024 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Required |
Validate one email address against ZeroBounce, with the deliverability verdict, why it was reached, the mailbox provider, and any owner details ZeroBounce holds. A negative verdict is a successful, billable result. $0.0336 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Required | Email address to validate. |
ipAddress | string | Optional | IP address the address signed up from. ZeroBounce uses it to add the geographic fields to the answer. |
Check whether an email address has shown recent activity across ZeroBounce's engagement network before you re-engage it. A no-activity answer is a successful, billable result. $0.0336 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Required | Email address to check for activity. |
Find a person's work email address from their name and company domain. $0.0308 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
person | object | Optional | The person to find an email for, e.g. {"firstName": "Jane", "surname": "Doe", "domain": "acme.com"} (domain also accepts a company name). Example: {"domain": "google.com", "firstName": "Damien", "surname": "Neil"} |
Verify an email address for deliverability: a status verdict (good, risky, or bad) with domain, mailbox, catch-all, disposable, and role signals plus a confidence score. Malformed addresses are rejected by the input schema with no charge; every syntactically valid address returns a billed verdict, including undeliverable ones. $0.0066 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Required | The email address to verify (e.g. jane.doe@acme.com). Exactly one @, a dotted domain, no whitespace or angle brackets. Addresses on reserved, never-deliverable TLDs (.invalid, .test, .example, .localhost, .local, .internal, .blink) and HTML/JSON escape artifacts (a u003e prefix) are rejected... |
Look up one Etsy listing by id and get its price, images, description, rating, reviews count, shop, category, variations, stock, ship-from country, favorites and materials in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
listingId | string | Required | Etsy listing id, the number in the listing URL (https://www.etsy.com/listing/<id>/...), e.g. 1810545592. The Etsy Search and Etsy Shop Listings SKUs return it as listingId. |
Search Etsy listings by keyword, the same results an Etsy search or /market page shows, with optional sort, price range and page, and get title, price, original price, image, shop, rating and ad flag for each listing in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
maxPrice | number | Optional | Optional maximum listing price, in USD. |
minPrice | number | Optional | Optional minimum listing price, in USD. |
page | integer | Optional | 1-based results page. Each page is billed as one request. Default 1. Max 250. |
query | string | Required | Search keywords, e.g. "cover letter template". For an Etsy /market page, pass its words: https://www.etsy.com/market/habit_tracker_2027 is the query "habit tracker 2027". |
sort | string | Optional | Result order: relevance (Etsy's own order, the default), newest, price_low, or price_high. One of: relevance, newest, price_low, price_high. Default "relevance". |
Look up one Etsy shop by name and get its id, location, sales, active listings, rating, reviews count, followers, description, logo and banner in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
shopName | string | Required | Etsy shop name, as in the shop URL (https://www.etsy.com/shop/<name>), e.g. StudioStelleHD. The Etsy Search and Etsy Product SKUs return it as shopName. |
List one Etsy shop's active listings by shop name, a page at a time, and get title, price, original price and image for each listing in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based results page of the shop's listings. Each page is billed as one request. Default 1. Max 250. |
shopName | string | Required | Etsy shop name, as in the shop URL (https://www.etsy.com/shop/<name>), e.g. StudioStelleHD. The Etsy Search and Etsy Product SKUs return it as shopName. |
Look up a single Meta Ad Library ad by ID or URL and get the advertiser, creative text, call-to-action, platforms, and run dates as clean JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | Meta Ad Library ad ID (e.g. "702369045530963"). Provide either id or url. |
url | string | Optional | Meta Ad Library ad URL (e.g. "https://www.facebook.com/ads/library?id=1185617869915074"). Provide either id or url. |
Pull one Meta Ad Library ad with its creative: every carousel variant, image and video URL, headline, body, and call to action. $0.00374 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | Meta Ad Library ad ID - the numeric id in an Ad Library URL (e.g. "962050096457659" from https://www.facebook.com/ads/library/?id=962050096457659). |
Get the spoken-word transcript of a Meta Ad Library video ad by ad ID or URL. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | Meta Ad Library ad ID (e.g. "1020359190509080"). Provide either id or url. |
url | string | Optional | Meta Ad Library ad URL (e.g. "https://www.facebook.com/ads/library?id=1020359190509080"). Provide either id or url. |
Search the Meta Ad Library by keyword and get matching ads (advertiser, creative text, CTA, platforms, and run dates) with cursor pagination. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adType | string | Optional | Restrict to all ads (default) or only political and issue ads. One of: all, political_and_issue_ads. |
country | string | Optional | Two-letter country code to scope results. Omit for all countries. |
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. |
endDate | string | Optional | Filter to ads with impressions on or before this date, in YYYY-MM-DD format. |
mediaType | string | Optional | Creative media type filter. One of: ALL, IMAGE, VIDEO, MEME, IMAGE_AND_MEME, NONE. |
query | string | Required | Keyword to search the Meta Ad Library for (e.g. "protein powder"). |
searchType | string | Optional | Match mode for the query: loose keyword match (keyword_unordered, the default) or exact phrase (keyword_exact_phrase). One of: keyword_unordered, keyword_exact_phrase. |
sortBy | string | Optional | Sort order: impressions (highest first, the default) or recent (most recent). One of: impressions, recent. |
startDate | string | Optional | Filter to ads with impressions on or after this date, in YYYY-MM-DD format. |
status | string | Optional | Ad status filter. One of: ALL, ACTIVE, INACTIVE. Default "ACTIVE". |
List the replies to a Facebook post comment (text, author, reactions, and timestamps) as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
expansionToken | string | Required | The expansion_token of the comment, from the post comments endpoint. |
feedbackId | string | Required | The feedback_id of the comment (not the comment id). |
List the Meta Ad Library ads a company is running by page ID or company name (creative text, format, platforms, and run dates) with cursor pagination. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyName | string | Optional | Company name to search (e.g. "nike"). Exact-match and case-sensitive against the Meta Ad Library index; an advertiser with no indexed page returns found:false. |
country | string | Optional | Two-letter country code to scope results. Defaults to all countries. |
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. |
endDate | string | Optional | Filter to ads with impressions on or before this date, in YYYY-MM-DD format. |
language | string | Optional | Two-letter language code to filter ads (e.g. "EN", "ES", "FR"). |
mediaType | string | Optional | Creative media type filter. One of: ALL, IMAGE, VIDEO, MEME, IMAGE_AND_MEME, NONE. |
pageId | string | Optional | Company's Ad Library page ID. Provide either pageId or companyName. |
sortBy | string | Optional | Sort order: impressions (highest first, the default) or recent (most recent). One of: impressions, recent. |
startDate | string | Optional | Filter to ads with impressions on or after this date, in YYYY-MM-DD format. |
status | string | Optional | Ad status filter. Defaults to ACTIVE. One of: ALL, ACTIVE, INACTIVE. |
Fetch full details for a single Facebook event by ID or URL (name, schedule, venue, hosts, and attendance) as normalized JSON. $0.0004 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | The event's numeric identifier. |
url | string | Optional | The event's Facebook URL. |
List public Facebook events for a city or place by its events-page URL (event name, date, venue, and attendance) as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response to fetch the next page. |
time | string | Optional | Timeframe filter for the returned events. Defaults to all time. One of: today, this_week, next_week. |
url | string | Required | URL of a city's or place's Facebook Events page (e.g. https://www.facebook.com/events/explore/saint-petersburg-florida/111326725552547). |
Search public Facebook events by keyword and get structured event records (name, schedule, venue, pricing, and attendance) as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
query | string | Required | The query to search events for. |
List the public followers (or accounts followed) of any Facebook page or profile URL as normalized JSON records. Returns up to 10 results per call (page with cursor/page where offered). $0.033 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
followType | string | Optional | Which relation to fetch: 'follower' or 'following' (e.g. follower). Default "follower". |
url | string | Required | Facebook page or profile URL to list follows for (e.g. https://www.facebook.com/nasa). |
Fetch recent posts from any public Facebook group by URL: text, author, reactions, and comment counts. $0.00072 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response to fetch the next page. |
sort | string | Optional | Ordering for the returned posts (e.g. TOP_POSTS). One of: TOP_POSTS, RECENT_ACTIVITY, CHRONOLOGICAL, CHRONOLOGICAL_LISTINGS. |
url | string | Required | The URL of a public Facebook group to fetch posts from (e.g. https://www.facebook.com/groups/instantpotcommunity/). |
Search Facebook Marketplace listings by keyword near a location, filter by price, condition, delivery, recency, and availability, and get title, price, location, and image as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
availability | string | Optional | Filter by availability: available (default), sold, or all (e.g. sold). One of: available, sold, all. |
condition | string | Optional | Only return listings in this condition (e.g. used_good). One of: new, used_like_new, used_good, used_fair. |
cursor | string | Optional | Pagination cursor from a previous response to fetch the next page. |
dateListed | string | Optional | Only return listings posted within this window (e.g. last_7_days). One of: all, last_24_hours, last_7_days, last_30_days. |
deliveryMethod | string | Optional | Only return listings offering this delivery method (e.g. shipping). One of: all, local_pickup, shipping. |
lat | string | Required | Latitude of the search location (e.g. '30.2677'). |
lng | string | Required | Longitude of the search location (e.g. '-97.7475'). |
priceMax | integer | Optional | Maximum listing price in whole currency units, e.g. 500 for $500. Facebook may mix in a few suggested listings outside the range. |
priceMin | integer | Optional | Minimum listing price in whole currency units, e.g. 100 for $100. Facebook may mix in a few suggested listings outside the range. |
query | string | Required | Search keyword for Marketplace listings (e.g. 'bike'). |
sort | string | Optional | Sort order for the returned listings (e.g. price_ascend). One of: suggested, distance_ascend, creation_time_descend, price_ascend, price_descend. |
Fetch full details for a single Facebook Marketplace listing by ID or URL (title, price, location, photos, and attributes) as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | Facebook Marketplace item ID. |
url | string | Optional | Facebook Marketplace item URL. |
Resolve a place name to Facebook Marketplace locations with coordinates and metadata as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Location search query (e.g. a city name). |
Look up a Facebook Page's public contact details (email, phone, website, and address) by page URL or ID. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Locale code for the returned data (e.g. en-US). Default "en-US". |
page | string | Required | Facebook Page URL or page ID to look up (e.g. https://www.facebook.com/nasa). A link to a post, video, photo or reels tab on a page is read as that page. A link to Facebook's own business, about, marketplace, fb-answers, videos, photos or reels section, a pages link without the page's id, or... |
Look up Facebook Pages and profiles by name with Facebook's own quick search. A name lookup that returns basic identity fields only: name, URL, profile image, Facebook id, and verified status. Matches can include personal profiles as well as Pages. For full Page details (category, followers, phone, website), use facebook.search_pages. $0.00975 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of matches to return (1-7, default 7). Facebook's quick search answers a name with at most 7 matches. Default 7. Max 7. |
query | string | Required | Name to look up, as you would type it into Facebook's search box (e.g. NASA or plumber chicago). |
Fetch recent photos posted by any public Facebook page or profile (image URLs, captions, and dimensions) as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response to fetch the next page. |
url | string | Required | URL of the public Facebook page or profile to fetch photos from (e.g. https://www.facebook.com/Spurs). |
Fetch a single Facebook post by URL with its text and engagement counts (likes, comments, shares, views). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full Facebook post URL. |
List the comments on a Facebook post by URL with cursor pagination (text, author, reactions, reply count). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
feedbackId | string | Optional | Facebook feedback id for the post (alternative to url). |
url | string | Optional | Full Facebook post URL. |
Get the spoken-word transcript of any public Facebook video post by URL as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | The Facebook post or video URL. |
Fetch a Facebook page's public profile (likes, followers, category, about) by URL or handle. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Optional | Facebook page handle/username. |
url | string | Optional | Full Facebook page URL. profile.php without an id value names no page and is refused as invalid input, with no charge. |
List upcoming and past events hosted by any public Facebook page by URL (name, schedule, venue, and host) as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
url | string | Required | The Facebook page link whose events to list, e.g. https://www.facebook.com/brickyardoldtown. Accepted: facebook.com/<name>, /p/<name>-<id>, /pages/<name>/<id>, /pg/<name>, /people/<name>/<id> and profile.php?id=<id>, on facebook.com or fb.com with or without www, m, mbasic, web, business or a... |
List a Facebook page's recent posts by URL or page id with cursor pagination (text, author, publication time, permalink). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
pageId | string | Optional | Facebook page id. |
url | string | Optional | Facebook page or profile link, e.g. https://www.facebook.com/nike. Accepted: facebook.com/<name>, /p/<name>-<id>, /pages/<name>/<id>, /pg/<name>, /people/<name>/<id>, profile.php?id=<id>, and share links to a page (/share/<id> or /share/p/<id>), on facebook.com or fb.com with or without www, m,... |
List a Facebook page's reels by URL with cursor pagination (caption, view count, permalink, thumbnail). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
url | string | Required | Full Facebook page/profile URL. |
Search the Meta Ad Library for advertisers by keyword and get matching pages: page ID, category, verification, follower counts, and linked Instagram. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Keyword to search advertiser pages for (e.g. "nike"). |
Search Facebook Pages by keyword, optionally narrowed to a location, and get structured page profiles (name, category, followers, contact details). Returns up to 10 results per call (page with cursor/page where offered). $0.1001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
location | string | Optional | Optional free-text location to narrow the search: a city, province, or country (e.g. 'Berlin'). |
query | string | Required | Keyword to search Facebook Pages for (e.g. 'coffee roasters'). |
Search public Facebook posts by keyword, optionally filtered by location, and get structured post records (text, author, engagement). $0.03 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
endDate | string | Optional | Only return posts published on or before this date, format YYYY-MM-DD (e.g. 2024-12-31). |
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Max 20. |
location | string | Optional | Optional place name; include both city and country for best matches (e.g. 'Paris, France'). Uses Facebook's place filter, which favors posts tagged at that place rather than every post by people who live there, and can still return some posts from elsewhere. |
query | string | Required | Keyword or phrase to search Facebook posts for (e.g. 'product launch'). |
startDate | string | Optional | Only return posts published on or after this date, format YYYY-MM-DD (e.g. 2024-01-01). |
Extract Fiverr gig listings from any search or category URL: titles, sellers, ratings, and pricing as structured JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0165 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Fiverr search or category page URL to extract gigs from. |
Pull G2 software reviews for any product: star rating, what reviewers like and dislike, problems solved, market segment, and G2's rating rubric as clean JSON. Returns up to 50 results per call (page with cursor/page where offered). $0.00265 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
product | string | Required | G2 product slug, for example hubspot-marketing-hub. A full G2 product URL is also accepted and reduced to its slug. |
sortBy | string | Optional | Sort order for the returned reviews: newest first, most helpful first, highest or lowest rated first, or G2's own default ordering. One of: recent, helpful, highest, lowest, default. Default "recent". |
Ask Gemini a web-grounded question and receive an answer with source citations. $0.0025 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
prompt | string | Required | Question or research prompt for Gemini to answer using web search. |
List the comments on a GitHub issue or pull request by its URL, oldest first, with each commenter's login, their relationship to the repository, reactions and the comment text. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
limit | integer | Optional | Rows per page, 1-100 (GitHub's own page-size limit). Each call returns one full page of this size; use nextCursor for the next page. Default 100. Max 100. |
since | string | Optional | Only comments updated on or after this date (YYYY-MM-DD). |
url | string | Required | URL of a GitHub issue or pull request, e.g. https://github.com/openai/whisper/pull/1838. |
Fetch a GitHub repository's metadata by URL (stars, forks, language, topics, license, and timestamps). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | GitHub repository URL (e.g. https://github.com/facebook/react). |
List the people who have committed to a GitHub repository by repository URL, ordered by number of commits, with each contributor's login, profile URL and commit count. Look each one up with github.user for their profile, website and socials. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Rows per page, 1-100 (GitHub's own page-size limit). Keep it the same while walking pages, because it sets the page size. Default 100. Max 100. |
page | integer | Optional | 1-based page of contributors. Request page + 1 while hasMore is true. Default 1. |
url | string | Required | GitHub repository URL, e.g. https://github.com/openai/whisper. |
List the forks of a GitHub repository by repository URL, with each fork's owner, description, stars, language and last push. Sort by newest, oldest or most starred. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Rows per page, 1-100 (GitHub's own page-size limit). Keep it the same while walking pages, because it sets the page size. Default 100. Max 100. |
page | integer | Optional | 1-based page of forks. Request page + 1 while hasMore is true. Default 1. |
sort | string | Optional | Order of the forks. Defaults to newest. One of: newest, oldest, stargazers, watchers. |
url | string | Required | GitHub repository URL, e.g. https://github.com/openai/whisper. |
List a GitHub repository's issues and pull requests by repository URL (GitHub lists pull requests as issues), with each one's author, state, labels, counts and body. Filter by state, sort and update date. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Rows per page, 1-100 (GitHub's own page-size limit). Keep it the same while walking pages, because it sets the page size. Default 100. Max 100. |
order | string | Optional | Sort direction. Defaults to desc. One of: desc, asc. |
page | integer | Optional | 1-based page of issues. Request page + 1 while hasMore is true. Default 1. |
since | string | Optional | Only issues updated on or after this date (YYYY-MM-DD). |
sort | string | Optional | Sort by creation date, last update, or number of comments. Defaults to created. One of: created, updated, comments. |
state | string | Optional | Which issues to list. Defaults to open. One of: open, closed, all. |
url | string | Required | GitHub repository URL, e.g. https://github.com/openai/whisper. |
Get a GitHub repository's README by repository URL, as the Markdown text the maintainers wrote, with its file name, path and size. Use it to learn what a project does, which models and tools it uses, and how to reach its authors. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | GitHub repository URL, e.g. https://github.com/openai/whisper. The README of the default branch is returned. |
Search issues and pull requests across GitHub with GitHub's own search syntax (repo:, is:pr, is:issue, author:, label:, created:...), with each result's author, state, labels, counts and body. Use it to find who opens issues and pull requests on a repository. $0.0024 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Rows per page, 1-100 (GitHub's own page-size limit). Keep it the same while walking pages, because it sets the page size. Default 100. Max 100. |
order | string | Optional | Sort direction when sort is set. Defaults to desc. One of: desc, asc. |
page | integer | Optional | 1-based page of results. Request page + 1 while hasMore is true. Default 1. |
query | string | Required | GitHub issue search query with any of GitHub's qualifiers, e.g. "repo:openai/whisper is:pr", "is:issue label:bug author:octocat", "repo:ggml-org/llama.cpp is:pr is:merged created:>2026-01-01". |
sort | string | Optional | Sort by number of comments, creation date, last update, or reactions. Omit for best match. One of: comments, created, updated, reactions. |
List trending GitHub developers (rank, username, name, avatar, and their most popular repository), optionally filtered by programming language and time range. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Programming language to filter trending developers (e.g. javascript, python, go). |
since | string | Optional | Trending range: daily, weekly, or monthly (defaults to daily). One of: daily, weekly, monthly. |
List GitHub Trending repositories (rank, stars, stars gained today, language, and description), filterable by language and time window. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Filter by programming language (e.g. "go", "typescript"). Omit for all languages. |
since | string | Optional | Trending window. One of: daily, weekly, monthly. Default "daily". |
Fetch a GitHub user's public profile by handle (name, bio, company, location, followers, and repo counts). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | GitHub username. |
List a GitHub user's public contribution activity by handle (grouped monthly summaries of commits, pull requests, and issues with repository links) for a given year. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response (pages backward by month). |
handle | string | Required | GitHub username. |
year | string | Optional | Year of contribution activity to return (defaults to the current year). |
Fetch a GitHub user's contribution graph for a year (total contributions plus per-day counts and heatmap intensity). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | GitHub username. |
year | integer | Optional | Calendar year of the contribution graph. Defaults to the current year. |
List a GitHub user's followers by handle (each follower's login, type, avatar, and profile URL) with pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response (page number, defaults to 1). |
handle | string | Required | GitHub username. |
List the GitHub users a given user follows by handle (each account's login, type, avatar, and profile URL) with pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response (page number, defaults to 1). |
handle | string | Required | GitHub username. |
List a GitHub user's public pull requests by handle (title, repository, state, creation date, and URL) with optional date filtering and pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response (page number, defaults to 1). |
handle | string | Required | GitHub username. |
since | string | Optional | Only include pull requests created on or after this date (YYYY-MM-DD). |
until | string | Optional | Only include pull requests created on or before this date (YYYY-MM-DD). |
List a GitHub user's public repositories (name, description, language, stars, and forks) with sorting and cursor pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it back to fetch the next page. |
direction | string | Optional | Sort direction, ascending or descending, paired with sort. One of: asc, desc. |
handle | string | Required | GitHub username. |
sort | string | Optional | Repository ordering. One of: created, updated, pushed, full_name. Default "updated". |
type | string | Optional | Which repositories to include: owner (default), all, or member. One of: owner, all, member. |
Search Glassdoor job listings by keyword and location, or scrape any Glassdoor company or job search page URL - up to 20 normalized job records per request. $0.007 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
easyApply | boolean | Optional | When true, only return jobs offering Easy Apply. Keyword mode only. |
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Max 20. |
location | string | Optional | City, region, or country to search within (keyword mode; e.g. United States, New York). |
postedLimit | string | Optional | Only jobs posted within this window (past 24 hours, week, or month). Keyword mode only. One of: 24h, week, month. |
query | string | Optional | Job title or keywords to search (keyword mode). Provide this or a url. |
sortBy | string | Optional | Sort order: most recent (date) or best match (relevance). Keyword mode only. One of: date, relevance. |
url | string | Optional | Alternatively, a Glassdoor company or job search page URL to scrape (e.g. https://www.glassdoor.com/Jobs/Google-Jobs-E9079.htm). The filters below apply in keyword (query) mode. |
workplaceType | string | Optional | Filter by workplace type (remote, hybrid, or onsite). Keyword mode only. One of: remote, hybrid, onsite. |
Look up a single Google Ads Transparency Center creative by URL and get its format, run dates, impression range, regions, and creative variations as clean JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Google Ads Transparency Center creative URL (e.g. "https://adstransparency.google.com/advertiser/AR.../creative/CR..."). |
Search the Google Ads Transparency Center for advertisers by keyword and get matching advertiser IDs, regions, and estimated ad counts as clean JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Advertiser name or keyword to search for (e.g. "lululemon"). |
region | string | Optional | Two-letter country code to scope results (e.g. "AU", "CA"). Defaults to US. |
List the ads a company is running from the Google Ads Transparency Center by domain or advertiser ID (creative ID, format, ad URL, and first/last shown dates) with cursor pagination. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
advertiserId | string | Optional | Advertiser ID. Provide either domain or advertiserId. |
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. |
domain | string | Optional | Company domain (e.g. "lululemon.com"). Provide either domain or advertiserId. |
endDate | string | Optional | Only return ads first shown on or before this date, format YYYY-MM-DD (e.g. 2024-12-31). |
format | string | Optional | Ad format filter. One of: text, image, video. |
platform | string | Optional | Platform filter. One of: google_maps, google_play, google_search, google_shopping, youtube. |
region | string | Optional | Two-letter country code to scope results (e.g. "US", "AU"). |
startDate | string | Optional | Only return ads first shown on or after this date, format YYYY-MM-DD (e.g. 2024-01-01). |
topic | string | Optional | Search topic. "political" requires a region. One of: all, political. |
Pull the ads an advertiser is running from the Google Ads Transparency Center (creative details, formats, run dates, and headline and text where Google publishes them) as clean JSON. Each ad's detail page is read, so a 20-ad call can take a minute or more; many text ads come back only as an image of the ad. Returns up to 10 results per call (page with cursor/page where offered). $0.00996 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | A Google Ads Transparency Center URL for a selected advertiser or domain (e.g. https://adstransparency.google.com/advertiser/AR01614014350098432001?region=US). |
Fetch a live quote for any stock, index, ETF, mutual fund, currency pair, or crypto symbol: name, current price, the absolute and percent change on the day, quote currency, exchange and market state, plus intraday and reference figures (open, day high/low, previous close, volume, market cap, and the 52-week range). $0.00116 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
symbol | string | Required | The symbol to quote. US stocks use a plain ticker (e.g. AAPL, TSLA); non-US stocks add a market suffix (e.g. VOW3.DE, BABA.HK, BARC.L); indices use a caret (e.g. ^GSPC, ^DJI); crypto and currencies use pair form (e.g. BTC-USD, EURUSD=X); mutual funds and futures use their symbol (e.g. VFIAX,... |
Get the Google Flights price calendar for a route: the lowest fare for every departure date across a window of up to 120 days, one way or as a round trip of a fixed length, with the return date of each round trip, a flag on every date within 5% of the cheapest, and the cheapest date of the window, as normalized JSON. Choose cabin class, adults and currency. Prices are the total for all passengers; dates with no fare are left out. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult passengers (1-9, default 1). Prices are for all passengers together. Child passengers cannot be priced on the calendar. Default 1. Max 9. |
cabinClass | string | Optional | Cabin class (default economy). One of: economy, premium_economy, business, first. Default "economy". |
currency | string | Optional | ISO 4217 currency code for prices (e.g. USD, EUR, GBP; default USD). Default "USD". |
departureDateFrom | string | Required | First departure date of the calendar in YYYY-MM-DD format (e.g. 2027-01-12). Today or later. |
departureDateTo | string | Required | Last departure date of the calendar in YYYY-MM-DD format (e.g. 2027-02-10). At most 120 days after departureDateFrom. |
destination | string | Required | Arrival airport as a three-letter IATA code in capitals (e.g. LHR), or a Google place ID for a city to cover all of its airports (e.g. /m/04jpl for London). |
origin | string | Required | Departure airport as a three-letter IATA code in capitals (e.g. JFK), or a Google place ID for a city to cover all of its airports (e.g. /m/02_286 for New York). |
tripLengthDays | integer | Optional | For a round trip, the number of days between departure and return (1-30, e.g. 7): each date is then priced as a round trip returning that many days later. Omit it for one way. Max 30. |
Search Google Flights between two airports on a date and get about 20 itineraries: price, airline, stops, total duration, CO2 emissions against the typical figure for the route, and every leg's airline code, flight number, airports, local departure and arrival times and duration, as normalized JSON. Filter by cabin class, stops, airlines and maximum price. One-way searches return the total fare for all passengers. With a returnDate, each result is an outbound option priced at the cheapest round trip that starts with it (priceType round_trip_starting); the return flights are not included. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult passengers (1-9, default 1). Prices are for all passengers together. Default 1. Max 9. |
airlines | array | Optional | Only itineraries flown by these airlines, as two-character IATA codes (e.g. ["BA", "AA"]). |
cabinClass | string | Optional | Cabin class (default economy). One of: economy, premium_economy, business, first. Default "economy". |
children | integer | Optional | Number of child passengers aged 2-11 (e.g. 1). Max 8. |
currency | string | Optional | ISO 4217 currency code for prices (e.g. USD, EUR, GBP; default USD). Default "USD". |
departureDate | string | Required | Departure date in YYYY-MM-DD format (e.g. 2027-01-12). Today or later. |
destination | string | Required | Arrival airport as a three-letter IATA code in capitals (e.g. LHR). |
maxPrice | integer | Optional | Highest total price to return, in currency (e.g. 600). |
maxStops | string | Optional | Most stops an itinerary may have (default any). One of: any, nonstop, one_or_fewer, two_or_fewer. Default "any". |
origin | string | Required | Departure airport as a three-letter IATA code in capitals (e.g. JFK). |
returnDate | string | Optional | Return date in YYYY-MM-DD format for a round trip (e.g. 2027-01-19). Omit it for one way. With it, each result is an outbound option priced at the cheapest round trip that starts with it, and the return flights are not included. |
sortBy | string | Optional | Result order: top_flights (Google's best flights first, the default), cheapest, departure_time, arrival_time, duration or emissions. One of: top_flights, cheapest, departure_time, arrival_time, duration, emissions. Default "top_flights". |
Get one hotel from Google Hotels by its property ID: address, phone, website, rating, nightly price, prices from each booking site, amenities and check-in times as normalized JSON. $0.0015 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult guests (default 2). Default 2. |
checkIn | string | Required | Check-in date in YYYY-MM-DD format (e.g. 2027-04-13). Today or later. |
checkOut | string | Required | Check-out date in YYYY-MM-DD format (e.g. 2027-04-15). After the check-in date. |
childrenAges | array | Optional | Age of each child guest, one entry per child (e.g. [5, 8] for two children aged 5 and 8). Omit it when no children are staying. |
country | string | Required | Two-letter lowercase ISO 3166-1 country code of the destination (e.g. us, pt, jp). It must be the country the hotels are in: results are searched from that country. |
currency | string | Optional | ISO 4217 currency code for prices (e.g. USD, EUR, JPY; default USD). Default "USD". |
propertyToken | string | Required | Google Hotels property ID of the hotel, the propertyToken google_hotels.search returns for it. |
Search Google Hotels by destination and dates and get hotels with their Google property ID, nightly price, rating, review count, coordinates, star class and photos as normalized JSON. $0.0015 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult guests (default 2). Default 2. |
checkIn | string | Required | Check-in date in YYYY-MM-DD format (e.g. 2027-04-13). Today or later. |
checkOut | string | Required | Check-out date in YYYY-MM-DD format (e.g. 2027-04-15). After the check-in date. |
childrenAges | array | Optional | Age of each child guest, one entry per child (e.g. [5, 8] for two children aged 5 and 8). Omit it when no children are staying. |
country | string | Required | Two-letter lowercase ISO 3166-1 country code of the destination (e.g. us, pt, jp). It must be the country the hotels are in: results are searched from that country. |
currency | string | Optional | ISO 4217 currency code for prices (e.g. USD, EUR, JPY; default USD). Default "USD". |
query | string | Required | What to search for, usually a destination or landmark (e.g. hotels near times square new york). |
Search Google Shopping by keyword and get up to 10 product offers (title, price, store, rating, and link), localized by country and language. $0.016 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
condition | string | Optional | Only return products in this condition (e.g. "USED"); defaults to any condition. One of: ANY, NEW, USED, REFURBISHED. |
country | string | Optional | ISO 3166-1 alpha-2 country code for localized results (e.g. "us", "gb", "de"). Default "us". |
language | string | Optional | ISO 639-1 language code for results (e.g. "en", "es", "fr"). Default "en". |
limit | integer | Optional | Maximum number of results to return (1-10, default 10). Max 10. |
query | string | Required | Product name, brand, or keywords to search for (e.g. "Nike running shoes"). |
sortBy | string | Optional | Sort order for results (e.g. "LOWEST_PRICE"); defaults to relevance. One of: BEST_MATCH, LOWEST_PRICE, HIGHEST_PRICE, TOP_RATED. |
Ask Google AI Mode a prompt and receive the cited answer it generates. AI Mode composes the answer at search time, so repeat calls on one prompt can differ in wording and in which sources are cited. $0.002 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
prompt | string | Required | The question or prompt to answer with Google AI Mode. |
Ask Google Search a prompt and receive the AI Overview it generated for that scrape, with every source Google listed. Google regenerates the overview per search, so the same prompt can return different wording and a different source list. $0.0048 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
prompt | string | Required | The question or prompt to answer with a Google AI Overview. |
Ask Google Search a prompt and receive the AI Overview as a searcher first sees it, before selecting Show more: the opening text and the sources linked inside it. When Google shows the whole overview without a Show more button, that is what you receive. For the complete expanded overview with every source Google listed, use google.ai_overview. $0.0007 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
prompt | string | Required | The question or prompt to search Google for. |
Get Google search autocomplete suggestions for a partial query (keyword ideas). $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
gl | string | Optional | Two-letter country code for result localization (e.g. us, gb, de). Default "us". |
hl | string | Optional | Two-letter interface and results language code for the suggestions (e.g. en, es, de). Default "en". |
query | string | Required | The partial Google search query. |
Run a Google Images search and get structured results: image URLs, dimensions, titles, and source pages. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
autocorrect | boolean | Optional | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. |
gl | string | Optional | Two-letter country code for result localization (e.g. us, gb, de). Default "us". |
hl | string | Optional | Two-letter interface and results language code (e.g. en, es, de). Default "en". |
limit | integer | Optional | Maximum number of images to return (1-100, default 20). Requests for 10 results or fewer are billed at a lower rate than larger requests. Default 20. Max 100. |
location | string | Optional | Fine-grained location for result localization, given as a canonical Google location string (e.g. 'New York, United States', 'London, United Kingdom'). More specific than the country-level gl. |
query | string | Required | Image search query (e.g. golden gate bridge at sunset). |
timeframe | string | Optional | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). One of: 1h, 1d, 7d, 1y, all. |
Fetch one Google Jobs listing by the listingToken that google.jobs returns: title, company, location, the site it was found on, the full description, apply links on every board that carries it, the posting details Google shows (posted, pay, job type, benefits), and the employer's ratings on review sites such as Glassdoor and Indeed when Google shows them. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
listingToken | string | Required | The listingToken of one listing in a google.jobs response. |
Search Google Jobs, the job listings Google gathers from LinkedIn, Indeed, ZipRecruiter, company career sites and other boards, and get about 10 listings per call: title, company, location, the site it was found on, the full description, apply links on every board that carries it, and the posting details Google shows (posted, pay, job type, benefits). Each listing carries a listingToken you can pass to google.job for employer ratings. Send nextCursor back as cursor to walk further pages. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque cursor from a previous response's nextCursor. Send it with the same query, location, gl and hl to get the next page of about 10 listings; it expires about an hour after it was issued, after which you start again from page 1. |
gl | string | Optional | Two-letter country code to search in (e.g. us, gb, de). Default "us". |
hl | string | Optional | Language code for the listings and their details (e.g. en, de, es). Default "en". |
location | string | Optional | City, region or country to search around, e.g. Chicago, IL or London. Google may include nearby places. |
query | string | Required | Job title or keywords to search, e.g. registered nurse. A place written into the query ("barista in Austin, TX") also localizes the search. |
Reverse image search: find web pages and visual matches for an image URL. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Public URL of the image to search with. |
Find the businesses Google lists in Local Services ads for a service in a US city (plumbers, electricians, cleaners...): up to 20 per request, each with phone, star rating, review count, category, service area and Google profile link. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of businesses to return (1-20, default 20). Google lists at most 20 businesses for one service in one city, so there are no further pages. Max 20. |
location | string | Required | The US city to search, with its state (e.g. Denver, CO or Austin, TX). |
query | string | Required | The service to find businesses for, in everyday words (e.g. plumber, electrician, house cleaning, roofer). |
Search Google News by keyword and get fresh articles (headlines, sources, links, and publish times) as clean JSON. $0.00099 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
gl | string | Optional | Two-letter country code for result localization (e.g. us, gb, de). Default "us". |
hl | string | Optional | Two-letter interface and results language code (e.g. en, es, de). Default "en". |
limit | integer | Optional | Requested article count (1-20, default 20). Google News returns its latest matching articles and may return more or fewer than requested. Price is flat per request. Max 20. |
location | string | Optional | Fine-grained location for result localization, given as a canonical Google location string (e.g. 'New York, United States', 'London, United Kingdom'). More specific than the country-level gl. |
query | string | Required | News search query; supports operators like '-', 'OR', and 'site:' (e.g. bitcoin site:cnn.com). |
timeframe | string | Optional | How far back to search, written as a count plus a unit: h hours, d days, w weeks, m months, y years. So 2h is the last two hours, 30d the last thirty days, 6m the last six months. Omit this field, or send 'all', to search without a time limit. |
Search Google Patents with title, patent number, inventor, assignee, key dates, and PDF link. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | The Google Patents search query. |
Turn Google redirect links (google.com/goto?url=...) into the destination URLs they point to. Google search, video, jobs and AI Overview results carry such a link in place of the destination when Google withholds it. Send up to 100 links in one call and get each one back in the order sent, with its destination, or resolved false when Google would not reveal it. One price per call whatever the number of links; a call usually answers in under 30 seconds and can take about a minute. $0.00009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
urls | array | Required | Google redirect links to resolve, as Google search, video, jobs or AI Overview results return them: https://www.google.com/goto?url=... or https://google.com/goto?url=.... Max 100 items. Example: ["https://www.google.com/goto?url=CAESXAHEIkXX-k1JDF6Qm-ZU80RgctK1e1kdU0lHAgJ3GmEYXJNuaDgsSFU8mZVr16FAhiZU72RhtPVNfgRmzgSrpkhv_3XB4FyHiTxWRGeAJxe08-tV3aHUReJ4kC6m", "https://www.google.com/goto?url=CAESWwHEIkXXUR3b8PmwqSp-vpUo7COcGYqs-lcvqN4jG_We2j1tLsoCdGeHmqS3QgYaD-ZgCuRLp_DiuWLobg_oiXpEk7o6rEZVKM |
Search Google Scholar for academic papers with title, authors, citation count, and PDF link. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | The Google Scholar search query. |
Run a Google web search and get the organic results (title, link, snippet, position) as clean JSON. Returns about 10 results per call - Google stopped honoring bulk result counts in September 2025, so a limit above 10 is accepted but returns no more than a page. Send page 2, 3, ... to walk further, or use google.search_100 for up to 100 ranked results in one call, which is normally cheaper past roughly 20 results. $0.0005 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
autocorrect | boolean | Optional | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. |
cursor | string | Optional | Deprecated: send page instead. A continuation token from an earlier response's nextCursor is still accepted and still continues on the source that issued it; page is ignored when cursor is sent alongside it. |
gl | string | Optional | Two-letter country code for result localization (e.g. us, gb, de). Default "us". |
hl | string | Optional | Two-letter interface and results language code (e.g. en, es, de). Default "en". |
limit | integer | Optional | Page size to ask for. Google returns about 10 organic results per page and stopped honoring larger counts in September 2025, so a limit above 10 still returns about 10. Some sources return their whole page of about 10 whatever limit says: a page is never trimmed after the call, so nextCursor... Default 10. Max 100. |
location | string | Optional | Fine-grained location to localize results to, more specific than the country-level gl. Send it as an Active Canonical Name from Google's geo-target list: place, then each parent region, then country, with no space after each comma, e.g. 'New York,New York,United States', 'Austin,Texas,United... |
page | integer | Optional | Which page of about 10 organic results to return, starting at 1. Send page 2, 3, ... to walk deeper; each page is billed as one request and any source can serve any page. Replaces cursor. Default 1. |
query | string | Required | The Google search query. |
requireCursor | boolean | Optional | Deprecated. Every source for this search returns a nextCursor, so this changes nothing about the price or which source serves you; it stays accepted so callers that already send it keep working. |
timeframe | string | Optional | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). One of: 1h, 1d, 7d, 1y, all. |
Run a Google web search and get up to 100 ranked organic results in one call, with true absolute positions rather than per-page numbering. One charge per call whatever the depth, which normally makes it cheaper than paging google.search past roughly 20 results; when the backup source has to answer, the call costs more, up to $0.024. It reads ten pages of Google to build the list, so a call can take up to about five minutes - use google.search when you want the first page back in a second. $0.024 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
autocorrect | boolean | Optional | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. |
gl | string | Optional | Two-letter country code for result localization (e.g. us, gb, de). Default "us". |
hl | string | Optional | Two-letter interface and results language code (e.g. en, es, de). Default "en". |
query | string | Required | The Google search query. |
timeframe | string | Optional | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). One of: 1h, 1d, 7d, 1y, all. |
Google Trends interest over time for up to 5 search terms compared on one 0-100 scale, where 100 is the peak search interest of any term in the window. Returns one series per term, in the order you sent them, with a value for every time bucket. Choose the country or region with geo (worldwide when omitted) and the window with timeframe (the past 12 months when omitted); both are echoed in the response. Interest over time only, not related queries or regions. $0.002 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
geo | string | Optional | Where the searches came from: an uppercase ISO country code (US, GB, DE) or a country subdivision (US-CA, GB-ENG). Omit it, or send worldwide, for worldwide interest. Default "worldwide". |
keywords | array | Required | Search terms to compare, 1 to 5, each 2 to 100 characters and without commas (e.g. ["coffee", "tea"]). Values are relative across the whole set, so the same term scores differently next to different terms. Max 5 items. Example: ["coffee", "tea"] |
timeframe | string | Optional | The window to chart, ending now: 1h, 4h, 1d or 7d (hours and days), 1m or 3m (months), 12m, 5y, or all (back to January 2004). Buckets grow with the window: minutes up to 1d, hours for 7d, days for 1m and 3m, weeks for 12m and 5y, months for all. One of: 1h, 4h, 1d, 7d, 1m, 3m, 12m, 5y, all. Default "12m". |
Search Google for video results (YouTube and others) with title, link, thumbnail, and source. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
autocorrect | boolean | Optional | Toggle Google spelling autocorrect (default true). Set false to search the exact query without correction. |
gl | string | Optional | Two-letter country code for result localization (e.g. us, gb, de). Default "us". |
hl | string | Optional | Two-letter interface and results language code (e.g. en, es, de). Default "en". |
location | string | Optional | Fine-grained location for result localization, given as a canonical Google location string (e.g. 'New York, United States', 'London, United Kingdom'). More specific than the country-level gl. |
query | string | Required | The video search query. |
timeframe | string | Optional | Restrict results to a recent time window: 1h, 1d, 7d, 1y, or all. Default all (no time restriction). One of: 1h, 1d, 7d, 1y, all. |
Get a Hacker News user's public profile by username - karma, bio, and account details as clean JSON. $0.0015 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Hacker News username, e.g. "pg". |
Search Hacker News by keyword - matching stories with title, link, author, points, and comment count as clean JSON. $0.0015 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Search keyword, e.g. "ai". |
tags | string | Optional | Optional result filter, e.g. "story" or "comment". |
Get a Hacker News story by id - title, link, author, points, and comment count as clean JSON. $0.0015 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | Hacker News story id, e.g. "47340079". |
List the comments on a Hacker News story by id - text, author, and timestamp as clean JSON. $0.0015 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | Hacker News story id, e.g. "47340079". |
Search IKEA's US store by keyword and get title, price, rating, and image for each product in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based results page of 24 products. Each page is billed as one request. Default 1. Max 100. |
query | string | Required | Search keywords, e.g. "bookshelf" or "desk". |
Search Indeed job listings by keyword, location, and country, with up to 20 normalized job records per request. $0.00125 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Two-letter country site code (e.g. us, uk, de). Default "us". |
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Max 20. |
location | string | Optional | City, state, zip, or 'remote'. |
postedLimit | string | Optional | Only return jobs posted within this window: 24h (past day) or week (past 7 days). Omit for all dates. This can raise your price: a dearer source serves a request that sets it, and you are quoted and charged its price. One of: 24h, week. |
query | string | Required | Job search keywords (e.g. software engineer). |
Get what Instagram's About this account page shows for a handle: when the account joined, the country it is based in, how many times it changed its username, and whether it is verified. $0.0022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Instagram username without the leading @. |
List Instagram reels that use a given audio track by audio id. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
audioId | string | Required | Audio identifier from the Instagram audio page URL. |
cursor | string | Optional | Pagination cursor returned by a previous response. |
Fetch an Instagram account's core public profile fields (followers, posts, bio, verification) by user id. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
userId | string | Required | Instagram numeric user id (the account's internal all-digits id, e.g. 314216), NOT the @handle or profile URL. Passing a handle here returns no profile. |
List the accounts that liked an Instagram comment, one page of up to 50 likers per call with cursor pagination, with each liker's handle, display name, verified and private flags and avatar. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
commentId | string | Required | Instagram's numeric comment id, as instagram.post_comments returns it in a comment's id. An id that is not a number is refused as invalid input, with no charge. |
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
List the replies to an Instagram comment with cursor pagination (text, author, likes). $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
commentId | string | Required | Instagram comment ID (a comment's id from the Instagram Post Comments endpoint). |
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
url | string | Required | Full Instagram post or reel URL the comment belongs to, carrying the media shortcode: /p/, /reel/, /reels/, or /tv/. A profile URL such as https://www.instagram.com/username names no post, so it is refused as invalid input, with no charge. |
Fetch the public embed HTML for an Instagram profile by handle. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Instagram username without the leading @. |
List about the first 50 followers of any public Instagram account by username: follower usernames, names, and profile details. Instagram caps follower lists, so this returns one page, not the whole list. $0.00173 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Today every source behind this endpoint returns a single page of about 50 followers and no continuation cursor, so nextCursor comes back empty and there is no further page to request; this parameter is accepted but has nothing to... |
username | string | Required | The Instagram username, user ID, or profile URL whose followers to list (e.g. natgeo). |
List about the first 50 accounts a public Instagram user follows: usernames, names, and profile details. Instagram caps these lists, so this returns one page, not the whole list. $0.00173 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Today every source behind this endpoint returns a single page of about 50 accounts and no continuation cursor, so nextCursor comes back empty and there is no further page to request; this parameter is accepted but has nothing to... |
username | string | Required | The Instagram username, user ID, or profile URL whose following list to fetch (e.g. natgeo). |
Get the total post count for any Instagram hashtag. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
hashtag | string | Required | The Instagram hashtag to analyze, with or without the # symbol (e.g. streetphotography). |
limit | integer | Optional | Deprecated. Has no effect. Max 20. |
Instagram posts published under a hashtag, newest first, read from its live chronological feed rather than a web search index. Built for monitoring: results arrive within a couple of minutes of posting, so engagement counts are usually still zero and reels do not appear (Instagram keeps those on a separate tab). For engagement-ranked results use instagram.hashtag_top_posts; for older relevance-ranked results use instagram.search_hashtag. $0.00188 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
hashtag | string | Required | Hashtag to monitor, without the leading #. |
Instagram's own top-ranked posts for a hashtag, read from its live hashtag feed rather than a web search index, with view, like, and comment counts. Reels-heavy and engagement-ranked, so it answers what is performing on a tag right now. For older relevance-ranked results with date and media-type filters use instagram.search_hashtag; for the chronological feed use instagram.hashtag_recent_posts. $0.00188 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
hashtag | string | Required | Hashtag to fetch, without the leading #. |
Fetch the details and media items of a single Instagram story highlight by id or highlight URL. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | The highlight to retrieve: its numeric id (e.g. 18201653992314974), the highlight:<id> form, or its highlight URL (https://www.instagram.com/stories/highlights/<id>/). instagram.user_highlights returns the id of each highlight. |
Look up one Instagram location by id: its name, category, coordinates, number of tagged posts and page slug, plus the street address, postal code, phone and linked business account when Instagram lists them. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
locationId | string | Required | Instagram's numeric location id, as instagram.search_locations returns it. An id that is not a number is refused as invalid input, with no charge. |
List public Instagram posts tagged at a location, ranked or most recent, with cursor pagination. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
locationId | string | Required | Instagram location id, as returned by instagram.search_locations. |
sort | string | Optional | Order the posts by Instagram's top ranking or by newest first. Defaults to ranked. One of: ranked, recent. |
Get the spoken-audio transcript text for an Instagram post or reel by URL. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Instagram post or reel URL. |
Fetch a single Instagram post or reel by URL (media URLs, like count, owner, type) as normalized JSON. Turn on hostVideo to also get the post's video on a hosted MP4 link that plays without an Instagram session, charged as an extra on top of the price. If you want the spoken words as well, instagram.reel_transcript transcribes the same reel. $0.0004 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
hostVideo | boolean | Optional | Set true to also get the post's video on a hosted MP4 link that plays without an Instagram session. The file is downloaded and stored for you, and the response adds `hostedUrl`, `expiresUtc` and `bytes`. It is charged as an extra on top of the price, and it never changes which source serves you:... Default false. |
requirePlayCount | boolean | Optional | Deprecated; send `requireFields: ["plays"]` instead, which does exactly the same thing. Set true to be served only by a source that reports a reel's play count. Omit it and routing is unchanged, with the cheapest source serving, which does not carry play counts, so `plays` is absent from its... |
url | string | Required | Full Instagram post or reel URL, carrying the media shortcode: /p/, /reel/, /reels/, or /tv/. A profile URL such as https://www.instagram.com/username names no post, so it is rejected instead of charged for an empty result - send that account's handle to instagram.profile, or its posts to... |
List the comments on an Instagram post or reel by URL with cursor pagination (text, author, likes). $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
url | string | Required | Full Instagram post or reel URL, carrying the media shortcode: /p/, /reel/, /reels/, or /tv/. A profile URL such as https://www.instagram.com/username names no post, so it is rejected instead of charged for an empty result - send that account's handle to instagram.user_posts to list its posts. |
List the accounts that liked a public Instagram post, one page of likers per call, with each liker's handle, display name, verified flag and avatar. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Canonical URL of a public Instagram post or reel, carrying the media shortcode: /p/, /reel/, /reels/, or /tv/. A profile URL such as https://www.instagram.com/username names no post, so it is refused as invalid input, with no charge - send that account's handle to instagram.user_posts to list... |
Fetch an Instagram account's public profile (followers, posts, bio, verification) by handle. $0.00056 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Instagram username without the leading @. |
Look up the contact email and phone number an Instagram creator or business publishes on its profile, including the address behind the profile's Email button that public profile lookups do not return. $0.0004 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Instagram username without the leading @. |
Transcribe any public Instagram reel or video post: the full speech transcript, speaker labels, and word-level timestamps, from a reel, /p/, or /tv/ URL or an Instagram CDN media URL you already hold. A video post is transcribed exactly like a reel. A photo post comes back found with its record and an empty transcript, charged the request price only. Transcription runs on MAI-Transcribe-2, chosen for its accuracy and its speaker labels. Turn on hostVideo to also get the MP4 on a hosted link that plays without an Instagram session. If you only want the text, instagram.media_transcript is the cheaper transcript-only option; if you only want the file, instagram.post is where you go. $0.095 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
hostVideo | boolean | Optional | Set true to also get the reel's MP4 on a hosted link you can play without an Instagram session. Charged as an extra on top of the transcript (e.g. true). A photo post has no file to host, so a request that sets this on one is refused with no charge; send it without hostVideo to get the post... Default false. |
url | string | Required | The URL of a public Instagram reel or video post (e.g. https://www.instagram.com/reel/C8yKXdRxKqK/), or an Instagram CDN media URL you already hold. |
wordTimestamps | boolean | Optional | Set true to include a precise timestamp for every word in the transcript (e.g. true). Default false. |
Search Instagram Reels by keyword against Instagram's own reels search and get matching reels with view, like and comment counts, caption, creator and duration. Results are relevance-ranked, not chronological. We remove overlap with recent pages, but older reels may reappear during a long search. nextCursor is null when a page contains only reels seen in recent pages. For a web-search-index view of the same keyword, with a recency filter and numbered pages, use instagram.web_reels_search. $0.00188 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
query | string | Required | Search keyword (e.g. "crossfit"). |
Search Instagram for users, hashtags, or places by keyword and get matching results with names, counts, and links. $0.00126 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Max 20. |
query | string | Required | Keyword to search Instagram for; one or more words without special punctuation (e.g. coffee roastery). |
type | string | Optional | What to search for: user profiles, hashtags, or places (e.g. hashtag). One of: user, hashtag, place. Default "user". |
Search Instagram's audio library by keyword and get licensed tracks and creators' original sounds, each with an audio id you can pass to instagram.audio_reels, its title, artist, and length. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Words to search Instagram's audio for, such as a song title, an artist, or a phrase. One call returns one page of up to about 13 results; there is no next page. |
Search the followers of a public Instagram account by name or username, using Instagram's own follower search. On smaller accounts it searches the whole follower list and returns close matches ranked by Instagram. On large accounts Instagram does not support searching followers, so the result is the account's most recent followers instead, whatever the query. Returns usernames, names, and profile details. $0.0022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Name or username text to look for among this account's followers (e.g. john). Instagram matches loosely, and on large accounts it does not search followers at all, so the most recent followers come back instead. |
username | string | Required | The Instagram username whose followers to search, without the leading @ (e.g. milada2788). |
Search the accounts a public Instagram user follows by name or username. Matching is Instagram's own loose search, so results are close matches ranked by Instagram and some may not contain your exact word. Returns usernames, names, and profile details. $0.0022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Name or username text to look for among the accounts this user follows (e.g. skin). Instagram matches loosely, so close matches are returned too. |
username | string | Required | The Instagram username whose following list to search, without the leading @ (e.g. moogooskincare). |
Search posts under an Instagram hashtag through a web search index rather than Instagram's own hashtag feed. That is what lets it filter by date and media type and return reels whose like counts have settled, and it is also why results skew older (median around three months) and stop at roughly 110 per hashtag. For Instagram's own live ranking of a tag use instagram.hashtag_top_posts, and for the chronological feed use instagram.hashtag_recent_posts. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
datePosted | string | Optional | Restrict results to posts published within this window. One of: last-hour, last-day, last-week, last-month, last-year. |
hashtag | string | Required | Hashtag to search, without the leading #. |
mediaType | string | Optional | Filter by media type. One of all, reel. One of: all, reel. |
Search Instagram locations by keyword and return each place's id, name, address and coordinates. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Place name, address or city to search for. |
Search public Instagram profiles by a bio or caption keyword. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor returned by a previous response. |
query | string | Required | Bio or caption keyword/phrase to search for. |
Search public Instagram profiles by a bio or caption keyword and get each account's country, the month it joined, and the public email and phone number it lists. Charged per profile that comes back with those details. Returns up to 8 results per call (page with cursor/page where offered). $0.0544 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor returned by a previous response. |
query | string | Required | Bio or caption keyword/phrase to search for. |
List the related profiles Instagram's website shows for a public profile, with each account's handle, display name, verified flag and avatar. This is Instagram's shorter web list: it often holds only a few accounts and can be empty even for a large profile. When it comes back empty or cannot be read, the accounts Instagram's app suggests for the profile may be returned instead. For the full list of accounts Instagram suggests as similar, use instagram.suggested_profiles. $0.00175 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Instagram username without the leading @. |
Fetch a public Instagram account's currently live stories with media, type, dimensions, posting time, and 24-hour expiry by username. $0.0022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
username | string | Required | Instagram username or handle without the @. |
Fetch a public Instagram account's currently live stories - media URL, owner, and posting time - by username. Lightweight projection; for media type, dimensions, and the 24h expiry time use instagram.stories_full. $0.00188 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
username | string | Required | Instagram username/handle to fetch currently live stories for (without the @). |
Fetch one live Instagram story by its link or id, with its image or video, posting time, author, and the accounts, links and stickers placed on it. $0.0022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | The story's link, such as https://www.instagram.com/stories/nasa/4029751009399397766/, or its numeric id alone. Short share links (instagram.com/s/...) are not accepted and are refused with no charge. A story stays available for 24 hours after it is posted. |
List the full set of accounts Instagram suggests as similar to a public profile, the list its app shows, with each account's handle, display name, verified flag, private flag and avatar. For the shorter related-profiles list Instagram's website shows, at a lower price, use instagram.similar_profiles. $0.0022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Instagram username without the leading @. |
List the posts an Instagram user is tagged in, with cursor pagination (author, caption, likes, comments). $0.00188 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
handle | string | Required | Instagram username without the leading @. |
List currently trending Instagram reels. Instagram does not return play counts on this feed. $0.0012 per call.
List an Instagram account's story highlight reels by handle. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Instagram username without the leading @. |
userId | string | Optional | Instagram numeric user id (optional, faster than handle). |
List an Instagram account's recent posts (likes, comments, captions) by handle with cursor pagination. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
handle | string | Required | Instagram username without the leading @. |
List an Instagram account's reels by handle with cursor pagination (caption, plays, likes, comments). $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor (max_id) from a previous response's nextCursor. |
handle | string | Optional | Instagram handle. |
userId | string | Optional | Instagram user id (faster than handle when known). |
List an Instagram account's reels by handle as a logged-in Instagram viewer sees them, with cursor pagination: everything instagram.user_reels returns plus saves, reposts, the caption-track URL and, for reels cross-posted to Facebook, the Facebook views, likes and comments. Views, likes and comments are Instagram-only; the Facebook figures are reported separately. $0.00173 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor (max_id) from a previous response's nextCursor. |
handle | string | Optional | Instagram handle. |
userId | string | Optional | Instagram user id (faster than handle when known). |
List the posts a public Instagram account has reposted to its feed, with cursor pagination. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
userId | string | Required | Instagram's numeric account id, as returned by instagram.profile. |
Search Instagram Reels through a web search index rather than Instagram's own search, and get matching reels (caption, likes, comments, creator, and duration). That is what lets it filter by a recency window and page by number, and it is also why the results are whatever the index has crawled rather than what Instagram ranks right now, and why paging tops out around 110 reels per query (11 pages of 10). Instagram does not return view or play counts here. For Instagram's own live reels search, with view counts, use instagram.reels_search. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
datePosted | string | Optional | Recency hint, not a hard filter. Reel discovery runs on top of Google search, so this window narrows Google's index by when it discovered or last crawled the reel, which is not the same as when the reel was published to Instagram. Returned reels can have a createdUtc outside the requested... One of: last-week, last-month, last-year. |
page | integer | Optional | 1-based results page. Default 1. |
query | string | Required | Search keyword (e.g. "crossfit"). |
Search TheirStack's job-post index by company, technology, keyword, title, seniority, salary, location and how recently the post appeared, and get the hiring company's full firmographic record with every post. Billed per job returned. Returns up to 25 results per call (page with cursor/page where offered). $1.68 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyCountryCodeNot | array | Optional | Return companies whose HQ country code is not any of the ones passed here, case sensitive. Pass ISO2 country codes. |
companyCountryCodeOr | array | Optional | Return companies whose HQ country code is any of the ones passed here, case sensitive. Pass ISO2 country codes. |
companyDescriptionPatternAccentInsensitive | boolean | Optional | Set to True to make company description searches accent insensitive. For example, "á" will match "a" as well. |
companyDescriptionPatternNot | array | Optional | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. |
companyDescriptionPatternOr | array | Optional | Case-insensitive patterns to match in the company description. Will return companies that match any of the patterns. |
companyDomainNot | array | Optional | Only return companies that don't match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). |
companyDomainOr | array | Optional | Only return companies that match these domains exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). This filter acts as an OR filter, so if you pass more than one company domain, it will return companies that match any of the domains. Example: ["stripe.com"] |
companyIdOr | array | Optional | Only return companies that match these IDs exactly. This filter acts as an OR filter, so if you pass more than one company ID, it will return companies that match any of the IDs. |
companyInvestorsOr | array | Optional | Investors of the company |
companyInvestorsPartialMatchOr | array | Optional | Investors of the company. Will return companies for which any of their investors contains any of the substrings passed here. For example, if you pass 'andree', all funds that match it (like 'Andreessen Horowitz', 'Andreessen Horowitz LLC', etc). |
companyKeywordSlugAnd | array | Optional | Return results from companies that have mentioned all of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
companyKeywordSlugNot | array | Optional | Return results from companies that haven't mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
companyKeywordSlugOr | array | Optional | Return results from companies that have mentioned any of these keywords in their jobs. Case sensitive. Pass slugs. Check out all the keywords we track at GET /v0/catalog/keywords |
companyLinkedinUrlExists | boolean | Optional | (Use `property_exists_or / property_exists_and` instead) Only return companies with a LinkedIn URL |
companyLinkedinUrlOr | array | Optional | Return companies whose LinkedIn URL matches any of the slugs passed here. Can also pass full LinkedIn company URLs. |
companyListIdNot | array | Optional | Return companies that don't belong to any of the company lists passed here |
companyListIdOr | array | Optional | Return companies that belong to any of the company lists passed here |
companyLocationPatternOr | array | Optional | Return companies whose city matches any of the patterns passed here. Case insensitive. For example, if you pass 'san francisco', it will return companies whose city is 'San Francisco', 'San Francisco Bay Area', etc. |
companyNameCaseInsensitiveOr | array | Optional | Only return companies that match these names exactly, case-insensitively. |
companyNameNot | array | Optional | Only return companies that don't match these names exactly, case-sensitively. |
companyNameOr | array | Optional | Only return companies that match these names exactly, case-sensitively. This filter acts as an OR filter, so if you pass more than one company name, it will return companies that match any of the names. |
companyNamePartialMatchNot | array | Optional | Company names. Will return companies whose name doesn't contain any of the the substrings passed here, case-insensitively. For example, if you pass 'google', it will exclude 'Google', 'Google LLC', 'Google Inc', etc. |
companyNamePartialMatchOr | array | Optional | Company names. Will return companies whose name contain any of the the substrings passed here, case-insensitively. For example, if you pass "google", it will return "Google", "Google LLC", "Google Inc", etc. |
companyTagsOr | array | Optional | Return companies that match any of these keywords |
companyTechnologySlugAnd | array | Optional | Will return jobs from companies that that have mentioned all of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_and instead. |
companyTechnologySlugNot | array | Optional | Will return jobs from companies that that haven't mentioned any of these technologies in their jobs. Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_not instead. |
companyTechnologySlugOr | array | Optional | Will return jobs from companies that that have mentioned any of these technologies in their jobs (not necessarily in the jobs returned). Case sensitive. Pass slugs. Check out all the technologies we track at GET /v0/catalog/technologies. Deprecated: use company_keyword_slug_or instead. |
companyType | string | Optional | Filter by company type. |
discoveredAtGte | string | Optional | Only jobs discovered by TheirStack on this date or datetime or after will be returned. In UTC timezone. |
discoveredAtLte | string | Optional | Only jobs discovered by TheirStack on this date or datetime or before will be returned. In UTC timezone. |
discoveredAtMaxAgeDays | integer | Optional | If 0, only return jobs added to our database in the current day. If 1, from today and yesterday, etc. |
discoveredAtMinAgeDays | integer | Optional | If 1, only return jobs discovered by TheirStack until yesterday. If 2, until 2 days ago, etc. |
easyApply | boolean | Optional | If True, only return jobs that can be applied directly through the job board. If False, only return jobs that require redirecting to the company's website. |
employmentStatusesOr | array | Optional | Filter jobs by employment status. Returns jobs that match any of the specified employment types. If no values are provided or an empty list is sent, all jobs regardless of employment status will be returned. |
finalUrlExists | boolean | Optional | (Use `property_exists_or / property_exists_and` instead) Only return jobs with a final URL. Typically jobs that were originally posted on an ATS. If True, only return jobs with a final URL. If False, only return jobs without a final URL. If None, return all jobs. |
fundingStageOr | array | Optional | Funding stages of companies returned. Possible values: ['angel', 'convertible_note', 'debt_financing', 'equity_crowdfunding', 'other', 'private_equity', 'seed', 'series_a', 'series_b', 'series_c', 'series_d', 'series_e', 'series_f', 'series_g', 'series_h', 'venture_round_not_specified',... |
hiringManagersExists | boolean | Optional | (Use `property_exists_or / property_exists_and` instead) If True, only return jobs with a hiring manager. If False, only return jobs without a hiring manager. If None, return all jobs. |
includeTotalResults | boolean | Optional | When enabled, calculates and returns `total_results` and `total_companies` fields in the response. WARNING: This significantly slows down responses as it requires reading the entire dataset. Recommended usage: enable only for the initial request to get totals, then disable for subsequent... |
industryIdNot | array | Optional | Industry ids to exclude. You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries |
industryIdOr | array | Optional | Industry codes. You can use any of LinkedIn's Industry Codes V2 or GET /v0/catalog/industries |
industryNot | array | Optional | Names of industries, case-insensitive. Results will exclude companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_not field instead. |
industryOr | array | Optional | Names of industries, case-insensitive. Results will only include companies that belong to any of the industries specified in this parameter. Available values: GET /v0/catalog/industries WARNING: Deprecated parameter. Use the industry_id_or field instead. |
jobCountryCodeNot | array | Optional | 2-letter ISO country code of the location of the job. Can pass more than 1. Will exclude jobs from these countries |
jobCountryCodeOr | array | Optional | 2-letter ISO country code of the location of the job. Can pass more than 1 |
jobDescriptionContainsNot | array | Optional | Exclude jobs whose description contains any of these whole words using word boundaries (\b). Case-insensitive by default, except for the patterns that are uppercase - in that case we'll respect it. Only finds complete words (e.g., searching 'quality' won't match 'inequality'). Results will... |
jobDescriptionContainsOr | array | Optional | Search for whole words in job descriptions using word boundaries (\b). Case-insensitive by default, except for the patterns that are uppercase - in that case we'll respect it. Only finds complete words (e.g., searching 'quality' won't match 'inequality'). Results will include jobs whose... |
jobDescriptionPatternAnd | array | Optional | Regex patterns that must ALL match the job description (AND logic). Use (?i) at the start of a pattern to make it case-insensitive. Results will only include jobs whose description matches every pattern in this list. |
jobDescriptionPatternCaseSensitiveOr | array | Optional | Deprecated. Use job_description_pattern_or instead, which now behaves identically. |
jobDescriptionPatternIsCaseInsensitive | boolean | Optional | Deprecated. Has no effect. |
jobDescriptionPatternNot | array | Optional | Regex patterns to look for in job descriptions. Case-sensitive. Results will include jobs whose description don't match any of these patterns. Use (?i) at the start of a pattern to make it case-insensitive. Can pass more than one. |
jobDescriptionPatternOr | array | Optional | Regex patterns to look for in job descriptions. Case-sensitive. Results will include jobs whose description matches any of these patterns. Use (?i) at the start of a pattern to make it case-insensitive. Can pass more than one. |
jobIdNot | array | Optional | Exclude jobs with these IDs. |
jobIdOr | array | Optional | Get jobs with these IDs only. |
jobIds | array | Optional | Get jobs with these IDs only. Deprecated parameter, use job_id_or instead. |
jobKeywordSlugAnd | array | Optional | Will return jobs where all of these keyword slugs appear. Case sensitive. Check out all the keywords we track at GET /v0/catalog/keywords |
jobKeywordSlugNot | array | Optional | Will return jobs where none of these keyword slugs appear. Case sensitive. Check out all the keywords we track at GET /v0/catalog/keywords |
jobKeywordSlugOr | array | Optional | Will return jobs where any of these keyword slugs appear. Case sensitive. Check out all the keywords we track at GET /v0/catalog/keywords |
jobLocationNot | array | Optional | Filter jobs by location. Returns jobs whose locations DO NOT match ANY of the specified location criteria. Each location criteria is specified using a JobLocationFilter object. (You can find location IDs using the locations catalog endpoint) |
jobLocationOr | array | Optional | Filter jobs by location. Returns jobs whose locations match ANY of the specified location criteria. Each location criteria is specified using a JobLocationFilter object. (You can find location IDs using the locations catalog endpoint) |
jobLocationPatternNot | array | Optional | Regex patterns to exclude job locations. Case-insensitive. Searches both the location field and the enhanced locations array (using normalized city and state name fields within each location element). Jobs matching ANY of the provided patterns will be EXCLUDED from results. Use this to filter... |
jobLocationPatternOr | array | Optional | Regex patterns to match job locations. Case-insensitive. Searches both the location field and the enhanced locations array (using normalized city and state name fields within each location element). Jobs matching ANY of the provided patterns will be returned. Use this to find jobs in specific... |
jobSeniorityOr | array | Optional | Will return jobs where the seniority is any of the ones passed here |
jobTechnologySlugAnd | array | Optional | Will return jobs where all of these technologies appear. Case sensitive. Pass slugs. Check out all the technologies we track with the technologies endpoint. |
jobTechnologySlugNot | array | Optional | Will return jobs where none of these technologies appear. Case sensitive. Pass slugs. Check out all the technologies we track with the technologies endpoint. |
jobTechnologySlugOr | array | Optional | Will return jobs where any of these technologies appear. Case sensitive. Pass slugs. Check out all the technologies we track with the technologies endpoint. If you pass more than one technology, we will return jobs that mentnion all of the technologies. |
jobTitleNot | array | Optional | Natural language patterns to match job titles. Case-insensitive. Only jobs with title that do not match any of these patterns will be returned. Uses Postgres full text search. |
jobTitleOr | array | Optional | Natural language patterns to match job titles. Case-insensitive. Only jobs with title that match any of these patterns will be returned. Uses Postgres full text search. |
jobTitlePatternAnd | array | Optional | Regex patterns to match job titles. Case-insensitive. Only jobs with title that match all of these patterns will be returned. |
jobTitlePatternNot | array | Optional | Regex patterns to match job titles. Case-insensitive. Jobs whose job title doesn't match any of the patterns will be returned. |
jobTitlePatternOr | array | Optional | Regex patterns to match job titles. Case-insensitive. Jobs whose job title matches of the filters will be returned. |
lastFundingRoundDateGte | string | Optional | Only return companies whose last funding round date is after or on this date. Format: 'YYYY-MM-DD' |
lastFundingRoundDateLte | string | Optional | Only return companies whose last funding round date is before or on this date. Format: 'YYYY-MM-DD' |
maxEmployeeCount | integer | Optional | Maximum number of employees in a company |
maxEmployeeCountOrNull | integer | Optional | Maximum number of employees in a company. If we don't have company size information, we will return it as well. |
maxFundingUsd | integer | Optional | Maximum company funding, in USD |
maxRevenueUsd | integer | Optional | Maximum company revenue, in USD |
maxSalaryUsd | number | Optional | Maximum annual salary in USD. For example, 150000 means $150,000. |
minEmployeeCount | integer | Optional | Minimum number of employees in a company |
minEmployeeCountOrNull | integer | Optional | Minimum number of employees in a company. If we don't have company size information, we will return it as well. |
minFundingUsd | integer | Optional | Minimum company funding, in USD |
minRevenueUsd | integer | Optional | Minimum company revenue, in USD |
minSalaryUsd | number | Optional | Minimum annual salary in USD. For example, 100000 means $100,000. |
offset | integer | Optional | Number of results to skip. Required for offset-based pagination. |
onlyJobsWithHiringManagers | boolean | Optional | Only return jobs with a hiring manager. If True, only return jobs with a hiring manager. If False, only return jobs without a hiring manager. If None, return all jobs. |
onlyJobsWithReportsTo | boolean | Optional | Only return jobs where we identified the role the hired person would report to. Deprecated field, use reports_to_exists instead. |
onlyYcCompanies | boolean | Optional | Only return YC companies |
orderBy | array | Optional | List of column objects. You can pass several columns to order by, in order of priority. Only `field` is required, `desc` is True by default. |
page | integer | Optional | Page number. Required when using page-based pagination. |
postedAtGte | string | Optional | ISO 8601 date string (yyyy-mm-dd). Only jobs published in this date or after will be returned. |
postedAtLte | string | Optional | ISO 8601 date string (yyyy-mm-dd). Only jobs published in this date or before will be returned. |
postedAtMaxAgeDays | integer | Optional | Date posted max age in days. If 0, only return jobs posted today. If 1, from today and yesterday, etc. |
propertyExistsAnd | array | Optional | |
propertyExistsOr | array | Optional | Return jobs that have any of these fields not null. For example, if you pass ['final_url'], it will return jobs that have a final_url set. This field also support chaining of fields. For example, if you pass ['company_object.domain', 'company_object.linkedin_url'], it will return jobs that have... |
remote | boolean | Optional | True: only show remote jobs. False: only show non-remote jobs. None: show all jobs. |
reportsToExists | boolean | Optional | Only return jobs where we identified the role the hired person would report to. If True, only return jobs where we identified the role the hired person would report to. If False, only return jobs where we didn't identify the role the hired person would report to. If None, return all jobs. |
scraperNamePatternOr | array | Optional | Regex patterns to match job sources. Case-insensitive. |
urlDomainNot | array | Optional | Exclude jobs if their URL domain (from `url` or `source_url`) is in the provided case-insensitive list. For example, ['greenhouse.io', 'workable.com'] will exclude URLs containing 'greenhouse.io' or 'workable.com'. Refer to our list of sources at https://theirstack.com/en/docs/data/job/sources. |
urlDomainOr | array | Optional | Include jobs only if their URL domain (from `url` or `source_url`) is in the provided case-insensitive list. For example, ['greenhouse.io', 'workable.com'] will match URLs containing 'greenhouse.io' or 'workable.com'. Refer to our list of sources at https://theirstack.com/en/docs/data/job/sources. |
Search Levels.fyi job listings by title or keyword and get each job with its salary range and estimated total compensation where Levels.fyi has them, plus company, location, posting date and apply link. Returns up to 20 jobs per call, grouped by company; filter by location and sort by relevance, date or pay. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of jobs to return (1-20, default 20). Levels.fyi groups jobs by company, up to 3 per company, so several results can come from one employer. Default 20. Max 20. |
location | string | Optional | Levels.fyi location slug as it appears in Levels.fyi URLs, e.g. united-states. Not a free-text city name; omit it to search everywhere. |
query | string | Required | Job title, keywords or company name to search, e.g. software engineer or google. |
sortBy | string | Optional | Sort order: best match (relevance), most recently posted (date), or highest total compensation (compensation). One of: relevance, date, compensation. Default "relevance". |
Look up a single LinkedIn Ad Library ad by URL and get the advertiser, headline, creative text, format, CTA, run dates, and impressions as clean JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | LinkedIn Ad Library ad URL (e.g. "https://www.linkedin.com/ad-library/detail/666281156"). |
Search the LinkedIn Ad Library by search URL and list the matching ads (advertiser, creative text, format). Returns up to 10 results per call (page with cursor/page where offered). $0.00621 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | LinkedIn Ad Library search URL or a LinkedIn company URL (e.g. https://www.linkedin.com/ad-library/search?companyIds=1035). |
Search the LinkedIn Ad Library by company or keyword and list matching ads (advertiser, headline, creative text, format, CTA, and run dates) with pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | string | Optional | Company name to search (e.g. "microsoft"). |
companyId | string | Optional | LinkedIn company identifier. |
countries | string | Optional | Comma-separated two-letter country codes (e.g. "US,CA,MX"). |
cursor | string | Optional | Opaque pagination cursor from a previous response's `nextCursor`; omit for the first page. |
endDate | string | Optional | Search end date in YYYY-MM-DD format. Today or a later date is moved back to yesterday in UTC when your range overlaps LinkedIn's accepted dates. When you send startDate without endDate, the search ends yesterday in UTC, the latest day LinkedIn accepts. |
keyword | string | Optional | Keyword term for the ad search. |
paginationToken | string | Optional | Legacy pagination alias. Prefer `cursor`; omit both fields for the first page. |
startDate | string | Optional | Search start date in YYYY-MM-DD format. An earlier date is moved up to one year ago in UTC when your range overlaps LinkedIn's accepted dates. |
Read a public LinkedIn article or newsletter issue by URL, including its full body text, author, publication time, and engagement counts. $0.00565 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Public LinkedIn article or newsletter issue URL, e.g. https://www.linkedin.com/pulse/your-article-slug. Pair it with the attachmentUrl returned by linkedin.search_posts_full to read the article behind a post. |
List who reacted to a comment on a LinkedIn post - reactor name, profile URL, job title, and reaction type, 100 per page. $0.0026 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | Which page of up to 100 reactions to return, starting at 1 (default 1). Each page is billed as one request; totalPages in the response says how many there are. Default 1. |
url | string | Required | LinkedIn comment URL, as returned in the url field of linkedin.post_comments or copied with "Copy link to comment" (a /feed/update/... link carrying commentUrn and dashCommentUrn). A post URL without dashCommentUrn, or a reply's URL (carrying replyUrn), is refused as invalid input, with no charge. |
List up to the 10 newest replies to a comment on a LinkedIn post - reply text, replier name/URL/job title, timestamps, and likes. $0.0026 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | LinkedIn comment URL, as returned in the url field of linkedin.post_comments or copied with "Copy link to comment" (a /feed/update/... link carrying commentUrn and dashCommentUrn). A reply's URL returns the thread it belongs to. A post URL without dashCommentUrn is refused as invalid input, with... |
Fetch a full LinkedIn company page by URL: name, description, industry, employee count and range, follower count, founded year, headquarters and office locations, funding data, tagline, logo, website, and specialities. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full LinkedIn company page URL. |
List the employees of a LinkedIn company by name or company URL, with optional job-title filtering. $0.006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | string | Required | Company name or LinkedIn company URL (e.g. google or https://www.linkedin.com/company/google/). |
jobTitle | string | Optional | Optional job-title filter supporting boolean operators (e.g. CEO OR CTO). |
limit | integer | Optional | Maximum number of results to return (1-10, default 10). Max 10. |
List a LinkedIn company page's recent posts by URL: full text, canonical link, publish date, author, engagement counts with a per-reaction breakdown, and attached media. $0.0029 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeQuotePosts | boolean | Optional | Include quote posts (posts shared with an added comment). Defaults to true; set false to exclude them. |
includeReposts | boolean | Optional | Include reposts (posts shared without an added comment). Defaults to true; set false to exclude them. |
limit | integer | Optional | Maximum number of posts to return. Default 10. Max 50. |
postedLimit | string | Optional | Only return posts published within this window (default any). One of: any, 1h, 24h, week, month, 3months, 6months, year. |
url | string | Required | Full LinkedIn company page URL. |
Post text and link only. No engagement counts, author details, media, or reaction breakdown - for those use linkedin.company_posts. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | Page number for pagination. |
url | string | Required | Full LinkedIn company page URL. |
Basic company: name, description, employee count, industry, logo, website, tagline. No follower count, founded year, office locations, or funding data - for those use linkedin.company. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full LinkedIn company page URL. |
Find the deliverability-validated work email behind a LinkedIn profile URL or public ID. Returns each discovered email with its deliverability, validation status, and quality score, plus the person's name and headline. $0.011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
profileUrl | string | Required | LinkedIn profile URL or public identifier (the last part of the URL) to find the deliverability-validated work email for. |
Fetch one LinkedIn group by URL or id: name, description, rules, member count, logo and cover image, creation date, visibility and join settings, and its admins. $0.0013 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
groupId | string | Optional | Numeric LinkedIn group id (e.g. 1898033), the number in the group URL. Send this or url. |
url | string | Optional | LinkedIn group URL (e.g. https://www.linkedin.com/groups/1898033). Send this or groupId. |
List the posts in a LinkedIn group by group URL, newest first: full text, canonical link, publish date, author, engagement counts with a per-reaction breakdown, and attached media. One call returns a page of about 100 posts; pass page to go further back. $0.0026 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | Which page of about 100 posts to return, starting at 1 (default 1). Page 2 continues where page 1 ended, going further back in time. Each page is billed as one request. Default 1. |
postedLimit | string | Optional | Only return posts published within this window (default any). The window is applied to the page, so a page can come back with fewer posts or none. One of: any, 1h, 24h, week, month, 3months, 6months, year. |
url | string | Required | Full LinkedIn group URL (e.g. https://www.linkedin.com/groups/1898033). |
Fetch one LinkedIn job posting by URL: title, full description, location, salary when disclosed, applicant count, employment and workplace type, seniority, benefits, industries, apply links, posting and expiry dates, the hiring team, the applicant tracking system behind it, and the hiring company with its size, follower count, website and description. $0.0015 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full LinkedIn job posting URL, e.g. https://www.linkedin.com/jobs/view/4431721875/. |
Search LinkedIn job listings by title and location - full records with description, salary, applicant count, seniority, company details, and benefits. Up to 25 jobs per request. $0.0195 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | string | Optional | Filter to a specific company by name (e.g. Google). |
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of job listings. |
easyApply | boolean | Optional | When true, only return jobs offering LinkedIn Easy Apply. |
employmentType | string | Optional | Filter by employment type. One of: full-time, part-time, contract, internship, temporary. |
experienceLevel | string | Optional | Filter by required seniority/experience level. One of: internship, entry, associate, mid-senior, director, executive. |
limit | integer | Optional | Accepted for compatibility and ignored: each call returns one full page of up to 25 jobs at one flat price per call; follow nextCursor for more. Max 25. |
location | string | Optional | City, region, or country to search within (e.g. United States, San Francisco). |
postedLimit | string | Optional | Only jobs posted within this window (past hour, 24 hours, week, or month). One of: 1h, 24h, week, month. |
query | string | Required | Job title or keywords to search. Supports LinkedIn boolean operators. |
salary | string | Optional | Filter by minimum base salary band (US dollars). One of: 40k+, 60k+, 80k+, 100k+, 120k+, 140k+, 160k+, 180k+, 200k+. |
sortBy | string | Optional | Sort order: most recent (date) or best match (relevance). One of: date, relevance. |
under10Applicants | boolean | Optional | When true, only return jobs with fewer than 10 applicants (lower competition). |
workplaceType | string | Optional | Filter by workplace type (remote, hybrid, or onsite). One of: remote, hybrid, onsite. |
Cheap job index: title, company, location, posted date, URL. No description, salary, applicant counts, or seniority - for those use linkedin.jobs. $0.00059 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Filter to a specific company by its LinkedIn numeric company id. |
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of job listings. |
employmentType | string | Optional | Filter by employment type. One of: full-time, part-time, contract, internship, temporary. |
experienceLevel | string | Optional | Filter by required seniority/experience level. One of: internship, entry, associate, mid-senior, director, executive. |
geoId | string | Optional | LinkedIn geo id to target a precise location (e.g. 103644278 for the United States); more exact than the free-text location. |
limit | integer | Optional | Accepted for compatibility and ignored: each call returns one full source page (10 or 25 jobs depending on source); follow nextCursor for more. Max 25. |
location | string | Optional | City, region, or country to search within. |
postedLimit | string | Optional | Only jobs posted within this window (past 24 hours, week, or month). One of: 24h, week, month. |
query | string | Required | Job title or keywords to search. |
workplaceType | string | Optional | Filter by workplace type (remote, hybrid, or onsite). One of: remote, hybrid, onsite. |
Fetch a single LinkedIn post or article by URL (title, text, author, like and comment counts, publish date). $0.00064 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full LinkedIn post or article URL. |
List comments on a LinkedIn post - full text, commenter name/URL/job title, timestamps, and engagement. $0.0029 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of comments to return. Default 100. Max 100. |
postedLimit | string | Optional | Only return comments posted within this window (default any). One of: any, 24h, week, month, 3months, 6months, year. |
url | string | Required | Full URL of the LinkedIn post to list comments for. |
List who reacted to a LinkedIn post - reactor name, profile URL, job title, and reaction type. Lead-gen grade. $0.0029 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of reactions to return (1-100, default 100). Max 100. |
url | string | Required | URL of the LinkedIn post to list reactions for (a /posts/...-activity-... or /feed/update/urn:li:activity:... link). |
Get the spoken transcript of a LinkedIn video post by URL. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | The full URL of the LinkedIn post to get the video transcript from. |
Fetch a rich LinkedIn member profile by URL: name, headline, avatar, location, connections and followers, current position, and full work experience with job titles, descriptions, dates, employment/workplace type, and per-role skills, plus education, skills, certifications, honors and awards, languages, projects, publications, and verified/premium/open-to-work flags. $0.0029 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full LinkedIn profile URL. |
List the comments a LinkedIn member has left on other people's posts - the comment text, its permalink and timestamp, plus the post it was left on and that post's author and engagement. $0.0029 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of comments to return. Default 100. Max 100. |
postedLimit | string | Optional | Only return comments posted within this window (default any). One of: any, 24h, week, month. |
url | string | Required | Full URL of the LinkedIn member profile whose comments on other people's posts should be listed. |
Fetch recent public LinkedIn profile posts with enriched author, engagement, article, newsletter, media, annotation, repost, and social activity details. $0.005 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
contextCountry | string | Optional | Regional LinkedIn context used when retrieving posts. One of: any, US, GB, DE, FR. |
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
includeQuotePosts | boolean | Optional | Whether to include quote posts that add commentary to shared content. Default true. |
includeReposts | boolean | Optional | Whether to include reposts that share content without added commentary. Default true. |
limit | integer | Optional | Most posts to return (1-100, default 10). Ignored on sources that page: each call returns one full page of 50 posts; follow nextCursor for more. Sources that cannot page return up to `limit` posts in one call with no nextCursor. Default 10. Max 100. |
postedLimit | string | Optional | Only return posts published within this relative time window. One of: any, 1h, 24h, week, month, 3months, 6months, year. |
postedLimitDate | string | Optional | Only return posts published on or after this date or timestamp, using a JavaScript-compatible date-time string. |
url | string | Required | Full URL of the public LinkedIn profile whose posts should be returned. |
Fetch recent public LinkedIn profile posts with portable identity, author, engagement, article, image, video, and repost fields. $0.005 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
limit | integer | Optional | Most posts to return (10-100, default 10). Ignored on sources that page: each call returns one full page of 50 posts; follow nextCursor for more. Sources that cannot page return up to `limit` posts in one call with no nextCursor. Default 10. Max 100. |
url | string | Required | Full URL of the public LinkedIn profile whose posts should be returned. |
List the posts a LinkedIn member has reacted to - the reaction, its timestamp, and the full post it was made on with author and engagement. $0.0029 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of reactions to return. One upstream page holds 100. Default 100. Max 100. |
url | string | Required | Full URL of the LinkedIn member profile whose reactions to list, for example https://www.linkedin.com/in/williamhgates. |
Lightweight profile: name, avatar, location, followers, public id, current company, and a basic experience/education list (company + dates; job titles, the current-role flag and the connections label only where the source and the profile show them; no descriptions or skills; past companies may be redacted). For full experience detail, skills, certifications, and verified flags use linkedin.profile. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full LinkedIn person profile URL, carrying the profile id after /in/, for example https://www.linkedin.com/in/williamhgates. Any other LinkedIn URL names no person, so it is rejected instead of charged: send a company page to linkedin.company_thin or linkedin.company, and a post to linkedin.post. |
Search LinkedIn companies by keyword with optional location filtering, returning normalized company records. $0.005 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Default 20. Max 20. |
location | string | Optional | Optional location filter, written out in full (e.g. United Kingdom or San Francisco). |
query | string | Required | Keyword to search LinkedIn companies for (e.g. marketing agency). |
Search LinkedIn groups by keyword, 10 per page: group name, URL, member count, summary, and logo. $0.0013 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | Which page of up to 10 groups to return, starting at 1 (1-100, default 1). Each page is billed as one request. Default 1. Max 100. |
query | string | Required | Keyword to search LinkedIn groups for (e.g. python or sales). |
LinkedIn lead search with Sales Navigator's search and filters: one call returns a page of up to 25 people matching a keyword and Sales Navigator lead filters (location, job title, current and past company, school, seniority, function, company size, and more), or the results of a Sales Navigator lead-search URL you built yourself. Each lead comes with name, current positions, location, summary, and photo, and its url opens the profile and can be passed to linkedin.profile for the full record. For full profiles in one call use linkedin.search_profiles. $0.07 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyHeadcount | array | Optional | Filter by current company size (employee count). Codes: A=Self-Employed, B=1-10, C=11-50, D=51-200, E=201-500, F=501-1,000, G=1,001-5,000, H=5,001-10,000, I=10,001+. One of: A, B, C, D, E, F, G, H, I. |
companyHeadquarterLocations | array | Optional | Filter by the location of the person's current company headquarters, by place name (e.g. ['United States']). Commas are not allowed in a value. Up to 70 values. Max 70 items. |
currentCompanies | array | Optional | Filter to people who currently work at any of these companies, by name (e.g. ['Google','Meta']). Multiple names widen the match (OR). Commas are not allowed in a value. Up to 50 values. Max 50 items. Example: ["Google"] |
excludeCompanyHeadquarterLocations | array | Optional | Exclude people whose current company is headquartered in any of these locations. Commas are not allowed in a value. Up to 70 values. Max 70 items. |
excludeCurrentCompanies | array | Optional | Exclude people who currently work at any of these companies, by name. Commas are not allowed in a value. Up to 50 values. Max 50 items. |
excludeCurrentJobTitles | array | Optional | Exclude people whose current job title matches any of these. Commas are not allowed in a value. Up to 70 values. Max 70 items. |
excludeFunctionIds | array | Optional | Exclude these job functions (same codes as functionIds). Up to 30 values. Max 30 items. |
excludeLocations | array | Optional | Exclude people in any of these locations, by place name. Commas are not allowed in a value. Up to 70 values. Max 70 items. |
excludePastCompanies | array | Optional | Exclude people who previously worked at any of these companies, by name. Commas are not allowed in a value. Up to 50 values. Max 50 items. |
excludePastJobTitles | array | Optional | Exclude people who held any of these past job titles. Commas are not allowed in a value. Up to 70 values. Max 70 items. |
excludeSchools | array | Optional | Exclude people who attended any of these schools, by name. Commas are not allowed in a value. Up to 50 values. Max 50 items. |
excludeSeniorityLevelIds | array | Optional | Exclude these seniority levels (same codes as seniorityLevelIds). Up to 20 values. One of: 100, 110, 120, 130, 200, 210, 220, 300, 310, 320. Max 20 items. |
firstNames | array | Optional | Filter to people whose first name matches any of these. Commas are not allowed in a value. Up to 70 values. Max 70 items. |
functionIds | array | Optional | Filter by job function. Codes: 1=Accounting, 2=Administrative, 3=Arts and Design, 4=Business Development, 5=Community and Social Services, 6=Consulting, 7=Education, 8=Engineering, 9=Entrepreneurship, 10=Finance, 11=Healthcare Services, 12=Human Resources, 13=Information Technology, 14=Legal,... |
jobTitle | string | Optional | Optional current job title filter (e.g. 'Software Engineer'). Commas are not allowed in a value. |
lastNames | array | Optional | Filter to people whose last name matches any of these. Commas are not allowed in a value. Up to 70 values. Max 70 items. |
location | string | Optional | Optional location filter (e.g. 'San Francisco'). Commas are not allowed in a value. |
page | integer | Optional | Which page of up to 25 leads to return, starting at 1 (1-100, default 1). Also pages through a salesNavUrl search. Each page is billed as one request. Default 1. Max 100. |
pastCompanies | array | Optional | Filter to people who previously worked at any of these companies, by name. Commas are not allowed in a value. Up to 50 values. Max 50 items. |
pastJobTitles | array | Optional | Filter by a past job title the person held (e.g. ['Product Manager']). Commas are not allowed in a value. Up to 70 values. Max 70 items. |
profileLanguages | array | Optional | Filter by the profile's primary language. |
query | string | Optional | Search keywords for LinkedIn leads: a role, name, or keywords (e.g. 'Marketing Manager'). Provide this or salesNavUrl. |
recentlyChangedJobs | boolean | Optional | When true, only return people who recently changed jobs (a strong sales/recruiting signal). |
recentlyPostedOnLinkedIn | boolean | Optional | When true, only return people who recently posted on LinkedIn (an activity signal). |
salesNavUrl | string | Optional | Alternatively, a LinkedIn Sales Navigator lead-search URL you built in Sales Navigator (e.g. https://www.linkedin.com/sales/search/people?query=(keywords%3Aengineer)). When set it overrides query and every other filter on this request; only page still applies. |
schools | array | Optional | Filter to people who attended any of these schools, by name. Commas are not allowed in a value. Up to 50 values. Max 50 items. |
seniorityLevelIds | array | Optional | Filter by seniority level. Codes: 100=In Training, 110=Entry Level, 120=Senior, 130=Strategic, 200=Entry Level Manager, 210=Experienced Manager, 220=Director, 300=Vice President, 310=CXO, 320=Owner/Partner. One of: 100, 110, 120, 130, 200, 210, 220, 300, 310, 320. |
yearsAtCurrentCompanyIds | array | Optional | Filter by tenure at the current company. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. One of: 1, 2, 3, 4, 5. |
yearsOfExperienceIds | array | Optional | Filter by total years of experience. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. One of: 1, 2, 3, 4, 5. |
Search public LinkedIn posts by keyword (text, link, publish date). Results come from search-engine matches over public LinkedIn posts and work best with English keywords. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
datePosted | string | Optional | Filter by recency. One of last-hour, last-day, last-week, last-month, last-year. One of: last-hour, last-day, last-week, last-month, last-year. |
query | string | Required | The post search query. |
requireCursor | boolean | Optional | Deprecated. Every source for this search returns a nextCursor, so this changes nothing about the price or which source serves you; it stays accepted so callers that already send it keep working. |
Search public LinkedIn posts with rich author, engagement, attachment, and poll details. $0.004 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
authorCompanyNames | array | Optional | Only return posts by people associated with these company names. Max 20 items. |
authorIndustryIds | array | Optional | Only return posts by authors associated with these LinkedIn industry IDs. Max 20 items. |
authorKeywords | string | Optional | Only return posts whose author profile headline or job title contains at least one of these keywords. |
authorUrls | array | Optional | Only return posts authored by these LinkedIn profile or company URLs. Max 10 items. |
contentType | string | Optional | Only return posts carrying this content type. One of: all, videos, images, jobs, live-videos, documents, collaborative-articles. |
datePosted | string | Optional | Only return posts published within this relative time window. Last-hour and windows beyond one month route to the provider that supports them. One of: last-hour, last-day, last-week, last-month, last-three-months, last-six-months, last-year. Default "last-day". |
limit | integer | Optional | Maximum number of posts to return (1-100, default 10). The upper bound is one LinkedIn search page. Default 10. Max 100. |
mentioningMemberUrls | array | Optional | Only return posts mentioning these LinkedIn member profile URLs. Max 10 items. |
query | string | Required | LinkedIn post search query, including quoted terms or Boolean operators accepted by LinkedIn search. |
sort | string | Optional | Order results by search relevance or publication date. One of: relevance, date. Default "relevance". |
Search LinkedIn profiles by keyword with optional location and job-title filters. Each match returns a full profile record: name, headline, location, current position, work experience, education, and skills, plus the profile URL, handle, and id. For a cheaper name/headline/URL-only search use linkedin.search_profiles_thin; add emails with linkedin.search_profiles_email. Returns up to 10 results per call (page with cursor/page where offered). $0.132 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyHeadcount | array | Optional | Filter by current company size (employee count). Codes: A=Self-Employed, B=1-10, C=11-50, D=51-200, E=201-500, F=501-1,000, G=1,001-5,000, H=5,001-10,000, I=10,001+. One of: A, B, C, D, E, F, G, H, I. |
companyHeadquarterLocations | array | Optional | Filter by the location of the person's current company headquarters, by place name (e.g. ['United States']). |
currentCompanies | array | Optional | Filter to people who currently work at any of these companies, by name (e.g. ['Google','Meta']). Multiple names widen the match (OR). Example: ["Google"] |
excludeCompanyHeadquarterLocations | array | Optional | Exclude people whose current company is headquartered in any of these locations. |
excludeCurrentCompanies | array | Optional | Exclude people who currently work at any of these companies, by name. |
excludeCurrentJobTitles | array | Optional | Exclude people whose current job title matches any of these. |
excludeFunctionIds | array | Optional | Exclude these job functions (same codes as functionIds). |
excludeLocations | array | Optional | Exclude people in any of these locations, by place name. |
excludePastCompanies | array | Optional | Exclude people who previously worked at any of these companies, by name. |
excludePastJobTitles | array | Optional | Exclude people who held any of these past job titles. |
excludeSchools | array | Optional | Exclude people who attended any of these schools, by name. |
excludeSeniorityLevelIds | array | Optional | Exclude these seniority levels (same codes as seniorityLevelIds). One of: 100, 110, 120, 130, 200, 210, 220, 300, 310, 320. |
firstNames | array | Optional | Filter to people whose first name matches any of these. |
functionIds | array | Optional | Filter by job function. Codes: 1=Accounting, 2=Administrative, 3=Arts and Design, 4=Business Development, 5=Community and Social Services, 6=Consulting, 7=Education, 8=Engineering, 9=Entrepreneurship, 10=Finance, 11=Healthcare Services, 12=Human Resources, 13=Information Technology, 14=Legal,... |
jobTitle | string | Optional | Optional current job title filter (e.g. 'Software Engineer'). |
lastNames | array | Optional | Filter to people whose last name matches any of these. |
location | string | Optional | Optional location filter (e.g. 'San Francisco'). |
pastCompanies | array | Optional | Filter to people who previously worked at any of these companies, by name. |
pastJobTitles | array | Optional | Filter by a past job title the person held (e.g. ['Product Manager']). |
profileLanguages | array | Optional | Filter by the profile's primary language. |
query | string | Required | Search query for LinkedIn profiles: a role, name, or keywords (e.g. 'Marketing Manager'). |
recentlyChangedJobs | boolean | Optional | When true, only return people who recently changed jobs (a strong sales/recruiting signal). |
recentlyPostedOnLinkedIn | boolean | Optional | When true, only return people who recently posted on LinkedIn (an activity signal). |
schools | array | Optional | Filter to people who attended any of these schools, by name. |
seniorityLevelIds | array | Optional | Filter by seniority level. Codes: 100=In Training, 110=Entry Level, 120=Senior, 130=Strategic, 200=Entry Level Manager, 210=Experienced Manager, 220=Director, 300=Vice President, 310=CXO, 320=Owner/Partner. One of: 100, 110, 120, 130, 200, 210, 220, 300, 310, 320. |
yearsAtCurrentCompanyIds | array | Optional | Filter by tenure at the current company. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. One of: 1, 2, 3, 4, 5. |
yearsOfExperienceIds | array | Optional | Filter by total years of experience. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. One of: 1, 2, 3, 4, 5. |
People search returning a full profile AND a verified work email for each hit. Search LinkedIn profiles by keyword with optional location and job-title filters; each match returns the full profile record (name, headline, location, current position, work experience, education, and skills, plus the profile URL, handle, and id) together with an emails array carrying the discovered work email and its deliverability. Email discovery is best effort and needs the profile to expose a resolvable company domain, so on a broad search many matches return an empty emails array while still billing the email rate. If you already have names and company domains, email.find, email_finding.icypeas, and email_finding.dropleads resolve addresses directly for less, and linkedin.email enriches a single known profile URL. For a full profile without email use linkedin.search_profiles; for a cheaper name/headline/URL-only search use linkedin.search_profiles_thin. Returns up to 10 results per call (page with cursor/page where offered). $0.187 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyHeadcount | array | Optional | Filter by current company size (employee count). Codes: A=Self-Employed, B=1-10, C=11-50, D=51-200, E=201-500, F=501-1,000, G=1,001-5,000, H=5,001-10,000, I=10,001+. One of: A, B, C, D, E, F, G, H, I. Example: ["B"] |
companyHeadquarterLocations | array | Optional | Filter by the location of the person's current company headquarters, by place name (e.g. ['United States']). |
currentCompanies | array | Optional | Filter to people who currently work at any of these companies, by name (e.g. ['Google','Meta']). Multiple names widen the match (OR). |
excludeCompanyHeadquarterLocations | array | Optional | Exclude people whose current company is headquartered in any of these locations. |
excludeCurrentCompanies | array | Optional | Exclude people who currently work at any of these companies, by name. |
excludeCurrentJobTitles | array | Optional | Exclude people whose current job title matches any of these. |
excludeFunctionIds | array | Optional | Exclude these job functions (same codes as functionIds). |
excludeLocations | array | Optional | Exclude people in any of these locations, by place name. |
excludePastCompanies | array | Optional | Exclude people who previously worked at any of these companies, by name. |
excludePastJobTitles | array | Optional | Exclude people who held any of these past job titles. |
excludeSchools | array | Optional | Exclude people who attended any of these schools, by name. |
excludeSeniorityLevelIds | array | Optional | Exclude these seniority levels (same codes as seniorityLevelIds). One of: 100, 110, 120, 130, 200, 210, 220, 300, 310, 320. |
firstNames | array | Optional | Filter to people whose first name matches any of these. |
functionIds | array | Optional | Filter by job function. Codes: 1=Accounting, 2=Administrative, 3=Arts and Design, 4=Business Development, 5=Community and Social Services, 6=Consulting, 7=Education, 8=Engineering, 9=Entrepreneurship, 10=Finance, 11=Healthcare Services, 12=Human Resources, 13=Information Technology, 14=Legal,... |
jobTitle | string | Optional | Optional current job title filter (e.g. 'Software Engineer'). |
lastNames | array | Optional | Filter to people whose last name matches any of these. |
location | string | Optional | Optional location filter (e.g. 'San Francisco'). |
pastCompanies | array | Optional | Filter to people who previously worked at any of these companies, by name. |
pastJobTitles | array | Optional | Filter by a past job title the person held (e.g. ['Product Manager']). |
profileLanguages | array | Optional | Filter by the profile's primary language. |
query | string | Required | Search query for LinkedIn profiles: a role, name, or keywords (e.g. 'Marketing Manager'). |
recentlyChangedJobs | boolean | Optional | When true, only return people who recently changed jobs (a strong sales/recruiting signal). |
recentlyPostedOnLinkedIn | boolean | Optional | When true, only return people who recently posted on LinkedIn (an activity signal). |
schools | array | Optional | Filter to people who attended any of these schools, by name. |
seniorityLevelIds | array | Optional | Filter by seniority level. Codes: 100=In Training, 110=Entry Level, 120=Senior, 130=Strategic, 200=Entry Level Manager, 210=Experienced Manager, 220=Director, 300=Vice President, 310=CXO, 320=Owner/Partner. One of: 100, 110, 120, 130, 200, 210, 220, 300, 310, 320. |
yearsAtCurrentCompanyIds | array | Optional | Filter by tenure at the current company. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. One of: 1, 2, 3, 4, 5. |
yearsOfExperienceIds | array | Optional | Filter by total years of experience. Codes: 1=Less than 1 year, 2=1 to 2 years, 3=3 to 5 years, 4=6 to 10 years, 5=More than 10 years. One of: 1, 2, 3, 4, 5. |
Cheap people search: name/handle, headline, VANITY profile URL, location. No full profile or email - for full profiles per hit use linkedin.search_profiles, add emails with linkedin.search_profiles_email. $0.032 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
currentCompanyId | string | Optional | Filter by current employer, using a numeric LinkedIn company id. Comma-separate for several. |
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; a page holds 10 profiles. |
firstName | string | Optional | Filter by first name (e.g. Jane). |
followerOfUrn | string | Optional | Return only people who follow this member, given the member's LinkedIn URN. |
industryId | string | Optional | Filter by industry, using a LinkedIn industry id. |
lastName | string | Optional | Filter by last name (e.g. Okafor). |
locationId | string | Optional | Filter by location, using a LinkedIn geocode id. |
pastCompanyId | string | Optional | Filter by a previous employer, using a numeric LinkedIn company id. |
profileLanguage | string | Optional | Filter by the language the profile is written in (ISO 2-letter code, e.g. en). |
query | string | Required | Search query for LinkedIn profiles - a role, name, or keywords (e.g. 'Marketing Manager'). |
schoolId | string | Optional | Filter by school, using a LinkedIn school id. |
serviceCategoryId | string | Optional | Filter by service category, using a numeric service-category id. |
title | string | Optional | Filter by job title or headline (e.g. Head of Talent). |
Find freelancers and service providers on LinkedIn by the service they offer (e.g. 'Web Development'), optionally in a location. One call returns a page of up to 10 people, each with name, headline, location, about text, photo, profile URL, service page URL, and the list of services they offer. The profile URL can be passed to linkedin.profile for the full record. $0.0026 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
geoId | string | Optional | LinkedIn geo id to target a precise location (e.g. 103644278 for the United States); more exact than the free-text location, and overrides it when both are sent. |
location | string | Optional | Optional location filter as a place name (e.g. 'Australia', 'New York'). LinkedIn picks its closest location match, so a short or ambiguous name can land elsewhere; use geoId for an exact place. |
page | integer | Optional | Which page of up to 10 people to return, starting at 1 (1-100, default 1). Each page is billed as one request. Default 1. Max 100. |
query | string | Required | The service to search for, as keywords (e.g. 'Web Development', 'Accounting', 'Photography'). |
Get a public Linktree page by URL: title, bio, picture, contact email, linked social accounts, and every link card with its destination. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | The Linktree profile URL, e.g. https://linktr.ee/mkbhd. |
Search Google Maps for businesses and enrich each result with contact details (emails, phones, and social profiles from their websites), up to 20 records per request. $0.00325 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categoryFilterWords | array | Optional | Optional list of Google Maps place-category names to keep; results are limited to places whose category matches one of these. Use lowercase category names as shown on Google Maps (e.g. ["dentist", "orthodontist"]). Omit to include all categories. |
language | string | Optional | Two-letter language code for the results (e.g. en). Default "en". |
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Max 20. |
location | string | Required | Free-text location to search in, ideally city plus country (e.g. Denver, USA). |
placeMinimumStars | string | Optional | Only return places with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit for no rating filter. One of: two, twoAndHalf, three, threeAndHalf, four, fourAndHalf. |
query | string | Required | What you would type in the Google Maps search bar (e.g. dentist). |
website | string | Optional | Filter places by whether they list a website: allPlaces (default), withWebsite (only places that have a website), or withoutWebsite (only places without one). Contact enrichment pulls emails and social profiles from a place's website, so withWebsite targets leads that can be enriched. One of: allPlaces, withWebsite, withoutWebsite. |
Look up a place on Google Maps by name or search query (optionally scoped to a location) and get the best-matching place with available address, contact, rating, and coordinate details as normalized JSON. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categoryFilterWords | array | Optional | Optional list of Google Maps place-category names to keep; the match is limited to a place whose category is one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop"]). Omit to allow any category and stay on the cheapest price; a category filter routes to a dearer... |
language | string | Optional | Two-letter language code for the result details (e.g. en). Default "en". |
location | string | Optional | Optional free-text location to scope the search, ideally city plus state or country (e.g. San Francisco, CA). Narrows the query to the best match in that area. |
placeMinimumStars | string | Optional | Only match a place with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit this field to stay on the cheapest price; a rating floor routes to a dearer source. One of: two, twoAndHalf, three, threeAndHalf, four, fourAndHalf. |
query | string | Required | The business name or search text to look up, as you would type it into the Google Maps search bar (e.g. Blue Bottle Coffee). |
website | string | Optional | Filter by whether the place lists a website: allPlaces (default), withWebsite (only if it has a website), or withoutWebsite (only if it has none). Omit this field, or send allPlaces, to stay on the cheapest price; withWebsite and withoutWebsite route to a dearer source. One of: allPlaces, withWebsite, withoutWebsite. |
Fetch up to 100 Google Maps reviews for a place by place ID, sorted the way you need, in one normalized response. Returns up to 10 results per call (page with cursor/page where offered). $0.00035 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Two-letter language code for the review details (e.g. en). Default "en". |
placeId | string | Required | The Google Maps place ID to fetch reviews for (e.g. ChIJj61dQgK6j4AR4GeTYWZsKWw). |
postedLimit | string | Optional | Only return reviews posted within this window: 24h (past 24 hours), week (past 7 days), month (past month), or year (past year). Omit for no recency filter. One of: 24h, week, month, year. |
reviewsFilterString | string | Optional | Only return reviews that Google's review search matches for this keyword or phrase. It matches whole words, case-insensitive, so mail does not match email. Omit to return all reviews (e.g. parking). |
sort | string | Optional | Order in which reviews are returned (e.g. newest). One of: newest, mostRelevant, highestRanking, lowestRanking. Default "newest". |
Search Google Maps for places matching a query and location: up to 20 normalized place records with ratings, addresses, and contact basics per request. $0.00148 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categoryFilterWords | array | Optional | Optional list of Google Maps place-category names to keep; results are limited to places whose category matches one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop", "restaurant"]). Omit to include all categories and stay on the cheapest price; a category... |
language | string | Optional | Two-letter language code for the results (e.g. en). Default "en". |
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Pricing depends on the selected provider and may be flat per request. Max 20. |
location | string | Required | Free-text location to search in, ideally city plus country (e.g. Austin, USA). |
placeMinimumStars | string | Optional | Only return places with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit this field to stay on the cheapest price; a rating floor routes to a dearer source. One of: two, twoAndHalf, three, threeAndHalf, four, fourAndHalf. |
query | string | Required | What you would type in the Google Maps search bar (e.g. coffee shop). |
website | string | Optional | Filter places by whether they list a website: allPlaces (default), withWebsite (only places that have a website), or withoutWebsite (only places without one). Omit this field, or send allPlaces, to stay on the cheapest price; withWebsite and withoutWebsite route to a dearer source. One of: allPlaces, withWebsite, withoutWebsite. |
Search Google Maps around an exact latitude and longitude and get up to 20 normalized places per call, each with the address broken into street, city, state, postal code and country. Use this when you have coordinates and want the map viewport centred on them; use maps.search when you only have a place name. Pass the returned nextCursor back as cursor for the next 20 places. $0.0013 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
coordinates | object | Required | The exact map centre to search around. Use maps.search instead if you only have a place name. Example: {"latitude": 30.2672, "longitude": -97.7431} |
cursor | string | Optional | Opaque cursor from a previous response's nextCursor. Pass it back to get the next page of places. |
language | string | Optional | Two-letter language code for the results (e.g. en). Default "en". |
limit | integer | Optional | Accepted but does not change the page: every call returns one full Google Maps viewport of about 20 places, never trimmed, so nextCursor continues exactly where this response ended. Price is flat per request. Default 20. Max 20. |
query | string | Required | What you would type in the Google Maps search bar (e.g. coffee shop). |
zoom | number | Optional | Google Maps viewport zoom. Lower covers a wider area, higher focuses more tightly around the coordinates. Default 13.1. Max 21. |
Get one Mercari US or Japan listing by item id or URL: title, description, price, original price, status, condition, brand, category, size, photos, shipping terms (who pays, method, ships-from region, handling days), whether offers are accepted, likes, seller name, rating, listing count and join date, when it was listed, and for a sold US item when it sold. For a sold item the price is the final sale price after any accepted offer. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Mercari marketplace of the item id: us (USD) or jp (JPY). Ids are not shared between countries. One of: us, jp. Default "us". |
itemId | string | Required | Mercari item id or full listing URL (e.g. m73121443159 or https://www.mercari.com/us/item/m73121443159/). A jp.mercari.com URL is looked up in Japan whatever country says. Every mercari.search and mercari.sold_listings row carries its itemId. |
Search active Mercari US or Japan listings for sale by keyword with optional price-range, condition, category, brand, and sort filters, page by page, with the total result count (price, original price, condition, brand, category path, size, seller, image; who pays shipping in Japan). The price excludes buyer fees, and whether shipping is included depends on the listing's shipping terms. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
brandId | string | Optional | Mercari brand id, or several separated by commas; the US and Japan use separate ids (e.g. 319 for Apple in the US). Every US row carries its brandId. |
categoryId | string | Optional | Mercari category id, or several separated by commas; the US and Japan use separate ids and a parent id includes its children (e.g. 778 for US cell phones and smartphones). Every row carries its categoryId. |
condition | array | Optional | Only listings in any of these condition grades (e.g. ["new", "like_new"]). worn is Japan only. One of: new, like_new, good, fair, poor, worn. |
country | string | Optional | Mercari marketplace: us (mercari.com, USD) or jp (jp.mercari.com, JPY). One of: us, jp. Default "us". |
cursor | string | Optional | Pagination cursor: pass the previous response's nextCursor with the same query and filters; omit for the first page. |
maxPrice | integer | Optional | Highest price to include, in whole units of the country's currency (e.g. 300). |
minPrice | integer | Optional | Lowest price to include, in whole units of the country's currency (US dollars or yen) (e.g. 50). |
query | string | Required | Search keyword (e.g. nike air jordan 1). Japanese terms return far more in Japan, though Latin brand and model names work. |
sort | string | Optional | Result order; omitted means Mercari's default (relevance). most_liked is Japan only (e.g. price_desc). One of: relevance, newest, price_asc, price_desc, most_liked. |
Search Mercari US or Japan sold listings by keyword with optional price-range, condition, category, brand, and sort filters, page by page, with the total result count; ideal for resale pricing research. The sold price is the final price after any accepted offer; it does not include buyer fees, and whether shipping is included depends on the listing's shipping terms. Rows carry no sale date: call mercari.product for soldUtc (US only). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
brandId | string | Optional | Mercari brand id, or several separated by commas; the US and Japan use separate ids (e.g. 319 for Apple in the US). Every US row carries its brandId. |
categoryId | string | Optional | Mercari category id, or several separated by commas; the US and Japan use separate ids and a parent id includes its children (e.g. 778 for US cell phones and smartphones). Every row carries its categoryId. |
condition | array | Optional | Only listings in any of these condition grades (e.g. ["new", "like_new"]). worn is Japan only. One of: new, like_new, good, fair, poor, worn. |
country | string | Optional | Mercari marketplace: us (mercari.com, USD) or jp (jp.mercari.com, JPY). One of: us, jp. Default "us". |
cursor | string | Optional | Pagination cursor: pass the previous response's nextCursor with the same query and filters; omit for the first page. |
maxPrice | integer | Optional | Highest sold price to include, in whole units of the country's currency (e.g. 300). |
minPrice | integer | Optional | Lowest sold price to include, in whole units of the country's currency (US dollars or yen) (e.g. 50). |
query | string | Required | Search keyword (e.g. nike air jordan 1). Japanese terms return far more in Japan, though Latin brand and model names work. |
sort | string | Optional | Result order; omitted means Mercari's default (most recently sold first for a US sold search). most_liked is Japan only; recently_sold is US only (e.g. price_desc). One of: relevance, newest, price_asc, price_desc, most_liked, recently_sold. |
Find a person's mobile phone from a LinkedIn URL or from a domain and full name. $0.084 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Optional | Person's company domain. |
fullName | string | Optional | Person's full name. |
linkedinUrl | string | Optional | Person's LinkedIn profile URL. |
Find a person's mobile phone from a profile URL or email. A no-match answer is a successful, billable result. $0.2016 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Optional | |
personalEmail | string | Optional | |
profileUrl | string | Optional | |
workEmail | string | Optional |
Search up to five enriched Naver blog results by keyword with stable cursor pagination: result rank, title, excerpt, post and blogger URLs, blogger name, publish time, and Naver's total match count. $0.032 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. |
limit | integer | Optional | Maximum number of title-enriched posts to return, from 1 to 5 (default 5). Max 5. |
query | string | Required | Keyword phrase to search across Naver blogs. |
sort | string | Optional | Order posts by Naver relevance or newest publication date (default relevance). One of: relevance, recent. |
Fetch one Nextdoor business page by its slug, with phone, email, website, and street address. Returns up to 1 results per call (page with cursor/page where offered). $0.00792 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
market | string | Optional | Nextdoor market the page belongs to: "us" (nextdoor.com), "gb" (nextdoor.co.uk), or "ca" (ca.nextdoor.com). Defaults to "us". One of: us, gb, ca. |
pageSlug | string | Required | Slug of the Nextdoor business page, the last path segment of its /pages/ URL, e.g. "radiant-plumbing-air-conditioning-austin-tx". |
Find local businesses listed on Nextdoor by city and trade category, with phone, email, website, and street address. Returns up to 10 results per call (page with cursor/page where offered). $0.0352 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
city | string | Required | Nextdoor city slug, lowercase, with the city and its state or region joined by two hyphens, e.g. "austin--tx" or "york--england". |
market | string | Optional | Nextdoor market the city belongs to: "us" (nextdoor.com), "gb" (nextdoor.co.uk), or "ca" (ca.nextdoor.com). Defaults to "us". One of: us, gb, ca. |
query | string | Required | Business category to look for in that city, e.g. "plumber", "bakery", "electrician". |
Search professional profiles with account, contact, and saved-list filters. Returns up to 10 results per call (page with cursor/page where offered). $0.084 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
account | object | Optional | Company-level filters, keyed by filter name. Accepted names: domain, employeeSize, foundedYear, funding, geoLocation, industries, keyword, language, linkedin, metric, naics, name, phoneNumber, productAndServices, retailSize, revenue, socialMedia, socialMediaLink, technologies, technology, type,... |
contact | object | Optional | Person-level filters, keyed by filter name. Accepted names: certification, certifications, company, contactLanguage, contactLocation, currentCompany, department, departmentAndFunction, education, experience, fullName, function, keyword, language, linkedin, location, name, pastCompany,... |
lists | object | Optional | AI Ark saved-list filter expression. |
page | integer | Optional | Zero-based result page. Default 0. |
Search Aviato's people database by name, current title, current employer and location, up to 100 people per page for one flat price. Each row carries the current role and employer; enrich a row with Person Enrichment - Aviato. $0.003 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
city | string | Optional | City the person lives in, e.g. San Francisco. |
country | string | Optional | Country the person lives in, e.g. United States. |
currentCompanyLinkedinUrl | string | Optional | LinkedIn page URL of the current employer, e.g. https://www.linkedin.com/company/stripe. |
currentCompanyName | string | Optional | Current employer name, e.g. Stripe. |
currentTitle | string | Optional | Current job title, matched as a whole title but not case, e.g. software engineer. |
fullName | string | Optional | Person's name, matched word by word, so similar names match too, e.g. Satya Nadella. |
limit | integer | Optional | People per page. A page costs the same at any size. Default 100. Max 100. |
page | integer | Optional | One-based result page. Default 1. |
region | string | Optional | State or region the person lives in, e.g. California. |
List the current and former employees of one company, 100 per page, with name, LinkedIn profile, title, department and start and end dates, from a domain, a LinkedIn company URL, or an Aviato company id. $0.006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyId | string | Optional | Aviato company id, as any Aviato SKU's companyId output returns it. |
domain | string | Optional | Company website domain, e.g. posthog.com. A full URL works too; only its host is sent. |
limit | integer | Optional | Employees per page. A page costs the same at any size. Default 100. Max 100. |
linkedinUrl | string | Optional | LinkedIn company page URL, e.g. https://www.linkedin.com/company/posthog. |
page | integer | Optional | One-based page of employees. Default 1. |
Find up to 100 professional profiles by company domain and title keywords. Returns up to 3 results per call (page with cursor/page where offered). $0.00552 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Required | Company domain without a path. |
country | string | Optional | |
fuzzyTitle | boolean | Optional | Default true. |
profileKeywords | array | Optional | |
requireVerifiedEmail | boolean | Optional | Default false. |
seniority | array | Optional | Crustdata seniority level, or one of the listed shorthands (vp, manager, founder...); an array matches any of them. |
titleKeywords | array | Required | Example: "engineer" |
Find up to 100 professional profiles by company domain and title keywords. $0.144 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Required | Company domain without a path. |
country | string | Optional | |
fuzzyTitle | boolean | Optional | Default true. |
limit | integer | Optional | Default 3. Max 100. |
profileKeywords | array | Optional | |
requireVerifiedEmail | boolean | Optional | Default false. |
seniority | array | Optional | |
titleKeywords | array | Required | Example: "engineer" |
Prospect FullEnrich's person database by title, seniority, function, skill, language and location, plus any current or past employer firmographic. Every row carries the person's employer record. Billed per person returned. Returns up to 10 results per call (page with cursor/page where offered). $0.252 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
currentCompanyDomains | array | Optional | Filter by current employer domain. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. Example: [{"exact_match": true, "value": "stripe.com"}] |
currentCompanyFoundedYears | array | Optional | Filter by current employer founding year. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanyHeadcounts | array | Optional | Filter by current employer headcount band. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanyHeadquarters | array | Optional | Filter by current employer headquarters location. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanyIds | array | Optional | Filter by FullEnrich company id of the current employer. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanyIndustries | array | Optional | Filter by current employer industry. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanyLinkedinUrls | array | Optional | Filter by current employer LinkedIn URL. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanyNames | array | Optional | Filter by current employer name. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanySpecialties | array | Optional | Filter by a current employer specialty. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentCompanyTypes | array | Optional | Filter by current employer ownership type. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentPositionJobFunctions | array | Optional | Filter by current job function. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentPositionSeniorityLevel | array | Optional | Filter by seniority, e.g. Owner, Founder, C-level, VP, Director, Manager. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentPositionSubFunctions | array | Optional | Filter by current job sub-function. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentPositionTitles | array | Optional | Filter by current job title. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
currentPositionYearsIn | array | Optional | Filter by years spent in the current position. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
cursor | string | Optional | Cursor from a previous response's nextCursor. Works at any depth, including past the 10000 offset ceiling. |
offset | integer | Optional | Rows to skip. FullEnrich caps offset at 10000; past that, page with cursor. Default 0. |
pastCompanyDomains | array | Optional | Filter by the domain of a past employer. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
pastCompanyNames | array | Optional | Filter by an employer the person worked at before. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
pastPositionTitles | array | Optional | Filter by a job title the person held before. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
personIds | array | Optional | Filter by FullEnrich person id. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
personLanguages | array | Optional | Filter by a language the person speaks. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
personLinkedinUrls | array | Optional | Filter by person LinkedIn URL. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
personLocations | array | Optional | Filter by the person's city, region or country. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
personNames | array | Optional | Filter by person name. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
personSkills | array | Optional | Filter by a skill the person lists. Each entry is an object taking a `value` string and an optional `exact_match` boolean, e.g. [{"value": "stripe.com", "exact_match": true}]. A bare string is rejected. |
Prospect Lusha's contact database by department, seniority, job title, location, company size, industry and technology. One flat price per page; reveal a contact's email and phone with Person Enrichment - Lusha. $0.084 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
excludeDnc | boolean | Optional | Exclude contacts whose phone numbers are all marked do-not-call. |
filters | object | Required | Prospecting filters. Two keys are accepted, contacts and companies, and each takes an include and an exclude object. contacts.include and contacts.exclude accept departments, seniority, locations, existing_data_points and signals; companies.include and companies.exclude accept names, locations,... Example: {"companies": {"include": {"names": ["PostHog"]}}, "contacts": {"include": {"departments": ["Engineering & Technical"]}}} |
includePartialContact | boolean | Optional | Include contacts Lusha holds only partial information for. Defaults to true upstream. |
pages | object | Optional | Which page of results to return. Lusha charges one flat price per page whatever its size. Example: {"page": 0, "size": 10} |
Search People Data Labs' person dataset with SQL or an Elasticsearch query. Results carry the professional and firmographic record plus availability flags for contact data; pull the actual email and phone with Person Enrichment - People Data Labs. Billed per profile returned. Returns up to 10 results per call (page with cursor/page where offered). $1.68 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
dataInclude | string | Optional | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; billing still follows profiles returned. |
dataset | string | Optional | People Data Labs dataset to search, when your plan exposes more than one. |
query | object | Optional | Elasticsearch-style query over the People Data Labs person dataset, e.g. {"bool": {"must": [{"term": {"job_company_website": "posthog.com"}}]}}. Send this or sql, never both. |
sql | string | Optional | People Data Labs SQL, in the form SELECT * FROM person WHERE ... . String literals take single quotes, only SELECT * is supported, and field names must be real People Data Labs person fields including nested subfields such as experience.title.name. Do not include a LIMIT clause; People Data Labs... |
titlecase | boolean | Optional | Return text in title case instead of People Data Labs' lowercase default. |
Prospect Prospeo's contact database by job title, department, seniority, experience, location and any company firmographic. One flat price per page of 25. $0.066 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | object | Optional | Filter by company names or websites, e.g. {"names": {"include": ["Stripe"]}, "websites": {"include": ["stripe.com"]}}. Example: {"websites": {"include": ["stripe.com"]}} |
companyAttributes | object | Optional | Filter by company characteristics, e.g. B2B, has pricing, has a free trial. |
companyEmailProvider | array | Optional | Filter by the company's email MX provider. |
companyFounded | object | Optional | Filter by founding year range. |
companyFunding | object | Optional | Filter by funding stage or amount raised. |
companyHeadcountByDepartment | array | Optional | Filter by headcount within a department. |
companyHeadcountCustom | object | Optional | Filter by a custom employee count range. |
companyHeadcountGrowth | object | Optional | Filter by headcount growth. |
companyHeadcountRange | array | Optional | Filter by Prospeo's predefined employee count bands. |
companyIndustry | object | Optional | Filter by company industry. |
companyJobPostingHiringFor | array | Optional | Filter by the roles the company is currently hiring for. |
companyJobPostingQuantity | object | Optional | Filter by how many roles the company has open. |
companyKeywords | object | Optional | Filter by keywords found in company data. |
companyLocationSearch | object | Optional | Filter by company headquarters location. |
companyNaics | object | Optional | Filter by NAICS codes. |
companyRevenue | object | Optional | Filter by revenue range. |
companySics | object | Optional | Filter by SIC codes. |
companyTechnology | object | Optional | Filter by technologies the company uses. |
companyType | string | Optional | Filter by ownership type. One of: Private, Public, Non Profit, Other. |
maxPersonPerCompany | integer | Optional | Cap how many people one company may contribute to the results. |
page | integer | Optional | Page number, one-based. Prospeo returns 25 results per page and charges one flat price per page. Default 1. |
personContactDetails | object | Optional | Filter by which contact channels Prospeo holds for the person. |
personDepartment | object | Optional | Filter by department. |
personDuplicateControl | object | Optional | Duplicate-control settings exported from the Prospeo dashboard. |
personJobTitle | object | Optional | Filter by job title, with exact, contains and boolean semantics, e.g. {"include": ["VP Sales"]}. |
personLocationSearch | object | Optional | Filter by where the person is located. |
personName | object | Optional | Filter by person name. |
personNameOrJobTitle | string | Optional | Free-text search across person name and job title. |
personSeniority | object | Optional | Filter by seniority. Prospeo's own values are case sensitive: Founder/Owner, C-Suite, Partner, Vice President, Head, Director, Manager, Senior, Entry, Intern. Common aliases such as vp and founder are normalized before the call. |
personTimeInCurrentCompany | object | Optional | Filter by time at the current company, as a numeric range. |
personTimeInCurrentRole | object | Optional | Filter by time in the current role, as a numeric range. |
personYearOfExperience | object | Optional | Filter by total years of experience, as a numeric range. |
Build a prospect list by title, industry, headcount, revenue, or location, and see which people have a work email or phone on file before you pay to reveal one. Contact values themselves are masked here; use Person Enrichment or the QuickEnrich company contacts search to resolve them. $0.0005 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
city | object | Optional | Filter on city name. |
companyDomain | object | Optional | Filter on employer website domain. |
companyName | object | Optional | Filter on employer name. |
country | object | Optional | Filter on ISO 3166-1 alpha-2 country code, e.g. "US". Example: {"include": ["US"]} |
employeeCount | object | Optional | Filter on employer headcount band. These bands differ from the companyEmployeeCount string returned on a result. |
hasEmail | boolean | Optional | Keep only people with a work email on file. The address itself is not returned here. |
hasPhone | boolean | Optional | Keep only people with a phone on file. The number itself is not returned here. |
industry | object | Optional | Filter on the employer's LinkedIn industry label. Values must match the QuickEnrich industry vocabulary exactly, e.g. "IT Services and IT Consulting". |
limit | integer | Optional | Maximum people to return on this page. Default 100. Max 100. |
linkedinBio | object | Optional | Filter on words found in the employer's LinkedIn bio. |
locality | object | Optional | Filter on locality. |
page | integer | Optional | One-based result page. Default 1. |
revenue | object | Optional | Filter on employer revenue band. |
services | object | Optional | Filter on the services the employer lists. |
title | object | Optional | Filter on job title. Example: {"include": ["CEO"]} |
List the known contacts at one company domain, with work emails and direct phone lines where they are held. Returns up to 20 people per page for a flat per-request price. Coverage is strongest for small and local businesses. $0.0072 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Required | Company website domain, normalized upstream (example.com or https://example.com both work). |
page | integer | Optional | One-based result page. Each page holds up to 20 people. Default 1. |
title | string | Optional | One job title, or several comma-separated, e.g. "CEO, CFO". |
Ask Perplexity a web-grounded question and receive an answer with source citations. $0.002 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
prompt | string | Required | Question or research prompt for Perplexity to answer using web search. |
Enrich one person into work history with every position held, education, degrees, location, skills, social profiles, LinkedIn following and investor profile from a LinkedIn profile URL or an Aviato person id. Emails are not included; get them with Contact Enrichment - Aviato. $0.06 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
linkedinUrl | string | Optional | LinkedIn profile URL, e.g. https://www.linkedin.com/in/satyanadella. |
personId | string | Optional | Aviato person id, as any Aviato SKU's personId output returns it. |
Run one contact through BetterContact's email waterfall from a name plus company domain or a LinkedIn URL, and get the winning address with its deliverability verdict, the provider that found it, and the employer record. Only a matched contact is billable. $0.0828 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | string | Optional | Employer name, for when you have no domain. |
companyDomain | string | Optional | Employer domain, e.g. stripe.com. The strongest company signal for the waterfall. |
customFields | object | Optional | Arbitrary identifiers echoed back on the result, for joining the answer to your own records. |
firstName | string | Required | Contact's first name. |
lastName | string | Required | Contact's last name. |
linkedinUrl | string | Optional | Contact's LinkedIn profile URL, which raises the match rate. |
Enrich one person from a LinkedIn profile URL or a business email: profile, headline, location, skills, current and past roles with the employer's domain, education, social handles, and GitHub profiles. Contact details are sold separately by Contact Enrichment - Crustdata v3. $0.096 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Optional | The person's business email address. |
linkedinUrl | string | Optional | LinkedIn profile URL, e.g. https://www.linkedin.com/in/satyanadella. Send exactly one of linkedinUrl or email. |
minSimilarityScore | number | Optional | For an email lookup, the lowest match similarity from 0 to 1 to accept. Leave unset to use Crustdata's default. Max 1. |
Enrich one person from an email, a phone number or a social profile URL into Data Legion's premium profile with contact data: emails, phone numbers, location, age and sex, plus current job and employer, seniority, job function, decision-maker flag, years of experience, work history, education, certifications, skills and social profiles. $0.09606 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Optional | Any email address the person uses, work or personal. Send exactly one of email, phone or socialUrl. |
minConfidence | string | Optional | Lowest match confidence that still counts as found. Omit it for Data Legion's default. One of: high, moderate, low. |
phone | string | Optional | Phone number with its country code, e.g. +1 415 555 0100. |
required | string | Optional | Fields a match must have, as a Data Legion expression over its snake_case field names combined with AND, OR and parentheses, e.g. work_email OR mobile_phone, or phones.type:mobile. A match without them counts as not found. |
socialUrl | string | Optional | Social profile URL: LinkedIn (linkedin.com/in/...), GitHub, X and similar networks. A LinkedIn URL matches most reliably. |
Run FullEnrich's waterfall on up to 99 people in one call and get back work emails, personal emails and mobile numbers, each with a deliverability status, alongside the full LinkedIn-grade profile and employer record for everyone matched. Only the contacts it matches are returned, and only those are billed. $0.1008 per contact, up to 10 per call. $0.1008 per call (per contact).
$0.1008 per contact; one per item in contacts (max 10, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
contacts | array | Required | People to enrich, up to 99 per call. You are charged only for the contacts the waterfall resolves, though the funds held cover every contact you submit until the call settles. Each entry is passed to FullEnrich exactly as you write it, which is why these keys are snake_case while the rest of the... Max 99 items. Example: [{"custom": {"row": "1"}, "domain": "stripe.com", "enrich_fields": ["contact.emails", "contact.personal_emails"], "first_name": "Patrick", "last_name": "Collison"}, {"company_name": "Figma", "custom": {"row": "2"}, "enrich_fields": ["contact.emails"], "first_name": "Dylan", "last_name": "Field", "li Max 10 per call; extras are dropped. |
Turn up to 99 email addresses into the people behind them: name, headline, location, LinkedIn profile, current title and seniority, full employment history, education, languages and skills, plus the employer record. Only the addresses it resolves are returned, and only those are billed. $0.1008 per contact, up to 10 per call. $0.1008 per call (per contact).
$0.1008 per contact; one per item in contacts (max 10, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
contacts | array | Required | Addresses to look up, up to 99 per call. You are charged only for the addresses that resolve to a person, though the funds held cover every address you submit until the call settles. Each entry is an object so you can tag it; the address itself goes in email. Max 99 items. Example: [{"custom": {"row": "1"}, "email": "dfield@figma.com"}, {"custom": {"row": "2"}, "email": "patrick@stripe.com"}] Max 10 per call; extras are dropped. |
Enrich one person into work email, direct dial, job title and employer firmographics from a LinkedIn URL, an email, or a name plus company. $0.084 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Optional | Employer domain, e.g. apollo.io. Secondary identifier for a name-based lookup. |
companyName | string | Optional | Employer name. Secondary identifier for a name-based lookup; companyDomain matches more reliably. |
email | string | Optional | Known email address, used to resolve the person's identity. |
firstName | string | Optional | First name. Send with lastName plus companyName or companyDomain. |
lastName | string | Optional | Last name. Send with firstName plus companyName or companyDomain. |
linkedinUrl | string | Optional | LinkedIn profile URL (linkedin.com/in/...). Highest match rate. |
refreshJobInfo | boolean | Optional | Force a fresh job title and employer lookup instead of the cached one. |
revealEmails | boolean | Optional | Reveal email addresses. Defaults to true upstream. |
revealPhones | boolean | Optional | Reveal phone numbers. Defaults to true upstream. |
signals | boolean | Optional | Include buying-intent signals in the response. |
Enrich one person into work email, personal emails, mobile phone, full work history, education and employer firmographics from any identifier People Data Labs can match on. $0.24 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
birthDate | string | Optional | Known birth date, to disambiguate a name match. |
company | string | Optional | Company name, website or social URL where the person has worked. |
country | string | Optional | Country to match on. |
dataInclude | string | Optional | Comma-separated People Data Labs fields to include, or a leading - list to exclude. Projection changes the payload only; it does not reduce what the call costs. |
email | string | Optional | Any email address the person has used. |
emailHash | string | Optional | SHA-256 or MD5 hash of an email address, for privacy-preserving matching. |
firstName | string | Optional | First name. Send with lastName plus company, school or location. |
includeIfMatched | boolean | Optional | Report which of the sent identifiers actually matched. |
lastName | string | Optional | Last name. Send with firstName plus company, school or location. |
linkedinId | string | Optional | LinkedIn numeric member id (PDL calls this lid). |
locality | string | Optional | City or locality to match on. |
location | string | Optional | Free-form location string, e.g. brookline, massachusetts, united states. |
middleName | string | Optional | Middle name. |
minLikelihood | integer | Optional | Minimum People Data Labs likelihood score a match must reach to count as found. Omitted, this SKU sends 6; the People Data Labs default is 2. Max 10. |
name | string | Optional | Full name, as an alternative to firstName plus lastName. |
pdlId | string | Optional | People Data Labs persistent person id, as returned by this SKU's pdlId output. |
phone | string | Optional | Phone number in international form, e.g. +16176695906. |
postalCode | string | Optional | Postal or ZIP code to match on. |
profile | string | Optional | Social profile URL the person has used, e.g. a LinkedIn, Twitter, Facebook or GitHub profile. The strongest single identifier. |
region | string | Optional | State or region to match on. |
required | string | Optional | People Data Labs boolean expression over top-level fields that a match must satisfy, e.g. personal_emails or (emails and phone_numbers). |
school | string | Optional | School the person attended, used to disambiguate a name match. |
streetAddress | string | Optional | Street address to match on. |
titlecase | boolean | Optional | Return text in title case instead of People Data Labs' lowercase default. |
Enrich one person into work email, mobile phone, full job history and employer firmographics from a LinkedIn URL, an email, or a name plus company domain. $0.066 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyLinkedinUrl | string | Optional | Employer LinkedIn page URL, for a more precise match. |
companyName | string | Optional | Employer name. Avoid sending it alone; many companies share a name. |
companyWebsite | string | Optional | Employer domain, e.g. stripe.com. Preferred over companyName. |
email | string | Optional | Known email address, used as the sole identity seed for a reverse lookup. |
enrichMobile | boolean | Optional | Reveal the mobile number. Without it the number comes back masked. |
firstName | string | Optional | First name. Send with lastName plus companyWebsite for the best hit rate. |
fullName | string | Optional | Full name, as an alternative to firstName plus lastName. |
lastName | string | Optional | Last name. |
linkedinUrl | string | Optional | LinkedIn profile URL. The most accurate identifier, alone or with a name. |
onlyVerifiedEmail | boolean | Optional | Return a match only when Prospeo has a verified email for it. Defaults to false. |
onlyVerifiedMobile | boolean | Optional | Return a match only when Prospeo has a verified mobile for it. |
personId | string | Optional | Prospeo person id from an earlier People Search - Prospeo call. |
Turn a work email into the person behind it: name, title, LinkedIn, and their employer's firmographics. Coverage is strongest for small and local businesses. $0.0072 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
email | string | Required | Exact work email address to look up. |
Skip-trace a person in the US by name, address, phone, or email and get back identity, address, and contact records in normalized JSON. $0.0077 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
address | string | Optional | Street address with city/state/zip. |
email | string | Optional | Email address to reverse-trace (e.g. john.smith@example.com). |
name | string | Optional | Full name of the person to trace. Provide at least one of name, address, phone, or email. |
phone | string | Optional | Phone number to reverse-trace (e.g. 415-555-2671). |
Search Pexels for free stock photos by keyword. Returns image URLs in several sizes, dimensions, alt text, the photographer's name and profile, and the photo's Pexels page. Returns up to 10 results per call (page with cursor/page where offered). $0.03355 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
minHeight | integer | Optional | Only return photos at least this many pixels tall. |
minWidth | integer | Optional | Only return photos at least this many pixels wide. |
orientation | string | Optional | Only return photos with this orientation. Omit for any orientation. One of: landscape, portrait, square. |
peopleCount | string | Optional | Only return photos showing this many people: "0" for none, "1" or "2". Omit for any number. One of: 0, 1, 2. |
query | string | Required | Keyword or phrase to search Pexels photos for, e.g. "coffee" or "city skyline". |
Fetch one public Pinterest pin by URL or numeric pin id: title, description, image, video, outbound link and site, save count, hashtags, the pinner with their follower count, and the board it was saved to, as normalized JSON. A pin that does not exist is not charged. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
pinId | string | Optional | Numeric Pinterest pin id, the number in the pin URL (https://www.pinterest.com/pin/<id>/), e.g. 101049585382283341. Pinterest Search returns it as id. Send this or url. |
url | string | Optional | Full Pinterest pin URL carrying the numeric pin id, e.g. https://www.pinterest.com/pin/101049585382283341/. Country sites such as uk.pinterest.com or pinterest.de work too. pin.it short links are not accepted: open the link in a browser and send the pinterest.com/pin/... address it lands on.... |
Search Pinterest by keyword and get pin, video, board, or profile results with titles, images, and links. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page. |
limit | integer | Optional | Page size to ask for (1-20). Some sources return their whole page of about 20 pins whatever limit says: a page is never trimmed after the call, so nextCursor continues exactly where this response ended. Max 20. |
query | string | Required | Keyword, topic, brand, or theme to search Pinterest for (e.g. mid-century living room). |
type | string | Optional | Kind of results to return: all pins, only video pins, boards, or profiles (e.g. videos). One of: all-pins, videos, boards, profiles. Default "all-pins". |
Get an Android app's Google Play listing by package name, in any store country: title, developer and contact details, rating, ratings count, installs, price, description, screenshots, and more. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
appId | string | Required | Android app package name, the id parameter of the app's Google Play URL (e.g. com.supercell.brawlstars). |
country | string | Optional | Two-letter Google Play store country code to read the listing from (e.g. gb); price and currency follow that country. Text is returned in English. Default "us". |
Fetch Google Play reviews for any Android app by package name or store URL: ratings, review text, dates, and helpfulness votes. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
appId | string | Required | Android app package name or full Google Play store URL (e.g. com.supercell.brawlstars). |
appVersion | array | Optional | Only return reviews left on these app versions (e.g. ["2.24.1", "2.24.2"]). |
deviceType | string | Optional | Only return reviews from this device type (e.g. "tablet"); omit for the provider default. One of: mobile, tablet, chromebook. |
endDate | string | Optional | Only return reviews on or before this date, inclusive, in YYYY-MM-DD format (e.g. 2026-06-30). |
keywords | array | Optional | Only return reviews whose text contains one of these keywords (e.g. ["crash", "login"]). |
languages | array | Optional | Only return reviews in these ISO 639-1 languages (e.g. ["en", "es"]). |
limit | integer | Optional | Maximum number of results to return (1-100, default 100). Max 100. |
rating | integer | Optional | Only return reviews with this exact star rating from 1 to 5 (e.g. 1); omit for all ratings. |
recentDays | integer | Optional | Only return reviews from the last N days (e.g. 30); omit for no time limit. |
sortBy | string | Optional | Review ordering: mostRelevant, newest, or rating (e.g. newest). |
Search Google Play for Android apps by keyword, in any store country: package name, title, developer, rating, installs, price, and category for each result. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Two-letter Google Play store country code to search (e.g. gb); results, prices, and currency follow that country. Text is returned in English. Default "us". |
limit | integer | Optional | Maximum number of apps to return in items (1-30, default 30). Google Play shows about 30 apps per search, so fewer may come back. The app Google Play features above the results comes back separately in featuredApps and does not count toward this limit. Default 30. Max 30. |
query | string | Required | Search keywords, as typed into the Google Play search box (e.g. budget tracker). |
Discover Polymarket prediction markets (question, outcome prices, volume, liquidity, and end dates) by keyword or sorted by activity, as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.1226 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Search term for markets (e.g. election, bitcoin, super bowl). |
sortBy | string | Optional | How discovered markets are ordered before results are returned (e.g. volume_24hr for recent momentum). One of: volume_24hr, volume, liquidity, start_date, ending_soon, competitive. Default "volume_24hr". |
status | string | Optional | Return "active" markets for current prices and volume, or "resolved" markets for historical outcomes. One of: active, resolved. Default "active". |
Look up the public property records for one US address: current and previous owners, parcel number (APN), last sale, assessed and market values, property tax, beds, baths, living area, lot size, year built, land use, and zoning. One address can match several parcels, and every match is returned. Billed only when a record is found. $0.1536 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
city | string | Required | City of the property, e.g. Austin. |
state | string | Required | US state of the property, as its two-letter code, e.g. TX. |
street | string | Required | Street line of one US property address, e.g. 4510 Secure Ln. Include a unit number when there is one. |
zip | string | Optional | Five-digit ZIP code, optionally with its four-digit extension, e.g. 78725. |
Search Realtor.com listings by location with optional price, property-type, beds/baths, listing-status, and keyword filters and get property records (price, address, beds, baths) as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
bathsMin | integer | Optional | Minimum number of bathrooms (e.g. 2). |
bedsMin | integer | Optional | Minimum number of bedrooms (e.g. 3). |
keyword | string | Optional | Free-text keyword that must appear in the listing description (e.g. 'pool'). |
location | string | Required | City, ZIP code, neighborhood or state to search (e.g. Las Vegas, NV). |
priceMax | integer | Optional | Maximum listing price in USD (e.g. 750000). |
priceMin | integer | Optional | Minimum listing price in USD (e.g. 250000). |
propertyTypes | array | Optional | Filter by one or more property types; omit for all types (e.g. ["single_family", "townhomes"]). One of: single_family, townhomes, condo_townhome, multi_family, land, farm, manufactured, mobile, apartment, coop, duplex_triplex. Example: ["single_family"] |
searchMode | string | Optional | Listing type to search: for_sale or sold (e.g. for_sale). One of: for_sale, sold. Default "for_sale". |
searchStatuses | array | Optional | Listing statuses to include in for_sale mode; omit for active For Sale + Ready to Build. Ignored in sold mode (e.g. ["for_sale", "pending"]). One of: for_sale, ready_to_build, pending, coming_soon, contingent. Example: ["pending"] |
Get a Reddit user's profile picture URL, karma, and account age by username. The cheapest Reddit user lookup; use reddit.profile for bio, trophies, and post and comment counts. $0.00036 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
username | string | Required | Reddit username, without the u/ prefix. Example: "spez". |
Fetch a single Reddit post by URL, including its full body text, score, comment count, upvote ratio, and subreddit, as normalized JSON. $0.0005 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Reddit post URL on reddit.com, e.g. "https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/". The /r/<subreddit>/comments/<id>/, /user/<name>/comments/<id>/, /comments/<id>/ and /gallery/<id> forms are accepted. Any other link, such as a share link or a... |
List the comments on a Reddit post by URL (author, body, score, timestamp, parent comment). Replies carry the parentId of the comment they answer. $0.00058 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Cursor from a previous response for more comments. |
url | string | Required | Full Reddit post URL on reddit.com. A gallery link (https://www.reddit.com/gallery/<id>) is read as the post it belongs to, and a relative permalink (/r/<subreddit>/comments/<id>/...) as the same path on https://www.reddit.com. |
Extract the spoken transcript from a Reddit video post by URL. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Optional two-letter language code (defaults to en). |
url | string | Required | Reddit post URL or direct v.redd.it video URL to transcribe. |
Fetch a Reddit user's public profile (karma split, post and comment counts, bio, avatar, account age) by username. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
username | string | Required | Reddit username, without the u/ prefix. Example: "spez". |
Search Reddit posts across all subreddits by query. $0.00034 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of results. Include `nextCursor` in requireFields on the first request to make sure a source that supports pagination serves it. |
query | string | Required | Free-text search across all of Reddit. Reddit's field operators are supported inside the string: subreddit:<name> to scope to one subreddit, author:<user>, title:<text>, selftext:<text>, self:yes|no, nsfw:yes|no, and boolean AND/OR/NOT. To restrict to a single subreddit you can use... |
sort | string | Optional | Result sort order. One of: relevance, hot, top, new, comments. |
timeframe | string | Optional | Time window for results. One of: hour, day, week, month, year, all. |
Fetch a subreddit's metadata (weekly active users, description, and category). $0.00036 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
subreddit | string | Required | Subreddit name without the r/ prefix. Case-sensitive (e.g. "AskReddit", not "askreddit"). |
Fetch posts from a subreddit listing (hot, new, or top). $0.00038 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
after | string | Optional | Legacy pagination alias. Prefer `cursor`; omit both fields for the first page. |
cursor | string | Optional | Opaque pagination cursor from a previous response's `nextCursor`; omit for the first page. |
limit | integer | Optional | Page size to ask for (up to 100). Some sources honor it; others always return their whole page of about 25 posts. A page is never trimmed after the call, so pass nextCursor back as cursor to continue exactly where this response ended. Default 100. Max 100. |
sort | string | Optional | Listing sort order. One of: hot, new, top. Default "hot". |
subreddit | string | Required | Subreddit name without the leading r/ (e.g. "golang"). |
timeframe | string | Optional | Time window, applied when sort is "top" (e.g. "year" for the year's top posts). Ignored for hot/new. Omit to default to the current day for top. One of: all, year, month, week, day, hour. |
Search posts within a single subreddit by query, sort, and timeframe. $0.00035 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Optional pagination token from a previous response. Include `nextCursor` in requireFields on the first request to make sure a source that supports pagination serves it. |
query | string | Optional | Optional search query to match posts (e.g. 'push ups'). |
sort | string | Optional | Optional sort order: relevance, hot, top, new, comments. One of: relevance, hot, top, new, comments. |
subreddit | string | Required | Subreddit name without the r/ prefix (e.g. 'Fitness'). |
timeframe | string | Optional | Optional time filter: all, year, month, week, day, hour. One of: all, year, month, week, day, hour. |
Get currently trending Reddit posts across all subreddits with stable cursor pagination. $0.0003 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
after | string | Optional | Pagination cursor from a previous response's nextCursor. Omit for the first page. |
limit | integer | Optional | Maximum number of trending posts to return (1-100, default 100). Default 100. Max 100. |
List a Reddit user's comments by username, sorted by new, top, hot, or controversial, with the parent post title and subreddit on every item and cursor pagination. Comment text may be truncated to a roughly 300-character preview, and this endpoint carries no per-comment permalink; use reddit.post_comments for full comment bodies and comment URLs on a given post. $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it back to fetch the next page. |
limit | integer | Optional | Page size to ask for (up to 100, default 100). Some sources honor it; others always return their whole page of about 25 comments. A page is never trimmed after the call, so pass nextCursor back as cursor to continue exactly where this response ended. Default 100. Max 100. |
sort | string | Optional | Sort order for the user's comments. Defaults to new (most recent first). One of: new, top, hot, controversial. |
username | string | Required | Reddit username, without the u/ prefix. Example: "spez". |
List a Reddit user's posts by username, sorted by new, top, hot, or controversial, with cursor pagination. $0.00038 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it back to fetch the next page. |
sort | string | Optional | Sort order for the user's posts. Defaults to new (most recent first). One of: new, top, hot, controversial. |
username | string | Required | Reddit username without the leading u/ prefix (e.g. "spez"). |
Fetch full details for a single Redfin home by its listing URL (price, beds, baths, square feet, address, listing agent, description and photos) as normalized JSON. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Redfin home details URL (e.g. https://www.redfin.com/TX/Austin/1819-Village-Oak-Ct-78704/home/30981993). |
Run a Redfin map search by URL and get matching home listings (price, address, beds, baths, status) as normalized JSON. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of results to return (1-25, default 25). Max 25. |
url | string | Required | Redfin search results URL for a city, ZIP or map area (e.g. https://www.redfin.com/city/30772/CA/San-Francisco). |
Look up a RedNote (Xiaohongshu) note by note ID and return normalized note details. $0.012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
noteId | string | Required | RedNote (Xiaohongshu) note ID. |
List comments on a RedNote (Xiaohongshu) note and return normalized comment records with pagination. $0.012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from the previous response. |
noteId | string | Required | RedNote (Xiaohongshu) note ID. |
Look up a RedNote (Xiaohongshu) profile by user ID and return normalized profile details. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
userId | string | Required | RedNote (Xiaohongshu) user ID. |
Search RedNote (Xiaohongshu) notes by keyword and return normalized note records with pagination. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from the previous response. |
query | string | Required | Keyword to search for on RedNote (Xiaohongshu). |
sort | string | Optional | Sort order for matching notes. One of: general, hot, time. Default "general". |
Search RedNote (Xiaohongshu) users by keyword and return normalized user records with pagination. $0.012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from the previous response. |
query | string | Required | Keyword to search for on RedNote (Xiaohongshu). |
List notes posted by a RedNote (Xiaohongshu) user and return normalized note records with pagination. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from the previous response. |
userId | string | Required | RedNote (Xiaohongshu) user ID. |
Status and result of an async AnyAPI request (email_finding/icypeas, email_verification/bounceban, youtube/channel_contact) that returned 202 with a request id. Free.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | Request id (UUID) from the 202 response. |
Fetch a SamsClub.com product by URL and get title, member price, stock, brand, model, UPC, rating, description, and images in one normalized response. $0.00319 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Sam's Club product page URL, e.g. https://www.samsclub.com/ip/Bounty-Select-A-Size-2-Ply-Paper-Towels-12-Rolls-110-sheets-roll/18040450426. Prices and stock are those of Sam's Club's default club. |
Search SamsClub.com by keyword with optional sort, price-range, and page filters and get title, member price, stock, and rating for each product in one normalized response. $0.00319 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
maxPrice | number | Optional | Optional maximum member price in USD. |
minPrice | number | Optional | Optional minimum member price in USD. |
page | integer | Optional | 1-based results page of about 40 to 50 products. Each page is billed as one request. Default 1. |
query | string | Required | Search keywords, e.g. "paper towels" or "tv". |
sort | string | Optional | Result sort order; omit for Sam's Club's Best Match (e.g. price_low sorts by lowest price first). One of: best_match, price_low, price_high. |
List a public company's SEC EDGAR filings - form type, filing date, accession number, and document links - by ticker, company name, or CIK, with optional form-type and date filters. Returns up to 10 results per call (page with cursor/page where offered). $0.0066 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyName | string | Optional | Company name to search for (partial match supported, e.g. 'Tesla' or 'Berkshire'). Use this when you do not have the ticker symbol. If both ticker and companyName are given, ticker takes precedence. |
dateFrom | string | Optional | Only return filings filed on or after this date, in YYYY-MM-DD format (e.g. 2025-01-01). |
dateTo | string | Optional | Only return filings filed on or before this date, in YYYY-MM-DD format (e.g. 2026-06-01). |
form | string | Optional | Filter filings by SEC form type (e.g. 10-K, 10-Q, 8-K, 4, DEF 14A, S-1, 13F-HR); omit for all forms. |
ticker | string | Optional | Company stock ticker symbol, e.g. AAPL, MSFT, or TSLA. Provide either ticker or companyName; ticker is the more precise lookup. |
Semrush keyword research for any term: monthly search volume, CPC, competition, keyword difficulty, plus related keywords and question keywords. $0.00495 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
database | string | Optional | Two-letter Semrush regional database that scopes the metrics (e.g. us, uk, de). Default "us". |
keyword | string | Required | The search term to research (e.g. "best running shoes"). |
a Semrush SEO overview for any domain: Authority Score, organic and paid traffic, keyword and backlink counts, top country, and the domain's top organic keywords. $0.00495 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
database | string | Optional | Two-letter Semrush regional database that scopes the metrics (e.g. us, uk, de). Default "us". |
domain | string | Required | The domain to analyze (e.g. ahrefs.com). |
includeMoz | boolean | Optional | Add Moz Domain Authority and Spam Score to the response. Default false. |
Get AnyAPI SEO anchor texts of the backlinks pointing at a domain or URL, each with backlink and referring domain counts, authority rank, and spam score as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0293 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeSubdomains | boolean | Optional | Count links pointing at the target's subdomains as well as the target itself. Default true. |
status | string | Optional | Count backlinks that are live now, ones that have been lost, or both. One of: live, lost, all. Default "live". |
target | string | Required | Domain, subdomain, or full page URL to analyze. Send a domain without a protocol or leading www. |
Find the domains that share the most backlinks with a domain or URL, each with its authority rank and shared backlink count as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0293 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
excludeLargeDomains | boolean | Optional | Leave out very large sites (such as google.com or wikipedia.org) that share backlinks with almost everyone. Default true. |
mainDomainOnly | boolean | Optional | Group results by registrable domain rather than listing subdomains separately. Default true. |
target | string | Required | Domain, subdomain, or full page URL to analyze. Send a domain without a protocol or leading www. |
Get AnyAPI SEO backlinks for a domain or URL, each with the linking page, anchor text, dofollow flag, authority rank, spam score, and first and last seen dates as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0293 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeSubdomains | boolean | Optional | Count links pointing at the target's subdomains as well as the target itself. Default true. |
mode | string | Optional | as_is returns every backlink; one_per_domain keeps one backlink per linking domain; one_per_anchor keeps one per anchor text. One of: as_is, one_per_domain, one_per_anchor. Default "as_is". |
status | string | Optional | Return backlinks that are live now, ones that have been lost, or both. One of: live, lost, all. Default "live". |
target | string | Required | Domain, subdomain, or full page URL to analyze. Send a domain without a protocol or leading www. |
Get AnyAPI SEO backlink profile totals for a domain or URL: backlinks, referring domains, authority rank, spam score, and broken links as normalized JSON. $0.02885 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeSubdomains | boolean | Optional | Count links pointing at the target's subdomains as well as the target itself. Default true. |
target | string | Required | Domain, subdomain, or full page URL to analyze. Send a domain without a protocol or leading www. |
Get AnyAPI SEO competitor domains for a target domain with shared keyword counts and organic metrics as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.03024 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Language code for SEO competitor metrics. Default "en". |
location | integer | Optional | Location code for SEO competitor metrics. The default is the United States. Default 2840. |
orderBy | string | Optional | Sort order for the returned competitors: by shared keyword count (intersections), organic keyword count, organic traffic value (etv), or average position. Omit for the default order. One of: intersections_desc, organic_keywords_desc, organic_etv_desc, avg_position_asc. |
target | string | Required | Domain to analyze, without a protocol or leading www. |
Get AnyAPI SEO keyword overlap for two domains with each domain's rankings, URLs, volume, CPC, and difficulty as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.03024 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
intersections | boolean | Optional | When true (the default), return keywords both domains rank for (overlap). When false, return keywords the first domain ranks for that the second domain does NOT (the content-gap query); in that mode secondRank and secondUrl are absent. |
language | string | Optional | Language code for SEO overlap metrics. Default "en". |
location | integer | Optional | Location code for SEO overlap metrics. The default is the United States. Default 2840. |
orderBy | string | Optional | Sort order for the returned keywords: by search volume, cost per click, or keyword difficulty, ascending or descending. Omit for the default order. One of: volume_desc, volume_asc, cpc_desc, difficulty_asc, difficulty_desc. |
target1 | string | Required | First domain to compare, without a protocol or leading www. |
target2 | string | Required | Second domain to compare, without a protocol or leading www. |
Get AnyAPI SEO pages of a domain with their backlink profile (rank, backlinks, referring domains) and on-page data (title, headings, word count, status, technologies) as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0293 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeSubdomains | boolean | Optional | Count links pointing at the target's subdomains as well as the target itself. Default true. |
status | string | Optional | Count backlinks that are live now, ones that have been lost, or both. One of: live, lost, all. Default "live". |
target | string | Required | Domain or subdomain to list pages for, without a protocol or leading www. |
Get AnyAPI SEO domain ranking, organic traffic, and paid traffic metrics as normalized JSON. $0.01455 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Language code for SEO domain metrics. Default "en". |
location | integer | Optional | Location code for SEO domain metrics. The default is the United States. Default 2840. |
target | string | Required | Domain to analyze, without a protocol or leading www. |
Detect the technology stack a website runs: CMS, analytics, marketing, hosting, and security, plus contacts and social profiles as normalized JSON. $0.0144 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Required | Domain to analyze, without a protocol or leading www. Billing is flat per request. |
Find websites running a given technology, category, or on-page term: domain, rank, detected stack, contacts, and social profiles as normalized JSON. Returns up to 20 results per call (page with cursor/page where offered). $0.03864 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
category | string | Optional | Technology category to match, for example marketing_automation. Broader than technology: it returns every domain running anything in that category. |
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. Omit for the first page. |
group | string | Optional | Top-level technology group to match, for example marketing or servers. The broadest selector. |
keyword | string | Optional | On-page term to match in the site's HTML, for example highlevel. Use this to find sites running a product that the technology index does not detect by name. |
orderBy | string | Optional | Sort order for the returned domains: by domain rank descending or ascending, by most recently crawled, or by country code. Omit for the default order. One of: rank_desc, rank_asc, last_visited_desc, country_asc. |
technology | string | Optional | Exact technology name to match, for example Nginx or HubSpot. Only technologies present in the detection index are accepted; any other name is rejected with a 400 error and no charge, so use keyword instead when a product is not matched by name. |
Get AnyAPI SEO keyword difficulty scores for one or more keywords as normalized JSON. $0.01454 per keyword, one per call. $0.01454 per call (per keyword).
$0.01454 per keyword; one per item in keywords (max 1, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Required | SEO keywords to score for organic ranking difficulty. Max 1000 items. Example: ["seo tools"] Max 1 per call; extras are dropped. |
language | string | Optional | Language code for SEO keyword difficulty metrics. Default "en". |
location | integer | Optional | Location code for SEO keyword difficulty metrics. The default is the United States. Default 2840. |
Find AnyAPI SEO keyword ideas from seed terms with volume, CPC, competition, difficulty, and intent as normalized JSON. $0.01512 per keyword, one per call. $0.01512 per call (per keyword).
$0.01512 per keyword; one per item in keywords (max 1, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
closelyVariants | boolean | Optional | When true, generate only close variants of the seed keywords; when false (the default), generate a broader set of related ideas. |
keywords | array | Required | Seed SEO keywords used to generate related keyword ideas. Max 200 items. Example: ["project management software"] Max 1 per call; extras are dropped. |
language | string | Optional | Language code for SEO metrics. Default "en". |
limit | integer | Optional | Maximum number of keyword ideas to return. You are billed per returned result, so a lower limit costs less. Default 5. Max 1000. |
location | integer | Optional | Location code for SEO metrics. The default is the United States. Default 2840. |
orderBy | string | Optional | Sort order for the returned ideas: by search volume, cost per click, or keyword difficulty, ascending or descending. Omit for the default order. One of: volume_desc, volume_asc, cpc_desc, difficulty_asc, difficulty_desc. |
Get AnyAPI SEO keyword metrics including search volume, CPC, competition, difficulty, and search intent as normalized JSON. $0.01454 per keyword, one per call. $0.01454 per call (per keyword).
$0.01454 per keyword; one per item in keywords (max 1, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Required | SEO keywords to analyze. Max 700 items. Example: ["project management software"] Max 1 per call; extras are dropped. |
language | string | Optional | Language code for SEO metrics. Default "en". |
location | integer | Optional | Location code for SEO metrics. The default is the United States. Default 2840. |
Find AnyAPI SEO keyword suggestions from a seed term with volume, CPC, competition, difficulty, and intent as normalized JSON. Returns up to 5 results per call (page with cursor/page where offered). $0.01576 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
exactMatch | boolean | Optional | When true, only return suggestions that contain the exact seed phrase; when false (the default), allow reordered and partial-match suggestions. |
keyword | string | Required | Seed SEO keyword used to generate keyword suggestions. |
language | string | Optional | Language code for SEO metrics. Default "en". |
location | integer | Optional | Location code for SEO metrics. The default is the United States. Default 2840. |
orderBy | string | Optional | Sort order for the returned suggestions: by search volume, cost per click, or keyword difficulty, ascending or descending. Omit for the default order. One of: volume_desc, volume_asc, cpc_desc, difficulty_asc, difficulty_desc. |
Find AI answers that mention a domain or keyword, from Google AI Overviews or ChatGPT, each with the question asked, the answer, its cited sources, and AI search volume as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.132 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Optional | Domain whose mentions to find, without a protocol or leading www. Send domain or keyword, not both. |
keyword | string | Optional | Brand name or phrase whose mentions to find. Send domain or keyword, not both. |
language | string | Optional | Language code to restrict answers to, for example en. Omit for every language. |
location | integer | Optional | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. |
platform | string | Optional | AI surface to search: google for Google AI Overviews, chat_gpt for ChatGPT. One of: google, chat_gpt. Default "google". |
Rank the brands ChatGPT names most often in answers about a keyword or domain, each with mention count, AI search volume, and the sources and categories behind them as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.132 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
breakdownLimit | integer | Optional | How many entries each breakdown list (cited domains, brands, locations, and so on) carries. Default 5. Max 10. |
domain | string | Optional | Only count AI answers that mention or cite this domain, without a protocol or leading www. Send domain or keyword, not both. |
keyword | string | Optional | Only count AI answers that contain this word or phrase. Send domain or keyword, not both. |
language | string | Optional | Language code to restrict answers to, for example en. Omit for every language. |
location | integer | Optional | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. |
Rank the domains Google AI Overviews and ChatGPT cite most often in answers about a keyword or domain, each with mention count, AI search volume, and breakdowns by platform, location, and co-cited sources as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.132 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
breakdownLimit | integer | Optional | How many entries each breakdown list (cited domains, brands, locations, and so on) carries. Default 5. Max 10. |
domain | string | Optional | Only count AI answers that mention or cite this domain, without a protocol or leading www. Send domain or keyword, not both. |
keyword | string | Optional | Only count AI answers that contain this word or phrase. Send domain or keyword, not both. |
language | string | Optional | Language code to restrict answers to, for example en. Omit for every language. |
location | integer | Optional | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. |
platform | string | Optional | AI surface to count: google for Google AI Overviews, chat_gpt for ChatGPT. Omit for both. One of: google, chat_gpt. |
Rank the pages Google AI Overviews and ChatGPT cite most often in answers about a keyword or domain, each with mention count, AI search volume, and breakdowns by platform, location, and co-cited sources as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.132 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
breakdownLimit | integer | Optional | How many entries each breakdown list (cited domains, brands, locations, and so on) carries. Default 5. Max 10. |
domain | string | Optional | Only count AI answers that mention or cite this domain, without a protocol or leading www. Send domain or keyword, not both. |
keyword | string | Optional | Only count AI answers that contain this word or phrase. Send domain or keyword, not both. |
language | string | Optional | Language code to restrict answers to, for example en. Omit for every language. |
location | integer | Optional | Location code to restrict answers to, for example 2840 for the United States. Omit for every location. |
platform | string | Optional | AI surface to count: google for Google AI Overviews, chat_gpt for ChatGPT. Omit for both. One of: google, chat_gpt. |
Get the Google local pack for a keyword in a city: the short list of businesses Google shows in the map box on its normal search results page, in pack order, with rating, review count, address, category, opening hours, phone, website, booking link, and Google listing ids. Sponsored listings are left out. For the full Google Maps results list, use maps.search. $0.0024 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Required | Search keyword, for example coffee shop or plumber. |
language | string | Optional | Language code for the search results. Default "en". |
limit | integer | Optional | Maximum number of local pack businesses to return. Google usually shows three. Billing is flat per request. Max 100. |
location | string | Required | Location to search from, formatted like City,Region,Country; for example, New York,New York,United States. |
Get AnyAPI SEO ranked keywords for a domain with rankings, traffic estimates, volume, CPC, difficulty, and intent as normalized JSON. One call returns up to 1,000 keywords; use offset to page further. Returns up to 10 results per call (page with cursor/page where offered). $0.01656 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Language code for SEO ranking metrics. Default "en". |
location | integer | Optional | Location code for SEO ranking metrics. The default is the United States. Default 2840. |
offset | integer | Optional | Number of ranked keywords to skip in the chosen sort order. To fetch the next page, set offset to the previous offset plus limit, and keep the same orderBy, location, and language across pages. You are billed only for the keywords returned. Default 0. |
orderBy | string | Optional | Sort order for the returned ranked keywords: by SERP position (ascending for best rankings first), search volume, or estimated traffic value (etv). Omit for the default order. One of: position_asc, position_desc, volume_desc, etv_desc. |
target | string | Required | Domain to analyze, without a protocol or leading www. |
Get AnyAPI SEO referring domains for a domain or URL, each with its backlink count, authority rank, spam score, and first seen date as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0293 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeSubdomains | boolean | Optional | Count links pointing at the target's subdomains as well as the target itself. Default true. |
target | string | Required | Domain, subdomain, or full page URL to analyze. Send a domain without a protocol or leading www. |
Find AnyAPI SEO related keywords from a seed term with volume, CPC, competition, difficulty, and intent as normalized JSON. Returns up to 5 results per call (page with cursor/page where offered). $0.01576 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
depth | integer | Optional | Depth of the related-keyword expansion (0-4). Higher depth explores a broader keyword tree; the number of returned results, and therefore the price, is still capped by limit. Max 4. |
keyword | string | Required | Seed SEO keyword used to find related keywords. |
language | string | Optional | Language code for SEO metrics. Default "en". |
location | integer | Optional | Location code for SEO metrics. The default is the United States. Default 2840. |
orderBy | string | Optional | Sort order for the returned related keywords: by search volume, cost per click, or keyword difficulty, ascending or descending. Omit for the default order. One of: volume_desc, volume_asc, cpc_desc, difficulty_asc, difficulty_desc. |
Classify AnyAPI SEO keyword search intent as normalized JSON. $0.01454 per keyword, one per call. $0.01454 per call (per keyword).
$0.01454 per keyword; one per item in keywords (max 1, extra items are dropped)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Required | SEO keywords to classify by search intent. Max 1000 items. Example: ["seo tools"] Max 1 per call; extras are dropped. |
language | string | Optional | Language code for search intent classification. Default "en". |
Get AnyAPI SEO keyword search volume, CPC, competition, bid estimates, and monthly history as normalized JSON. $0.108 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
dateFrom | string | Optional | Start of the historical monthly-searches window, formatted YYYY-MM-DD. Cannot be more than four years before today. Omit for the default trailing window. |
dateTo | string | Optional | End of the historical monthly-searches window, formatted YYYY-MM-DD. Omit for the default trailing window. |
keywords | array | Required | SEO keyword phrases to retrieve search-volume metrics for. Max 1000 items. Example: ["seo tools"] |
language | string | Optional | Language code for SEO search-volume metrics. Default "en". |
location | integer | Optional | Location code for SEO search-volume metrics. The default is the United States. Default 2840. |
searchPartners | boolean | Optional | When true, include Google search-partner network volume in the reported numbers; when false (the default), count Google search only. |
Get AnyAPI SEO top pages of a domain by organic search, each with ranking keyword counts, estimated traffic and its ad value, and position distribution as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0159 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | Language code for search metrics. Default "en". |
location | integer | Optional | Location code for search metrics. The default is the United States. Default 2840. |
status | string | Optional | Count rankings the page holds now, rankings it has lost, or both. One of: live, lost, all. Default "live". |
target | string | Required | Domain to analyze, without a protocol or leading www. |
Look up one product on any public Shopify store by its handle or product page URL and get title, vendor, type, tags, description, price range, sale price, stock, images, options and every variant's SKU, price and stock in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
product | string | Required | Product handle, the slug after /products/ in the product URL, e.g. mens-strider; the full product page URL also works. |
store | string | Required | Domain or URL of a public Shopify store, e.g. allbirds.com or https://kith.com. A store on its own domain is addressed by that domain. |
List the products of any public Shopify store by its domain, a page at a time, with title, vendor, type, tags, price range, sale price, stock, images, options and every variant's SKU, price and stock. Filter by vendor, type, tag, title, SKU, price, sale, stock or recent arrivals. A domain that is not a public Shopify store comes back not found. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Products the store is asked for per page (1-250, default 250). The filters below are applied to that page, so a filtered page can hold fewer, even none while hasMore is true. Default 250. Max 250. |
maxPrice | number | Optional | Only products priced at or below this, in the store's currency. |
minPrice | number | Optional | Only products priced at or above this, in the store's currency. |
onlyInStock | boolean | Optional | Only products with at least one variant in stock. Default false. |
onlyOnSale | boolean | Optional | Only products with at least one discounted variant. Default false. |
page | integer | Optional | 1-based page of the store's product list. Each page is billed as one request. Default 1. |
productType | string | Optional | Only products whose product type contains this text, e.g. "Shoes". |
publishedWithinDays | integer | Optional | Only products published to the store within the last this many days. |
skuContains | string | Optional | Only products with a variant whose SKU code contains this text. |
store | string | Required | Domain or URL of a public Shopify store, e.g. allbirds.com or https://kith.com. A store on its own domain is addressed by that domain. |
tags | array | Optional | Only products carrying at least one of these tags. |
titleContains | string | Optional | Only products whose title contains this text. |
vendor | string | Optional | Only products whose vendor (brand) contains this text. |
Search one public Shopify store's products by keyword with the store's own search and get its top matches with title, vendor, type, tags, price range, sale price, stock and images. A domain that is not a public Shopify store comes back not found. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Search keywords, e.g. "wool" or "hoodie". |
store | string | Required | Domain or URL of a public Shopify store, e.g. allbirds.com or https://kith.com. A store on its own domain is addressed by that domain. |
Look up any public Shopify store by its domain and get its name, description, currency, country and city, the countries it ships to, its published product and collection counts and its social links in one normalized response. A domain that is not a public Shopify store comes back not found. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
store | string | Required | Domain or URL of a public Shopify store, e.g. allbirds.com or https://kith.com. A store on its own domain is addressed by that domain. |
Get the Similarweb traffic overview for any website: estimated monthly visits and a three-month history, global, country, and category rank, bounce rate, pages per visit, visit duration, traffic sources including AI chatbots, top countries, and top search keywords - as normalized JSON. $0.00082 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Required | The website's domain, without a scheme or path (e.g. stripe.com). |
Find the websites Similarweb ranks as most similar to any website: up to 20 competitor and alternative sites in similarity order, each with its similarity score, category, top-country rank, estimated monthly visits, and description - as normalized JSON. $0.00083 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Required | The website's domain, without a scheme or path (e.g. stripe.com). |
Fetch one Slickdeals deal by URL and get title, price, list price, store, coupon code, score, views, comments, and description in one normalized response. $0.00213 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Slickdeals deal page URL, e.g. https://slickdeals.net/f/20177112-lg-55-c6-series-oled-evo-ai-4k-smart-webos-tv-2026-best-buy-amazon-999-99. |
Search Slickdeals deals by keyword with optional sort, price, discount, and page filters and get title, price, list price, store, score, and comment count for each deal in one normalized response. $0.00213 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
hideExpired | boolean | Optional | Optional; true leaves out deals the community marked expired. |
maxPrice | number | Optional | Optional maximum deal price in USD; deals without a numeric price are left out. |
minDiscount | integer | Optional | Optional; keep only deals at least this many percent off the list price, e.g. 50. Max 99. |
minPrice | number | Optional | Optional minimum deal price in USD; deals without a numeric price are left out. |
page | integer | Optional | 1-based page of 40 deals; Slickdeals stops at page 25. Each page is billed as one request. Default 1. Max 25. |
query | string | Required | Search keywords, e.g. "airpods" or "laptop". |
sort | string | Optional | Result order; omit for Slickdeals' relevance order (e.g. new for the most recently posted deals first). One of: best_match, new, popular, price_low, price_high. |
Fetch a Snapchat user's public profile by username: display name, bio, subscriber count, and recent public content. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
username | string | Required | The Snapchat username or profile URL to look up (e.g. fcbarcelona or https://www.snapchat.com/add/fcbarcelona). |
Find a person's or brand's profiles across major social networks from a single name, returned as normalized JSON. Returns up to 10 results per call (page with cursor/page where offered). $0.0231 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
name | string | Required | The profile name or handle to search for across social networks (e.g. johndoe). |
platform | string | Optional | Limit the search to one network: askfm, discord, facebook, github, instagram, linkedin, medium, pinterest, steam, threads, tiktok, twitch, or youtube (e.g. instagram); all networks are searched when omitted. |
Fetch a Spotify album's tracklist, play counts, label, and release details by album URL or ID. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | Spotify album ID (alternative to url). |
url | string | Optional | Spotify album URL (e.g. https://open.spotify.com/album/0pgrg7phBbnwGJ2HBEl9EG). |
Fetch a Spotify artist's discography (albums, singles, top tracks) and metadata by artist URL or ID. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | Spotify artist ID (alternative to url). |
url | string | Optional | Spotify artist URL (e.g. https://open.spotify.com/artist/3DiDSECUqqY1AuBP8qtaIa). |
Fetch stream counts and stats for a Spotify track, album, or artist URL. $0.0022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Spotify track, album, or artist URL to fetch stream counts for (e.g. https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp). |
Fetch a Spotify podcast show's name, publisher, description, rating, and topics by show URL or ID. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | Spotify podcast show ID (alternative to url). |
url | string | Optional | Spotify podcast show URL (e.g. https://open.spotify.com/show/3mliji9352UAk3XnWElnDV). |
List a Spotify podcast show's episodes with titles, durations, descriptions, and release dates by show URL or ID. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response for subsequent pages. |
id | string | Optional | Spotify podcast show ID (alternative to url). |
url | string | Optional | Spotify podcast show URL (e.g. https://open.spotify.com/show/4rOoJ6Egrf8K2IrywzwOMk). |
Search Spotify for matching tracks, albums, artists, podcasts, and playlists by keyword. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Search term (e.g. "my first million"). |
Fetch a Spotify track's play count, popularity, duration, and album details by track URL or ID. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | Spotify track ID (alternative to url). |
url | string | Optional | Spotify track URL (e.g. https://open.spotify.com/track/4cOdK2wGLETKBW3PvgPWqT). |
Pull posts from any Substack publication by its URL, or pass a single post URL (…/p/slug) to fetch just that one article. Returns title, subtitle, publish date, paywall status, word count, engagement (reactions, comments, restacks), author profile, publication details, the full article body as text, HTML and Markdown, and optional comment threads. Returns up to 10 results per call (page with cursor/page where offered). $0.02679 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
contentType | string | Optional | Restrict to a single post type, or 'all' (e.g. newsletter). One of: all, newsletter, podcast, thread. Default "all". |
endDate | string | Optional | Only return posts published on or before this date, format YYYY-MM-DD (e.g. 2024-12-31). Applied within the most recent 'limit' posts scanned. |
includeComments | boolean | Optional | Include public comment threads and their direct replies on each post (e.g. true). Default false. |
includeContent | boolean | Optional | Include the full article body as text, HTML and Markdown. Set false for metadata only, which is faster (e.g. false). Default true. |
maxComments | integer | Optional | Maximum comments collected per post when 'includeComments' is true (0-500, default 20). Costs nothing extra (e.g. 50). Max 500. |
minComments | integer | Optional | Only return posts with at least this many comments (e.g. 10). |
minReactions | integer | Optional | Only return posts with at least this many reactions (e.g. 100). |
minWordCount | integer | Optional | Only return posts with at least this many words, which filters out short notes and announcements (e.g. 1000). |
onlyFree | boolean | Optional | Return only free (non-paywalled) posts (e.g. true). Default false. |
startDate | string | Optional | Only return posts published on or after this date, format YYYY-MM-DD (e.g. 2024-01-01). Applied within the most recent 'limit' posts scanned, so raise 'limit' to reach older date ranges. |
url | string | Required | Either a Substack publication URL / custom domain to fetch its recent posts (e.g. https://www.astralcodexten.com), OR a single post URL to fetch just that one article with full content (e.g. https://www.astralcodexten.com/p/your-book-review). |
Fetch a Target.com product by URL and get title, price, brand, rating, description, and images in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Target product page URL; the TCIN after /A- identifies the product (e.g. https://www.target.com/p/-/A-91863920). |
Pull a page of 10 customer reviews for any Target.com product by URL, newest first or by helpfulness or rating: rating, title, text, date, reviewer, and verified-purchase badge. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based page of 10 reviews. Each page is billed as one request; keep url and sort the same while walking pages. Default 1. |
sort | string | Optional | Review order: recent (newest first, the default), helpful, rating_high, or rating_low (e.g. helpful). One of: recent, helpful, rating_high, rating_low. Default "recent". |
url | string | Required | Target product page URL; the TCIN after /A- identifies the product (e.g. https://www.target.com/p/-/A-91863920). |
Search Target.com by keyword with optional sort, price-range, and page filters and get title, price, rating, and brand for each product in one normalized response. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
maxPrice | number | Optional | Optional maximum product price in USD. |
minPrice | number | Optional | Optional minimum product price in USD. |
page | integer | Optional | 1-based results page of 24 products; Target serves no products past page 50. Each page is billed as one request. Default 1. Max 50. |
query | string | Required | Search keywords, e.g. "coffee maker" or "lego". |
sort | string | Optional | Result sort order; omit for Target's own relevance order (e.g. price_low sorts by lowest price first). One of: best_match, best_seller, price_low, price_high, rating_high, new. |
Read the technology stack TheirStack detects for a company from its job posts, with how many posts mention each technology, when it was first and last seen, and how dominant it is within its category. Billed per technology returned. Returns up to 25 results per call (page with cursor/page where offered). $4.98 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
companyDomain | string | Optional | Only return companies that match this domain exactly. It accepts full urls (https://www.google.com/) and emails (john.polo@gmail.com). |
companyId | string | Optional | Only return companies that match this TheirStack Company ID exactly. This ID is temporary and internal and will change in the future and become stable. Until then, it is only meant to be used internally by our UI (app.theirstack.com). For deduplication logic, use company_domain or... |
companyKeywordSlugOr | array | Optional | Return companies that have mentioned any of these keywords (technologies or buying intent topics) in their jobs. Case sensitive. Pass slugs. Check out all keywords at GET /v0/catalog/keywords |
companyLinkedinUrl | string | Optional | Return companies whose LinkedIn URL matches this URL exactly. |
companyName | string | Optional | Only return companies that match this name exactly, case-sensitively. |
companyNameOr | array | Optional | Only return companies that match these names exactly, case-sensitively. Deprecated, use the `company_name` filter instead. |
companyTechnologySlugOr | array | Optional | Return companies that have mentioned any of these keywords (technologies or buying intent topics) in their jobs. Case sensitive. Pass slugs. Check out all keywords at GET /v0/catalog/keywords |
confidenceOr | array | Optional | Returns technologies with any of these confidence values that the companies use them. Available values: "high", "medium", "low" |
firstDateFoundGte | string | Optional | Only return technologies where the first time they were found was after or on this date. Format: "YYYY-MM-DD" |
firstDateFoundLte | string | Optional | Only return technologies where the first time they were found was before or on this date. Format: "YYYY-MM-DD" |
includeTotalResults | boolean | Optional | When enabled, calculates and returns `total_results` and `total_companies` fields in the response. WARNING: This significantly slows down responses as it requires reading the entire dataset. Recommended usage: enable only for the initial request to get totals, then disable for subsequent... |
keywordCategorySlugOr | array | Optional | Return companies that have mentioned any keyword from any of these categories in their jobs. Case sensitive. Pass slugs. Check out all keyword categories at GET /v0/catalog/keywords/categories |
keywordParentCategorySlugOr | array | Optional | Return companies that have mentioned any keyword from any of these parent categories in their jobs. Case sensitive. Pass slugs. Check out all keyword categories at GET /v0/catalog/keywords/categories |
keywordSlugOr | array | Optional | Return companies that have mentioned any of these keywords (technologies or buying intent topics) in their jobs. Case sensitive. Pass slugs. Check out all keywords at GET /v0/catalog/keywords |
lastDateFoundGte | string | Optional | Only return technologies where the last time they were found was after or on this date. Format: "YYYY-MM-DD" |
lastDateFoundLte | string | Optional | Only return technologies where the last time they were found was before or on this date. Format: "YYYY-MM-DD" |
maxJobs | integer | Optional | Maximum number of jobs found by each company using a technology |
maxRank | integer | Optional | The rank measures how common is a technology within its category. The technology most used among similar ones by a company will have a rank of 1, the second: 2, etc. This is useful to filter results by technology and get only results for the primary technology. |
minJobs | integer | Optional | Minimum number of jobs found by each company using a technology |
minRelativeOccurrence | number | Optional | Minimum value of relative_occurrence_within_category for each technology. Higher values increase the probability that this technology is actually used by the company, because it means a higher percentage of mentions to technologies among this category are of this technology. |
offset | integer | Optional | Number of results to skip. Required for offset-based pagination. |
orderBy | array | Optional | List of column objects. You can pass several columns to order by, in order of priority. Only `field` is required, `desc` is True by default. |
page | integer | Optional | Page number. Required when using page-based pagination. |
technologyCategorySlugOr | array | Optional | Deprecated: use `keyword_category_slug_or` instead. Will return companies that have mentioned any keyword from any of these categories in their jobs. Case sensitive. Pass slugs. |
technologyParentCategorySlugOr | array | Optional | Deprecated: use `keyword_parent_category_slug_or` instead. Will return companies that have mentioned any keyword from any of these parent categories in their jobs. Case sensitive. Pass slugs. |
technologySlugOr | array | Optional | Deprecated: use `keyword_slug_or` instead. Will return companies that have mentioned any of these technologies in their jobs. Case sensitive. Pass slugs. |
Get a public Telegram channel by username: name, bio, photo, verified badge, exact subscriber count, and how many photos, videos, files and links it has posted. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Public Telegram channel username, with or without the @ (e.g. "telegram"), or its t.me link. |
Get a public Telegram channel's posts by username, about 20 per page with a cursor for older pages: text, posting time, views, photo and video links, and reactions. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor, for older posts. Omit for the newest page; a page holds about 20 posts. |
handle | string | Required | Public Telegram channel username, with or without the @ (e.g. "telegram"), or its t.me link. |
Get one public Telegram channel post by its t.me link: text, posting time, views, photo and video links, and reactions. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Link to one public channel post, e.g. https://t.me/telegram/460 (t.me/s/ links work too). |
Fetch a single Threads post by URL: text, author, engagement counts, and timestamp. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | The full URL of the Threads post to fetch (e.g. https://www.threads.com/@zuck/post/C8yKXdRxKqK). |
Fetch a Threads user's public profile (bio, follower count, verification, profile picture) by username. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
username | string | Required | The Threads username to look up, without the @ prefix (e.g. zuck). |
Search public Threads posts by keyword or hashtag and get normalized post records: text, author, and engagement. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
endDate | string | Optional | Only return posts published on or before this date, format YYYY-MM-DD (e.g. 2026-08-07). Threads pages backwards in time from here, so narrowing this is how you walk older results. |
query | string | Required | Keyword or #hashtag to search public Threads posts for (e.g. Widgetable). A #hashtag can return different posts than the plain word, so if a tag returns nothing, try the word without #. Single words and brand names return the most; quotes around the whole query are removed, since quoted searches... |
startDate | string | Optional | Only return posts published on or after this date, format YYYY-MM-DD (e.g. 2026-08-01). |
Search Threads users by name or username and get normalized profile records: username, full name, verification, and picture. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | The name or username to search Threads users for. |
List a Threads user's recent public posts by username: text, engagement counts, and post URLs. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | The Threads username to list posts for, without the @ prefix. |
List the TikTok Shop category tree for a market: top-level categories with ids, slugs, and images, each with its child categories. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
region | string | Optional | Country code of the TikTok Shop market whose category tree to list. Only US and VN publish a category tree. One of: US, VN. Default "US". |
TikTok Shop creator performance by handle: GMV range, promoted product count, brand collaborations, follower age/gender/location demographics, category GMV split, and video versus live engagement. $0.0055 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | TikTok handle of the creator or shop account, without the @ (e.g. golinutrition). |
region | string | Optional | Country code of the TikTok Shop market. Only the US market is served; creators in other markets are not available. One of: us, US. Default "us". |
Fetch TikTok Shop product details (title, price, sales, seller, and ratings) from a product URL. $0.00095 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
region | string | Optional | Two-letter country code for the proxy location used to access region-specific products (e.g. US, GB, FR). Defaults to US. |
url | string | Required | TikTok Shop product detail page URL (e.g. https://www.tiktok.com/shop/pdp/.../1729587769570529799). |
Fetch customer reviews for a TikTok Shop product by URL (rating, text, reviewer, country, and verified-purchase flag). $0.00095 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based results page. Use with hasMore in the output to paginate. Default 1. |
region | string | Optional | Two-letter country code of the product's shop region (e.g. US). Strongly recommended for correct results. |
url | string | Required | TikTok Shop product URL (e.g. https://www.tiktok.com/shop/pdp/.../1729385633899532161). |
Search TikTok Shop products by keyword across 15 countries: price, sales, rating, and seller info per product, in one normalized response. $0.00095 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Country code of the TikTok Shop market to search (e.g. US). One of: US, VN, TH, PH, MY, ID, GB, SG, ES, MX, DE, IT, FR, BR, JP. Default "US". |
limit | integer | Optional | Maximum products to return, honoured on US searches up to 30. Other countries and larger values return every product TikTok Shop gives for the query, typically about 30 and occasionally more than 50. The price per call is the same either way. |
query | string | Required | Search keyword for TikTok Shop products (e.g. wireless earbuds). |
Get TikTok Shop search autocomplete terms for a keyword: the long-tail queries shoppers actually type, for keyword and demand research. $0.00095 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Optional | Two-letter country code of the TikTok Shop market (e.g. US). Default "US". |
language | string | Optional | Language tag for the suggestions (e.g. en-US). Default "en-US". |
query | string | Required | Seed keyword to expand (e.g. ashwagandha gummies). |
List every product of a TikTok Shop store by URL (title, price, sales, and rating per product plus shop-level stats) with cursor pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. |
region | string | Optional | Two-letter country code of the store's market (e.g. US). |
sortBy | string | Optional | Product ordering within the store. One of: top, new_releases. Default "top". |
url | string | Required | TikTok Shop store URL (e.g. https://www.tiktok.com/shop/store/<name>/<id> or https://shop.tiktok.com/us/store/<name>/<id>). The link must include the store's numeric id, the long number after the store name: a link with only the name (tiktok.com/shop/store/<name>) does not open a store page on... |
List the TikTok Shop products a creator showcases (title, price, rating, and sales per product). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination token for retrieving subsequent product pages. |
handle | string | Required | The handle of the TikTok user (e.g. mrtiktokreviews). |
region | string | Optional | Geographical region for proxy placement (defaults to US). |
Fetch full details for a single TikTok ad (brand, title, spend, CTR, objectives, landing page, and video info). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adId | string | Required | TikTok Top Ads material/ad ID, or a Top Ads detail URL (e.g. 7648493525660270600). |
Search TikTok's public Ads Library by keyword or advertiser (advertiser, title, audience band, run dates, library link, and video). $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
advertiserName | string | Optional | Advertiser name to list ads for (e.g. Spotify). Provide advertiserName or query, never both. |
cursor | string | Optional | Opaque cursor from a previous response's nextCursor. Omit it for the first page. |
query | string | Optional | Keyword to search ad titles and content (e.g. spotify). Provide query or advertiserName, never both. |
region | string | Optional | Two-letter region code for TikTok's Commercial Content Library, such as DE, FR, GB or IT. Each region holds a different set of ads. Omit it to take the library's own default region, DE. Coverage is the EU and EEA; a non-EU code such as US is not served. |
Search TikTok's EU Commercial Content Library by keyword or advertiser ID. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
advertiserId | string | Optional | TikTok Commercial Content Library advertiser ID. Provide advertiserId or query. |
cursor | string | Optional | Search cursor from a previous response's nextCursor. |
days | integer | Optional | Number of days of Commercial Content Library history to search, from 1 to 365. Defaults to 30. Default 30. Max 365. |
limit | integer | Optional | Maximum number of ads to return, from 1 to 50. Defaults to 50. Billing is flat per request. Default 50. Max 50. |
offset | integer | Optional | Zero-based result offset. Defaults to 0. Default 0. |
query | string | Optional | Keyword to search in TikTok's EU Commercial Content Library. Provide query or advertiserId. |
region | string | Optional | Region code for the transparency search. Defaults to DE. Default "DE". |
sort | string | Optional | Upstream sort expression. Defaults to last_shown_date,desc. Default "last_shown_date,desc". |
Get the audience country breakdown (follower count and share per country) for a TikTok creator by handle. $0.016 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | TikTok username without the leading @ (e.g. "shakira"). |
List the replies to a TikTok comment with cursor pagination (text, author, likes). $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
commentId | string | Required | TikTok comment ID (the comment's cid from the comments endpoint). |
cursor | string | Optional | Pagination cursor from a previous response. |
url | string | Required | TikTok video URL the comment belongs to, on tiktok.com: a video or photo post (https://www.tiktok.com/@<user>/video/<id> or /photo/<id>) or a vm.tiktok.com, vt.tiktok.com or tiktok.com/t/ share link. A /video/ or /photo/ link without the post's numeric id, a profile link... |
List the followers of a TikTok account by username, returning each follower's profile basics. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor, to fetch the next page of followers. |
handle | string | Required | TikTok username whose followers to list, without the @ prefix (e.g. stoolpresidente). |
List the accounts a TikTok user follows (handle, display name, follower count, bio) by username. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
handle | string | Required | TikTok username without the leading @ (e.g. "stoolpresidente"). |
requireCursor | boolean | Optional | Deprecated; send `requireFields: ["nextCursor"]` instead, which does exactly the same thing. Set true if you intend to page through results, so the request is only served by a source that can return a nextCursor. Omit it and routing is unchanged, with the cheapest source serving. This can raise... |
List recent TikTok videos for a hashtag (creator, caption, views, likes, shares). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of videos. |
hashtag | string | Required | TikTok hashtag to fetch videos for, without the # prefix (e.g. booktok). |
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Max 20. |
Check whether a TikTok creator is live and get the current live room (title, viewers, start time) by handle. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | TikTok username without the leading @ (e.g. "thejustalex"). |
Get every image in a TikTok photo-mode (slideshow) post by URL, in order, with pixel dimensions and both the clean and watermarked variant of each. Videos carry no images - use tiktok.video_download for those. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full TikTok photo-mode post URL. TikTok serves slideshow posts under the same /video/<id> path as videos, so the normal share link works. |
List the videos inside one TikTok playlist by playlist URL or id, in playlist order, with view, like and comment counts. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
id | string | Optional | TikTok playlist id. Use it when tiktok.profile_playlists handed you the id. |
limit | integer | Optional | Maximum items to return in one page. Default 20. Max 30. |
url | string | Optional | Full TikTok playlist URL. The playlist id is the numeric run at the end. |
Fetch a TikTok creator's public profile (followers, likes, bio, verification) by handle. $0.0004 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | TikTok username without the leading @ (e.g. "stoolpresidente"). |
Find the public contact email behind a TikTok creator's profile: the address written into the bio plus any published on the site the profile links to, each labelled with where it came from. Returns the creator's profile stats and linked social accounts alongside. $0.00088 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | TikTok username without the leading @. |
List the playlists a TikTok creator has published on their profile, with each playlist's name, video count and cover image. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
limit | integer | Optional | Maximum items to return in one page. Default 20. Max 30. |
secUid | string | Required | TikTok's opaque sec_uid for the account. TikTok's own endpoint keys on it and will not accept a handle; call tiktok.profile with the handle first and read secUid off its response. |
Resolve the home region (country) of a TikTok creator by handle. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | TikTok username without the leading @ (e.g. "stoolpresidente"). |
List the videos a TikTok creator has reposted to their profile, with view, like and comment counts and cursor pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
limit | integer | Optional | Maximum items to return in one page. Default 30. Max 30. |
secUid | string | Required | TikTok's opaque sec_uid for the account. TikTok's own endpoint keys on it and will not accept a handle; call tiktok.profile with the handle first and read secUid off its response. |
List a TikTok creator's recent videos (views, likes, comments) by handle with cursor pagination. $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
handle | string | Required | TikTok username without the leading @. |
Search TikTok by hashtag and get matching videos (caption, views, likes, comments, shares) as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
query | string | Required | Hashtag or keyword to search for (without the leading #). |
Search TikTok by keyword and get matching videos (caption, views, likes, comments, shares) as normalized JSON. $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
datePosted | integer | Optional | Time frame filter, in days back from now. Use a canonical JSON integer that is nonnegative: 0 for any time, 1 for the past 24 hours, 7 for the past week, 30 for the past month, 90 for the past three months, or 180 for the past six months. Any other number is not guaranteed to filter anything.... Default 0. |
query | string | Required | The keyword to search TikTok for. |
requireCursor | boolean | Optional | Deprecated: name `nextCursor` in `requireFields` instead, which is the field this flag is translated into. It stays accepted so callers that already send it keep working. Sending it routes you to a source that returns a pagination cursor, which can raise your price when the cheapest source... |
sortBy | string | Optional | Sort order: relevance, most-liked, date-posted. One of: relevance, most-liked, date-posted. Default "relevance". |
Search TikTok for photo-mode (slideshow) posts by keyword, with every image in each post plus view, like and comment counts. tiktok.search_keyword returns videos and drops these. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
limit | integer | Optional | Maximum items to return in one page. Default 30. Max 30. |
query | string | Required | Search keyword. |
Get the search terms TikTok suggests for a keyword, each with its language and relative weight - the queries real TikTok users type around your topic. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
query | string | Required | Seed keyword to expand. |
Search TikTok's top results for a keyword (caption, views, likes, comments, shares) with cursor pagination. $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response. |
publishTime | string | Optional | Time-frame filter: yesterday, this-week, this-month, last-3-months, last-6-months, all-time. One of: yesterday, this-week, this-month, last-3-months, last-6-months, all-time. |
query | string | Required | Keyword to search for (e.g. "funny"). |
region | string | Optional | 2-letter country code for the proxy location (e.g. US, GB, FR). |
sortBy | string | Optional | Sort order: relevance, most-liked, date-posted. One of: relevance, most-liked, date-posted. |
Search TikTok accounts by keyword (handle, nickname, follower count) with cursor pagination. $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
query | string | Required | The keyword to search TikTok accounts for. |
Fetch details for a TikTok song or sound (title, author, duration, cover art, and how many videos use it). $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
clipId | string | Required | The clip identifier for the song, found in TikTok music URLs (e.g. 7439295283975702544). |
List TikTok videos that use a given song or sound (with descriptions, authors, and engagement stats). $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
clipId | string | Required | The song ID found in TikTok music URLs (e.g. 7439295283975702544). |
cursor | string | Optional | Pagination cursor for retrieving the next page of results. |
Search TikTok Creative Center top video ads by keyword, with campaign objective, performance percentile, and time-window filters. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of ads requested for this page, from 1 through 20 (default 20). Default 20. Max 20. |
objective | string | Optional | Campaign objective filter. Omit it to search every objective. One of: traffic, app_installs, conversions, video_views, reach, lead_generation, product_sales. |
page | integer | Optional | One-based provider page number (default 1). Default 1. |
performanceRank | string | Optional | Ad performance percentile bucket, where top_1_20 is the highest-performing 20 percent. Omit it to search every bucket. One of: top_1_20, top_21_40, top_41_60, top_61_80. |
period | integer | Optional | Lookback period in days (default 180). One of: 7, 30, 180. Default 180. |
query | string | Required | Keyword to search in TikTok Creative Center top video ads. |
Sample TikTok's For You feed as served to a viewer in one country (caption, views, likes, comments, author). Returns a rotating sample, not a ranked chart. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
region | string | Required | 2-letter country code for the proxy location (e.g. "US"). |
trim | string | Optional | Set to true to return a simplified response. |
Rank TikTok's trending hashtags for one country and industry, with each hashtag's daily popularity curve, post count, video views, and leading creators. Ranks 15 industry categories, or omit industry for the all-industries board. TikTok publishes only the top 3 hashtags per board to anonymous callers, so limit 1-3 is served cheaply; a limit above 3 routes to a dearer authenticated source that returns the full ranking. Covers 27 markets: AE, AR, AU, BR, CA, CO, DE, EG, ES, FR, GB, ID, IL, IT, JP, KR, MX, MY, PH, SA, SG, TH, TR, TW, US, VN, ZA. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
industry | string | Optional | Restrict the ranking to one industry. Omit for the all-industries board. One of: apparel_accessories, baby_kids_maternity, beauty_personal_care, education, food_beverage, games, health, home_improvement, household_products, news_entertainment, pets, sports_outdoor, tech_electronics, travel, vehicle_transportation. |
limit | integer | Optional | Maximum number of ranked hashtags to return, from 1 through 100 (default 3). TikTok publishes only the top 3 hashtags per board to anonymous callers, so 1 through 3 is served by the cheapest source; a higher limit routes to a dearer source that reads the full ranking. Default 3. Max 100. |
period | integer | Optional | Lookback window in days that the ranking and the popularity curve cover (default 7). One of: 7, 30, 90. Default 7. |
region | string | Optional | Two-letter country code of the market whose hashtag ranking to read (default US). Each market is ranked independently, so US and DE return different boards. Default "US". |
Get a TikTok creator's active public stories by username: video or photo links, cover, posting and expiry times, and view, like, share and save counts. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | TikTok username, without the @ (e.g. "jasonderulo"). |
Fetch a single TikTok video by URL with its caption and engagement counts (views, likes, comments, shares, saves). $0.0004 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | TikTok video ID, the numeric run at the end of a video URL. Use it when a listing SKU handed you an id and no URL. |
url | string | Optional | Full TikTok video URL. |
List the comments on a TikTok video by URL with cursor pagination (text, author, likes, reply count). $0.0006 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. |
url | string | Required | TikTok post URL on tiktok.com: a video or photo post (https://www.tiktok.com/@<user>/video/<id> or /photo/<id>) or a vm.tiktok.com or vt.tiktok.com short link. A profile link (https://www.tiktok.com/@<user>), a video file link (tiktokcdn.com) or a link to any other site is refused as invalid... |
Get the playable media files behind a TikTok video URL: the clean no-watermark MP4, the watermarked one TikTok's own save button produces, and the cover image, with duration and pixel dimensions. Photo-mode posts carry no video file - use tiktok.photos for those. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full TikTok video URL. Share links and tracking query params are fine. |
Fetch the caption track TikTok itself published for a video, as TikTok wrote it. It is the cheapest way to get the words, and it is only as good as TikTok's own transcription: it mishears names and uncommon words, and many videos - especially non-English ones - have no caption track at all, which comes back as not found. When you need the words to be right, or there is no track to read, tiktok.video_transcript_full transcribes the audio with AnyAPI's own speech-to-text instead. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | TikTok video URL on tiktok.com: a video or photo post (https://www.tiktok.com/@<user>/video/<id> or /photo/<id>) or a vm.tiktok.com, vt.tiktok.com or tiktok.com/t/ share link. A profile link (https://www.tiktok.com/@<user>), a /@<user>/<id> link without /video/ (TikTok sends it to the For You... |
Transcribe the spoken audio of a TikTok video with AnyAPI's own speech-to-text: timed sentence-level segments, speaker labels, detected language, and optional per-word timings, for videos TikTok publishes no caption track for and for videos whose caption track gets the words wrong. AnyAPI downloads the video and runs the audio through MAI-Transcribe-2 rather than reading anything TikTok wrote, which is why it handles non-English speech and hears words the native captions mishear. The answer also carries the video's id, URL, creator handle, and cover image. Turn on hostVideo to also get the MP4 on a hosted link that plays without TikTok's signed, short-lived CDN URL expiring on you. If you only want whatever TikTok itself published and you want it for a tenth of the price, tiktok.video_transcript is that. $0.095 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
hostVideo | boolean | Optional | Also store the video and return a hosted MP4 link that plays without TikTok's signed CDN URL. Charged as an extra on top of the transcript. Default false. |
url | string | Required | TikTok video URL (e.g. "https://www.tiktok.com/@user/video/1234567890"). |
wordTimestamps | boolean | Optional | Return per-word timings inside each segment. Words carry timings only; the recognizer scores a phrase rather than a word, so there is no per-word confidence to report. Default false. |
Fetch the latest reviews for any Tripadvisor hotel, restaurant, or attraction by its page URL: rating, text, date, and trip details as normalized JSON. $0.003 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor from a previous response's nextCursor. Omit for the first page. |
languages | array | Optional | Only return reviews originally written in these ISO 639-1 languages (e.g. ["en", "es"]); omit for all languages. Reviews are never translated. Each page is filtered after it is fetched, so a page can hold fewer than `limit` reviews, or none, while nextCursor still leads to more. |
limit | integer | Optional | Reviews per page (1-20, default 20). Sources that page return one page of up to `limit` reviews, newest first, with a nextCursor for the next page; sources that cannot page return up to `limit` reviews in one call with no nextCursor. Max 20. |
ratings | array | Optional | Only return reviews whose bubble rating is in this set (e.g. ["5", "4"] for 4 and 5 star reviews); omit for all ratings. One of: 1, 2, 3, 4, 5. |
since | string | Optional | Only return reviews newer than this date, YYYY-MM-DD or a relative window like '3 months' (e.g. 2026-01-01). |
url | string | Required | Tripadvisor page URL of the hotel, restaurant, or attraction, carrying its -d<id>- place id (e.g. https://www.tripadvisor.com/Hotel_Review-g60763-d93450-Reviews-The_Plaza-New_York_City_New_York.html). Any other link, such as a city listing page or a site that is not Tripadvisor, is refused as... |
Search Tripadvisor for hotels, restaurants, and attractions in any destination and get rich place records (ratings, review counts, contact details, pricing) as normalized JSON. $0.003 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
currency | string | Optional | ISO currency code for prices (e.g. USD, EUR). Default "USD". |
includeAttractions | boolean | Optional | Include attractions and things to do in the results; set false to exclude them (e.g. false). Defaults to true. Default true. |
includeHotels | boolean | Optional | Include hotels in the results; set false to exclude them (e.g. false). Defaults to true. Default true. |
includeRestaurants | boolean | Optional | Include restaurants in the results; set false to exclude them (e.g. false). Defaults to true. Default true. |
limit | integer | Optional | Maximum number of results to return (1-20, default 20). Max 20. |
query | string | Required | Destination or keyword to search for (e.g. Barcelona). |
Pull Trustpilot reviews for any company by brand name: star ratings, review text, dates, and reviewer details as clean JSON. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
company | string | Required | Brand name or Trustpilot review-page URL to fetch reviews for (e.g. nike or https://www.trustpilot.com/review/nike.com). |
countries | array | Optional | Only return reviews from reviewers in these ISO 3166-1 alpha-2 countries (e.g. ["US", "GB"]). Omit this field for all countries and to stay on the cheapest price; a country filter routes to the dearest source. |
languages | array | Optional | Only return reviews in these ISO 639-1 languages (e.g. ["en", "de"]). Omit this field for all languages and to stay on the cheapest price; a language filter routes to the dearest source. |
limit | integer | Optional | Maximum number of results to return (1-200, default 200). Trustpilot serves at most 200 reviews per company. Default 200. Max 200. |
sortBy | string | Optional | Review ordering: auto, relevancy, or recent (e.g. recent). One of: auto, relevancy, recent. Default "auto". |
stars | string | Optional | Limit reviews to a single star rating from 1 to 5 (e.g. 5). |
startDate | string | Optional | Only return reviews on or after this date, inclusive, in YYYY-MM-DD format (e.g. 2026-01-01). Omit this field to stay on the cheapest price; a date floor routes to the dearest source. |
verifiedOnly | boolean | Optional | Set true to return only verified reviews (e.g. true). Omit this field, or send false, to stay on the cheapest price; true routes to a dearer source. Default false. |
Get a single Truth Social post by its URL - text, author, engagement (likes, comments, shares), and timestamp as clean JSON. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Full Truth Social post URL, e.g. "https://truthsocial.com/@realDonaldTrump/posts/116824551176646175". |
Get a Truth Social account's public profile by handle - display name, bio, follower/following counts, and post count as clean JSON. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Truth Social handle without the @, e.g. "realDonaldTrump". |
List a Truth Social account's recent posts by handle - text, engagement (likes, comments, shares), and timestamps as clean JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; a page holds 20 posts. |
handle | string | Required | Truth Social handle without the @, e.g. "realDonaldTrump". |
Get a public X long-form article from its wrapper post URL, including its author, engagement, cover image, and structured content blocks. $0.00049 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Canonical x.com or twitter.com URL of the public wrapper post for an X Article. |
Fetch a Twitter/X community's public details (name, description, member count, join policy) by URL. $0.0001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Community URL (e.g. https://x.com/i/communities/1926186499399139650). |
List recent tweets posted in a Twitter/X community by URL. $0.00045 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Community URL (e.g. https://x.com/i/communities/1926186499399139650). |
Fetch the follower list of any public X (Twitter) account by username with cursor pagination. Limit is a per-page maximum and a native page holds up to 200 accounts; follow the response's nextCursor for more. $0.00045 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of followers. |
limit | integer | Optional | Accepted but does not change the page: every call returns one full native page of followers (up to 200, depending on the source), never trimmed, so follow nextCursor to continue exactly where this response ended. Default 200. Max 100000. |
username | string | Required | The X (Twitter) username to fetch followers for, without the @ prefix (e.g. elonmusk). |
List the accounts a public X (Twitter) account follows by username with cursor pagination. Limit is a per-page maximum; follow the response's nextCursor for more. $0.00045 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of followed accounts. |
limit | integer | Optional | Accepted but does not change the page: every call returns one full native page of followed accounts (about 50), never trimmed, so follow nextCursor to continue exactly where this response ended. Default 200. Max 100000. |
username | string | Required | The X (Twitter) username to fetch the following list for, without the @ prefix (e.g. elonmusk). |
Fetch a Twitter/X account's public profile (followers, tweets, bio, verification) by handle. $0.00022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
handle | string | Required | Twitter/X handle without the leading @. |
Fetch the replies to any X (Twitter) post URL as structured records: author, text, and engagement. An empty result is valid and does not assert whether the target post exists. $0.00045 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of replies. |
limit | integer | Optional | Maximum number of results to return (1-40, default 40). Per-result lanes cost less at lower limits; a backup that bills its native page may cost up to the advertised request price. Max 40. |
url | string | Required | Full URL of the X (Twitter) post to fetch replies for (e.g. https://x.com/nasa/status/1846987139428634858). |
Search X (Twitter) with full advanced-search syntax (operators like from:, since:, until:, min_faves: work inline in the query) and get structured tweets with text, author, engagement, and cursor pagination. Limit is a per-page maximum; native pages contain approximately 20 tweets unless requireSinglePage selects a bulk lane. $0.00048 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of search results. |
limit | integer | Optional | Page size to ask for (1-50, default 20). Some sources honor it; others always return their whole native page of about 20. A page is never trimmed after the call, so follow nextCursor to continue exactly where this response ended. Default 20. Max 50. |
query | string | Required | Search query using X (Twitter) advanced-search syntax. IMPORTANT: bare terms are ANDed - a tweet must contain EVERY word, so a list of loosely related keywords matches nothing; use one short phrase or OR between alternatives (e.g. 'anyapi OR getanyapi'). When an operator follows an OR list, put... |
queryType | string | Optional | Which posts to return: 'Latest' (newest first, the default), 'Top' (most popular), 'Photos' (newest posts with images), or 'Videos' (newest posts with video). Photos and Videos search your query as written with filter:images or filter:videos added after it, so they cost the same as a Latest search. One of: Latest, Top, Photos, Videos. Default "Latest". |
requireSinglePage | boolean | Optional | Set true to get up to limit results in one response instead of provider-native pages, served by a bulk provider when needed. |
Search X (Twitter) communities by keyword and get their id, name, topic, and member count with cursor pagination. This is how you find a community URL to pass to twitter.community or twitter.community_tweets. $0.0011 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of communities. |
query | string | Required | Keyword to match against X (Twitter) community names and topics (e.g. artificial intelligence). |
Search X (Twitter) accounts by keyword - the People tab of X search. Matches handles, display names, and profile bios, and returns normalized profile records with follower, following, and post counts plus cursor pagination. Use twitter.search for posts. $0.00049 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page; pass it to fetch the next page of accounts. |
query | string | Required | Keyword to match against X (Twitter) handles, display names, and profile bios. This is the People tab of X search: pass a topic ('ai agents'), a name ('Elon Musk'), or a handle ('openai') and get back accounts, not posts. Use twitter.search for posts. |
Resolve the linear self-thread containing an X (Twitter) post, from its root through the author's linked continuations. This excludes replies from other users. $0.00242 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Canonical x.com or twitter.com status URL with a numeric tweet ID. Any tweet in the self-thread can be supplied; the provider resolves the thread root. |
Get current X (Twitter) trends for worldwide, a country, or a city in X ranking order, including the resolved location. $0.0001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of ranked trends to return (1-50, default 50). Default 50. Max 50. |
location | string | Optional | Country name, city name, or ISO country code. Omit for worldwide trends. |
Fetch a single Twitter/X tweet by URL with its full text and engagement counts (likes, retweets, replies, quotes, bookmarks, views). $0.00022 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Canonical x.com or twitter.com status URL with a numeric tweet ID, including /i/web/status and media-share variants. |
Extract the spoken transcript from a Twitter/X video tweet by URL. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Tweet URL of the video to transcribe (e.g. https://x.com/TheoVon/status/1916982720317821050). |
Get an X (Twitter) account's profile Posts-tab timeline by handle. Results follow profile order: a pinned post may appear first, followed by otherwise reverse-chronological authored posts, reposts, quotes, and self-thread continuations. $0.00044 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page. |
handle | string | Required | Twitter/X handle without the leading @. |
Get up to the requested limit of tweets and replies authored by an X (Twitter) account, with engagement, views, language, and cursor pagination where available. $0.00044 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Opaque pagination cursor from a previous response's nextCursor. Omit for the first page. |
handle | string | Required | Twitter/X handle without the leading @. |
limit | integer | Optional | Page size to ask for (1-100, default 20). Some sources honor it; others always return their whole native page of about 20 authored tweets and replies. A page is never trimmed after the call, so follow nextCursor and pass it back as cursor to continue exactly where this response ended. Default 20. Max 100. |
requireSinglePage | boolean | Optional | Require a lane that can return the requested limit in one response. |
Search Unsplash for free stock photos by keyword. Returns image URLs in several sizes, dimensions, alt text, the photographer's name and profile, and the photo's Unsplash page. Returns up to 10 results per call (page with cursor/page where offered). $0.01705 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
color | string | Optional | Only return photos with this dominant color tone. Omit for any color. One of: black_and_white, black, white, yellow, orange, red, purple, magenta, green, teal, blue. |
orientation | string | Optional | Only return photos with this orientation. Omit for any orientation. One of: landscape, portrait, square. |
query | string | Required | Keyword or phrase to search Unsplash photos for, e.g. "coffee" or "minimal workspace". |
sortBy | string | Optional | Order results by best match (relevant, the default) or newest first (recent). One of: relevant, recent. Default "relevant". |
Search Upwork job postings by keyword, with up to 25 fresh listings per request. $0.007 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
experienceLevel | string | Optional | Filter by required experience level. One of: entry, intermediate, expert. |
jobType | string | Optional | Filter by payment type: fixed-price or hourly jobs. One of: fixed, hourly. |
limit | integer | Optional | Maximum number of results to return (10-25, default 25). Max 25. |
location | string | Optional | Filter by client location - a region, subregion, or country (e.g. United States, Europe). |
paymentVerified | boolean | Optional | When true, only return jobs from clients with a verified payment method. |
query | string | Required | Keywords to search Upwork jobs for (e.g. react developer). |
sort | string | Optional | Sort order for listings: newest or relevance (e.g. newest). One of: newest, relevance. Default "newest". |
Get one Vrbo vacation rental by its property ID: name, link, address, coordinates, bedrooms, bathrooms, beds and guest capacity, guest rating with category scores and review count, amenities by group, full description, house rules, important information, availability and price for your dates (total and average per night, fees included), every photo with its caption and the latest guest reviews, as normalized JSON. Takes the id vrbo.search returns. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult guests to price for (1-20, default 2). Default 2. Max 20. |
checkIn | string | Optional | Check-in date to price and check availability for, in YYYY-MM-DD format (e.g. 2027-01-15). Today or later. Without dates, a 3-night stay about a month ahead is priced; the dates used are in stay. |
checkOut | string | Optional | Check-out date in YYYY-MM-DD format (e.g. 2027-01-18). After the check-in date. With a check-in date alone, the stay is 3 nights. |
childrenAges | array | Optional | Age of each child guest, one entry per child (e.g. [5, 8] for two children aged 5 and 8). Omit it when no children are staying. Max 8 items. |
propertyId | string | Required | Vrbo property ID: the id vrbo.search returns for a listing (e.g. 69764328). |
Search Vrbo vacation rentals by destination and dates, with guest, bedroom, bed, bathroom and price filters, and get up to 50 listings per call: Vrbo property ID and link, name, summary line, property type, bedrooms, beds, guest rating and review count, nightly and total stay price with the original nightly price before any discount, and photos as normalized JSON. Page with offset; the price is the same whatever the limit. $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
adults | integer | Optional | Number of adult guests (e.g. 2). Max 20. |
checkIn | string | Required | Check-in date in YYYY-MM-DD format (e.g. 2027-01-15). Today or later. |
checkOut | string | Required | Check-out date in YYYY-MM-DD format (e.g. 2027-01-18). After the check-in date. |
childrenAges | array | Optional | Age of each child guest, one entry per child (e.g. [5, 8] for two children aged 5 and 8). Omit it when no children are staying. Max 8 items. |
limit | integer | Optional | Maximum number of listings to return (1-50, default 50). The price is the same whatever the limit. Default 50. Max 50. |
location | string | Required | Destination to search rentals in: a city, region or area (e.g. Lake Tahoe, Lisbon, Outer Banks, North Carolina). |
minBathrooms | integer | Optional | Minimum number of bathrooms (e.g. 2). Max 50. |
minBedrooms | integer | Optional | Minimum number of bedrooms (e.g. 3). Max 50. |
minBeds | integer | Optional | Minimum number of beds (e.g. 4). Max 20. |
offset | integer | Optional | Number of listings to skip, for paging: send offset 20 with limit 20 for the second page. Default 0. Max 1000. |
priceMax | integer | Optional | Maximum price in the currency results are priced in (each listing's currency), per night or for the whole stay as priceType says (e.g. 400). With a price filter, only listings Vrbo prices for your dates are returned. Max 1000000. |
priceMin | integer | Optional | Minimum price in the currency results are priced in (each listing's currency), per night or for the whole stay as priceType says (e.g. 100). Max 1000000. |
priceType | string | Optional | Whether priceMin and priceMax are a nightly price (default) or the total for the stay. One of: nightly, total. Default "nightly". |
sort | string | Optional | Result order: recommended (Vrbo's default), price_low_to_high, price_high_to_low, review (highest rated first) or review_count (most reviewed first). One of: recommended, price_low_to_high, price_high_to_low, review, review_count. |
Fetch a Walmart product page by URL and get full product details (title, price, availability, ratings, images, and specs) in one normalized response. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Walmart product page URL. |
Pull a page of 10 customer reviews for any Walmart product by URL, newest first or by relevance, helpfulness, or rating: rating, title, text, date and reviewer, plus the verified-purchase badge and helpful votes where the source has them (name them in requireFields to get them). $0.00085 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
page | integer | Optional | 1-based page of 10 reviews, Walmart's fixed page size; Walmart serves at most 100 pages. Each page is billed as one request; keep url and sort the same while walking pages. Default 1. Max 100. |
sort | string | Optional | Review order: recent (newest first, the default), oldest, relevancy, helpful, rating_high, or rating_low (e.g. helpful). One of: recent, oldest, relevancy, helpful, rating_high, rating_low. Default "recent". |
url | string | Required | Walmart product page URL (e.g. https://www.walmart.com/ip/Apple-AirPods-Pro-2/5689919121). |
Search Walmart by keyword with optional sort, price-range, facet, and page filters and get title, price, rating, seller, and availability for each product in one normalized response. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
facet | string | Optional | Optional Walmart facet filter token, e.g. brand:HP to keep only HP products. |
maxPrice | number | Optional | Optional maximum product price in USD. |
minPrice | number | Optional | Optional minimum product price in USD. |
page | integer | Optional | 1-based results page of about 40 to 60 products; Walmart serves no products past page 10. Each page is billed as one request. Walmart re-ranks between requests, so consecutive pages can repeat a product: deduplicate on itemId. Default 1. Max 10. |
query | string | Required | Search keywords, e.g. "airpods" or "paper towels". |
sort | string | Optional | Result sort order; omit for Walmart's Best Match (e.g. price_low sorts by lowest price first). One of: best_match, best_seller, price_low, price_high, rating_high, new. |
Crawl a website and get up to 10 of its pages as separate items, each with its URL, title, description, language, HTTP status, clean Markdown text and page metadata such as headings and structured data, ideal for feeding sites into LLMs and search indexes. Pages that failed or were skipped are listed separately and never billed. Returns up to 10 results per call (page with cursor/page where offered). $0.0125 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | The website URL or domain to crawl. Pages linked from it on the same site are crawled too. |
Map an entire website into a clean list of its URLs (with titles and descriptions) in a single call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeSubdomains | boolean | Optional | When true (upstream default), include URLs on subdomains of the target (for example docs.example.com when mapping example.com). Set false to return only URLs on the exact host. |
limit | integer | Optional | Maximum number of links to return. Default 100. |
search | string | Optional | Optional term that orders the returned links by relevance. |
sitemap | string | Optional | How to use the site's sitemap.xml when discovering URLs. 'include' (upstream default) merges sitemap URLs with links found by crawling; 'only' returns just the URLs listed in the sitemap (fastest and most authoritative); 'skip' ignores the sitemap and discovers URLs by crawling links. Omit to... One of: include, skip, only. |
url | string | Required | The base URL of the site to map into a list of links. |
Scrape any web page and get its content back as clean Markdown (or HTML, or raw HTML) plus title and metadata. $0.0007 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
blockAds | boolean | Optional | When true (upstream default), strip ad and cookie-consent elements before capture. Set false to keep them. |
excludeTags | array | Optional | CSS selectors to drop before capture (for example ["nav", "footer", ".ads"]). Applied after includeTags. |
formats | array | Optional | Which representations of the page to return. Any combination of: markdown (page content as Markdown), html (the page HTML exactly as the browser received it, including head and script tags). Each requested format is returned under the matching output field. Defaults to both. rawHtml is a... One of: markdown, html, rawHtml. Default ["markdown", "html"]. Example: ["markdown", "html"] |
includeTags | array | Optional | CSS selectors to keep. When set, only content matching these selectors is captured (for example ["article", "main"] or ["#content"]). |
mobile | boolean | Optional | When true, render the page with a mobile viewport and user agent instead of desktop. Some sites serve materially different content to mobile. |
onlyMainContent | boolean | Optional | When true, return only the main article content, stripping navigation, headers, footers, and other boilerplate. Defaults to false to capture the full page. Default false. |
url | string | Required | The full web address of the page to scrape, including its domain, for example https://example.com. The https:// prefix is optional. |
waitFor | integer | Optional | Milliseconds to wait for the page to finish rendering before capture. Use this for JavaScript-heavy pages or single-page apps whose content loads after the initial paint. Capped at 15000 to stay within the request timeout. This wait is time you asked us to spend, so your response takes this much... Max 15000. |
Capture a real-browser screenshot of any web page URL. $0.0013 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | The full URL of the page to capture. |
viewportWidth | integer | Optional | Browser viewport width in pixels (e.g. 1280). Default 1280. |
Get the complete current Weibo hot-search ranking with labels and heat values. $0.0018 per call.
Fetch a public Weibo post by ID with normalized author and engagement data. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeLongText | string | Optional | Whether to include the full text of long posts. Default "true". |
postId | string | Required | Weibo post identifier. |
List first-level comments on a public Weibo post with pagination. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination cursor returned as nextCursor. |
limit | integer | Optional | Requested comment count. Default 10. |
postId | string | Required | Weibo post identifier. |
Fetch a public Weibo profile by user ID with normalized audience and account data. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
userId | string | Required | Weibo user identifier. |
Search public Weibo posts with optional result, media, and time filters. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
includeType | string | Optional | Media filter, such as all, pic, video, music, or link. |
page | integer | Optional | Page number starting at 1. Default 1. |
query | string | Required | Search keyword. |
searchType | string | Optional | Search type, such as all, hot, original, verified, media, or viewpoint. |
timeScope | string | Optional | Custom time range in the API's custom:start:end format. |
List public posts from a Weibo user with normalized author and engagement data. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Pagination identifier returned as nextCursor. |
feature | integer | Optional | Response detail feature: 0 basic, 1 extended, 2 image-oriented, or 3 video-oriented. Default 0. |
page | integer | Optional | Page number starting at 1. Default 1. |
userId | string | Required | Weibo user identifier. |
Look up a stock or ETF by ticker symbol and get its Yahoo Finance quote (price, market cap, volume, and key stats) as normalized JSON. $0.00105 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
ticker | string | Required | The ticker symbol to look up. |
Search Yelp for businesses by keyword and location: up to 20 listings with ratings, categories, and core business info per request. $0.0025 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Maximum number of results to return (1 to 20, default 20). Default 20. Max 20. |
location | string | Required | City and state defining the search area (e.g. San Francisco, CA). |
query | string | Required | Search term or category to look for (e.g. sushi). |
Fetch a YouTube channel's stats (subscribers, video count, total views, description) and the links on its About page, by handle or channel ID. $0.00045 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID (UC...). Pass it directly when you have it: some sources accept only the ID and otherwise look up the handle first, which adds a step. |
handle | string | Optional | YouTube channel handle. |
List a YouTube channel's community posts by handle or channel ID with cursor pagination (text, likes, image, publish time). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID. |
cursor | string | Optional | Continuation token from a previous response for pagination. |
handle | string | Optional | YouTube channel handle. |
Reveal the business inquiry email a YouTube creator publishes behind the channel's View email address button. YouTube gates that address behind a signed-in Google session and a CAPTCHA, so it is absent from the channel page a logged-out scraper reads. Each lookup runs on one source only and never moves to another: the cheapest source unless the call names one. An email found inside the call is charged that source's price, and a channel with no email is free. A lookup the source cannot answer yet takes minutes to hours: it is charged when the lookup starts, refunded automatically if no email is found within 48 hours, and the call returns a request id at once with a link that collects the answer later with no API key. A finished answer stays readable for 3 days after it is found. Set `fresh` to true to have the address read from YouTube now instead of one a source already holds: that costs more, $0.44 per email found instead of the normal $0.11 or $0.132, and it runs only on the source that offers it. Async: if the response is 202 with a request id, poll GET /requests/{id}. $0.11 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID (UC...). |
fresh | boolean | Optional | Optional, and it costs more. Set true to have the address read from YouTube now instead of one a source already holds, for a channel that may have changed its email. With it on, the price is $0.44 per email found instead of this API's normal $0.11 or $0.132; a channel with no email is still... Default false. |
handle | string | Optional | YouTube channel handle, with or without the leading @. |
List a YouTube channel's live and past-live streams by handle or channel ID with cursor pagination (title, views, length, publish time). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID. |
cursor | string | Optional | Continuation token from a previous response for pagination. |
handle | string | Optional | YouTube channel handle. |
List a YouTube channel's playlists by handle or channel ID with cursor pagination (title, video count, thumbnail). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID. |
cursor | string | Optional | Continuation token from a previous response for pagination. |
handle | string | Optional | YouTube channel handle. |
Get the email address a YouTube creator writes in the channel's public description, the text anyone can read on the About tab. It never returns the business email YouTube hides behind the View email address button; youtube.channel_contact reveals that one. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID (UC...). |
handle | string | Optional | YouTube channel handle, with or without the leading @. |
List a YouTube channel's Shorts by handle or channel ID with cursor pagination, views, and publish timestamps. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID beginning with UC. |
cursor | string | Optional | Continuation token from a previous response. |
handle | string | Optional | YouTube channel handle, including or omitting the leading @. |
sort | string | Optional | Sort order for the Shorts feed. latest and newest are equivalent. One of: latest, newest, popular. |
List a YouTube channel's videos by handle or channel ID with cursor pagination (title, views, length, publish time). $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
channelId | string | Optional | YouTube channel ID. |
cursor | string | Optional | Continuation token from a previous response for pagination. |
handle | string | Optional | YouTube channel handle. |
sort | string | Optional | Sort order. One of: latest, popular. |
List replies to a YouTube comment using a continuation token with cursor pagination (text, author, likes, publish time). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
continuationToken | string | Required | Replies continuation token from the comments endpoint, or the continuationToken from a previous replies response for further pagination. |
Fetch a single YouTube community post by URL (text, images, channel, publish time). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | URL of the YouTube community post. |
List every video in a YouTube playlist (title, length, and channel per video plus playlist owner and totals). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
playlistId | string | Required | The playlist ID: the "list" parameter in a playlist URL (e.g. "PLu0W_9lII9ahIappRPN0MCAgtOu3lQjQi"). |
Search YouTube and get matching videos (title, channel, views, length, publish time) as normalized JSON. $0.0005 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Continuation token from a previous response for pagination. |
query | string | Required | The YouTube search query. |
requireCursor | boolean | Optional | Deprecated; send `requireFields: ["nextCursor"]` instead, which does exactly the same thing. Set true if you intend to page through results, so the request is only served by a source that can return a nextCursor. Omit it and routing is unchanged, with the cheapest source serving. This can raise... |
sortBy | string | Optional | Sort order: "relevance" (default) or "popular" (most-viewed). One of: relevance, popular. Default "relevance". |
uploadDate | string | Optional | Filter by upload recency. Omit for any time. One of: today, this_week, this_month, this_year. |
Search YouTube videos by hashtag with cursor pagination (title, channel, views, length, publish time). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Continuation token from a previous response for pagination. |
hashtag | string | Required | Hashtag to search for (without the leading #). |
type | string | Optional | Content filter. Only "all" is served: no source we buy returns a Shorts row with the channel and publish time this endpoint requires. One of: all. |
Search YouTube Shorts by keyword and get matching Shorts (title, views, URL) with cursor pagination as normalized JSON. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Continuation token from a previous response for pagination. |
query | string | Required | The keyword to search Shorts for. |
sortBy | string | Optional | Sort order: "relevance" (default) or "popular" (most-viewed). One of: relevance, popular. Default "relevance". |
uploadDate | string | Optional | Filter by upload recency. Omit for any time. One of: today, this_week, this_month, this_year. |
List currently trending YouTube Shorts (title, channel, views, likes, duration). $0.0012 per call.
Fetch a YouTube video or Short's metadata (title, channel, views, likes, duration, publish date) by URL or ID. $0.00078 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | YouTube video ID. A Short uses the same ID as any other video. |
url | string | Optional | Full YouTube video URL. Shorts (youtube.com/shorts/...), youtu.be, live, and embed URLs all work. |
List the comments on a YouTube video or Short by URL with cursor pagination (text, author, likes, reply count). $0.00078 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
cursor | string | Optional | Continuation token from a previous response for pagination. |
order | string | Optional | Comment order (e.g. top, newest). One of: top, newest. |
url | string | Required | Full YouTube video URL. Shorts (youtube.com/shorts/...) and youtu.be URLs also work. |
Detect suspected sponsors and paid promotions in a YouTube video by URL (sponsor names, websites, confidence). $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
language | string | Optional | 2-letter language code for transcript lookup (e.g. en, es, fr). |
url | string | Required | YouTube video or Short URL. |
Fetch the transcript/captions of a YouTube video or Short by URL or ID. $0.0009 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | YouTube video ID. A Short uses the same ID as any other video. |
url | string | Optional | Full YouTube video URL carrying the video id. Shorts (youtube.com/shorts/...), youtu.be, live, and embed URLs all work. A link without the video id, such as https://www.youtube.com/watch?v= or a channel link, is refused as invalid input, with no charge; send the video's link or its id instead. |
Fetch a YouTube video or Short transcript with timed segments and its provenance: whether the words are creator-written captions or machine speech recognition. $0.002 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
captionKind | string | Optional | Which caption track to accept: "manual" only creator-written captions, "automatic" only YouTube's speech recognition, "any" whichever exists. One of: manual, automatic, any. Default "any". |
language | string | Optional | Preferred caption language code (e.g. "en", "es"). Defaults to English. If the video has no captions in that language, you get the transcript in another language the video has; the `language` field in the result says which. With `captionKind` set to "manual" or "automatic", no other language is... |
url | string | Required | YouTube video or Short URL (e.g. "https://www.youtube.com/watch?v=dQw4w9WgXcQ" or "https://www.youtube.com/shorts/Fir1x9cw2vg"). |
Fetch a public Zhihu answer with normalized author and question data. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
answerId | string | Required | Zhihu answer identifier. |
Fetch a public Zhihu profile with normalized identity and audience data. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
userToken | string | Required | Zhihu user URL token. |
Fetch a public Zhihu question with normalized text and engagement statistics. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
questionId | string | Required | Zhihu question identifier. |
List the first page of public answers to a Zhihu question with normalized authors and engagement data. Pagination is not supported. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | integer | Optional | Number of answers requested on the first page. Pagination is not supported. Default 5. |
order | string | Optional | Answer ordering: default ranking or recently updated. One of: default, updated. Default "default". |
questionId | string | Required | Zhihu question identifier. |
Search public Zhihu articles by keyword with normalized author and engagement data. $0.0012 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
limit | string | Optional | Number of articles requested per page. Default "20". |
offset | string | Optional | Result offset returned as nextOffset in the previous response. Default "0". |
query | string | Required | Search keyword. |
searchHashId | string | Optional | Search hash identifier returned in the previous response. |
showAllTopics | integer | Optional | Whether to include all topics: 0 excludes them and 1 includes them. Default 0. |
sort | string | Optional | Article ordering: comprehensive, most upvoted, or newest. One of: , upvoted_count, created_time. |
timeInterval | string | Optional | Optional publication-time filter. One of: , a_day, a_week, a_month, three_months, half_a_year, a_year. |
verticalInfo | string | Optional | Article-search vertical continuation state returned as nextVerticalInfo in the previous response. Default "0,0,0,0,0,0,0,0,0,2,0,0". |
Fetch one Zillow real estate agent's profile by URL: name, phone, email, brokerage, rating, review count, sales, and service areas. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Zillow agent profile URL (e.g. https://www.zillow.com/profile/gregorycarlsonATX/). |
Fetch full details for a single Zillow property listing by URL (price, facts and features, photos, and price/tax history). $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | Zillow property details URL (e.g. https://www.zillow.com/homedetails/123-Main-St-Anytown-CA-90210/12345678_zpid/). |
Search Zillow for-sale, rental, or sold listings by region-level location (city, ZIP, county, or neighborhood) with optional price, bedroom, living-area, home-type, recency, and sort filters and get matching properties (price, address, beds, baths, living area, status, Zestimate) as normalized JSON. $0.0008 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
daysOnZillow | string | Optional | Only include listings on Zillow at most this long (e.g. 1_week). One of: 1_day, 1_week, 2_weeks, 1_month, 3_months, 6_months, 12_months, 24_months, 36_months. |
homeTypes | array | Optional | Filter by property type; omit for any. Rentals support only singleFamily, multiFamily, townhome, and condo (e.g. ["singleFamily", "condo"]). One of: singleFamily, multiFamily, townhome, condo, apartment, manufactured, land. |
includeAcceptingBackupOffers | boolean | Optional | Include listings accepting backup offers, which Zillow excludes by default (e.g. true). |
includePendingAndUnderContract | boolean | Optional | Include pending and under-contract listings, which Zillow excludes by default (e.g. true). |
includeRoomForRent | boolean | Optional | Include room-for-rent listings in rent searches; when omitted or false only entire places are returned (e.g. true). |
limit | integer | Optional | Maximum number of results to return (1-25, default 25). Default 25. Max 25. |
listingTypes | array | Optional | Listing types to include for buy searches; omit for all standard types. fsba = agent listed, fsbo = for sale by owner. Ignored for rent and sold (e.g. ["newConstruction"]). One of: fsba, fsbo, newConstruction, comingSoon, auction, foreclosure, foreclosed, preforeclosure. |
location | string | Required | Region-level location to search: ZIP code, city and state, county, or neighborhood (e.g. 'Austin, TX' or '78701'). Street addresses are not supported; use the property's ZIP code instead. |
maxBedrooms | integer | Optional | Maximum number of bedrooms (e.g. 5). |
maxLivingAreaSqft | integer | Optional | Maximum living area in square feet (e.g. 3000). |
maxPrice | integer | Optional | Maximum price in USD: monthly rent for rentals, total price for buy/sold (e.g. 750000). |
minBedrooms | integer | Optional | Minimum number of bedrooms (e.g. 3). |
minLivingAreaSqft | integer | Optional | Minimum living area in square feet (e.g. 1500). |
minPrice | integer | Optional | Minimum price in USD: monthly rent for rentals, total price for buy/sold (e.g. 250000). |
operation | string | Optional | Listing type: buy (for sale), rent, or sold. One of: buy, rent, sold. Default "buy". |
showOnlyPriceReductions | boolean | Optional | Only show listings with a price reduction. Buy searches only; ignored for rentals (e.g. true). |
sortBy | string | Optional | Sort order for results; omit for Zillow's default relevance. rentalPriorityScore applies to rent searches only (e.g. newest). One of: newest, recentlyChanged, price_high, price_low, bedrooms, bathrooms, rentalPriorityScore. |