Skip to content

About

Official Node.js and TypeScript SDK for the Piloterr web scraping API.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Piloterr Node.js SDK

The official Node.js and TypeScript SDK for the Piloterr web scraping API.

Scrape 300+ websites (Amazon, LinkedIn, Google, Zillow, Crunchbase…) as structured JSON with one API.

The SDK exposes 392 typed methods, one per documented endpoint, plus a generic request() for anything else.

Requirements

  • Node.js 20 or newer

Installation

npm install @piloterr/sdk

The SDK works with TypeScript and JavaScript (ES modules). The examples below use TypeScript; JavaScript users can use the same API by omitting TypeScript-only syntax.

Get your API key

Sign up for Piloterr or sign in to your existing account, then copy your API key from the dashboard. Store it securely, for example in the PILOTERR_API_KEY environment variable, which the client reads by default.

Quick start

import { PiloterrClient } from "@piloterr/sdk";

const client = new PiloterrClient({ apiKey: process.env.PILOTERR_API_KEY });

const response = await client.amazonProduct({ query: "B09DFCB66S" });
console.log(response.data);

Every method takes a parameter object that mirrors the API reference (snake_case names, exactly as documented) and an optional RequestOptions object.

Binary responses

Some endpoints return a file (image, PDF…) instead of JSON. Their methods return an ApiResponse, so check kind:

import { writeFile } from "node:fs/promises";

const response = await client.websiteScreenshot({ url: "https://example.com" });
if (response.kind === "binary") {
  await writeFile("screenshot.png", response.bytes);
} else {
  console.log(response.data);
}

Async jobs

Any call accepts is_async: true (useful past the 60-second server limit): the response is then a job_id. waitForJob() polls GET /v1/jobs/{id} until the job reaches a terminal status (CompletedJob, Error, NotFound, BadRequest):

const submitted = await client.amazonProduct({
  query: "B09DFCB66S",
  is_async: true,
});
const job = await client.waitForJob(submitted.data.job_id, {
  onProgress: (j) => console.log(`${j.status} ${j.progress ?? 0}%`),
});
console.log(JSON.stringify(job.data, null, 2));

GET or POST

Methods use GET when the endpoint supports it: parameters travel in the query string. POST sends the same parameters as a JSON body.

await client.aboutyouProduct({ query: "test" }, { method: "POST" });

null, undefined and empty arrays are omitted, false and 0 are sent, and arrays repeat the parameter name (a=1&a=2).

Any endpoint

request() reaches any path, including endpoints released after this SDK version:

const response = await client.request("GET", "/v1/usage");

Responses

  • JsonResponse — kind: "json", the parsed body in data (pass a type argument to type it: client.amazonProduct<MyType>(…)).
  • BinaryResponse — kind: "binary", the body in bytes and its contentType.

Both keep the buffered rawResponse (status, headers, content type, body bytes).

Errors

import { PiloterrApiError } from "@piloterr/sdk";

try {
  await client.amazonProduct({ query: "B09DFCB66S" });
} catch (error) {
  if (error instanceof PiloterrApiError) {
    console.error(error.status, error.message, error.responseBody);
  }
  throw error;
}
Error When
PiloterrConfigurationError Missing API key, invalid options or unsupported method.
PiloterrSerializationError A required parameter is missing or a value can't be sent.
PiloterrTransportError Network failure or client-side timeout.
PiloterrApiError The API answered with a non-2xx status (status, message, responseBody).
PiloterrResponseDecodingError A success response could not be decoded.

All of them extend PiloterrError. Common statuses: 400 invalid parameters, 401 invalid API key, 402 no credits left, 429 rate limit exceeded.

Retries

Requests are retried up to 3 times after a network error, a 408, 500, 502, 503 or 504, or a rate limit — which the API returns as 401 (or 429) with a Rate limit exceeded message. Per-key quota errors (…: quota daily) are not retried, nor are 400, 402, 404 or client-side timeouts. The delay starts at 1 second and grows 1.5× per retry (capped at 30 seconds); a Retry-After header wins.

const client = new PiloterrClient({ maxRetries: 5, retryDelay: 500 });

// or for one request
await client.amazonProduct({ query: "B09DFCB66S" }, { maxRetries: 0 });

Batch requests

batch() runs a task per item with at most 10 in flight (concurrency), and returns one result per item in input order, shaped like Promise.allSettled. One failure never stops the others.

const inputs = ["B09DFCB66S", "B0BSHF7WHW", "B08N5WRWNW"];
const results = await client.batch(
  inputs,
  (query) => client.amazonProduct({ query }),
  { concurrency: 5 },
);

for (const result of results) {
  if (result.status === "fulfilled") console.log(result.value.data);
  else console.error(inputs[result.index], result.reason);
}
Constant Default Description
DEFAULT_CONCURRENCY 10 Tasks run at the same time by batch
DEFAULT_TIMEOUT_MS 120000 Request timeout (milliseconds)
MAX_RETRIES 3 Retry attempts after a network error, a 408/5xx or a rate limit
RETRY_BACKOFF_FACTOR 1.5 Exponential backoff multiplier
DEFAULT_RETRY_DELAY_MS 1000 Delay before the first retry (milliseconds)

Timeouts and cancellation

const client = new PiloterrClient({ timeout: 60_000 }); // default 120000 ms, 0 disables

await client.amazonProduct(
  { query: "B09DFCB66S" },
  {
    signal: AbortSignal.timeout(30_000),
  },
);

Advanced: custom Fetch transport

import { PiloterrClient, type PiloterrFetch } from "@piloterr/sdk";

const loggingFetch: PiloterrFetch = async (input, init) => {
  const response = await fetch(input, init);
  console.log(init.method, String(input), response.status);
  return response;
};

const client = new PiloterrClient({ fetch: loggingFetch });

Endpoints

392 methods, generated from the OpenAPI document.

Method HTTP Description
aboutyouProduct() GET / POST /v2/aboutyou/product Read one About You product from a product URL or a keyword. A keyword opens the first search hit. Set region when the query does not alread…
aboutyouSearch() GET / POST /v2/aboutyou/search Search an About You shop with a keyword or a search URL. Pick the country with region, or let a full link choose the shop. Cards include br…
actionProduct() GET / POST /v2/action/product Action Product API: fetch full product page data from a product ID or URL on Action.com. Returns pricing, specs, images, breadcrumbs and av…
actionSearch() GET / POST /v2/action/search Action Search API: search product listings by keyword or URL on Action.com across European locales. Returns prices, images, locale, currenc…
aldiProduct() GET / POST /v2/aldi/product Aldi Product API: fetch full product page data from an Aldi URL or path slug. Returns pricing, images, description, category and cooling fl…
aldiSearch() GET / POST /v2/aldi/search Aldi Search API: list products from an Aldi category page URL or path across FR, DE, NL and Canarias shops. Returns prices, thumbnails and…
alibabaProduct() GET / POST /v2/alibaba/product Alibaba Product API. Fetch a full B2B product page by URL or product ID with optional locale subdomain. Browser rendering returns tiered pr…
alibabaSearch() GET / POST /v2/alibaba/search Alibaba Search API. Query B2B product listings by keyword or search URL across 17 locale subdomains. Request mode returns prices, MOQ, sell…
aliexpressProduct() GET / POST /v2/aliexpress/product AliExpress Product API: scrape live /item/ product pages from a full URL. Get title, images, seller identity, pricing, specs, delivery, and…
aliexpressProductReviews() GET / POST /v2/aliexpress/product/reviews AliExpress Reviews API: list buyer reviews for a product id or item URL. Each review includes author, star rating, text, date, and photos w…
aliexpressSearch() GET / POST /v2/aliexpress/search AliExpress Search API: search by keyword or wholesale URL and get product listings with prices, ratings, sold counts, and pagination as JSO…
aliexpressStoreProduct() GET / POST /v2/aliexpress/store/product AliExpress Store Product API: list products from an AliExpress seller store by URL or store ID. Returns store metadata and product cards (~…
allegroProduct() GET / POST /v2/allegro/product Allegro Product API. Extract full product page data from allegro.pl by URL (/produkt/, /oferta/, /ogloszenie/). Browser rendering, 3 credit…
allegroSearch() GET / POST /v2/allegro/search Allegro Search API. Query product listings by keyword, optional page number, or full allegro.pl listing URL. Returns results with prices, s…
amazonProduct() GET / POST /v2/amazon/product Efficiently extract product details from Amazon for dynamic retail insights, including price, stock, features, and seller data.
amazonProductOffer() GET / POST /v2/amazon/product/offer Efficiently extract details of third-party seller offers for any Amazon product across multiple marketplaces.
amazonSearch() GET / POST /v2/amazon/search Efficiently scrape Amazon search results for real-time product data and insights across multiple Amazon marketplaces.
apartmentsProperty() GET / POST /v2/apartments/property Extract a full Apartments.com rental listing from a property URL, including amenities, gallery, description, geolocation, and unit details…
apartmentsSearch() GET / POST /v2/apartments/search Search Apartments.com rentals from a full city or browse URL and retrieve prices, photos, addresses, phone numbers, and pagination via brow…
argenpropProperty() GET / POST /v2/argenprop/property Read one Argenprop listing from its URL or id. You get price, address, rooms, expenses, and the agent when the page shows them.
argenpropSearch() GET / POST /v2/argenprop/search Search Argenprop by neighbourhood or city. Set operation to venta or alquiler, and property_type such as departamentos or casas. Page with…
argosProduct() GET / POST /v2/argos/product Argos Product API: one UK product by id or URL. Browser rendering (2 credits).
argosSearch() GET / POST /v2/argos/search Search the Argos UK catalogue by keyword and page the results. Prices are in pounds. A one-word query that Argos turns into a brand page wi…
arxivPaper() GET / POST /v2/arxiv/paper Fetch one arXiv paper by id or by an abs, pdf, or html URL.
arxivSearch() GET / POST /v2/arxiv/search Search arXiv papers by keyword, author query such as au:einstein, or arXiv id. A paper URL returns 400. Page through results when the match…
auchanProduct() GET / POST /v2/auchan/product Effortlessly extract product details from Auchan for dynamic business insights, including nutritional information, ingredients, ratings, an…
auchanSearch() GET / POST /v2/auchan/search Extract Auchan product listings from keyword searches for insightful market analysis and competitive edge.
autodocProduct() GET / POST /v2/autodoc/product Scrape Autodoc product pages: price, specs, EAN, images, compatibility, and TecDoc-related vehicle data via the Related endpoint.
autodocProductRelated() GET / POST /v2/autodoc/product/related Vehicle fitment lines per maker for an Autodoc product. All parameters from Product fetch.params are required.
autodocSearch() GET / POST /v2/autodoc/search Search Autodoc by URL: keyword pages use /search?keyword=… (e.g. frein on auto-doc.fr). Extract product cards, prices, and pagination.
autoeuropeResult() GET / POST /v2/autoeurope/result Read one vehicle from an Auto Europe quote. Pass the offer id from Search, with the same pickup and dates. You get the supplier, the SIPP c…
autoeuropeSearch() GET / POST /v2/autoeurope/search Quote a rental car on Auto Europe. Pass pickup, pickup date, and dropoff date. Region chooses the country site and its currency. The whole…
autoscout24Ad() GET / POST /v2/autoscout24/ad Read one AutoScout24 listing, including an inactive ad that still exposes the listing. Price, vehicle, seller, and location. (1 credit)
autoscout24Search() GET / POST /v2/autoscout24/search Search AutoScout24 listings from a search URL. Each card has make, model, numeric price, mileage, and the listing URL. (1 credit)
autotraderAd() GET / POST /v2/autotrader/ad Extract full vehicle details from an AutoTrader UK car-details URL, including price, specs, gallery, seller, and description via browser re…
autotraderSearch() GET / POST /v2/autotrader/search Search AutoTrader UK listings from a car-search URL and retrieve prices, specs, photos, seller info, and pagination via browser rendering.
bestbuyProduct() GET / POST /v2/bestbuy/product Get a Best Buy US or Canada product page: title, price, brand, stock, images, categories and specs via browser rendering.
bestbuyProductReviews() GET / POST /v2/bestbuy/product/reviews Get customer reviews for a Best Buy product URL: rating, review text, author, photos and pagination.
bestbuySearch() GET / POST /v2/bestbuy/search Search Best Buy US or Canada by keyword or search URL. Returns product listings with price, rating and pagination via browser rendering.
bhphotovideoProduct() GET / POST /v2/bhphotovideo/product Read a B&H Photo Video product from its URL or id. Returns price, rating, specifications, and box contents.
bhphotovideoSearch() GET / POST /v2/bhphotovideo/search Search B&H Photo Video by keyword or search URL. Returns BH numbers, dollar prices, and a next page URL.
bingSearch() GET / POST /v2/bing/search Scrape real-time Bing search results with full control over location, language, and pagination.
bitibaProduct() GET / POST /v2/bitiba/product Read one product from a live Bitiba shop, including the selected variant price and the pack list.
bitibaSearch() GET / POST /v2/bitiba/search Search a live Bitiba country shop. Germany is the default. www.bitiba.com is closed and returns 400.
bolProduct() GET / POST /v2/bol/product Read one bol.com product by URL or product id, in nl, be-nl, or be-fr. You get the selling price, the list price, and the seller.
bolSearch() GET / POST /v2/bol/search Search bol.com by keyword. Region is nl, be-nl, or be-fr. Page the product cards. Sponsored ads can repeat across pages.
boulangerProduct() GET / POST /v2/boulanger/product Read one Boulanger product from its URL or product id. You get price, brand, rating, seller, and specifications.
boulangerSearch() GET / POST /v2/boulanger/search Search Boulanger by keyword and page the product grid. Cards include price, brand, seller, and the product URL.
braveSearch() GET / POST /v2/brave/search Access the Brave search engine results directly through our efficient Piloterr service for reliable data scraping.
bricodepotProduct() GET / POST /v2/bricodepot/product Read one Brico Dépôt product from its product URL. You get price, brand, SKU, and availability.
bricodepotSearch() GET / POST /v2/bricodepot/search Search Brico Dépôt with a /produits/ listing URL, not a keyword box. Page 2 is the same path with /2 at the end.
bricoramaProduct() GET / POST /v2/bricorama/product Read one Bricorama product from its URL. You get price, brand, and the product details.
bricoramaSearch() GET / POST /v2/bricorama/search Search Bricorama by keyword or search URL and page the home-improvement grid.
carrefourProduct() GET / POST /v2/carrefour/product Read one Carrefour.fr product from its page URL. Every product returns the same keys: price, brand, pack size, Nutriscore, categories, unit…
carrefourSearch() GET / POST /v2/carrefour/search Search for products on Carrefour by keyword or URL, returning structured listings with prices, ratings, and pagination.
carrefourSuggest() GET / POST /v2/carrefour/suggest Get product suggestions from Carrefour by keyword or EAN, returning matching products with pricing, availability, and product details.
castoramaProduct() GET / POST /v2/castorama/product Read one Castorama product from its URL. You get price, brand, and specifications.
castoramaSearch() GET / POST /v2/castorama/search Search Castorama by keyword or search URL and page the DIY listings. Cards include title, price, and product link.
cdiscountProduct() GET / POST /v2/cdiscount/product Extract full product details from a Cdiscount product page, including price, seller, ratings, specifications, and offers.
cdiscountProductOffer() GET / POST /v2/cdiscount/product/offer Retrieve all marketplace seller offers for a Cdiscount product, including prices, seller ratings, shipping costs, and availability.
cdiscountSearch() GET / POST /v2/cdiscount/search Extract product listings from Cdiscount search results or category pages for market intelligence and competitive analysis.
centrisProperty() GET / POST /v2/centris/property Read one Centris property from its URL or listing id. You get price, address, rooms, and the broker.
centrisSearch() GET / POST /v2/centris/search Search Centris listings by city or by a full results URL. Use the English or French path. Page through properties for sale.
chewyProduct() GET / POST /v2/chewy/product Read one Chewy product by URL or numeric id. The default mode is expert and returns the historical product cache. simple returns one snake_…
chewySearch() GET / POST /v2/chewy/search Search Chewy by keyword or listing URL. The default mode is expert and returns the historical listing objects. simple returns short snake_c…
clearedjobsJob() GET / POST /v2/clearedjobs/job Fetch one cleared job by its URL or by a slug that ends in the numeric id.
clearedjobsSearch() GET / POST /v2/clearedjobs/search Search cleared jobs by keyword. Only the first HTML page is available, so pagination.next is null and page 2 returns 404.
company() GET / POST /v2/company Retrieve comprehensive company data including financials, technologies, social profiles, and location by domain name.
coolblueProduct() GET / POST /v2/coolblue/product Read one Coolblue product by article id or product URL, in the region of that shop.
coolblueSearch() GET / POST /v2/coolblue/search Search Coolblue with a product keyword. Region defaults to Belgium. Also use nl or de. Page through product cards.
copartLot() GET / POST /v2/copart/lot Copart Lot API: retrieve structured auction lot data by lot number or URL. Specs, damage, bids, photos, yard location and sale status acros…
copartSearch() GET / POST /v2/copart/search Copart Search API: search auction lots by keyword or URL across Copart regional sites. Returns lot listings and pagination.
costcoProduct() GET / POST /v2/costco/product Costco Product API: fetch full product page data from a product ID or URL across regional Costco sites. Returns pricing, availability, rati…
costcoSearch() GET / POST /v2/costco/search Costco Search API: search product listings by keyword or URL across 13 regional Costco sites. Returns prices, availability, review counts a…
crunchbaseCompanyInfo() GET / POST /v2/crunchbase/company/info Convert URLs into detailed Crunchbase profiles for immediate company insights.
crunchbaseEvent() GET / POST /v2/crunchbase/event Retrieve detailed Crunchbase event profiles with speakers, sponsors, exhibitors, and press timelines.
crunchbaseFundingRound() GET / POST /v2/crunchbase/funding_round Retrieve full details of a specific Crunchbase funding round including investors and press timeline.
crunchbaseFundingRounds() GET / POST /v2/crunchbase/funding_rounds Monitor funding history and financial milestones of companies with Crunchbase data.
crunchbasePeopleInfo() GET / POST /v2/crunchbase/people/info Retrieve detailed Crunchbase profiles for individuals including career history, investments, and board positions.
crunchbaseSearch() GET / POST /v2/crunchbase/search Search Crunchbase for companies and people by keyword and retrieve their profiles and Crunchbase identifiers.
culturaProduct() GET / POST /v2/cultura/product Read one Cultura product from its URL or SKU. You get price, EAN, seller, condition, and stock wording.
culturaSearch() GET / POST /v2/cultura/search Search Cultura by keyword and page through books, games, and culture products. Cards include title, price, availability, and the product li…
dartyProduct() GET / POST /v2/darty/product Read one Darty product sheet from a product URL or a Darty product id. You get price, brand, availability, rating, and specifications.
dartySearch() GET / POST /v2/darty/search Search Darty by keyword or search URL and page through the listing. Each card has title, price, brand, seller, and product link.
datasetsLinkedinCompany() POST /v2/datasets/linkedin/company Query the LinkedIn company dataset with Elasticsearch Query DSL. Filter by name, domain, industry, headcount, and country. POST-only, 1 cre…
decathlonProduct() GET / POST /v2/decathlon/product Read one Decathlon product from a product URL, a product path, or a keyword. A keyword uses the first search hit. Set region when the query…
decathlonSearch() GET / POST /v2/decathlon/search Search a Decathlon shop with a keyword or a search URL. Choose the country with region, or let a full link pick the shop, then page through…
digikeyProduct() GET / POST /v2/digikey/product Get a DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet and specs via browser rendering.
digikeySearch() GET / POST /v2/digikey/search Search DigiKey country sites by keyword or result/filter URL. Returns category branches or product listings with pagination via browser ren…
doajArticle() GET / POST /v2/doaj/article Fetch one DOAJ article by its id or by a doaj.org article URL.
doajJournal() GET / POST /v2/doaj/journal Fetch one DOAJ journal by ISSN, journal id, or a doaj.org toc URL.
doajSearch() GET / POST /v2/doaj/search Search DOAJ articles or journals. kind is article (default) or journal. Article ids and journal ISSNs are the detail keys.
domainDnsbl() GET / POST /v2/domain/dnsbl Check if a domain or IP address is listed in DNS-based blacklists (DNSBL), with detailed provider-level detection and category information.
domainMalicious() GET / POST /v2/domain/malicious Check if a domain or IP address has been flagged as malicious across multiple threat intelligence feeds, with source attribution.
domainWhois() GET / POST /v2/domain/whois Retrieve WHOIS registration data for any domain, including registration dates, registrar details, name servers, and contact information.
domaincomauProperty() GET / POST /v2/domaincomau/property Read one Domain.com.au listing from its URL. The response is a flat object with price, address, agency, and photos.
domaincomauSearch() GET / POST /v2/domaincomau/search Search Domain.com.au by suburb. mode is sale, rent, or sold. page starts at 1. Each card has a dollar price and a price label rebuilt from…
duckduckgoSearch() GET / POST /v2/duckduckgo/search Query DuckDuckGo via API and retrieve structured organic results with region and language.
ebayProduct() GET / POST /v2/ebay/product eBay Product API: one listing on a supported eBay site, by URL or item id (3 credits).
ebaySearch() GET / POST /v2/ebay/search eBay Search API: search listings on supported eBay sites. Returns price, seller, and pagination (3 credits).
elcorteinglesProduct() GET / POST /v2/elcorteingles/product El Corte Inglés Product API. Fetch a full product page from elcorteingles.es by URL or product id. Returns pricing, stock, images and ident…
elcorteinglesSearch() GET / POST /v2/elcorteingles/search El Corte Inglés Search API. Search product listings on elcorteingles.es by keyword or URL. Returns prices, brands, images and pagination vi…
eleclercProduct() GET / POST /v2/eleclerc/product Read one E.Leclerc product by EAN or product URL. Pass store_id to get that store's price and stock. Another store returns a different pric…
eleclercSearch() GET / POST /v2/eleclerc/search Search for products on E.Leclerc by keyword with optional store-specific filtering and pagination.
eleclercSuggest() GET / POST /v2/eleclerc/suggest Get instant product autocomplete suggestions from E.Leclerc for a given keyword or EAN.
emailAnalyzes() GET / POST /v2/email/analyzes Analyze a domain to retrieve its email infrastructure. Microsoft 365 and Google Workspace domains, SPF records, and DNS configurations.
emailFinder() GET / POST /v2/email/finder Find verified professional email addresses by combining a person's full name with their company domain or company name.
emailVerify() GET / POST /v2/email/verify Verify whether an email address is valid and deliverable, returning a clear status to prevent bounces and maintain list hygiene.
europagesCompany() GET / POST /v2/europages/company Europages company profile with address, supplier type and the products listed on the page (1 credit).
europagesSearch() GET / POST /v2/europages/search Search Europages suppliers by keyword or category URL. Returns company cards and pagination (1 credit).
eventbriteEvent() GET / POST /v2/eventbrite/event Get one Eventbrite event by detail URL or numeric id: venue, organizer, schedule, and description (1 credit).
eventbriteSearch() GET / POST /v2/eventbrite/search Search Eventbrite events by keyword or paste a city/category URL. Returns event cards and pagination (1 credit).
expediaAd() GET / POST /v2/expedia/ad Fetch one Expedia hotel from its information URL: name, postal address, and amenity groups.
expediaFlight() GET / POST /v2/expedia/flight Search Expedia flights by airport route and dates, or by a flight search URL. Each offer includes the airline, times, stops, and displayed…
expediaSearch() GET / POST /v2/expedia/search Execute a hotel search on Expedia using a direct search URL and receive structured hotel listings with prices, ratings, and availability.
fashionphileProduct() GET / POST /v2/fashionphile/product Load one Fashionphile product from a handle or a product URL. Keywords and search URLs belong on the search endpoint.
fashionphileSearch() GET / POST /v2/fashionphile/search Search Fashionphile by keywords, a search URL, a collection URL, or a products.json URL. A product handle or product URL belongs on the pro…
finderChewyProducts() GET / POST /v2/finder/chewy-products Find Chewy product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.
finderEleclercStores() GET / POST /v2/finder/eleclerc-stores Search Eleclerc stores by name or city to retrieve contact details, opening hours, and geolocation.
finderGoogleCountries() GET / POST /v2/finder/google-countries Search the list of Google-supported countries by name or country code to use in Google Search API requests.
finderGoogleLanguages() GET / POST /v2/finder/google-languages Search the list of Google-supported languages by name to retrieve language codes for use in Google Search API requests.
finderGoogleLocations() GET / POST /v2/finder/google-locations Search Google-supported locations by name to retrieve location IDs and GPS coordinates for geo-targeted search API calls.
finderLeroymerlinProducts() GET / POST /v2/finder/leroymerlin-products Find Leroy Merlin product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.
finderLeroymerlinStores() GET / POST /v2/finder/leroymerlin-stores Search Leroy Merlin stores by name, city or postal code to retrieve their store ID, slug, address and store locator URL.
finderLinkedinIndustries() GET / POST /v2/finder/linkedin-industries Search LinkedIn industry taxonomy to retrieve industry IDs and hierarchies for use in LinkedIn API calls and data enrichment.
finderMrbricolageStores() GET / POST /v2/finder/mrbricolage-stores Search Mr.Bricolage stores by name, city or postal code to retrieve their store ID, slug, contact information and geolocation.
fiverrProfileInfo() GET / POST /v2/fiverr/profile/info Extract complete public profile data from any Fiverr seller, including gigs, ratings, reviews, skills, portfolio, and consultation pricing.
fiverrSearch() GET / POST /v2/fiverr/search Search Fiverr gigs using a direct search URL and receive paginated listings with seller information, gig titles, images, and seller levels.
fnacProduct() GET / POST /v2/fnac/product Read one Fnac product from its URL or product id. You get the price, brand, EAN, seller, and rating.
fnacSearch() GET / POST /v2/fnac/search Search Fnac for a keyword or a SearchResult URL. Each card has the product id, name, price, seller, and stock.
fotocasaAd() GET / POST /v2/fotocasa/ad Get a full Fotocasa listing by URL: price, features, coordinates, energy certificate, images, and agency (browser rendering, 2 credits).
fotocasaSearch() GET / POST /v2/fotocasa/search Search Fotocasa listings by city or search URL. Returns prices, rooms, area, coordinates, and agency data via browser rendering (2 credits).
franchisedirectFranchise() GET / POST /v2/franchisedirect/franchise Read one Franchise Direct profile: cash requirement, franchise fee, investment range, and training.
franchisedirectSearch() GET / POST /v2/franchisedirect/search Search Franchise Direct listings by keyword or listing URL. Each card includes a USD cash figure and a numeric minimum.
fressnapfProduct() GET / POST /v2/fressnapf/product Read a Fressnapf Germany product sheet from its URL. Returns sku, GTIN, euro price, unit price, and pack variants.
fressnapfSearch() GET / POST /v2/fressnapf/search Search Fressnapf Germany by keyword or category URL. Returns product cards with euro prices and pagination.
fundaProperty() GET / POST /v2/funda/property Read one Funda listing from its URL. You get the asking price, living area, and the feature groups.
fundaSearch() GET / POST /v2/funda/search Search Funda by place. Set offering to koop for sale or huur for rent, then page the listings.
g2ProductInfo() GET / POST /v2/g2/product/info Read a G2 product reviews page: rating, pricing, categories, alternatives, screenshots, and the reviews shown on the page.
githubUserInfo() GET / POST /v2/github/user/info Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses.
glassdoorCompanyInfo() GET / POST /v2/glassdoor/company/info Get one Glassdoor company profile by URL or employer id (2 credits).
glassdoorCompanySearch() GET / POST /v2/glassdoor/company/search Search Glassdoor employers by keyword across country sites (2 credits).
glassdoorJobInfo() GET / POST /v2/glassdoor/job/info Get one Glassdoor job listing by URL or jl id (2 credits).
glassdoorJobSearch() GET / POST /v2/glassdoor/job/search Search Glassdoor jobs by keyword or SEO URL, with domain and filters (2 credits).
goodreadsBook() GET / POST /v2/goodreads/book Read one Goodreads book by the numeric id from search, such as 44767458 for Dune.
goodreadsSearch() GET / POST /v2/goodreads/search Search Goodreads books by keyword. pagination.next is a Goodreads search URL for the following page.
googleImages() GET / POST /v2/google/images Google Images Scraper API – bringing the power of visual search to your fingertips.
googleJobs() GET / POST /v2/google/jobs Extract job listings from Google Careers for enhanced recruitment and market analysis.
googleMaps() GET / POST /v2/google/maps Extract comprehensive company data from Google Maps for enhanced business insights.
googleNews() GET / POST /v2/google/news Extract real-time news articles from Google News with advanced filtering by topic, location, language, and pagination.
googleSearch() GET / POST /v2/google/search Scrape real-time Google search results with organic listings, knowledge graph, related searches, and advanced filters.
googleSearchAi() GET / POST /v2/google/search/ai Scrape real-time Google AI Mode answers: text_blocks, references, and shopping_results.
googleSearchAutocomplete() GET / POST /v2/google/search/autocomplete Retrieve real-time Google Search autocomplete suggestions for any query, with support for language and country localization.
googleShopping() GET / POST /v2/google/shopping Search Google Shopping and retrieve structured product listings with prices, ratings, merchants, and product IDs.
googleVideos() GET / POST /v2/google/videos Scrape video results from Google Videos search including YouTube, Reddit, and other video platforms, with location and language support.
googleadstransparencyAd() GET / POST /v2/googleadstransparency/ad Get one Google Ads Transparency creative by URL: dates, impressions, platforms, regions, and the text read from the preview image (2 credit…
googleadstransparencySearch() GET / POST /v2/googleadstransparency/search Search the Google Ads Transparency Center by domain, advertiser, region, format, platform, and date. Returns creative cards and pagination…
graingerProduct() GET / POST /v2/grainger/product Get a Grainger US or Canada product page: SKU, brand, price, images, description and specs via browser rendering.
graingerSearch() GET / POST /v2/grainger/search Search Grainger US or Canada by keyword, category URL or SKU. Returns product listings, category branches and suggestions via browser rende…
greenhouseJob() GET / POST /v2/greenhouse/job Fetch one Greenhouse job by board/id, such as discord/8806482002, or by a job-boards.greenhouse.io job URL.
greenhouseSearch() GET / POST /v2/greenhouse/search List jobs on a Greenhouse board. query is the board token, such as discord. keyword filters title and location.
gsaelibraryContract() GET / POST /v2/gsaelibrary/contract Read one GSA eLibrary contractor record from the contract URL returned by search.
gsaelibrarySearch() GET / POST /v2/gsaelibrary/search Search GSA eLibrary for schedule, SIN, and contract rows by keyword or by a full search URL.
homestraAd() GET / POST /v2/homestra/ad Retrieve detailed property listing data from Homestra, including price, size, location, features, photos, and nearby properties.
homestraSearch() GET / POST /v2/homestra/search Search Homestra property listings using a direct search URL with filters, returning structured results with prices, sizes, locations, and p…
huggingfaceModel() GET / POST /v2/huggingface/model Read one public Hugging Face model by an id such as google-bert/bert-base-uncased.
huggingfaceSearch() GET / POST /v2/huggingface/search Search the public Hugging Face models API by keyword and follow pagination.next to the next cursor page.
idealistaProperty() GET / POST /v2/idealista/property Extract full property details from an Idealista listing URL, including price, specs, photos by room, features, energy rating, and advertise…
idealistaProvinces() GET / POST /v2/idealista/provinces List the 50 Spanish provinces Idealista shows for homes for sale. Each row includes the sale search URL to pass as query to Idealista Searc…
idealistaSearch() GET / POST /v2/idealista/search Search Idealista listings from a search URL and retrieve prices, specs, photos, agency info, and pagination. Pass a province URL from /v2/i…
idealoProduct() GET / POST /v2/idealo/product Get an Idealo product from Spain, France, or Germany. URL or product id. Offers, shipping, specs, and images via WebUnlocker (3 credits).
idealoSearch() GET / POST /v2/idealo/search Search Idealo Spain, France, and Germany. Keyword or search URL. Prices, shipping, ratings, and pagination via WebUnlocker (3 credits).
ikeaProduct() GET / POST /v2/ikea/product Extract full IKEA product details from a product URL, including price, gallery, variants, dimensions, and breadcrumb.
ikeaSearch() GET / POST /v2/ikea/search Search IKEA products from a search URL and retrieve prices, ratings, dimensions, images, and pagination.
immobilienscout24Property() GET / POST /v2/immobilienscout24/property Read one ImmobilienScout24 expose by URL or numeric id. You get cold rent or purchase price, address, and area.
immobilienscout24Search() GET / POST /v2/immobilienscout24/search Search ImmobilienScout24 by region and property type. real_estate_type covers rent, buy, house, and land. Page with pagenumber.
immoscout24chSearch() GET / POST /v2/immoscout24ch/search Search ImmoScout24.ch listings by city or search URL and retrieve the CHF price, rooms, living area, and address. Property pages are not av…
immoweltProperty() GET / POST /v2/immowelt/property Extract full property details from an Immowelt listing URL, including price, specs, photo gallery, energy certificate, location, and contac…
immoweltSearch() GET / POST /v2/immowelt/search Search Immowelt listings from a search URL and retrieve prices, specs, photos, agency info, and pagination.
imoveiswebProperty() GET / POST /v2/imoveisweb/property Read one Imobiliária Aquários listing from its imoveisweb.com.br URL. price_display is rebuilt from the asking amount.
imoveiswebSearch() GET / POST /v2/imoveisweb/search Search the Imobiliária Aquários catalog on imoveisweb.com.br. Pass a catalog name such as casas. price_display is rebuilt from the asking a…
indeedCompanyInfo() GET / POST /v2/indeed/company/info Indeed Company Info API. Full employer profile by slug or URL. Browser rendering returns headcount, revenue, industry and FAQ or review blo…
indeedCompanySearch() GET / POST /v2/indeed/company/search Indeed Company Search API. Search fr.indeed.com employer profiles by keyword or URL. Browser rendering returns ratings, industry and profil…
indeedJobInfo() GET / POST /v2/indeed/job/info Indeed Job Info API. Fetch a full job posting by viewjob URL, sponsored click URL or job key. Browser rendering returns description and str…
indeedJobSalary() GET / POST /v2/indeed/job/salary Indeed Job Salary API. Career salary aggregates by job title slug or URL. Browser rendering returns median, percentiles and top paying citi…
indeedJobSearch() GET / POST /v2/indeed/job/search Indeed Job Search API. Search fr.indeed.com job listings by keyword or URL. Browser rendering returns cards with salary snippets and pagina…
inetProduct() GET / POST /v2/inet/product Read one Inet.se product by article number or URL, including SEK price, specs, and warehouse stock.
inetSearch() GET / POST /v2/inet/search Search Inet.se by keyword or category. Prices are inc-VAT SEK, with the next page URL when more results exist.
instagramPostInfo() GET / POST /v2/instagram/post/info Monitor competitors and market trends by scraping Instagram posts for valuable data.
instagramUserInfo() GET / POST /v2/instagram/user/info Gather user insights efficiently from Instagram for targeted marketing strategies.
intermarcheProduct() GET / POST /v2/intermarche/product Get an Intermarché product sheet for a store (shop_id). Try an EAN or product URL with shop_id=11301. 3 credits per call.
intermarcheSearch() GET / POST /v2/intermarche/search Search Intermarché products for a store (shop_id). Try query=lait and shop_id=11301. 3 credits per call.
intersportProduct() GET / POST /v2/intersport/product Read one Intersport product from its URL. You get price, brand, and the product details.
intersportSearch() GET / POST /v2/intersport/search Search Intersport by keyword and page the sports grid. Cards include title, price, and product link.
jameseditionProperty() GET / POST /v2/jamesedition/property Read one JamesEdition listing from its URL.
jameseditionSearch() GET / POST /v2/jamesedition/search Search JamesEdition luxury homes by keyword or by a results URL.
jobs() GET /v1/jobs/{id} Poll the status, progress (0–100) and result of a job started with is_async=true. Polling is free. Poll until status is terminal: Completed…
kickUserInfo() GET / POST /v2/kick/user/info Retrieve complete public channel data from Kick including streamer profile, follower count, live status, and recent categories.
kijijiAd() GET / POST /v2/kijiji/ad Read one Kijiji ad from its id or URL. You get the asking price, the title, and the city.
kijijiSearch() GET / POST /v2/kijiji/search Search Kijiji with a results URL or a city and category. Language can be English or French. Page through classified ads.
krogerProduct() GET / POST /v2/kroger/product Read one Kroger product by UPC. The sheet uses the same default store as search. You get the shelf price and the previous price when Kroger…
krogerSearch() GET / POST /v2/kroger/search Search Kroger groceries by keyword and page the results. Prices come from the default pickup store returned in the response. A location id…
lamudiAd() GET / POST /v2/lamudi/ad Get a full Lamudi listing by URL: price, area, amenities, coordinates, images, and agent (browser rendering, 2 credits).
lamudiSearch() GET / POST /v2/lamudi/search Search Lamudi Philippines and Indonesia listings. Pass a search URL in query, or use location and filters. Prices, area, rooms, tags, and p…
leboncoinAd() GET / POST /v2/leboncoin/ad Extract full details from a Leboncoin ad including price, location, attributes, seller info, and images. Returns structured JSON by default…
leboncoinSearch() GET / POST /v2/leboncoin/search Scrape Leboncoin search results or category pages by URL, returning paginated listings with price, location, and attributes. Returns struct…
leboncoinSearchApi() POST /v2/leboncoin/search_api Search Leboncoin listings via structured POST API with advanced filters for category, location, price range, seller type, and sorting.
lenovoProduct() GET / POST /v2/lenovo/product Extract a Lenovo product page by URL: id, name, price, currency, availability, images, and description (browser rendering, 2 credits).
lenovoSearch() GET / POST /v2/lenovo/search Search Lenovo products by keyword or listing URL. Returns product id, price, currency, series, and availability via browser rendering (2 cr…
leroymerlinProduct() GET / POST /v2/leroymerlin/product Live Leroy Merlin product detail for France and Romania from a URL or identifier: offers, currency, images, features and store context.
leroymerlinSearch() GET / POST /v2/leroymerlin/search Live Leroy Merlin search across France and Romania: title, URL, price, currency, brand, seller, rating and pagination.
lidlProduct() GET / POST /v2/lidl/product Lidl Product API: fetch full product page data from a Lidl URL or ERP id. Returns pricing, images, description, availability and category v…
lidlSearch() GET / POST /v2/lidl/search Lidl Search API: search product listings by keyword or URL across Lidl online shops in 27 countries. Parses Nuxt SSR payload from HTML; ret…
linkedinCompanyInfo() GET / POST /v2/linkedin/company/info LinkedIn Company Info API. Fetch firmographics by LinkedIn slug, URL, company ID, or reverse domain lookup (guideflow.com). Industry, headc…
linkedinJobCount() GET / POST /v2/linkedin/job/count Obtain real-time job counts on LinkedIn by industry, region, and role for strategic planning.
linkedinJobInfo() GET / POST /v2/linkedin/job/info Dive into LinkedIn job data and trends for in-depth labor market insights.
linkedinJobSearch() GET / POST /v2/linkedin/job/search Experience advanced job data extraction from LinkedIn, enhancing your recruitment strategy.
linkedinJobSuggest() GET / POST /v2/linkedin/job/suggest Get personalized job suggestions based on keywords or locations to streamline your job search.
linkedinPostInfo() GET / POST /v2/linkedin/post/info Simplify LinkedIn post retrieval with our efficient API for enhanced content analysis.
linkedinProductInfo() GET / POST /v2/linkedin/product/info Gain competitive insights with detailed LinkedIn product information for strategic advantage.
linkedinProfileInfo() GET / POST /v2/linkedin/profile/info Streamline recruitment and business development by extracting valuable LinkedIn profile insights.
linkedinadlibraryAd() GET / POST /v2/linkedinadlibrary/ad Get one LinkedIn Ad Library creative by URL or id: copy, CTA, payer, impressions, and targeting (2 credits).
linkedinadlibrarySearch() GET / POST /v2/linkedinadlibrary/search Search the LinkedIn Ad Library by advertiser, keyword, country, and date. Returns ad cards and pagination (2 credits).
loopnetProperty() GET / POST /v2/loopnet/property Read one LoopNet commercial listing from its URL.
loopnetSearch() GET / POST /v2/loopnet/search Search LoopNet commercial listings by city or by a results URL.
maerskTracking() GET / POST /v2/maersk/tracking Track a Maersk container or BOL: origin, destination, current milestone and full transport-plan events via browser rendering.
manomanoProduct() GET / POST /v2/manomano/product Read a ManoMano product URL. The body is the product page: brand and seller are objects, and the current price is price.primary_price.amoun…
manomanoProductOffer() GET / POST /v2/manomano/product/offer List the other sellers for a ManoMano product id. Each offer adds price and price_display on top of the site offer.
manomanoSearch() GET / POST /v2/manomano/search Read a ManoMano category URL or keyword. Each card keeps the site fields and adds prices.main, brand_name, and image_fullpath. pagination.n…
mascusAd() GET / POST /v2/mascus/ad Get full details for a Mascus used equipment listing: specs, price, seller and description.
mascusSearch() GET / POST /v2/mascus/search Search used equipment listings on Mascus from a category URL, with pagination that keeps country and category filters.
mediamarktProduct() GET / POST /v2/mediamarkt/product Read one MediaMarkt product by id or product URL, in the region you choose. You get price, currency, EAN, and availability.
mediamarktSearch() GET / POST /v2/mediamarkt/search Search a MediaMarkt shop by keyword. Set region for Switzerland, Germany, Austria, and the other MediaMarktSaturn countries, then page the…
micromaniaProduct() GET / POST /v2/micromania/product Read one Micromania product from its URL or product id. You get the price, brand, EAN, platform, and stock.
micromaniaSearch() GET / POST /v2/micromania/search Search Micromania for a keyword or a Search-Show URL. Each card has the product id, name, brand, EAN, price, and stock.
mobileAd() GET / POST /v2/mobile/ad Mobile Ad API. Fetch full car listing data from a mobile.de ad URL or numeric id. Returns pricing, specs, images and features via webunlock…
mobileSearch() GET / POST /v2/mobile/search Mobile Search API. Same mobile.de inventory for every locale. locale sets the language label and ad links, not which cars are returned. (3…
moreleProduct() GET / POST /v2/morele/product Read one morele.net product page. Flat JSON with PLN price, EAN, specs, and availability.
moreleSearch() GET / POST /v2/morele/search Search morele.net by keyword or search URL. Returns product cards with PLN prices and pagination.
mrbricolageSuggest() GET / POST /v2/mrbricolage/suggest Live Mr.Bricolage product suggestions for a search keyword or EAN, including title, URL, image, price and currency.
neweggProduct() GET / POST /v2/newegg/product Read a Newegg product from an item number, catalog id, or URL. Returns price, specs, images, and seller.
neweggSearch() GET / POST /v2/newegg/search Search Newegg by keyword or search URL. Returns item numbers, dollar prices, stock, and pagination.
northdataCompany() GET / POST /v2/northdata/company North Data company profile: register, address, financials and history (1 credit).
northdataSearch() GET / POST /v2/northdata/search Search North Data companies and people by name. Returns suggestion cards and pagination (1 credit).
npiProvider() GET / POST /v2/npi/provider Fetch one NPPES provider or organization by 10-digit NPI or provider-view URL, including addresses and taxonomies.
npiSearch() GET / POST /v2/npi/search Search the NPPES NPI registry by person name, organization, or 10-digit NPI. With NPI-2, a text query is the organization name. total_resul…
oceanioSearch() GET / POST /v2/oceanio/search Search Ocean.io by domain or company name to find the matching company, similar companies, contacts, and people.
olxAd() GET / POST /v2/olx/ad Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name.
olxProduct() GET / POST /v2/olx/product Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name.
olxSearch() GET / POST /v2/olx/search Search OLX Brazil classifieds by keyword and get title, price, location, seller type, and condition as structured JSON in real time.
oscaroProduct() GET / POST /v2/oscaro/product Oscaro Product API. Fetch full auto parts product data from an Oscaro product URL. Returns pricing, brand, reference, images and availabili…
oscaroSearch() GET / POST /v2/oscaro/search Oscaro Search API. Search auto parts by keyword, search URL or category listing on oscaro.com, oscaro.es and oscaro.pt. Returns prices and…
ovokoAd() GET / POST /v2/ovoko/ad Extract an Ovoko listing from a SKU URL: price, currency, images, seller, quality, vehicle make, part numbers, and warranty.
ovokoSearch() GET / POST /v2/ovoko/search Search Ovoko used-parts listings from a search URL and retrieve title, price, OEM codes, seller, vehicle text, and pagination.
owlerCompanyInfo() GET / POST /v2/owler/company/info Retrieve detailed company intelligence from Owler, including revenue, employee count, CEO info, competitors, funding, and industry sectors.
owlerSearch() GET / POST /v2/owler/search Search for companies on Owler by name or keyword, returning a list of matching companies with slugs, logos, domains, and profile URLs.
pagesjaunesPageInfo() GET / POST /v2/pagesjaunes/page/info Retrieve detailed business information from a PagesJaunes page, including contact details, opening hours, services, payment methods, and SI…
pagesjaunesSearch() GET / POST /v2/pagesjaunes/search Search PagesJaunes for French local businesses by category and location, returning paginated results with contact details and ratings.
patreonProfileInfo() GET / POST /v2/patreon/profile/info Retrieve a Patreon creator profile with patron counts, membership tiers, campaign summary, and creator metadata.
patreonSearch() GET / POST /v2/patreon/search Search Patreon creators by keyword and retrieve campaign cards with patron counts, post counts, and profile URLs.
petsmartProduct() GET / POST /v2/petsmart/product Read one PetSmart product URL, including the selected size, dollar price, flavor, and item number.
petsmartSearch() GET / POST /v2/petsmart/search Search PetSmart by keyword or search URL. Page through pet food, litter, and supplies with dollar prices.
picardProduct() GET / POST /v2/picard/product Picard Product API. Fetch full frozen food product data from a Picard URL or reference. Returns pricing, images, description, Nutri-Score,…
picardSearch() GET / POST /v2/picard/search Picard Search API. Search frozen food listings on picard.fr by keyword or URL. Parses SFCC Search-UpdateGrid HTML; returns prices, Nutri-Sc…
pinterestUserInfo() GET / POST /v2/pinterest/user/info Access Pinterest user profiles and analytics for targeted marketing and audience insights.
pitchbookCompanyInfo() GET / POST /v2/pitchbook/company/info Get a PitchBook company profile: overview, funding, competitors and more via browser rendering.
pitchbookSearch() GET / POST /v2/pitchbook/search Search PitchBook for companies, news and profiles by keyword or search URL via browser rendering.
pointpProduct() GET / POST /v2/pointp/product Point.P Product API: scrape live /p/ product pages from a full URL. Get title, images, EAN, pricing, specifications, and breadcrumbs as JSO…
pointpSearch() GET / POST /v2/pointp/search Point.P Search API: search by keyword or URL and get building-material listings with prices, brands, ratings, units, and pagination as JSON…
prnewswireArticle() GET / POST /v2/prnewswire/article Read one PR Newswire press release from its URL.
prnewswireSearch() GET / POST /v2/prnewswire/search Search PR Newswire press releases by keyword or by a news-search URL.
producthuntProductInfo() GET / POST /v2/producthunt/product/info Retrieve product data from ProductHunt, including tagline, categories, screenshots, reviews rating, and social links.
proshopProduct() GET / POST /v2/proshop/product Read one proshop.dk product page. Flat JSON with DKK price, EAN, specs, and stock text.
proshopSearch() GET / POST /v2/proshop/search Search proshop.dk by keyword or search URL. Returns product cards with DKK prices and pagination.
rappiProduct() GET / POST /v2/rappi/product Fetch one Rappi Mexico product, including the primary store price and the other store offers. The primary price can differ from a search ca…
rappiSearch() GET / POST /v2/rappi/search Search Rappi Mexico on rappi.com.mx. The city resolves to Mexico City. Each row is one store offer, and next is null.
ratemyprofessorsProfessor() GET / POST /v2/ratemyprofessors/professor Read one Rate My Professors profile, including difficulty and would-take-again when the page shows them.
ratemyprofessorsSearch() GET / POST /v2/ratemyprofessors/search Search Rate My Professors by name. Cards include school, department, difficulty, and would-take-again when the card shows them.
realestatecomauSearch() GET / POST /v2/realestatecomau/search Search realestate.com.au buy, rent, or sold results. A place such as Sydney, NSW defaults to homes for sale. Each card has price, address,…
realtorProperty() GET / POST /v2/realtor/property Extract full property details from a Realtor.com listing URL, including price, specs, photos, agents, features, and location data.
realtorSearch() GET / POST /v2/realtor/search Search Realtor.com listings from a search URL and retrieve prices, beds, baths, sqft, photos, and property metadata.
redfinProperty() GET / POST /v2/redfin/property Read one for-sale Redfin home. Pass the url from search, which already includes the market id. The response is a flat listing, the same fie…
redfinSearch() GET / POST /v2/redfin/search Search for-sale homes on Redfin from a city, neighborhood, or county link. Each listing url includes the market id to pass to the property…
reicheltProduct() GET / POST /v2/reichelt/product Read one reichelt.de product URL, including article number, EAN, and the euro price.
reicheltSearch() GET / POST /v2/reichelt/search Search reichelt.de by keyword or category. Euro prices are rebuilt from the number, including whole-euro amounts.
reverbProduct() GET / POST /v2/reverb/product Reverb Product API: fetch full listing data from a Reverb URL or listing id. Returns pricing, specs, images, description and shop info via…
reverbSearch() GET / POST /v2/reverb/search Reverb Search API: search music gear listings by keyword, query string or marketplace URL on Reverb. Returns prices, thumbnails and paginat…
rexelProduct() GET / POST /v2/rexel/product Get a Rexel France product page: references, EAN, descriptions, images and specs via browser rendering.
rexelSearch() GET / POST /v2/rexel/search Search Rexel France by keyword, EAN or search URL. Returns product cards and pagination via browser rendering.
rightmoveProperty() GET / POST /v2/rightmove/property Read one Rightmove property from its URL or numeric id. The response is a flat object with price, tenure, floor area, stations, and the age…
rightmoveSearch() GET / POST /v2/rightmove/search Search Rightmove by a UK place name or a search URL. Each card has a numeric price, a price label rebuilt from that number, the address, th…
rsonlineProduct() GET / POST /v2/rsonline/product Read one RS Online UK product URL, including the RS stock number, manufacturer part, and pound price.
rsonlineSearch() GET / POST /v2/rsonline/search Search RS Online UK by keyword or category. Pound prices keep the amount printed on the page.
seekJob() GET / POST /v2/seek/job Read one SEEK Australia job from its URL or numeric id.
seekSearch() GET / POST /v2/seek/search Search SEEK Australia jobs by keyword or by a results URL.
selogerAgency() GET / POST /v2/seloger/agency Retrieve detailed profile information for a SeLoger real estate agency including contact details, ratings, reviews, and address.
selogerAgencyRent() GET / POST /v2/seloger/agency/rent Retrieve paginated rental property listings published by a specific SeLoger agency using its numeric agency ID.
selogerAgencySale() GET / POST /v2/seloger/agency/sale Retrieve paginated sale property listings published by a specific SeLoger agency using its numeric agency ID.
selogerProperty() GET / POST /v2/seloger/property Efficiently extract detailed data from a SeLoger real estate listing including agency info, pricing, photos, description, and property crit…
selogerSearch() GET / POST /v2/seloger/search Efficiently extract real estate listings from SeLoger search pages for market insights, property management, and investment analysis.
sephoraProduct() GET / POST /v2/sephora/product Read one European Sephora product by id or product URL. Set region when you are not on the French shop.
sephoraSearch() GET / POST /v2/sephora/search Search a European Sephora shop by keyword. Region defaults to France. Page through makeup and skincare cards. The US site is a different pa…
shophouzzProduct() GET / POST /v2/shophouzz/product Retrieve full product details from Shophouzz, including title, price, variants, images, vendor, and structured metadata.
shopifyApps() GET / POST /v2/shopify/apps Retrieve structured details about any Shopify App Store listing, including title, logo, screenshots, pricing plans, categories, and descrip…
shopifyCatalog() GET / POST /v2/shopify/catalog List products from a Shopify shop. query is the shop domain or a URL on that shop. page and limit choose the slice.
shopifyCollections() GET / POST /v2/shopify/collections List collections from a Shopify shop. query is the shop domain or a URL on that shop. page and limit choose the slice.
shopifyProduct() GET / POST /v2/shopify/product Extract full product details from any Shopify store product page, including title, variants, pricing, images, inventory, and options.
similarwebDomain() GET / POST /v2/similarweb/domain Retrieve website traffic and engagement metrics for a domain from the public Similarweb page, including visits, bounce rate, rank, keywords…
similarwebSearch() GET / POST /v2/similarweb/search Search the public Similarweb page for websites, companies, and mobile apps related to a keyword.
snapedaProduct() GET / POST /v2/snapeda/product SnapEDA Product API: fetch full part page data from a SnapEDA URL or MPN/manufacturer slug. Returns CAD models, datasheet, RoHS, distributo…
snapedaSearch() GET / POST /v2/snapeda/search SnapEDA Search API: search electronic parts by keyword or URL on SnapMagic Search (ex-SnapEDA). Returns MPN, manufacturer, pricing, CAD ava…
starbucksMenu() GET / POST /v2/starbucks/menu Full Starbucks menu for one café, with the default-size price of each item. Prices use browser rendering.
starbucksProduct() GET / POST /v2/starbucks/product One Starbucks item at one café, with a price for every size. Get the café from Search first. Prices use browser rendering.
starbucksSearch() GET / POST /v2/starbucks/search Nearest Starbucks cafés from coordinates or a store-locator URL. Returns address, hours, amenities, and the store number used by Menu and P…
stats() GET /v2/stats Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant. Enabled per account: HTTP 403 mea…
stockxProduct() GET / POST /v2/stockx/product Retrieve detailed product information from StockX, including market prices, bid/ask data, size variants, and product metadata.
stockxSearch() GET / POST /v2/stockx/search Search StockX for products by name, brand, SKU, or slug and receive a list of matching items with product IDs, slugs, images, and colorways.
stockxTrends() GET / POST /v2/stockx/trends Retrieve trending products on StockX by category, with options to sort by featured, most active, or release date.
stubhubEvent() GET / POST /v2/stubhub/event Read one StubHub event from its URL or numeric id, including the lowest printed ticket price.
stubhubSearch() GET / POST /v2/stubhub/search Search StubHub events by keyword or by a StubHub search URL. The response is the first embedded page.
targetProduct() GET / POST /v2/target/product Get a Target.com product page: price, description, images and variations via browser rendering.
targetSearch() GET / POST /v2/target/search Search Target.com by keyword or search URL. Returns product cards with price, rating and pagination via browser rendering.
tdlrLicense() GET / POST /v2/tdlr/license Fetch one TDLR license by detail id or SearchResultDetail URL, including status, subtype, DBA, and notes.
tdlrSearch() GET / POST /v2/tdlr/search Search Texas TDLR licenses by name, city, county, or ZIP. license_type such as AIRREF is required for a useful search. 25 rows per page.
tedNotice() GET / POST /v2/ted/notice TED notice profile: buyer, lots, deadline, value and documents (1 credit).
tedSearch() GET / POST /v2/ted/search Search TED procurement notices by keyword or filters. Returns notice cards and pagination (1 credit).
thaliaProduct() GET / POST /v2/thalia/product Read one Thalia product from its URL. You get price, author or brand, and the product details.
thaliaSearch() GET / POST /v2/thalia/search Search Thalia by keyword and page books, media, and gifts. Cards include title, price, and the product link.
theforkRestaurant() GET / POST /v2/thefork/restaurant Extract a full TheFork restaurant profile from a restaurant page URL, including ratings, tags, photo gallery, opening hours, and AI review…
theforkSearch() GET / POST /v2/thefork/search Search TheFork restaurants from a full search or city URL and retrieve ratings, cuisine, prices, availability, review summaries, and pagina…
thomasnetCompany() GET / POST /v2/thomasnet/company Get a full Thomasnet supplier profile from a company URL, including contact details, product categories, and business information.
thomasnetSearch() GET / POST /v2/thomasnet/search Search Thomasnet suppliers from a search or category URL and get company listings, filters, name suggestions, and pagination.
ticketmasterEvent() GET / POST /v2/ticketmaster/event Fetch one Ticketmaster event from a slugged event URL. The slug is searched and the matching event id is returned with the venue address.
ticketmasterSearch() GET / POST /v2/ticketmaster/search Search Ticketmaster events by keyword. Returns event cards, including Ticketweb partner rows, and pagination.
tiktoktopadsAd() GET / POST /v2/tiktoktopads/ad Get one TikTok Creative Center Top Ad by URL or id: creative, landing page, CTR, and engagement (1 credit).
tiktoktopadsSearch() GET / POST /v2/tiktoktopads/search Search TikTok Creative Center Top Ads by region, objective, period, and keyword. Returns ad cards and pagination (1 credit).
tradeaplaneListing() GET / POST /v2/tradeaplane/listing Read one Trade-A-Plane aircraft listing from its URL. You get the asking price, the airframe details, and the seller.
tradeaplaneSearch() GET / POST /v2/tradeaplane/search Search Trade-A-Plane aircraft listings by keyword and page the results. Cards include title, price, and the listing link.
trustpilotCompanyInfo() GET / POST /v2/trustpilot/company/info Retrieve Trustpilot company profile data, including trust score, star rating, categories, contact info, and review response behavior.
untappdBeer() GET / POST /v2/untappd/beer Read one Untappd beer, including ABV, IBU, and brewery.
untappdSearch() GET / POST /v2/untappd/search Search Untappd beers by keyword. Cards include brewery, ABV, and IBU. next is null when Untappd does not expose a next page.
upworkFreelancer() GET / POST /v2/upwork/freelancer Upwork Freelancer API: fetch public freelancer profile data from a profile ID, username or URL. Returns bio, hourly rate, skills, ratings a…
upworkJobs() GET / POST /v2/upwork/jobs Upwork Jobs API: search freelance job listings by skill slug or URL. Returns budgets, skills, experience level and pagination via browser r…
upworkServices() GET / POST /v2/upwork/services Upwork Services API: browse Project Catalog listings by category slug or URL. Returns prices, product IDs and pagination via browser render…
upworkServicesInfo() GET / POST /v2/upwork/services/info Upwork Services Info API: fetch Project Catalog product details from a product URL. Returns packages, pricing, seller, media and breadcrumb…
usage() GET /v2/usage Retrieve real-time usage statistics and credit balance for your Piloterr account.
usaspendingAward() GET / POST /v2/usaspending/award Fetch one US federal award by its generated id or by a usaspending.gov award URL. Amounts are a number plus a display string.
usaspendingSearch() GET / POST /v2/usaspending/search Search US federal awards by keyword. award_type selects one group: contract (default), grant, idv, or loan. Amounts are a number plus a dis…
vestiairecollectiveProduct() GET / POST /v2/vestiairecollective/product Fetch one Vestiaire Collective listing by product URL. The response is a flat object with price, size, condition, and seller.
vestiairecollectiveSearch() GET / POST /v2/vestiairecollective/search Search Vestiaire Collective by keyword or catalog URL. Each card has brand, name, price, size, and a product link.
vintedItem() GET / POST /v2/vinted/item Fetch a Vinted listing by item URL or numeric ID. Parses the public item page (Next.js payload), returns a normalized snake_case object wit…
vintedSearch() GET / POST /v2/vinted/search Search Vinted second-hand listings by keyword or catalog URL across vinted.fr, vinted.com and other domains. Returns results and pagination.
vintedUserInfo() GET / POST /v2/vinted/user/info Retrieve public Vinted seller profile by member URL or user ID. Returns the raw /api/v2/users/{id} object: login, photo, feedback stats, fo…
vivarealProperty() GET / POST /v2/vivareal/property Read one Viva Real property from its URL. The price follows the operation of that URL, so a sale link stays a sale price.
vivarealSearch() GET / POST /v2/vivareal/search Search Viva Real by city and operation, sale or rent. Page with pagina. Development cards and 'from' prices are left out.
walmartProduct() GET / POST /v2/walmart/product Extract full Walmart product page (PDP) data from a /ip/ URL: pricing, ratings, images, fulfillment, specs, badges, and availability via br…
walmartSearch() GET / POST /v2/walmart/search Scrape Walmart.com search result pages from a full URL and retrieve product cards with pricing, ratings, availability, and pagination via b…
walmartSuggest() GET / POST /v2/walmart/suggest Get Walmart.com search autocomplete suggestions for a keyword via browser rendering, with optional US ZIP code localization.
websiteAntibot() GET /v2/website/antibot Detect which anti-bot protection protects a website before you scrape. Get the vendor, confidence level, and matching clues from a single U…
websiteCrawler() GET / POST /v2/website/crawler Fetch public pages with fast HTTP crawling (no JavaScript). Best first choice for static or server-rendered HTML; use Rendering or WebUnloc…
websiteEmailPhoneExtractor() GET / POST /v2/website/email_phone_extractor Extract emails and phone numbers from websites for comprehensive contact details, including social media profiles across 12+ platforms.
websiteRendering() GET / POST /v2/website/rendering Render JavaScript-heavy pages in a headless browser and return post-render HTML. Use when Crawler returns empty DOM; escalate to WebUnlocke…
websiteScreenshot() GET / POST /v2/website/screenshot Browser-like Screenshot API that captures webpages as PNG/JPEG/WebP or PDF for previews, QA, reporting, monitoring, and archiving no headle…
websiteTechnology() GET / POST /v2/website/technology Identify the technologies behind any website CMS, frameworks, analytics, CDN, hosting, and more, for competitive market analysis and techno…
websiteWebunlocker() GET / POST /v2/website/webunlocker Bypass advanced anti-bot systems (Cloudflare, DataDome, Akamai, PerimeterX) on whitelisted domains. Combines browser rendering and unlock t…
weiboPostInfo() GET / POST /v2/weibo/post/info Retrieve one public Weibo post by post id, including text, images, publish time, engagement counts, and author profile.
weiboSearch() GET / POST /v2/weibo/search Search public Weibo posts by keywords. Each post includes the author, text, publish time, engagement counts, image, and video link.
welcometothejungleCompany() GET / POST /v2/welcometothejungle/company Welcome to the Jungle company profile: headcount, offices, sectors and website (1 credit).
welcometothejungleSearch() GET / POST /v2/welcometothejungle/search Search Welcome to the Jungle jobs. Returns offer cards and pagination (1 credit).
wellfoundCompanyInfo() GET / POST /v2/wellfound/company/info Retrieve startup and company data from Wellfound (formerly AngelList), including description, funding, team size, hiring status, and social…
xPostInfo() GET / POST /v2/x/post/info X Post Info API: fetch public tweet data (text, likes, retweets, views, media) from a status URL or tweet ID via browser rendering.
xProfileInfo() GET / POST /v2/x/profile/info X Profile Info API: fetch public X/Twitter profile data (bio, followers, verification, avatars) from a username or URL via browser renderin…
yahooSearch() GET / POST /v2/yahoo/search Query Yahoo via API and retrieve structured organic results with country and language.
yellowpagesBusiness() GET / POST /v2/yellowpages/business Extract a full Yellow Pages business profile from a listing URL, including phone, website, categories, and ratings via browser rendering.
yellowpagesSearch() GET / POST /v2/yellowpages/search Search Yellow Pages businesses from a full search URL and retrieve names, phones, addresses, ratings, opening hours, and pagination via bro…
yelpBusiness() GET / POST /v2/yelp/business Fetch a Yelp business profile from a full business URL with phone, address, website, logo, hours, and claim status.
yelpReviews() GET / POST /v2/yelp/reviews Fetch paginated Yelp reviews for a business with rating, text, author profile, reactions, and attached photos or videos.
yelpSearch() GET / POST /v2/yelp/search Search Yelp by keyword and location and retrieve paginated business cards with ratings, categories, photos, and sponsored flags.
zapimoveisAd() GET / POST /v2/zapimoveis/ad Get a full Zap Imóveis listing by URL: price, IPTU, features, coordinates, images, and publisher (1 credit).
zapimoveisSearch() GET / POST /v2/zapimoveis/search Search Zap Imóveis listings by city or search URL. Returns prices, IPTU, condominium fees, rooms, and pagination (1 credit).
zazzleProduct() GET / POST /v2/zazzle/product Fetch one Zazzle product by its product URL or by a slug that ends in the numeric product id.
zazzleSearch() GET / POST /v2/zazzle/search Search Zazzle products by keyword. page maps to the pg parameter. Prices are a number plus a display string.
zillowProperty() GET / POST /v2/zillow/property Extract full property details from a Zillow homedetails URL, including specs, photos, schools, tax history, and agent attribution.
zillowSearch() GET / POST /v2/zillow/search Search Zillow listings from a search or map URL and retrieve prices, beds, baths, coordinates, and listing status.
zonapropProperty() GET / POST /v2/zonaprop/property Read one ZonaProp listing from its URL. You get the asking price in USD or ARS, the address, and the publisher.
zonapropSearch() GET / POST /v2/zonaprop/search Search ZonaProp for apartments or houses in an Argentine city. Page with pagina. A few featured ads can repeat. Development projects priced…
zooplaProperty() GET / POST /v2/zoopla/property Extract full property details from a Zoopla listing URL, including price, specs, photo gallery, EPC rating, coordinates, and agent data.
zooplaSearch() GET / POST /v2/zoopla/search Search Zoopla listings from a search URL and retrieve prices, specs, photos, agency info, and pagination.
zooplusProduct() GET / POST /v2/zooplus/product Read one Zooplus product by id or URL, in the region of that shop. Variants keep their own price and EAN.
zooplusSearch() GET / POST /v2/zooplus/search Search a Zooplus country shop by keyword. Region defaults to France. Page through food, litter, and accessory cards with local prices.
zoroProduct() GET / POST /v2/zoro/product Get a Zoro product page: title, brand, USD price, Zoro number, manufacturer number, images, and specifications.
zoroSearch() GET / POST /v2/zoro/search Search Zoro by keyword or category URL. Returns product cards with USD price, brand, Zoro number, and pagination.

All Piloterr SDKs

SDK Package Install
Node.js @piloterr/sdk npm install @piloterr/sdk
Python piloterr pip install piloterr
Go piloterr-go go get github.com/piloterr/piloterr-go
.NET Piloterr dotnet add package Piloterr
Ruby piloterr gem install piloterr
PHP piloterr/sdk composer require piloterr/sdk
Java piloterr-java build from source, see its README
CLI @piloterr/cli npm install -g @piloterr/cli
MCP server @piloterr/mcp npx -y @piloterr/mcp

License

MIT — see LICENSE.

About

Official Node.js and TypeScript SDK for the Piloterr web scraping API.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages