piloterr

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 6, 2026 License: MIT Imports: 18 Imported by: 0

README

Piloterr Go SDK

The official Go 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(). It has no dependencies outside the standard library.

Requirements

  • Go 1.22 or newer

Installation

go get github.com/piloterr/piloterr-go

Get your API key

Sign up for Piloterr or sign in, then copy your API key from the dashboard. NewClient("", nil) reads the PILOTERR_API_KEY environment variable.

Quick start

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/piloterr/piloterr-go"
)

func main() {
	client, err := piloterr.NewClient("", nil) // reads PILOTERR_API_KEY
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()
	response, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S"})
	if err != nil {
		log.Fatal(err)
	}
	data, err := response.Map()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(data)
}

Parameter structs mirror the API reference. Required fields are plain values; optional fields are pointers — use piloterr.String, piloterr.Float, piloterr.Int and piloterr.Bool.

Decode into your own types with response.Decode(&value).

Binary responses

Endpoints that return a file (image, PDF…) give you the bytes in Body; IsJSON tells both cases apart:

response, err := client.WebsiteScreenshot(ctx, &piloterr.WebsiteScreenshotParams{URL: "https://example.com"})
if err != nil {
	log.Fatal(err)
}
if !response.IsJSON {
	err = os.WriteFile("screenshot.png", response.Body, 0o644)
}

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 a terminal status (CompletedJob, Error, NotFound, BadRequest):

submitted, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S", IsAsync: piloterr.Bool(true)})
if err != nil {
	log.Fatal(err)
}
var accepted struct{ JobID string `json:"job_id"` }
if err := submitted.Decode(&accepted); err != nil {
	log.Fatal(err)
}
job, err := client.WaitForJob(ctx, accepted.JobID, &piloterr.WaitForJobOptions{
	OnProgress: func(job map[string]any) { fmt.Println(job["status"], job["progress"]) },
})

GET or POST

Methods use GET when the endpoint supports it (parameters in the query string); WithMethod("POST") sends them as a JSON body.

response, err := client.AboutyouProduct(ctx, &piloterr.AboutyouProductParams{Query: "test"}, piloterr.WithMethod("POST"))

Any endpoint

response, err := client.Request(ctx, "GET", "/v1/usage", nil)

Errors

response, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S"})
if apiError, ok := piloterr.IsAPIError(err); ok {
	log.Printf("HTTP %d: %s", apiError.StatusCode, apiError.Message)
}
Error When
*ConfigurationError Missing API key, invalid options or unsupported method.
*SerializationError A required parameter is missing or a value can't be sent.
*TransportError Network failure, timeout or cancelled context (errors.Is(err, context.DeadlineExceeded)).
*APIError Non-2xx status (StatusCode, Message, Response).
*ResponseDecodingError A success response could not be decoded.

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.

client, err := piloterr.NewClient("", &piloterr.ClientOptions{
	MaxRetries: 5,                      // negative disables retries
	RetryDelay: 500 * time.Millisecond,
})

// or for one request
response, err := client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: "B09DFCB66S"}, piloterr.WithMaxRetries(0))

Batch requests

piloterr.Batch runs a function per item with at most 10 calls in flight and returns one BatchResult per item, in input order. A failing item never stops the others.

inputs := []string{"B09DFCB66S", "B0BSHF7WHW", "B08N5WRWNW"}
results := piloterr.Batch(ctx, inputs, 5, func(ctx context.Context, value string) (*piloterr.Response, error) {
	return client.AmazonProduct(ctx, &piloterr.AmazonProductParams{Query: value})
})
for _, result := range results {
	if result.Err != nil {
		log.Printf("%s: %v", inputs[result.Index], result.Err)
		continue
	}
	fmt.Println(string(result.Value.Body))
}
Constant Default Description
DefaultConcurrency 10 Tasks run at the same time by batch
DefaultTimeout 120 * time.Second Request timeout
MaxRetries 3 Retry attempts after a network error, a 408/5xx or a rate limit
RetryBackoffFactor 1.5 Exponential backoff multiplier
DefaultRetryDelay time.Second Delay before the first retry

Timeouts and custom HTTP clients

client, err := piloterr.NewClient("", &piloterr.ClientOptions{
	Timeout:    60 * time.Second, // default 120 s; negative disables
	HTTPClient: &http.Client{Transport: myTransport},
})

Every method also honours the deadline and cancellation of the context.Context you pass.

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.

License

MIT — see LICENSE.

Documentation

Overview

Package piloterr is the official Go SDK for the Piloterr API (https://www.piloterr.com).

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

Create one client and reuse it: 

client, err := piloterr.NewClient("", nil) // reads PILOTERR_API_KEY
response, err := client.AmazonProduct(ctx, ...)

Every documented endpoint has a typed method; Client.Request reaches any other path.

Index

Constants

View Source 
const (
	// DefaultBaseURL is the production API origin.
	DefaultBaseURL = "https://api.piloterr.com"
	// DefaultTimeout bounds every request unless ClientOptions.Timeout says otherwise.
	DefaultTimeout = 120 * time.Second
	// APIKeyEnvironmentVariable is read when NewClient receives an empty API key.
	APIKeyEnvironmentVariable = "PILOTERR_API_KEY"
	// DefaultConcurrency is the number of tasks Batch runs at the same time.
	DefaultConcurrency = 10
	// MaxRetries is the default number of retries after a network error or a 408, 429, 500, 502, 503 or 504.
	MaxRetries = 3
	// RetryBackoffFactor multiplies the delay before each new retry (a Retry-After header wins).
	RetryBackoffFactor = 1.5
	// DefaultRetryDelay is the delay before the first retry.
	DefaultRetryDelay = time.Second
	// MaxRetryDelay caps the delay between two attempts.
	MaxRetryDelay = 30 * time.Second
)
View Source 
const Version = "0.1.0"

Version is the SDK version sent in the User-Agent header.

Variables

View Source 
var JobTerminalStatuses = []string{"CompletedJob", "Error", "NotFound", "BadRequest"}

JobTerminalStatuses are the job statuses WaitForJob stops on.

Functions

func Bool 

func Bool(v bool) *bool

Bool returns a pointer to v, for optional boolean parameters.

func Float 

func Float(v float64) *float64

Float returns a pointer to v, for optional number parameters.

func Int 

func Int(v int64) *int64

Int returns a pointer to v, for optional integer parameters.

func String 

func String(v string) *string

String returns a pointer to v, for optional parameters.

Types

type APIError 

type APIError struct {
	StatusCode int
	// Message is the "error" (or "message") field of the JSON body, when present.
	Message  string
	Response *Response
}

APIError is returned for non-2xx responses.

func IsAPIError 

func IsAPIError(err error) (*APIError, bool)

IsAPIError reports whether err is an *APIError and returns it.

func (*APIError) Error 

func (e *APIError) Error() string

type AboutyouProductParams 

type AboutyouProductParams struct {
	// Product URL or keyword. A keyword opens the first search result.
	Query string `json:"query" api:"query,required"`
	// Shop code. Default is fr. A full link in query picks the shop, and a conflicting region returns 400.
	Region *string `json:"region" api:"region"`
	// Return the rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AboutyouProductParams holds the parameters of AboutyouProduct (GET / POST /v2/aboutyou/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AboutyouSearchParams 

type AboutyouSearchParams struct {
	// Keyword or About You search, category, or brand URL.
	Query string `json:"query" api:"query,required"`
	// Shop code. Default is fr. A full link in query picks the shop, and a conflicting region returns 400.
	Region *string `json:"region" api:"region"`
	// Only page 1 is available.
	Page *float64 `json:"page" api:"page"`
	// Return the rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AboutyouSearchParams holds the parameters of AboutyouSearch (GET / POST /v2/aboutyou/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ActionProductParams 

type ActionProductParams struct {
	// Action product ID or full product URL.
	Query string `json:"query" api:"query,required"`
	// Locale (fr-fr, de-de, pt-pt, …) or country code (fr, de, pt). Default: fr-fr.
	Region *string `json:"region" api:"region"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ActionProductParams holds the parameters of ActionProduct (GET / POST /v2/action/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ActionSearchParams 

type ActionSearchParams struct {
	// Search keyword or full Action.com search URL.
	Query string `json:"query" api:"query,required"`
	// Locale (fr-fr, de-de, pt-pt, …) or country code (fr, de, pt). Default: fr-fr.
	Region *string `json:"region" api:"region"`
	// 1-based page number (default: 1).
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ActionSearchParams holds the parameters of ActionSearch (GET / POST /v2/action/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AldiProductParams 

type AldiProductParams struct {
	// Aldi product page URL or site path slug.
	Query string `json:"query" api:"query,required"`
	// Target country when query is a path only (default: fr). Ignored for full product URLs.
	Region *string `json:"region" api:"region"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AldiProductParams holds the parameters of AldiProduct (GET / POST /v2/aldi/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AldiSearchParams 

type AldiSearchParams struct {
	// Aldi category page URL or site path.
	Query string `json:"query" api:"query,required"`
	// Target country when query is a path only (default: fr).
	Region *string `json:"region" api:"region"`
	// 1-based page number override (default: read from URL or 1).
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AldiSearchParams holds the parameters of AldiSearch (GET / POST /v2/aldi/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AlibabaProductParams 

type AlibabaProductParams struct {
	// Full Alibaba product URL or numeric product ID.
	Query string `json:"query" api:"query,required"`
	// Locale subdomain when query is a bare product ID, or to override the host on a product URL.
	Subdomain *string `json:"subdomain" api:"subdomain"`
	// When true, return the rendered HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AlibabaProductParams holds the parameters of AlibabaProduct (GET / POST /v2/alibaba/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AlibabaSearchParams 

type AlibabaSearchParams struct {
	// Search keyword or full Alibaba search URL.
	Query string `json:"query" api:"query,required"`
	// Locale subdomain for keyword searches when query is not a full URL.
	Subdomain *string `json:"subdomain" api:"subdomain"`
	// 1-based page number (20 results per page). Default: 1.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw open-s JSON as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AlibabaSearchParams holds the parameters of AlibabaSearch (GET / POST /v2/alibaba/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AliexpressProductParams 

type AliexpressProductParams struct {
	// Full AliExpress product page URL (/item/{id}.html).
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of parsed JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AliexpressProductParams holds the parameters of AliexpressProduct (GET / POST /v2/aliexpress/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AliexpressProductReviewsParams 

type AliexpressProductReviewsParams struct {
	// AliExpress product id or item URL.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Defaults to 1. The feed returns up to 20 reviews per page. pagination.next is the next page URL, or null on the last page.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw feed body as {"result": "..."} instead of parsed JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AliexpressProductReviewsParams holds the parameters of AliexpressProductReviews (GET / POST /v2/aliexpress/product/reviews). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AliexpressSearchParams 

type AliexpressSearchParams struct {
	// Search keyword or full AliExpress search results URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AliexpressSearchParams holds the parameters of AliexpressSearch (GET / POST /v2/aliexpress/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AliexpressStoreProductParams 

type AliexpressStoreProductParams struct {
	// AliExpress store URL or numeric store ID.
	Query string `json:"query" api:"query,required"`
	// Optional sort alias for the store all-items page.
	Sort *string `json:"sort" api:"sort"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AliexpressStoreProductParams holds the parameters of AliexpressStoreProduct (GET / POST /v2/aliexpress/store/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AllegroProductParams 

type AllegroProductParams struct {
	// Full allegro.pl product or offer URL to extract structured PDP data.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AllegroProductParams holds the parameters of AllegroProduct (GET / POST /v2/allegro/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AllegroSearchParams 

type AllegroSearchParams struct {
	// Search keyword or full Allegro listing URL.
	Query string `json:"query" api:"query,required"`
	// Page number for keyword searches (default 1).
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AllegroSearchParams holds the parameters of AllegroSearch (GET / POST /v2/allegro/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AmazonProductOfferParams 

type AmazonProductOfferParams struct {
	// Amazon product ASIN (Amazon Standard Identification Number) to retrieve third-party seller offers for.
	Query string `json:"query" api:"query,required"`
	// Amazon domain extension to query. Controls which Amazon marketplace is targeted. Default: "com".
	Domain *string `json:"domain" api:"domain"`
	// Page number for paginated offer results. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AmazonProductOfferParams holds the parameters of AmazonProductOffer (GET / POST /v2/amazon/product/offer). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AmazonProductParams 

type AmazonProductParams struct {
	// Amazon product ASIN (Amazon Standard Identification Number) to retrieve full product details for.
	Query string `json:"query" api:"query,required"`
	// Amazon domain extension to query. Controls which Amazon marketplace is targeted. Default: "com".
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AmazonProductParams holds the parameters of AmazonProduct (GET / POST /v2/amazon/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AmazonSearchParams 

type AmazonSearchParams struct {
	// Keyword or phrase to search for products on Amazon.
	Query string `json:"query" api:"query,required"`
	// Amazon domain extension to query. Controls which Amazon marketplace is searched. Default: "com".
	Domain *string `json:"domain" api:"domain"`
	// Page number for paginated search results. Each page returns up to 60 results. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AmazonSearchParams holds the parameters of AmazonSearch (GET / POST /v2/amazon/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ApartmentsPropertyParams 

type ApartmentsPropertyParams struct {
	// Full Apartments.com property listing URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ApartmentsPropertyParams holds the parameters of ApartmentsProperty (GET / POST /v2/apartments/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ApartmentsSearchParams 

type ApartmentsSearchParams struct {
	// Full Apartments.com search or city browse URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ApartmentsSearchParams holds the parameters of ApartmentsSearch (GET / POST /v2/apartments/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ArgenpropPropertyParams 

type ArgenpropPropertyParams struct {
	// The full listing page on argenprop.com. Copy it from results[].url on [Argenprop Search](https://www.piloterr.com/library/argenprop-search). The listing id is the number after the double dash.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ArgenpropPropertyParams holds the parameters of ArgenpropProperty (GET / POST /v2/argenprop/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ArgenpropSearchParams 

type ArgenpropSearchParams struct {
	// The place to search, or a full Argenprop results page.
	Query string `json:"query" api:"query,required"`
	// Which page of the list to open. The first page is 1. The placeholder is 2. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Sale or rent, when query is a place name. The placeholder is venta, which means for sale. alquiler is a long-term rental. alquiler-temporal is a short stay. sale, buy, and rent are accepted as aliases. Default: "venta".
	Operation *string `json:"operation" api:"operation"`
	// The kind of home, when query is a place name. The placeholder is departamentos, which means apartments. Also accepted: casas (houses), ph, terrenos, locales, oficinas, and quintas. casa and house map to casas. Default: "departamentos".
	PropertyType *string `json:"property_type" api:"property_type"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ArgenpropSearchParams holds the parameters of ArgenpropSearch (GET / POST /v2/argenprop/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ArgosProductParams 

type ArgosProductParams struct {
	// Argos product id or product URL.
	Query string `json:"query" api:"query,required"`
	// When true, return raw HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ArgosProductParams holds the parameters of ArgosProduct (GET / POST /v2/argos/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ArgosSearchParams 

type ArgosSearchParams struct {
	// Keyword or Argos UK search URL.
	Query string `json:"query" api:"query,required"`
	// Page number from 1.
	Page *float64 `json:"page" api:"page"`
	// When true, return raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ArgosSearchParams holds the parameters of ArgosSearch (GET / POST /v2/argos/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ArxivPaperParams 

type ArxivPaperParams struct {
	// Required. arXiv id or an abs, pdf, or html URL. Example: 2201.00978 or https://arxiv.org/abs/cond-mat/0011267v1.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ArxivPaperParams holds the parameters of ArxivPaper (GET / POST /v2/arxiv/paper). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ArxivSearchParams 

type ArxivSearchParams struct {
	// Required. Keyword, fielded query such as au:einstein, arXiv id, or an arxiv.org search URL. Example: electron. A paper URL such as https://arxiv.org/abs/2201.00978 returns 400.
	Query string `json:"query" api:"query,required"`
	// Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 papers.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ArxivSearchParams holds the parameters of ArxivSearch (GET / POST /v2/arxiv/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AuchanProductParams 

type AuchanProductParams struct {
	// URL of the Auchan product page to extract data from.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AuchanProductParams holds the parameters of AuchanProduct (GET / POST /v2/auchan/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AuchanSearchParams 

type AuchanSearchParams struct {
	// Search keyword or Auchan search URL to retrieve product listings.
	Query string `json:"query" api:"query,required"`
	// Page number for paginated search results. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AuchanSearchParams holds the parameters of AuchanSearch (GET / POST /v2/auchan/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AutodocProductParams 

type AutodocProductParams struct {
	// HTTPS URL of an Autodoc product page.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AutodocProductParams holds the parameters of AutodocProduct (GET / POST /v2/autodoc/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AutodocProductRelatedParams 

type AutodocProductRelatedParams struct {
	// Same HTTPS product page URL as Product.
	Query string `json:"query" api:"query,required"`
	// TecDoc maker id from compatibility.cars[] / compatibility.trucks[], e.g. 93 for RENAULT.
	MakerID float64 `json:"maker_id" api:"maker_id,required"`
	// Required. pkw (passenger cars) or lkw (commercial). Must match the compatibility row. Default: "pkw".
	VehicleType string `json:"vehicle_type" api:"vehicle_type,required"`
	// Required maker label from compatibility, e.g. RENAULT. Used to parse vehicle lines.
	MakerName string `json:"maker_name" api:"maker_name,required"`
	// Required article id from Product response or URL path, e.g. 7999541.
	ProductID float64 `json:"product_id" api:"product_id,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AutodocProductRelatedParams holds the parameters of AutodocProductRelated (GET / POST /v2/autodoc/product/related). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AutodocSearchParams 

type AutodocSearchParams struct {
	// Full Autodoc search/listing URL, or path only when domain sets the shop.
	Query string `json:"query" api:"query,required"`
	// Regional shop hostname without https:// or www. (e.g. auto-doc.fr, autodoc.de). Omit to default to autodoc.de.
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AutodocSearchParams holds the parameters of AutodocSearch (GET / POST /v2/autodoc/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AutoeuropeResultParams 

type AutoeuropeResultParams struct {
	// Vehicle id from search results[].id, or a package id of that vehicle.
	OfferID string `json:"offer_id" api:"offer_id,required"`
	// Same pickup place as the search. Example: CDG
	Pickup string `json:"pickup" api:"pickup,required"`
	// Same pickup date as the search, YYYY-MM-DD. Example: 2026-11-06
	PickupDate string `json:"pickup_date" api:"pickup_date,required"`
	// Same return date as the search, YYYY-MM-DD, after pickup_date. Example: 2026-11-09
	DropoffDate string `json:"dropoff_date" api:"dropoff_date,required"`
	// Country site used for the search. Default fr. Example: fr. There is no page parameter.
	Region *string `json:"region" api:"region"`
	// Return place when it differs from pickup.
	Dropoff *string `json:"dropoff" api:"dropoff"`
	// Pickup time HH:MM. Default 10:00. Default: "10:00".
	PickupTime *string `json:"pickup_time" api:"pickup_time"`
	// Return time HH:MM. Default 10:00. Default: "10:00".
	DropoffTime *string `json:"dropoff_time" api:"dropoff_time"`
	// Driver age from 18 to 99. Default 40.
	DriverAge *float64 `json:"driver_age" api:"driver_age"`
	// When true, return the raw quote HTML instead of JSON. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AutoeuropeResultParams holds the parameters of AutoeuropeResult (GET / POST /v2/autoeurope/result). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AutoeuropeSearchParams 

type AutoeuropeSearchParams struct {
	// Pickup place or airport code.
	Pickup string `json:"pickup" api:"pickup,required"`
	// Pickup date, YYYY-MM-DD.
	PickupDate string `json:"pickup_date" api:"pickup_date,required"`
	// Return date, YYYY-MM-DD, after pickup_date.
	DropoffDate string `json:"dropoff_date" api:"dropoff_date,required"`
	// Country site. Default fr. Example: fr. A code such as de or uk, or a full Auto Europe URL. There is no page parameter.
	Region *string `json:"region" api:"region"`
	// Return place when it differs from pickup.
	Dropoff *string `json:"dropoff" api:"dropoff"`
	// Pickup time HH:MM. Default 10:00. Default: "10:00".
	PickupTime *string `json:"pickup_time" api:"pickup_time"`
	// Return time HH:MM. Default 10:00. Default: "10:00".
	DropoffTime *string `json:"dropoff_time" api:"dropoff_time"`
	// Driver age from 18 to 99. Default 40.
	DriverAge *float64 `json:"driver_age" api:"driver_age"`
	// When true, return the raw quote HTML instead of JSON. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AutoeuropeSearchParams holds the parameters of AutoeuropeSearch (GET / POST /v2/autoeurope/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type Autoscout24AdParams 

type Autoscout24AdParams struct {
	// Full AutoScout24 listing URL. An inactive listing that still contains script#__NEXT_DATA__ is returned with status Inactive. A page without that selector returns 404.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

Autoscout24AdParams holds the parameters of Autoscout24Ad (GET / POST /v2/autoscout24/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type Autoscout24SearchParams 

type Autoscout24SearchParams struct {
	// Full AutoScout24 search URL. Filters and page in the URL are kept. page starts at 1. A page with no cards returns 404.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

Autoscout24SearchParams holds the parameters of Autoscout24Search (GET / POST /v2/autoscout24/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AutotraderAdParams 

type AutotraderAdParams struct {
	// Full AutoTrader UK car details URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AutotraderAdParams holds the parameters of AutotraderAd (GET / POST /v2/autotrader/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type AutotraderSearchParams 

type AutotraderSearchParams struct {
	// Full AutoTrader UK car search URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

AutotraderSearchParams holds the parameters of AutotraderSearch (GET / POST /v2/autotrader/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BatchResult 

type BatchResult[T any] struct {
	Index int
	Value T
	Err   error
}

BatchResult is the outcome of one Batch item.

func Batch 

func Batch[I, T any](ctx context.Context, items []I, concurrency int, task func(ctx context.Context, item I) (T, error)) []BatchResult[T]

Batch runs task for every item with at most concurrency calls in flight (DefaultConcurrency when concurrency <= 0) and returns one result per item, in input order. A failing item never stops the others; items not started when ctx is done get ctx.Err().

type BestbuyProductParams 

type BestbuyProductParams struct {
	// Full Best Buy product URL.
	Query string `json:"query" api:"query,required"`
	// When true, return rendered HTML as {"result": "..."} instead of JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BestbuyProductParams holds the parameters of BestbuyProduct (GET / POST /v2/bestbuy/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BestbuyProductReviewsParams 

type BestbuyProductReviewsParams struct {
	// Best Buy product URL or reviews URL.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Default 1. A value above 1 overrides page on the Best Buy URL. If this stays at 1, a page already on the URL is kept.
	Page *float64 `json:"page" api:"page"`
	// When true, return the rendered HTML instead of JSON. Default false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BestbuyProductReviewsParams holds the parameters of BestbuyProductReviews (GET / POST /v2/bestbuy/product/reviews). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BestbuySearchParams 

type BestbuySearchParams struct {
	// Keyword or full Best Buy search URL.
	Query string `json:"query" api:"query,required"`
	// Best Buy country when query is not a full URL (default: com).
	Region *string `json:"region" api:"region"`
	// Page number (default: 1).
	Page *float64 `json:"page" api:"page"`
	// Sort order (default: best_selling). Default: "best_selling".
	Sort *string `json:"sort" api:"sort"`
	// When true, return rendered HTML as {"result": "..."} instead of JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BestbuySearchParams holds the parameters of BestbuySearch (GET / POST /v2/bestbuy/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BhphotovideoProductParams 

type BhphotovideoProductParams struct {
	// Product URL or id.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML. The string false stays false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BhphotovideoProductParams holds the parameters of BhphotovideoProduct (GET / POST /v2/bhphotovideo/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BhphotovideoSearchParams 

type BhphotovideoSearchParams struct {
	// Keyword or a bhphotovideo.com search URL.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Example: 2.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML. The string false stays false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BhphotovideoSearchParams holds the parameters of BhphotovideoSearch (GET / POST /v2/bhphotovideo/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BingSearchParams 

type BingSearchParams struct {
	// The search query to execute on Bing. Supports all Bing advanced search operators.
	Query string `json:"query" api:"query,required"`
	// Page number of results to retrieve. Used for pagination.
	Page *float64 `json:"page" api:"page"`
	// Number of results per page. Minimum: 10, Maximum: 50.
	Num *float64 `json:"num" api:"num"`
	// City or region from which the search should originate. If multiple locations match, the most popular one is selected.
	Location *string `json:"location" api:"location"`
	// GPS latitude coordinate for the search origin.
	Lat *float64 `json:"lat" api:"lat"`
	// GPS longitude coordinate for the search origin.
	Lon *float64 `json:"lon" api:"lon"`
	// Market code combining language and country, in the form <language>-<country>. Defines where the results come from.
	Mkt *string `json:"mkt" api:"mkt"`
	// Two-letter ISO 3166-1 country code defining the country to search from.
	Cc *string `json:"cc" api:"cc"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BingSearchParams holds the parameters of BingSearch (GET / POST /v2/bing/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BitibaProductParams 

type BitibaProductParams struct {
	// Product URL, shop path, or product number. Example: 75036. A search link returns 400.
	Query string `json:"query" api:"query,required"`
	// Shop used when query is a number or a path. de is Germany (default). Default: "de".
	Region *string `json:"region" api:"region"`
	// Set to true to get the raw HTML in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BitibaProductParams holds the parameters of BitibaProduct (GET / POST /v2/bitiba/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BitibaSearchParams 

type BitibaSearchParams struct {
	// What to look for. A word such as hundefutter, or a Bitiba search link. A product link returns 400. www.bitiba.com returns 400.
	Query string `json:"query" api:"query,required"`
	// Country shop. de is Germany (default), fr is France, uk is the United Kingdom. gb means uk. Default: "de".
	Region *string `json:"region" api:"region"`
	// Page number, starting at 1. Page 2 uses p=2.
	Page *float64 `json:"page" api:"page"`
	// Set to true to get the raw HTML in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BitibaSearchParams holds the parameters of BitibaSearch (GET / POST /v2/bitiba/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BolProductParams 

type BolProductParams struct {
	// Product URL or numeric product id.
	Query string `json:"query" api:"query,required"`
	// Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from the path.
	Region *string `json:"region" api:"region"`
	// When true, return the raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BolProductParams holds the parameters of BolProduct (GET / POST /v2/bol/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BolSearchParams 

type BolSearchParams struct {
	// Keyword or full bol.com search URL. A product URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Shop. Use nl for the Netherlands in Dutch, be-nl for Belgium in Dutch, or be-fr for Belgium in French. Leave empty for nl. A full URL picks the shop from /nl/nl/, /be/nl/, or /be/fr/.
	Region *string `json:"region" api:"region"`
	// Page number, starting at 1. Page 2 asks bol for the next screen of the same search.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BolSearchParams holds the parameters of BolSearch (GET / POST /v2/bol/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BoulangerProductParams 

type BoulangerProductParams struct {
	// Product URL /ref/{id}, or the numeric product id.
	Query string `json:"query" api:"query,required"`
	// When true, returns the raw HTML instead of the parsed JSON. The response shape is {"result": "<html>..."}. Default false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BoulangerProductParams holds the parameters of BoulangerProduct (GET / POST /v2/boulanger/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BoulangerSearchParams 

type BoulangerSearchParams struct {
	// Keyword, a Boulanger /resultats URL, or a /c/ category URL.
	Query string `json:"query" api:"query,required"`
	// Page number, from 1. Default is 1. Page 2 is sent as numPage=2 and returns different product ids.
	Page *float64 `json:"page" api:"page"`
	// When true, returns the raw HTML instead of the parsed JSON. The response shape is {"result": "<html>..."}. Default false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BoulangerSearchParams holds the parameters of BoulangerSearch (GET / POST /v2/boulanger/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BraveSearchParams 

type BraveSearchParams struct {
	// The search query to execute on Brave Search. Supports all standard Brave search operators.
	Query string `json:"query" api:"query,required"`
	// Page number of results to retrieve. Used for pagination. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Country code, for example us, fr, gb, de. Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language code, for example en, fr, de. Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BraveSearchParams holds the parameters of BraveSearch (GET / POST /v2/brave/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BricodepotProductParams 

type BricodepotProductParams struct {
	// Product URL /p/{ean}/{slug}.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BricodepotProductParams holds the parameters of BricodepotProduct (GET / POST /v2/bricodepot/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BricodepotSearchParams 

type BricodepotSearchParams struct {
	// Brico Dépôt listing URL under /produits/.
	Query string `json:"query" api:"query,required"`
	// Page from 1. Page 2 is the /2 path suffix.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BricodepotSearchParams holds the parameters of BricodepotSearch (GET / POST /v2/bricodepot/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BricoramaProductParams 

type BricoramaProductParams struct {
	// Product URL /p/{slug}/{ean}.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BricoramaProductParams holds the parameters of BricoramaProduct (GET / POST /v2/bricorama/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type BricoramaSearchParams 

type BricoramaSearchParams struct {
	// Keyword, or a Bricorama /search URL.
	Query string `json:"query" api:"query,required"`
	// Page from 1. Sent as ?page= on the listing.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

BricoramaSearchParams holds the parameters of BricoramaSearch (GET / POST /v2/bricorama/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CarrefourProductParams 

type CarrefourProductParams struct {
	// Product page URL on www.carrefour.fr. The path starts with /p/.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CarrefourProductParams holds the parameters of CarrefourProduct (GET / POST /v2/carrefour/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CarrefourSearchParams 

type CarrefourSearchParams struct {
	// Search keyword or full Carrefour search page URL.
	Query string `json:"query" api:"query,required"`
	// Carrefour domain to search on. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Page number to retrieve. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CarrefourSearchParams holds the parameters of CarrefourSearch (GET / POST /v2/carrefour/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CarrefourSuggestParams 

type CarrefourSuggestParams struct {
	// Search keyword or EAN code to get product suggestions from Carrefour.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CarrefourSuggestParams holds the parameters of CarrefourSuggest (GET / POST /v2/carrefour/suggest). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CastoramaProductParams 

type CastoramaProductParams struct {
	// Product URL ending in _CAFR.prd.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CastoramaProductParams holds the parameters of CastoramaProduct (GET / POST /v2/castorama/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CastoramaSearchParams 

type CastoramaSearchParams struct {
	// Keyword, or a Castorama listing URL (/search or a .cat category).
	Query string `json:"query" api:"query,required"`
	// Page from 1. Sent as ?page= on the listing.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CastoramaSearchParams holds the parameters of CastoramaSearch (GET / POST /v2/castorama/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CdiscountProductOfferParams 

type CdiscountProductOfferParams struct {
	// Cdiscount product offer page URL. Pass the multiple_offer_url value returned by the Cdiscount Product API.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CdiscountProductOfferParams holds the parameters of CdiscountProductOffer (GET / POST /v2/cdiscount/product/offer). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CdiscountProductParams 

type CdiscountProductParams struct {
	// Full Cdiscount product page URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CdiscountProductParams holds the parameters of CdiscountProduct (GET / POST /v2/cdiscount/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CdiscountSearchParams 

type CdiscountSearchParams struct {
	// Cdiscount search results page URL. Use any URL from a search or category browse on cdiscount.com.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CdiscountSearchParams holds the parameters of CdiscountSearch (GET / POST /v2/cdiscount/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CentrisPropertyParams 

type CentrisPropertyParams struct {
	// Full Centris listing URL, in English or French.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CentrisPropertyParams holds the parameters of CentrisProperty (GET / POST /v2/centris/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CentrisSearchParams 

type CentrisSearchParams struct {
	// Place name or a full Centris results URL.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Default is 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Results language when query is a place name. Default is en. Default: "en".
	Language *string `json:"language" api:"language"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CentrisSearchParams holds the parameters of CentrisSearch (GET / POST /v2/centris/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ChewyProductParams 

type ChewyProductParams struct {
	// Which product to read. A Chewy product URL such as https://www.chewy.com/purina-pro-plan-adult-sensitive-skin/dp/128666, or just the numeric id 128666. A search link, a keyword, or another website returns 400.
	Query string `json:"query" api:"query,required"`
	// Which JSON to return. Default expert. Default: "expert".
	Mode *string `json:"mode" api:"mode"`
	// Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ChewyProductParams holds the parameters of ChewyProduct (GET / POST /v2/chewy/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ChewySearchParams 

type ChewySearchParams struct {
	// What to search for. A keyword such as salmon kibble, or a Chewy search or category link such as https://www.chewy.com/s?query=dog+food. A product link (a URL that contains /dp/) returns 400. Another website returns 400.
	Query string `json:"query" api:"query,required"`
	// Which page to fetch, starting at 1. Leave this empty for page 1. If query is a listing link that already has page=2, this value replaces that page. In simple mode, pagination.page is this page and pagination.next is the next page URL or null.
	Page *float64 `json:"page" api:"page"`
	// Which JSON to return. Default expert. Default: "expert".
	Mode *string `json:"mode" api:"mode"`
	// Set to true to get the rendered HTML in result instead of JSON. Default false. The string false stays false and still returns JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ChewySearchParams holds the parameters of ChewySearch (GET / POST /v2/chewy/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ClearedjobsJobParams 

type ClearedjobsJobParams struct {
	// Required. Job URL or slug ending in the numeric id. Example: analyst-washington-district-of-columbia-1902823.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ClearedjobsJobParams holds the parameters of ClearedjobsJob (GET / POST /v2/clearedjobs/job). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ClearedjobsSearchParams 

type ClearedjobsSearchParams struct {
	// Required. Keyword or a clearedjobs.net jobs URL. Example: analyst. A job URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Optional. Only page 1 is available. Example: 1. page=2 returns 404. pagination.next is always null.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ClearedjobsSearchParams holds the parameters of ClearedjobsSearch (GET / POST /v2/clearedjobs/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is a reusable, concurrency-safe Piloterr API client.

func NewClient 

func NewClient(apiKey string, options *ClientOptions) (*Client, error)

NewClient creates a client. An empty apiKey falls back to the PILOTERR_API_KEY environment variable.

func (*Client) AboutyouProduct 

func (c *Client) AboutyouProduct(ctx context.Context, params *AboutyouProductParams, options ...RequestOption) (*Response, error)

AboutyouProduct — About You 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 already name the shop. Credit cost: 2 credits per call.

GET / POST /v2/aboutyou/product

func (*Client) AboutyouSearch 

func (c *Client) AboutyouSearch(ctx context.Context, params *AboutyouSearchParams, options ...RequestOption) (*Response, error)

AboutyouSearch — About You 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 brand, price, and the product link. Credit cost: 2 credits per call.

GET / POST /v2/aboutyou/search

func (*Client) ActionProduct 

func (c *Client) ActionProduct(ctx context.Context, params *ActionProductParams, options ...RequestOption) (*Response, error)

ActionProduct — 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 availability via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/action/product

func (*Client) ActionSearch 

func (c *Client) ActionSearch(ctx context.Context, params *ActionSearchParams, options ...RequestOption) (*Response, error)

ActionSearch — Action Search. Action Search API: search product listings by keyword or URL on Action.com across European locales. Returns prices, images, locale, currency and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/action/search

func (*Client) AldiProduct 

func (c *Client) AldiProduct(ctx context.Context, params *AldiProductParams, options ...RequestOption) (*Response, error)

AldiProduct — Aldi Product. Aldi Product API: fetch full product page data from an Aldi URL or path slug. Returns pricing, images, description, category and cooling flags. Credit cost: 1 credit per call.

GET / POST /v2/aldi/product

func (*Client) AldiSearch 

func (c *Client) AldiSearch(ctx context.Context, params *AldiSearchParams, options ...RequestOption) (*Response, error)

AldiSearch — 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 pagination. Credit cost: 1 credit per call.

GET / POST /v2/aldi/search

func (*Client) AlibabaProduct 

func (c *Client) AlibabaProduct(ctx context.Context, params *AlibabaProductParams, options ...RequestOption) (*Response, error)

AlibabaProduct — Alibaba Product. Alibaba Product API. Fetch a full B2B product page by URL or product ID with optional locale subdomain. Browser rendering returns tiered pricing, seller profile and lead times. Credit cost: 2 credits per call.

GET / POST /v2/alibaba/product

func (*Client) AlibabaSearch 

func (c *Client) AlibabaSearch(ctx context.Context, params *AlibabaSearchParams, options ...RequestOption) (*Response, error)

AlibabaSearch — Alibaba Search. Alibaba Search API. Query B2B product listings by keyword or search URL across 17 locale subdomains. Request mode returns prices, MOQ, seller data and pagination. Credit cost: 1 credit per call.

GET / POST /v2/alibaba/search

func (*Client) AliexpressProduct 

func (c *Client) AliexpressProduct(ctx context.Context, params *AliexpressProductParams, options ...RequestOption) (*Response, error)

AliexpressProduct — AliExpress Product. AliExpress Product API: scrape live /item/ product pages from a full URL. Get title, images, seller identity, pricing, specs, delivery, and FAQs as JSON via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/aliexpress/product

func (*Client) AliexpressProductReviews 

func (c *Client) AliexpressProductReviews(ctx context.Context, params *AliexpressProductReviewsParams, options ...RequestOption) (*Response, error)

AliexpressProductReviews — AliExpress Reviews. AliExpress Reviews API: list buyer reviews for a product id or item URL. Each review includes author, star rating, text, date, and photos when the buyer attached them. Credit cost: 1 credit per call.

GET / POST /v2/aliexpress/product/reviews

func (*Client) AliexpressSearch 

func (c *Client) AliexpressSearch(ctx context.Context, params *AliexpressSearchParams, options ...RequestOption) (*Response, error)

AliexpressSearch — AliExpress Search. AliExpress Search API: search by keyword or wholesale URL and get product listings with prices, ratings, sold counts, and pagination as JSON via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/aliexpress/search

func (*Client) AliexpressStoreProduct 

func (c *Client) AliexpressStoreProduct(ctx context.Context, params *AliexpressStoreProductParams, options ...RequestOption) (*Response, error)

AliexpressStoreProduct — 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 (~40 SSR items) as JSON via browser rendering. Pagination is not supported. Credit cost: 2 credits per call.

GET / POST /v2/aliexpress/store/product

func (*Client) AllegroProduct 

func (c *Client) AllegroProduct(ctx context.Context, params *AllegroProductParams, options ...RequestOption) (*Response, error)

AllegroProduct — Allegro Product. Allegro Product API. Extract full product page data from allegro.pl by URL (/produkt/, /oferta/, /ogloszenie/). Browser rendering, 3 credits per call. Pair with Allegro Search (3 credits) for listing discovery. Credit cost: 3 credits per call.

GET / POST /v2/allegro/product

func (*Client) AllegroSearch 

func (c *Client) AllegroSearch(ctx context.Context, params *AllegroSearchParams, options ...RequestOption) (*Response, error)

AllegroSearch — Allegro Search. Allegro Search API. Query product listings by keyword, optional page number, or full allegro.pl listing URL. Returns results with prices, sellers, sponsorship flags and pagination. 3 credits per call. Credit cost: 3 credits per call.

GET / POST /v2/allegro/search

func (*Client) AmazonProduct 

func (c *Client) AmazonProduct(ctx context.Context, params *AmazonProductParams, options ...RequestOption) (*Response, error)

AmazonProduct — Amazon Product. Efficiently extract product details from Amazon for dynamic retail insights, including price, stock, features, and seller data. Credit cost: 1 credit per call.

GET / POST /v2/amazon/product

func (*Client) AmazonProductOffer 

func (c *Client) AmazonProductOffer(ctx context.Context, params *AmazonProductOfferParams, options ...RequestOption) (*Response, error)

AmazonProductOffer — Amazon Product Offer. Efficiently extract details of third-party seller offers for any Amazon product across multiple marketplaces. Credit cost: 1 credit per call.

GET / POST /v2/amazon/product/offer

func (*Client) AmazonSearch 

func (c *Client) AmazonSearch(ctx context.Context, params *AmazonSearchParams, options ...RequestOption) (*Response, error)

AmazonSearch — Amazon Search. Efficiently scrape Amazon search results for real-time product data and insights across multiple Amazon marketplaces. Credit cost: 1 credit per call.

GET / POST /v2/amazon/search

func (*Client) ApartmentsProperty 

func (c *Client) ApartmentsProperty(ctx context.Context, params *ApartmentsPropertyParams, options ...RequestOption) (*Response, error)

ApartmentsProperty — Apartments Property. Extract a full Apartments.com rental listing from a property URL, including amenities, gallery, description, geolocation, and unit details via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/apartments/property

func (*Client) ApartmentsSearch 

func (c *Client) ApartmentsSearch(ctx context.Context, params *ApartmentsSearchParams, options ...RequestOption) (*Response, error)

ApartmentsSearch — Apartments Search. Search Apartments.com rentals from a full city or browse URL and retrieve prices, photos, addresses, phone numbers, and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/apartments/search

func (*Client) ArgenpropProperty 

func (c *Client) ArgenpropProperty(ctx context.Context, params *ArgenpropPropertyParams, options ...RequestOption) (*Response, error)

ArgenpropProperty — 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. Credit cost: 1 credit per call.

GET / POST /v2/argenprop/property

func (*Client) ArgenpropSearch 

func (c *Client) ArgenpropSearch(ctx context.Context, params *ArgenpropSearchParams, options ...RequestOption) (*Response, error)

ArgenpropSearch — Argenprop Search. Search Argenprop by neighbourhood or city. Set operation to venta or alquiler, and property_type such as departamentos or casas. Page with pagina. Credit cost: 1 credit per call.

GET / POST /v2/argenprop/search

func (*Client) ArgosProduct 

func (c *Client) ArgosProduct(ctx context.Context, params *ArgosProductParams, options ...RequestOption) (*Response, error)

ArgosProduct — Argos Product. Argos Product API: one UK product by id or URL. Browser rendering (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/argos/product

func (*Client) ArgosSearch 

func (c *Client) ArgosSearch(ctx context.Context, params *ArgosSearchParams, options ...RequestOption) (*Response, error)

ArgosSearch — 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 with no product cards returns no results. Credit cost: 2 credits per call.

GET / POST /v2/argos/search

func (*Client) ArxivPaper 

func (c *Client) ArxivPaper(ctx context.Context, params *ArxivPaperParams, options ...RequestOption) (*Response, error)

ArxivPaper — arXiv Paper. Fetch one arXiv paper by id or by an abs, pdf, or html URL. Credit cost: 1 credit per call.

GET / POST /v2/arxiv/paper

func (*Client) ArxivSearch 

func (c *Client) ArxivSearch(ctx context.Context, params *ArxivSearchParams, options ...RequestOption) (*Response, error)

ArxivSearch — 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 count is large. Credit cost: 1 credit per call.

GET / POST /v2/arxiv/search

func (*Client) AuchanProduct 

func (c *Client) AuchanProduct(ctx context.Context, params *AuchanProductParams, options ...RequestOption) (*Response, error)

AuchanProduct — Auchan Product. Effortlessly extract product details from Auchan for dynamic business insights, including nutritional information, ingredients, ratings, and reviews. Credit cost: 2 credits per call.

GET / POST /v2/auchan/product

func (*Client) AuchanSearch 

func (c *Client) AuchanSearch(ctx context.Context, params *AuchanSearchParams, options ...RequestOption) (*Response, error)

AuchanSearch — Auchan Search. Extract Auchan product listings from keyword searches for insightful market analysis and competitive edge. Credit cost: 2 credits per call.

GET / POST /v2/auchan/search

func (*Client) AutodocProduct 

func (c *Client) AutodocProduct(ctx context.Context, params *AutodocProductParams, options ...RequestOption) (*Response, error)

AutodocProduct — Autodoc Product. Scrape Autodoc product pages: price, specs, EAN, images, compatibility, and TecDoc-related vehicle data via the Related endpoint. Credit cost: 2 credits per call.

GET / POST /v2/autodoc/product

func (*Client) AutodocProductRelated 

func (c *Client) AutodocProductRelated(ctx context.Context, params *AutodocProductRelatedParams, options ...RequestOption) (*Response, error)

AutodocProductRelated — Autodoc Product Related. Vehicle fitment lines per maker for an Autodoc product. All parameters from Product fetch.params are required. Credit cost: 2 credits per call.

GET / POST /v2/autodoc/product/related

func (*Client) AutodocSearch 

func (c *Client) AutodocSearch(ctx context.Context, params *AutodocSearchParams, options ...RequestOption) (*Response, error)

AutodocSearch — Autodoc Search. Search Autodoc by URL: keyword pages use /search?keyword=… (e.g. frein on auto-doc.fr). Extract product cards, prices, and pagination. Credit cost: 2 credits per call.

GET / POST /v2/autodoc/search

func (*Client) AutoeuropeResult 

func (c *Client) AutoeuropeResult(ctx context.Context, params *AutoeuropeResultParams, options ...RequestOption) (*Response, error)

AutoeuropeResult — Auto Europe 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 code, and the package prices. Credit cost: 1 credit per call.

GET / POST /v2/autoeurope/result

func (*Client) AutoeuropeSearch 

func (c *Client) AutoeuropeSearch(ctx context.Context, params *AutoeuropeSearchParams, options ...RequestOption) (*Response, error)

AutoeuropeSearch — Auto Europe 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 quote comes back on one page. Credit cost: 1 credit per call.

GET / POST /v2/autoeurope/search

func (*Client) Autoscout24Ad 

func (c *Client) Autoscout24Ad(ctx context.Context, params *Autoscout24AdParams, options ...RequestOption) (*Response, error)

Autoscout24Ad — AutoScout24 Ad. Read one AutoScout24 listing, including an inactive ad that still exposes the listing. Price, vehicle, seller, and location. (1 credit) Credit cost: 1 credit per call.

GET / POST /v2/autoscout24/ad

func (*Client) Autoscout24Search 

func (c *Client) Autoscout24Search(ctx context.Context, params *Autoscout24SearchParams, options ...RequestOption) (*Response, error)

Autoscout24Search — AutoScout24 Search. Search AutoScout24 listings from a search URL. Each card has make, model, numeric price, mileage, and the listing URL. (1 credit) Credit cost: 1 credit per call.

GET / POST /v2/autoscout24/search

func (*Client) AutotraderAd 

func (c *Client) AutotraderAd(ctx context.Context, params *AutotraderAdParams, options ...RequestOption) (*Response, error)

AutotraderAd — Autotrader Ad. Extract full vehicle details from an AutoTrader UK car-details URL, including price, specs, gallery, seller, and description via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/autotrader/ad

func (*Client) AutotraderSearch 

func (c *Client) AutotraderSearch(ctx context.Context, params *AutotraderSearchParams, options ...RequestOption) (*Response, error)

AutotraderSearch — Autotrader Search. Search AutoTrader UK listings from a car-search URL and retrieve prices, specs, photos, seller info, and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/autotrader/search

func (*Client) BestbuyProduct 

func (c *Client) BestbuyProduct(ctx context.Context, params *BestbuyProductParams, options ...RequestOption) (*Response, error)

BestbuyProduct — Best Buy Product. Get a Best Buy US or Canada product page: title, price, brand, stock, images, categories and specs via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/bestbuy/product

func (*Client) BestbuyProductReviews 

func (c *Client) BestbuyProductReviews(ctx context.Context, params *BestbuyProductReviewsParams, options ...RequestOption) (*Response, error)

BestbuyProductReviews — Best Buy Reviews. Get customer reviews for a Best Buy product URL: rating, review text, author, photos and pagination. Credit cost: 2 credits per call.

GET / POST /v2/bestbuy/product/reviews

func (*Client) BestbuySearch 

func (c *Client) BestbuySearch(ctx context.Context, params *BestbuySearchParams, options ...RequestOption) (*Response, error)

BestbuySearch — Best Buy Search. Search Best Buy US or Canada by keyword or search URL. Returns product listings with price, rating and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/bestbuy/search

func (*Client) BhphotovideoProduct 

func (c *Client) BhphotovideoProduct(ctx context.Context, params *BhphotovideoProductParams, options ...RequestOption) (*Response, error)

BhphotovideoProduct — B&H Photo Video Product. Read a B&H Photo Video product from its URL or id. Returns price, rating, specifications, and box contents. Credit cost: 1 credit per call.

GET / POST /v2/bhphotovideo/product

func (*Client) BhphotovideoSearch 

func (c *Client) BhphotovideoSearch(ctx context.Context, params *BhphotovideoSearchParams, options ...RequestOption) (*Response, error)

BhphotovideoSearch — B&H Photo Video Search. Search B&H Photo Video by keyword or search URL. Returns BH numbers, dollar prices, and a next page URL. Credit cost: 1 credit per call.

GET / POST /v2/bhphotovideo/search

func (*Client) BingSearch 

func (c *Client) BingSearch(ctx context.Context, params *BingSearchParams, options ...RequestOption) (*Response, error)

BingSearch — Bing Search. Scrape real-time Bing search results with full control over location, language, and pagination. Credit cost: 1 credit per call.

GET / POST /v2/bing/search

func (*Client) BitibaProduct 

func (c *Client) BitibaProduct(ctx context.Context, params *BitibaProductParams, options ...RequestOption) (*Response, error)

BitibaProduct — Bitiba Product. Read one product from a live Bitiba shop, including the selected variant price and the pack list. Credit cost: 1 credit per call.

GET / POST /v2/bitiba/product

func (*Client) BitibaSearch 

func (c *Client) BitibaSearch(ctx context.Context, params *BitibaSearchParams, options ...RequestOption) (*Response, error)

BitibaSearch — Bitiba Search. Search a live Bitiba country shop. Germany is the default. www.bitiba.com is closed and returns 400. Credit cost: 1 credit per call.

GET / POST /v2/bitiba/search

func (*Client) BolProduct 

func (c *Client) BolProduct(ctx context.Context, params *BolProductParams, options ...RequestOption) (*Response, error)

BolProduct — 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. Credit cost: 2 credits per call.

GET / POST /v2/bol/product

func (*Client) BolSearch 

func (c *Client) BolSearch(ctx context.Context, params *BolSearchParams, options ...RequestOption) (*Response, error)

BolSearch — 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. Credit cost: 2 credits per call.

GET / POST /v2/bol/search

func (*Client) BoulangerProduct 

func (c *Client) BoulangerProduct(ctx context.Context, params *BoulangerProductParams, options ...RequestOption) (*Response, error)

BoulangerProduct — Boulanger Product. Read one Boulanger product from its URL or product id. You get price, brand, rating, seller, and specifications. Credit cost: 2 credits per call.

GET / POST /v2/boulanger/product

func (*Client) BoulangerSearch 

func (c *Client) BoulangerSearch(ctx context.Context, params *BoulangerSearchParams, options ...RequestOption) (*Response, error)

BoulangerSearch — Boulanger Search. Search Boulanger by keyword and page the product grid. Cards include price, brand, seller, and the product URL. Credit cost: 2 credits per call.

GET / POST /v2/boulanger/search

func (*Client) BraveSearch 

func (c *Client) BraveSearch(ctx context.Context, params *BraveSearchParams, options ...RequestOption) (*Response, error)

BraveSearch — Brave Search. Access the Brave search engine results directly through our efficient Piloterr service for reliable data scraping. Credit cost: 1 credit per call.

GET / POST /v2/brave/search

func (*Client) BricodepotProduct 

func (c *Client) BricodepotProduct(ctx context.Context, params *BricodepotProductParams, options ...RequestOption) (*Response, error)

BricodepotProduct — Brico Dépôt Product. Read one Brico Dépôt product from its product URL. You get price, brand, SKU, and availability. Credit cost: 1 credit per call.

GET / POST /v2/bricodepot/product

func (*Client) BricodepotSearch 

func (c *Client) BricodepotSearch(ctx context.Context, params *BricodepotSearchParams, options ...RequestOption) (*Response, error)

BricodepotSearch — Brico Dépôt 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. Credit cost: 1 credit per call.

GET / POST /v2/bricodepot/search

func (*Client) BricoramaProduct 

func (c *Client) BricoramaProduct(ctx context.Context, params *BricoramaProductParams, options ...RequestOption) (*Response, error)

BricoramaProduct — Bricorama Product. Read one Bricorama product from its URL. You get price, brand, and the product details. Credit cost: 1 credit per call.

GET / POST /v2/bricorama/product

func (*Client) BricoramaSearch 

func (c *Client) BricoramaSearch(ctx context.Context, params *BricoramaSearchParams, options ...RequestOption) (*Response, error)

BricoramaSearch — Bricorama Search. Search Bricorama by keyword or search URL and page the home-improvement grid. Credit cost: 1 credit per call.

GET / POST /v2/bricorama/search

func (*Client) CarrefourProduct 

func (c *Client) CarrefourProduct(ctx context.Context, params *CarrefourProductParams, options ...RequestOption) (*Response, error)

CarrefourProduct — Carrefour Product. Read one Carrefour.fr product from its page URL. Every product returns the same keys: price, brand, pack size, Nutriscore, categories, unit price, and customer reviews. Credit cost: 2 credits per call.

GET / POST /v2/carrefour/product

func (*Client) CarrefourSearch 

func (c *Client) CarrefourSearch(ctx context.Context, params *CarrefourSearchParams, options ...RequestOption) (*Response, error)

CarrefourSearch — Carrefour Search. Search for products on Carrefour by keyword or URL, returning structured listings with prices, ratings, and pagination. Credit cost: 2 credits per call.

GET / POST /v2/carrefour/search

func (*Client) CarrefourSuggest 

func (c *Client) CarrefourSuggest(ctx context.Context, params *CarrefourSuggestParams, options ...RequestOption) (*Response, error)

CarrefourSuggest — Carrefour Suggest. Get product suggestions from Carrefour by keyword or EAN, returning matching products with pricing, availability, and product details. Credit cost: 1 credit per call.

GET / POST /v2/carrefour/suggest

func (*Client) CastoramaProduct 

func (c *Client) CastoramaProduct(ctx context.Context, params *CastoramaProductParams, options ...RequestOption) (*Response, error)

CastoramaProduct — Castorama Product. Read one Castorama product from its URL. You get price, brand, and specifications. Credit cost: 1 credit per call.

GET / POST /v2/castorama/product

func (*Client) CastoramaSearch 

func (c *Client) CastoramaSearch(ctx context.Context, params *CastoramaSearchParams, options ...RequestOption) (*Response, error)

CastoramaSearch — Castorama Search. Search Castorama by keyword or search URL and page the DIY listings. Cards include title, price, and product link. Credit cost: 1 credit per call.

GET / POST /v2/castorama/search

func (*Client) CdiscountProduct 

func (c *Client) CdiscountProduct(ctx context.Context, params *CdiscountProductParams, options ...RequestOption) (*Response, error)

CdiscountProduct — Cdiscount Product. Extract full product details from a Cdiscount product page, including price, seller, ratings, specifications, and offers. Credit cost: 2 credits per call.

GET / POST /v2/cdiscount/product

func (*Client) CdiscountProductOffer 

func (c *Client) CdiscountProductOffer(ctx context.Context, params *CdiscountProductOfferParams, options ...RequestOption) (*Response, error)

CdiscountProductOffer — Cdiscount Product Offer. Retrieve all marketplace seller offers for a Cdiscount product, including prices, seller ratings, shipping costs, and availability. Credit cost: 2 credits per call.

GET / POST /v2/cdiscount/product/offer

func (*Client) CdiscountSearch 

func (c *Client) CdiscountSearch(ctx context.Context, params *CdiscountSearchParams, options ...RequestOption) (*Response, error)

CdiscountSearch — Cdiscount Search. Extract product listings from Cdiscount search results or category pages for market intelligence and competitive analysis. Credit cost: 2 credits per call.

GET / POST /v2/cdiscount/search

func (*Client) CentrisProperty 

func (c *Client) CentrisProperty(ctx context.Context, params *CentrisPropertyParams, options ...RequestOption) (*Response, error)

CentrisProperty — Centris Property. Read one Centris property from its URL or listing id. You get price, address, rooms, and the broker. Credit cost: 1 credit per call.

GET / POST /v2/centris/property

func (*Client) CentrisSearch 

func (c *Client) CentrisSearch(ctx context.Context, params *CentrisSearchParams, options ...RequestOption) (*Response, error)

CentrisSearch — Centris Search. Search Centris listings by city or by a full results URL. Use the English or French path. Page through properties for sale. Credit cost: 1 credit per call.

GET / POST /v2/centris/search

func (*Client) ChewyProduct 

func (c *Client) ChewyProduct(ctx context.Context, params *ChewyProductParams, options ...RequestOption) (*Response, error)

ChewyProduct — 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_case product. Credit cost: 3 credits per call.

GET / POST /v2/chewy/product

func (*Client) ChewySearch 

func (c *Client) ChewySearch(ctx context.Context, params *ChewySearchParams, options ...RequestOption) (*Response, error)

ChewySearch — Chewy Search. Search Chewy by keyword or listing URL. The default mode is expert and returns the historical listing objects. simple returns short snake_case cards. Credit cost: 3 credits per call.

GET / POST /v2/chewy/search

func (*Client) ClearedjobsJob 

func (c *Client) ClearedjobsJob(ctx context.Context, params *ClearedjobsJobParams, options ...RequestOption) (*Response, error)

ClearedjobsJob — ClearedJobs Job. Fetch one cleared job by its URL or by a slug that ends in the numeric id. Credit cost: 1 credit per call.

GET / POST /v2/clearedjobs/job

func (*Client) ClearedjobsSearch 

func (c *Client) ClearedjobsSearch(ctx context.Context, params *ClearedjobsSearchParams, options ...RequestOption) (*Response, error)

ClearedjobsSearch — ClearedJobs Search. Search cleared jobs by keyword. Only the first HTML page is available, so pagination.next is null and page 2 returns 404. Credit cost: 1 credit per call.

GET / POST /v2/clearedjobs/search

func (*Client) Company 

func (c *Client) Company(ctx context.Context, params *CompanyParams, options ...RequestOption) (*Response, error)

Company — Company Database. Retrieve comprehensive company data including financials, technologies, social profiles, and location by domain name. Credit cost: 1 credit per call.

GET / POST /v2/company

func (*Client) CoolblueProduct 

func (c *Client) CoolblueProduct(ctx context.Context, params *CoolblueProductParams, options ...RequestOption) (*Response, error)

CoolblueProduct — Coolblue Product. Read one Coolblue product by article id or product URL, in the region of that shop. Credit cost: 1 credit per call.

GET / POST /v2/coolblue/product

func (*Client) CoolblueSearch 

func (c *Client) CoolblueSearch(ctx context.Context, params *CoolblueSearchParams, options ...RequestOption) (*Response, error)

CoolblueSearch — Coolblue Search. Search Coolblue with a product keyword. Region defaults to Belgium. Also use nl or de. Page through product cards. Credit cost: 1 credit per call.

GET / POST /v2/coolblue/search

func (*Client) CopartLot 

func (c *Client) CopartLot(ctx context.Context, params *CopartLotParams, options ...RequestOption) (*Response, error)

CopartLot — Copart Lot. Copart Lot API: retrieve structured auction lot data by lot number or URL. Specs, damage, bids, photos, yard location and sale status across regional Copart sites. Credit cost: 2 credits per call.

GET / POST /v2/copart/lot

func (*Client) CopartSearch 

func (c *Client) CopartSearch(ctx context.Context, params *CopartSearchParams, options ...RequestOption) (*Response, error)

CopartSearch — Copart Search. Copart Search API: search auction lots by keyword or URL across Copart regional sites. Returns lot listings and pagination. Credit cost: 2 credits per call.

GET / POST /v2/copart/search

func (*Client) CostcoProduct 

func (c *Client) CostcoProduct(ctx context.Context, params *CostcoProductParams, options ...RequestOption) (*Response, error)

CostcoProduct — Costco Product. Costco Product API: fetch full product page data from a product ID or URL across regional Costco sites. Returns pricing, availability, ratings, images and breadcrumbs via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/costco/product

func (*Client) CostcoSearch 

func (c *Client) CostcoSearch(ctx context.Context, params *CostcoSearchParams, options ...RequestOption) (*Response, error)

CostcoSearch — Costco Search. Costco Search API: search product listings by keyword or URL across 13 regional Costco sites. Returns prices, availability, review counts and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/costco/search

func (*Client) CrunchbaseCompanyInfo 

func (c *Client) CrunchbaseCompanyInfo(ctx context.Context, params *CrunchbaseCompanyInfoParams, options ...RequestOption) (*Response, error)

CrunchbaseCompanyInfo — Crunchbase Company Info. Convert URLs into detailed Crunchbase profiles for immediate company insights. Credit cost: 2 credits per call.

GET / POST /v2/crunchbase/company/info

func (*Client) CrunchbaseEvent 

func (c *Client) CrunchbaseEvent(ctx context.Context, params *CrunchbaseEventParams, options ...RequestOption) (*Response, error)

CrunchbaseEvent — Crunchbase Event. Retrieve detailed Crunchbase event profiles with speakers, sponsors, exhibitors, and press timelines. Credit cost: 2 credits per call.

GET / POST /v2/crunchbase/event

func (*Client) CrunchbaseFundingRound 

func (c *Client) CrunchbaseFundingRound(ctx context.Context, params *CrunchbaseFundingRoundParams, options ...RequestOption) (*Response, error)

CrunchbaseFundingRound — Crunchbase Funding Round. Retrieve full details of a specific Crunchbase funding round including investors and press timeline. Credit cost: 2 credits per call.

GET / POST /v2/crunchbase/funding_round

func (*Client) CrunchbaseFundingRounds 

func (c *Client) CrunchbaseFundingRounds(ctx context.Context, params *CrunchbaseFundingRoundsParams, options ...RequestOption) (*Response, error)

CrunchbaseFundingRounds — Crunchbase Funding Rounds. Monitor funding history and financial milestones of companies with Crunchbase data. Credit cost: 2 credits per call.

GET / POST /v2/crunchbase/funding_rounds

func (*Client) CrunchbasePeopleInfo 

func (c *Client) CrunchbasePeopleInfo(ctx context.Context, params *CrunchbasePeopleInfoParams, options ...RequestOption) (*Response, error)

CrunchbasePeopleInfo — Crunchbase People Info. Retrieve detailed Crunchbase profiles for individuals including career history, investments, and board positions. Credit cost: 2 credits per call.

GET / POST /v2/crunchbase/people/info

func (*Client) CrunchbaseSearch 

func (c *Client) CrunchbaseSearch(ctx context.Context, params *CrunchbaseSearchParams, options ...RequestOption) (*Response, error)

CrunchbaseSearch — Crunchbase Search. Search Crunchbase for companies and people by keyword and retrieve their profiles and Crunchbase identifiers. Credit cost: 2 credits per call.

GET / POST /v2/crunchbase/search

func (*Client) CulturaProduct 

func (c *Client) CulturaProduct(ctx context.Context, params *CulturaProductParams, options ...RequestOption) (*Response, error)

CulturaProduct — Cultura Product. Read one Cultura product from its URL or SKU. You get price, EAN, seller, condition, and stock wording. Credit cost: 2 credits per call.

GET / POST /v2/cultura/product

func (*Client) CulturaSearch 

func (c *Client) CulturaSearch(ctx context.Context, params *CulturaSearchParams, options ...RequestOption) (*Response, error)

CulturaSearch — Cultura Search. Search Cultura by keyword and page through books, games, and culture products. Cards include title, price, availability, and the product link. Credit cost: 2 credits per call.

GET / POST /v2/cultura/search

func (*Client) DartyProduct 

func (c *Client) DartyProduct(ctx context.Context, params *DartyProductParams, options ...RequestOption) (*Response, error)

DartyProduct — Darty Product. Read one Darty product sheet from a product URL or a Darty product id. You get price, brand, availability, rating, and specifications. Credit cost: 2 credits per call.

GET / POST /v2/darty/product

func (*Client) DartySearch 

func (c *Client) DartySearch(ctx context.Context, params *DartySearchParams, options ...RequestOption) (*Response, error)

DartySearch — Darty Search. Search Darty by keyword or search URL and page through the listing. Each card has title, price, brand, seller, and product link. Credit cost: 2 credits per call.

GET / POST /v2/darty/search

func (*Client) DatasetsLinkedinCompany 

func (c *Client) DatasetsLinkedinCompany(ctx context.Context, params *DatasetsLinkedinCompanyParams, options ...RequestOption) (*Response, error)

DatasetsLinkedinCompany — Dataset Linkedin Company. Query the LinkedIn company dataset with Elasticsearch Query DSL. Filter by name, domain, industry, headcount, and country. POST-only, 1 credit per row returned. Credit cost: 1 credit per row.

POST /v2/datasets/linkedin/company

func (*Client) DecathlonProduct 

func (c *Client) DecathlonProduct(ctx context.Context, params *DecathlonProductParams, options ...RequestOption) (*Response, error)

DecathlonProduct — 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 does not already name the shop. Credit cost: 1 credit per call.

GET / POST /v2/decathlon/product

func (*Client) DecathlonSearch 

func (c *Client) DecathlonSearch(ctx context.Context, params *DecathlonSearchParams, options ...RequestOption) (*Response, error)

DecathlonSearch — 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 titles, prices, and product links. Credit cost: 1 credit per call.

GET / POST /v2/decathlon/search

func (*Client) DigikeyProduct 

func (c *Client) DigikeyProduct(ctx context.Context, params *DigikeyProductParams, options ...RequestOption) (*Response, error)

DigikeyProduct — DigiKey Product. Get a DigiKey product page: part numbers, manufacturer, price tiers, stock, images, datasheet and specs via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/digikey/product

func (*Client) DigikeySearch 

func (c *Client) DigikeySearch(ctx context.Context, params *DigikeySearchParams, options ...RequestOption) (*Response, error)

DigikeySearch — DigiKey Search. Search DigiKey country sites by keyword or result/filter URL. Returns category branches or product listings with pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/digikey/search

func (*Client) DoajArticle 

func (c *Client) DoajArticle(ctx context.Context, params *DoajArticleParams, options ...RequestOption) (*Response, error)

DoajArticle — DOAJ Article. Fetch one DOAJ article by its id or by a doaj.org article URL. Credit cost: 1 credit per call.

GET / POST /v2/doaj/article

func (*Client) DoajJournal 

func (c *Client) DoajJournal(ctx context.Context, params *DoajJournalParams, options ...RequestOption) (*Response, error)

DoajJournal — DOAJ Journal. Fetch one DOAJ journal by ISSN, journal id, or a doaj.org toc URL. Credit cost: 1 credit per call.

GET / POST /v2/doaj/journal

func (*Client) DoajSearch 

func (c *Client) DoajSearch(ctx context.Context, params *DoajSearchParams, options ...RequestOption) (*Response, error)

DoajSearch — DOAJ Search. Search DOAJ articles or journals. kind is article (default) or journal. Article ids and journal ISSNs are the detail keys. Credit cost: 1 credit per call.

GET / POST /v2/doaj/search

func (*Client) DomainDnsbl 

func (c *Client) DomainDnsbl(ctx context.Context, params *DomainDnsblParams, options ...RequestOption) (*Response, error)

DomainDnsbl — Domain DNSBL. Check if a domain or IP address is listed in DNS-based blacklists (DNSBL), with detailed provider-level detection and category information. Credit cost: 1 credit per call.

GET / POST /v2/domain/dnsbl

func (*Client) DomainMalicious 

func (c *Client) DomainMalicious(ctx context.Context, params *DomainMaliciousParams, options ...RequestOption) (*Response, error)

DomainMalicious — Domain Malicious. Check if a domain or IP address has been flagged as malicious across multiple threat intelligence feeds, with source attribution. Credit cost: 1 credit per call.

GET / POST /v2/domain/malicious

func (*Client) DomainWhois 

func (c *Client) DomainWhois(ctx context.Context, params *DomainWhoisParams, options ...RequestOption) (*Response, error)

DomainWhois — Domain Whois. Retrieve WHOIS registration data for any domain, including registration dates, registrar details, name servers, and contact information. Credit cost: 1 credit per call.

GET / POST /v2/domain/whois

func (*Client) DomaincomauProperty 

func (c *Client) DomaincomauProperty(ctx context.Context, params *DomaincomauPropertyParams, options ...RequestOption) (*Response, error)

DomaincomauProperty — Domain.com.au Property. Read one Domain.com.au listing from its URL. The response is a flat object with price, address, agency, and photos. Credit cost: 2 credits per call.

GET / POST /v2/domaincomau/property

func (*Client) DomaincomauSearch 

func (c *Client) DomaincomauSearch(ctx context.Context, params *DomaincomauSearchParams, options ...RequestOption) (*Response, error)

DomaincomauSearch — Domain.com.au 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 that amount. Credit cost: 2 credits per call.

GET / POST /v2/domaincomau/search

func (*Client) DuckduckgoSearch 

func (c *Client) DuckduckgoSearch(ctx context.Context, params *DuckduckgoSearchParams, options ...RequestOption) (*Response, error)

DuckduckgoSearch — DuckDuckGo Search. Query DuckDuckGo via API and retrieve structured organic results with region and language. Credit cost: 1 credit per call.

GET / POST /v2/duckduckgo/search

func (*Client) EbayProduct 

func (c *Client) EbayProduct(ctx context.Context, params *EbayProductParams, options ...RequestOption) (*Response, error)

EbayProduct — eBay Product. eBay Product API: one listing on a supported eBay site, by URL or item id (3 credits). Credit cost: 3 credits per call.

GET / POST /v2/ebay/product

func (*Client) EbaySearch 

func (c *Client) EbaySearch(ctx context.Context, params *EbaySearchParams, options ...RequestOption) (*Response, error)

EbaySearch — eBay Search. eBay Search API: search listings on supported eBay sites. Returns price, seller, and pagination (3 credits). Credit cost: 3 credits per call.

GET / POST /v2/ebay/search

func (*Client) ElcorteinglesProduct 

func (c *Client) ElcorteinglesProduct(ctx context.Context, params *ElcorteinglesProductParams, options ...RequestOption) (*Response, error)

ElcorteinglesProduct — El Corte Inglés 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 identifiers via browser rendering. Credit cost: 3 credits per call.

GET / POST /v2/elcorteingles/product

func (*Client) ElcorteinglesSearch 

func (c *Client) ElcorteinglesSearch(ctx context.Context, params *ElcorteinglesSearchParams, options ...RequestOption) (*Response, error)

ElcorteinglesSearch — El Corte Inglés Search. El Corte Inglés Search API. Search product listings on elcorteingles.es by keyword or URL. Returns prices, brands, images and pagination via webunlocker. Credit cost: 3 credits per call.

GET / POST /v2/elcorteingles/search

func (*Client) EleclercProduct 

func (c *Client) EleclercProduct(ctx context.Context, params *EleclercProductParams, options ...RequestOption) (*Response, error)

EleclercProduct — E.Leclerc 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 price and stock. Credit cost: 1 credit per call.

GET / POST /v2/eleclerc/product

func (*Client) EleclercSearch 

func (c *Client) EleclercSearch(ctx context.Context, params *EleclercSearchParams, options ...RequestOption) (*Response, error)

EleclercSearch — E.Leclerc Search. Search for products on E.Leclerc by keyword with optional store-specific filtering and pagination. Credit cost: 1 credit per call.

GET / POST /v2/eleclerc/search

func (*Client) EleclercSuggest 

func (c *Client) EleclercSuggest(ctx context.Context, params *EleclercSuggestParams, options ...RequestOption) (*Response, error)

EleclercSuggest — E.Leclerc Suggest. Get instant product autocomplete suggestions from E.Leclerc for a given keyword or EAN. Credit cost: 1 credit per call.

GET / POST /v2/eleclerc/suggest

func (*Client) EmailAnalyzes 

func (c *Client) EmailAnalyzes(ctx context.Context, params *EmailAnalyzesParams, options ...RequestOption) (*Response, error)

EmailAnalyzes — Email Analyzes. Analyze a domain to retrieve its email infrastructure. Microsoft 365 and Google Workspace domains, SPF records, and DNS configurations. Credit cost: 1 credit per call.

GET / POST /v2/email/analyzes

func (*Client) EmailFinder 

func (c *Client) EmailFinder(ctx context.Context, params *EmailFinderParams, options ...RequestOption) (*Response, error)

EmailFinder — Email Finder. Find verified professional email addresses by combining a person's full name with their company domain or company name. Credit cost: 1 credit per call.

GET / POST /v2/email/finder

func (*Client) EmailVerify 

func (c *Client) EmailVerify(ctx context.Context, params *EmailVerifyParams, options ...RequestOption) (*Response, error)

EmailVerify — Email Verify. Verify whether an email address is valid and deliverable, returning a clear status to prevent bounces and maintain list hygiene. Credit cost: 1 credit per call.

GET / POST /v2/email/verify

func (*Client) EuropagesCompany 

func (c *Client) EuropagesCompany(ctx context.Context, params *EuropagesCompanyParams, options ...RequestOption) (*Response, error)

EuropagesCompany — Europages Company. Europages company profile with address, supplier type and the products listed on the page (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/europages/company

func (*Client) EuropagesSearch 

func (c *Client) EuropagesSearch(ctx context.Context, params *EuropagesSearchParams, options ...RequestOption) (*Response, error)

EuropagesSearch — Europages Search. Search Europages suppliers by keyword or category URL. Returns company cards and pagination (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/europages/search

func (*Client) EventbriteEvent 

func (c *Client) EventbriteEvent(ctx context.Context, params *EventbriteEventParams, options ...RequestOption) (*Response, error)

EventbriteEvent — Eventbrite Event. Get one Eventbrite event by detail URL or numeric id: venue, organizer, schedule, and description (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/eventbrite/event

func (*Client) EventbriteSearch 

func (c *Client) EventbriteSearch(ctx context.Context, params *EventbriteSearchParams, options ...RequestOption) (*Response, error)

EventbriteSearch — Eventbrite Search. Search Eventbrite events by keyword or paste a city/category URL. Returns event cards and pagination (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/eventbrite/search

func (*Client) ExpediaAd 

func (c *Client) ExpediaAd(ctx context.Context, params *ExpediaAdParams, options ...RequestOption) (*Response, error)

ExpediaAd — Expedia Ad. Fetch one Expedia hotel from its information URL: name, postal address, and amenity groups. Credit cost: 2 credits per call.

GET / POST /v2/expedia/ad

func (*Client) ExpediaFlight 

func (c *Client) ExpediaFlight(ctx context.Context, params *ExpediaFlightParams, options ...RequestOption) (*Response, error)

ExpediaFlight — 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 price. Credit cost: 2 credits per call.

GET / POST /v2/expedia/flight

func (*Client) ExpediaSearch 

func (c *Client) ExpediaSearch(ctx context.Context, params *ExpediaSearchParams, options ...RequestOption) (*Response, error)

ExpediaSearch — Expedia Search. Execute a hotel search on Expedia using a direct search URL and receive structured hotel listings with prices, ratings, and availability. Credit cost: 2 credits per call.

GET / POST /v2/expedia/search

func (*Client) FashionphileProduct 

func (c *Client) FashionphileProduct(ctx context.Context, params *FashionphileProductParams, options ...RequestOption) (*Response, error)

FashionphileProduct — Fashionphile Product. Load one Fashionphile product from a handle or a product URL. Keywords and search URLs belong on the search endpoint. Credit cost: 1 credit per call.

GET / POST /v2/fashionphile/product

func (*Client) FashionphileSearch 

func (c *Client) FashionphileSearch(ctx context.Context, params *FashionphileSearchParams, options ...RequestOption) (*Response, error)

FashionphileSearch — 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 product endpoint. Credit cost: 1 credit per call.

GET / POST /v2/fashionphile/search

func (*Client) FinderChewyProducts 

func (c *Client) FinderChewyProducts(ctx context.Context, params *FinderChewyProductsParams, options ...RequestOption) (*Response, error)

FinderChewyProducts — Chewy Products Finder. Find Chewy product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.

GET / POST /v2/finder/chewy-products

func (*Client) FinderEleclercStores 

func (c *Client) FinderEleclercStores(ctx context.Context, params *FinderEleclercStoresParams, options ...RequestOption) (*Response, error)

FinderEleclercStores — Eleclerc Stores Finder. Search Eleclerc stores by name or city to retrieve contact details, opening hours, and geolocation.

GET / POST /v2/finder/eleclerc-stores

func (*Client) FinderGoogleCountries 

func (c *Client) FinderGoogleCountries(ctx context.Context, params *FinderGoogleCountriesParams, options ...RequestOption) (*Response, error)

FinderGoogleCountries — Google Countries Finder. Search the list of Google-supported countries by name or country code to use in Google Search API requests.

GET / POST /v2/finder/google-countries

func (*Client) FinderGoogleLanguages 

func (c *Client) FinderGoogleLanguages(ctx context.Context, params *FinderGoogleLanguagesParams, options ...RequestOption) (*Response, error)

FinderGoogleLanguages — Google Languages Finder. Search the list of Google-supported languages by name to retrieve language codes for use in Google Search API requests.

GET / POST /v2/finder/google-languages

func (*Client) FinderGoogleLocations 

func (c *Client) FinderGoogleLocations(ctx context.Context, params *FinderGoogleLocationsParams, options ...RequestOption) (*Response, error)

FinderGoogleLocations — Google Locations Finder. Search Google-supported locations by name to retrieve location IDs and GPS coordinates for geo-targeted search API calls.

GET / POST /v2/finder/google-locations

func (*Client) FinderLeroymerlinProducts 

func (c *Client) FinderLeroymerlinProducts(ctx context.Context, params *FinderLeroymerlinProductsParams, options ...RequestOption) (*Response, error)

FinderLeroymerlinProducts — Leroy Merlin Products Finder. Find Leroy Merlin product URLs by product name, ID, or any combination of filters to use in product detail and rendering API calls.

GET / POST /v2/finder/leroymerlin-products

func (*Client) FinderLeroymerlinStores 

func (c *Client) FinderLeroymerlinStores(ctx context.Context, params *FinderLeroymerlinStoresParams, options ...RequestOption) (*Response, error)

FinderLeroymerlinStores — Leroy Merlin Stores Finder. Search Leroy Merlin stores by name, city or postal code to retrieve their store ID, slug, address and store locator URL.

GET / POST /v2/finder/leroymerlin-stores

func (*Client) FinderLinkedinIndustries 

func (c *Client) FinderLinkedinIndustries(ctx context.Context, params *FinderLinkedinIndustriesParams, options ...RequestOption) (*Response, error)

FinderLinkedinIndustries — LinkedIn Industries Finder. Search LinkedIn industry taxonomy to retrieve industry IDs and hierarchies for use in LinkedIn API calls and data enrichment.

GET / POST /v2/finder/linkedin-industries

func (*Client) FinderMrbricolageStores 

func (c *Client) FinderMrbricolageStores(ctx context.Context, params *FinderMrbricolageStoresParams, options ...RequestOption) (*Response, error)

FinderMrbricolageStores — Mr.Bricolage Stores Finder. Search Mr.Bricolage stores by name, city or postal code to retrieve their store ID, slug, contact information and geolocation.

GET / POST /v2/finder/mrbricolage-stores

func (*Client) FiverrProfileInfo 

func (c *Client) FiverrProfileInfo(ctx context.Context, params *FiverrProfileInfoParams, options ...RequestOption) (*Response, error)

FiverrProfileInfo — Fiverr Profile Info. Extract complete public profile data from any Fiverr seller, including gigs, ratings, reviews, skills, portfolio, and consultation pricing. Credit cost: 1 credit per call.

GET / POST /v2/fiverr/profile/info

func (*Client) FiverrSearch 

func (c *Client) FiverrSearch(ctx context.Context, params *FiverrSearchParams, options ...RequestOption) (*Response, error)

FiverrSearch — Fiverr Search. Search Fiverr gigs using a direct search URL and receive paginated listings with seller information, gig titles, images, and seller levels. Credit cost: 1 credit per call.

GET / POST /v2/fiverr/search

func (*Client) FnacProduct 

func (c *Client) FnacProduct(ctx context.Context, params *FnacProductParams, options ...RequestOption) (*Response, error)

FnacProduct — Fnac Product. Read one Fnac product from its URL or product id. You get the price, brand, EAN, seller, and rating. Credit cost: 2 credits per call.

GET / POST /v2/fnac/product

func (*Client) FnacSearch 

func (c *Client) FnacSearch(ctx context.Context, params *FnacSearchParams, options ...RequestOption) (*Response, error)

FnacSearch — Fnac Search. Search Fnac for a keyword or a SearchResult URL. Each card has the product id, name, price, seller, and stock. Credit cost: 2 credits per call.

GET / POST /v2/fnac/search

func (*Client) FotocasaAd 

func (c *Client) FotocasaAd(ctx context.Context, params *FotocasaAdParams, options ...RequestOption) (*Response, error)

FotocasaAd — Fotocasa Property Ad. Get a full Fotocasa listing by URL: price, features, coordinates, energy certificate, images, and agency (browser rendering, 2 credits). Credit cost: 2 credits per call.

GET / POST /v2/fotocasa/ad

func (*Client) FotocasaSearch 

func (c *Client) FotocasaSearch(ctx context.Context, params *FotocasaSearchParams, options ...RequestOption) (*Response, error)

FotocasaSearch — Fotocasa Property Search. Search Fotocasa listings by city or search URL. Returns prices, rooms, area, coordinates, and agency data via browser rendering (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/fotocasa/search

func (*Client) FranchisedirectFranchise 

func (c *Client) FranchisedirectFranchise(ctx context.Context, params *FranchisedirectFranchiseParams, options ...RequestOption) (*Response, error)

FranchisedirectFranchise — Franchise Direct Franchise. Read one Franchise Direct profile: cash requirement, franchise fee, investment range, and training. Credit cost: 1 credit per call.

GET / POST /v2/franchisedirect/franchise

func (*Client) FranchisedirectSearch 

func (c *Client) FranchisedirectSearch(ctx context.Context, params *FranchisedirectSearchParams, options ...RequestOption) (*Response, error)

FranchisedirectSearch — Franchise Direct Search. Search Franchise Direct listings by keyword or listing URL. Each card includes a USD cash figure and a numeric minimum. Credit cost: 1 credit per call.

GET / POST /v2/franchisedirect/search

func (*Client) FressnapfProduct 

func (c *Client) FressnapfProduct(ctx context.Context, params *FressnapfProductParams, options ...RequestOption) (*Response, error)

FressnapfProduct — Fressnapf Product. Read a Fressnapf Germany product sheet from its URL. Returns sku, GTIN, euro price, unit price, and pack variants. Credit cost: 1 credit per call.

GET / POST /v2/fressnapf/product

func (*Client) FressnapfSearch 

func (c *Client) FressnapfSearch(ctx context.Context, params *FressnapfSearchParams, options ...RequestOption) (*Response, error)

FressnapfSearch — Fressnapf Search. Search Fressnapf Germany by keyword or category URL. Returns product cards with euro prices and pagination. Credit cost: 1 credit per call.

GET / POST /v2/fressnapf/search

func (*Client) FundaProperty 

func (c *Client) FundaProperty(ctx context.Context, params *FundaPropertyParams, options ...RequestOption) (*Response, error)

FundaProperty — Funda Property. Read one Funda listing from its URL. You get the asking price, living area, and the feature groups. Credit cost: 2 credits per call.

GET / POST /v2/funda/property

func (*Client) FundaSearch 

func (c *Client) FundaSearch(ctx context.Context, params *FundaSearchParams, options ...RequestOption) (*Response, error)

FundaSearch — Funda Search. Search Funda by place. Set offering to koop for sale or huur for rent, then page the listings. Credit cost: 2 credits per call.

GET / POST /v2/funda/search

func (*Client) G2ProductInfo 

func (c *Client) G2ProductInfo(ctx context.Context, params *G2ProductInfoParams, options ...RequestOption) (*Response, error)

G2ProductInfo — G2 Product Info. Read a G2 product reviews page: rating, pricing, categories, alternatives, screenshots, and the reviews shown on the page. Credit cost: 2 credits per call.

GET / POST /v2/g2/product/info

func (*Client) GithubUserInfo 

func (c *Client) GithubUserInfo(ctx context.Context, params *GithubUserInfoParams, options ...RequestOption) (*Response, error)

GithubUserInfo — GitHub User Info. Retrieve public GitHub user profile data including bio, company, location, follower count, repositories, and associated email addresses. Credit cost: 1 credit per call.

GET / POST /v2/github/user/info

func (*Client) GlassdoorCompanyInfo 

func (c *Client) GlassdoorCompanyInfo(ctx context.Context, params *GlassdoorCompanyInfoParams, options ...RequestOption) (*Response, error)

GlassdoorCompanyInfo — Glassdoor Company Info. Get one Glassdoor company profile by URL or employer id (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/glassdoor/company/info

func (*Client) GlassdoorCompanySearch 

func (c *Client) GlassdoorCompanySearch(ctx context.Context, params *GlassdoorCompanySearchParams, options ...RequestOption) (*Response, error)

GlassdoorCompanySearch — Glassdoor Company Search. Search Glassdoor employers by keyword across country sites (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/glassdoor/company/search

func (*Client) GlassdoorJobInfo 

func (c *Client) GlassdoorJobInfo(ctx context.Context, params *GlassdoorJobInfoParams, options ...RequestOption) (*Response, error)

GlassdoorJobInfo — Glassdoor Job Info. Get one Glassdoor job listing by URL or jl id (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/glassdoor/job/info

func (*Client) GlassdoorJobSearch 

func (c *Client) GlassdoorJobSearch(ctx context.Context, params *GlassdoorJobSearchParams, options ...RequestOption) (*Response, error)

GlassdoorJobSearch — Glassdoor Job Search. Search Glassdoor jobs by keyword or SEO URL, with domain and filters (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/glassdoor/job/search

func (*Client) GoodreadsBook 

func (c *Client) GoodreadsBook(ctx context.Context, params *GoodreadsBookParams, options ...RequestOption) (*Response, error)

GoodreadsBook — Goodreads Book. Read one Goodreads book by the numeric id from search, such as 44767458 for Dune. Credit cost: 2 credits per call.

GET / POST /v2/goodreads/book

func (*Client) GoodreadsSearch 

func (c *Client) GoodreadsSearch(ctx context.Context, params *GoodreadsSearchParams, options ...RequestOption) (*Response, error)

GoodreadsSearch — Goodreads Search. Search Goodreads books by keyword. pagination.next is a Goodreads search URL for the following page. Credit cost: 2 credits per call.

GET / POST /v2/goodreads/search

func (*Client) GoogleImages 

func (c *Client) GoogleImages(ctx context.Context, params *GoogleImagesParams, options ...RequestOption) (*Response, error)

GoogleImages — Google Images. Google Images Scraper API – bringing the power of visual search to your fingertips. Credit cost: 1 credit per call.

GET / POST /v2/google/images

func (*Client) GoogleJobs 

func (c *Client) GoogleJobs(ctx context.Context, params *GoogleJobsParams, options ...RequestOption) (*Response, error)

GoogleJobs — Google Jobs. Extract job listings from Google Careers for enhanced recruitment and market analysis. Credit cost: 1 credit per call.

GET / POST /v2/google/jobs

func (*Client) GoogleMaps 

func (c *Client) GoogleMaps(ctx context.Context, params *GoogleMapsParams, options ...RequestOption) (*Response, error)

GoogleMaps — Google Maps. Extract comprehensive company data from Google Maps for enhanced business insights. Credit cost: 3 credits per call.

GET / POST /v2/google/maps

func (*Client) GoogleNews 

func (c *Client) GoogleNews(ctx context.Context, params *GoogleNewsParams, options ...RequestOption) (*Response, error)

GoogleNews — Google News. Extract real-time news articles from Google News with advanced filtering by topic, location, language, and pagination. Credit cost: 1 credit per call.

GET / POST /v2/google/news

func (*Client) GoogleSearch 

func (c *Client) GoogleSearch(ctx context.Context, params *GoogleSearchParams, options ...RequestOption) (*Response, error)

GoogleSearch — Google Search. Scrape real-time Google search results with organic listings, knowledge graph, related searches, and advanced filters. Credit cost: 1 credit per call.

GET / POST /v2/google/search

func (*Client) GoogleSearchAI 

func (c *Client) GoogleSearchAI(ctx context.Context, params *GoogleSearchAIParams, options ...RequestOption) (*Response, error)

GoogleSearchAI — Google AI Mode. Scrape real-time Google AI Mode answers: text_blocks, references, and shopping_results. Credit cost: 3 credits per call.

GET / POST /v2/google/search/ai

func (*Client) GoogleSearchAutocomplete 

func (c *Client) GoogleSearchAutocomplete(ctx context.Context, params *GoogleSearchAutocompleteParams, options ...RequestOption) (*Response, error)

GoogleSearchAutocomplete — Google Search Autocomplete. Retrieve real-time Google Search autocomplete suggestions for any query, with support for language and country localization. Credit cost: 1 credit per call.

GET / POST /v2/google/search/autocomplete

func (*Client) GoogleShopping 

func (c *Client) GoogleShopping(ctx context.Context, params *GoogleShoppingParams, options ...RequestOption) (*Response, error)

GoogleShopping — Google Shopping. Search Google Shopping and retrieve structured product listings with prices, ratings, merchants, and product IDs. Credit cost: 1 credit per call.

GET / POST /v2/google/shopping

func (*Client) GoogleVideos 

func (c *Client) GoogleVideos(ctx context.Context, params *GoogleVideosParams, options ...RequestOption) (*Response, error)

GoogleVideos — Google Videos. Scrape video results from Google Videos search including YouTube, Reddit, and other video platforms, with location and language support. Credit cost: 1 credit per call.

GET / POST /v2/google/videos

func (*Client) GoogleadstransparencyAd 

func (c *Client) GoogleadstransparencyAd(ctx context.Context, params *GoogleadstransparencyAdParams, options ...RequestOption) (*Response, error)

GoogleadstransparencyAd — Google Ads Transparency Ad. Get one Google Ads Transparency creative by URL: dates, impressions, platforms, regions, and the text read from the preview image (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/googleadstransparency/ad

func (*Client) GoogleadstransparencySearch 

func (c *Client) GoogleadstransparencySearch(ctx context.Context, params *GoogleadstransparencySearchParams, options ...RequestOption) (*Response, error)

GoogleadstransparencySearch — Google Ads Transparency Search. Search the Google Ads Transparency Center by domain, advertiser, region, format, platform, and date. Returns creative cards and pagination (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/googleadstransparency/search

func (*Client) GraingerProduct 

func (c *Client) GraingerProduct(ctx context.Context, params *GraingerProductParams, options ...RequestOption) (*Response, error)

GraingerProduct — Grainger Product. Get a Grainger US or Canada product page: SKU, brand, price, images, description and specs via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/grainger/product

func (*Client) GraingerSearch 

func (c *Client) GraingerSearch(ctx context.Context, params *GraingerSearchParams, options ...RequestOption) (*Response, error)

GraingerSearch — Grainger Search. Search Grainger US or Canada by keyword, category URL or SKU. Returns product listings, category branches and suggestions via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/grainger/search

func (*Client) GreenhouseJob 

func (c *Client) GreenhouseJob(ctx context.Context, params *GreenhouseJobParams, options ...RequestOption) (*Response, error)

GreenhouseJob — Greenhouse Job. Fetch one Greenhouse job by board/id, such as discord/8806482002, or by a job-boards.greenhouse.io job URL. Credit cost: 1 credit per call.

GET / POST /v2/greenhouse/job

func (*Client) GreenhouseSearch 

func (c *Client) GreenhouseSearch(ctx context.Context, params *GreenhouseSearchParams, options ...RequestOption) (*Response, error)

GreenhouseSearch — Greenhouse Search. List jobs on a Greenhouse board. query is the board token, such as discord. keyword filters title and location. Credit cost: 1 credit per call.

GET / POST /v2/greenhouse/search

func (*Client) GsaelibraryContract 

func (c *Client) GsaelibraryContract(ctx context.Context, params *GsaelibraryContractParams, options ...RequestOption) (*Response, error)

GsaelibraryContract — GSA eLibrary Contract. Read one GSA eLibrary contractor record from the contract URL returned by search. Credit cost: 1 credit per call.

GET / POST /v2/gsaelibrary/contract

func (*Client) GsaelibrarySearch 

func (c *Client) GsaelibrarySearch(ctx context.Context, params *GsaelibrarySearchParams, options ...RequestOption) (*Response, error)

GsaelibrarySearch — GSA eLibrary Search. Search GSA eLibrary for schedule, SIN, and contract rows by keyword or by a full search URL. Credit cost: 1 credit per call.

GET / POST /v2/gsaelibrary/search

func (*Client) HomestraAd 

func (c *Client) HomestraAd(ctx context.Context, params *HomestraAdParams, options ...RequestOption) (*Response, error)

HomestraAd — Homestra Ad. Retrieve detailed property listing data from Homestra, including price, size, location, features, photos, and nearby properties. Credit cost: 1 credit per call.

GET / POST /v2/homestra/ad

func (*Client) HomestraSearch 

func (c *Client) HomestraSearch(ctx context.Context, params *HomestraSearchParams, options ...RequestOption) (*Response, error)

HomestraSearch — Homestra Search. Search Homestra property listings using a direct search URL with filters, returning structured results with prices, sizes, locations, and photos. Credit cost: 1 credit per call.

GET / POST /v2/homestra/search

func (*Client) HuggingfaceModel 

func (c *Client) HuggingfaceModel(ctx context.Context, params *HuggingfaceModelParams, options ...RequestOption) (*Response, error)

HuggingfaceModel — Hugging Face Model. Read one public Hugging Face model by an id such as google-bert/bert-base-uncased. Credit cost: 1 credit per call.

GET / POST /v2/huggingface/model

func (*Client) HuggingfaceSearch 

func (c *Client) HuggingfaceSearch(ctx context.Context, params *HuggingfaceSearchParams, options ...RequestOption) (*Response, error)

HuggingfaceSearch — Hugging Face Search. Search the public Hugging Face models API by keyword and follow pagination.next to the next cursor page. Credit cost: 1 credit per call.

GET / POST /v2/huggingface/search

func (*Client) IdealistaProperty 

func (c *Client) IdealistaProperty(ctx context.Context, params *IdealistaPropertyParams, options ...RequestOption) (*Response, error)

IdealistaProperty — Idealista Property. Extract full property details from an Idealista listing URL, including price, specs, photos by room, features, energy rating, and advertiser data. Credit cost: 3 credits per call.

GET / POST /v2/idealista/property

func (*Client) IdealistaProvinces 

func (c *Client) IdealistaProvinces(ctx context.Context, params *IdealistaProvincesParams, options ...RequestOption) (*Response, error)

IdealistaProvinces — 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 Search. Madrid is madrid-provincia. Credit cost: 3 credits per call.

GET / POST /v2/idealista/provinces

func (*Client) IdealistaSearch 

func (c *Client) IdealistaSearch(ctx context.Context, params *IdealistaSearchParams, options ...RequestOption) (*Response, error)

IdealistaSearch — Idealista Search. Search Idealista listings from a search URL and retrieve prices, specs, photos, agency info, and pagination. Pass a province URL from /v2/idealista/provinces (results[].url) as query. Madrid is `https://www.idealista.com/venta-vivien… Credit cost: 3 credits per call.

GET / POST /v2/idealista/search

func (*Client) IdealoProduct 

func (c *Client) IdealoProduct(ctx context.Context, params *IdealoProductParams, options ...RequestOption) (*Response, error)

IdealoProduct — Idealo Product. Get an Idealo product from Spain, France, or Germany. URL or product id. Offers, shipping, specs, and images via WebUnlocker (3 credits). Credit cost: 3 credits per call.

GET / POST /v2/idealo/product

func (*Client) IdealoSearch 

func (c *Client) IdealoSearch(ctx context.Context, params *IdealoSearchParams, options ...RequestOption) (*Response, error)

IdealoSearch — Idealo Search. Search Idealo Spain, France, and Germany. Keyword or search URL. Prices, shipping, ratings, and pagination via WebUnlocker (3 credits). Credit cost: 3 credits per call.

GET / POST /v2/idealo/search

func (*Client) IkeaProduct 

func (c *Client) IkeaProduct(ctx context.Context, params *IkeaProductParams, options ...RequestOption) (*Response, error)

IkeaProduct — IKEA Product. Extract full IKEA product details from a product URL, including price, gallery, variants, dimensions, and breadcrumb. Credit cost: 1 credit per call.

GET / POST /v2/ikea/product

func (*Client) IkeaSearch 

func (c *Client) IkeaSearch(ctx context.Context, params *IkeaSearchParams, options ...RequestOption) (*Response, error)

IkeaSearch — IKEA Search. Search IKEA products from a search URL and retrieve prices, ratings, dimensions, images, and pagination. Credit cost: 1 credit per call.

GET / POST /v2/ikea/search

func (*Client) Immobilienscout24Property 

func (c *Client) Immobilienscout24Property(ctx context.Context, params *Immobilienscout24PropertyParams, options ...RequestOption) (*Response, error)

Immobilienscout24Property — ImmobilienScout24 Property. Read one ImmobilienScout24 expose by URL or numeric id. You get cold rent or purchase price, address, and area. Credit cost: 2 credits per call.

GET / POST /v2/immobilienscout24/property

func (*Client) Immobilienscout24Search 

func (c *Client) Immobilienscout24Search(ctx context.Context, params *Immobilienscout24SearchParams, options ...RequestOption) (*Response, error)

Immobilienscout24Search — ImmobilienScout24 Search. Search ImmobilienScout24 by region and property type. real_estate_type covers rent, buy, house, and land. Page with pagenumber. Credit cost: 2 credits per call.

GET / POST /v2/immobilienscout24/search

func (*Client) Immoscout24chSearch 

func (c *Client) Immoscout24chSearch(ctx context.Context, params *Immoscout24chSearchParams, options ...RequestOption) (*Response, error)

Immoscout24chSearch — ImmoScout24 Switzerland Search. Search ImmoScout24.ch listings by city or search URL and retrieve the CHF price, rooms, living area, and address. Property pages are not available. Credit cost: 2 credits per call.

GET / POST /v2/immoscout24ch/search

func (*Client) ImmoweltProperty 

func (c *Client) ImmoweltProperty(ctx context.Context, params *ImmoweltPropertyParams, options ...RequestOption) (*Response, error)

ImmoweltProperty — Immowelt Property. Extract full property details from an Immowelt listing URL, including price, specs, photo gallery, energy certificate, location, and contact data. Credit cost: 1 credit per call.

GET / POST /v2/immowelt/property

func (*Client) ImmoweltSearch 

func (c *Client) ImmoweltSearch(ctx context.Context, params *ImmoweltSearchParams, options ...RequestOption) (*Response, error)

ImmoweltSearch — Immowelt Search. Search Immowelt listings from a search URL and retrieve prices, specs, photos, agency info, and pagination. Credit cost: 1 credit per call.

GET / POST /v2/immowelt/search

func (*Client) ImoveiswebProperty 

func (c *Client) ImoveiswebProperty(ctx context.Context, params *ImoveiswebPropertyParams, options ...RequestOption) (*Response, error)

ImoveiswebProperty — ImoveisWeb Property. Read one Imobiliária Aquários listing from its imoveisweb.com.br URL. price_display is rebuilt from the asking amount. Credit cost: 1 credit per call.

GET / POST /v2/imoveisweb/property

func (*Client) ImoveiswebSearch 

func (c *Client) ImoveiswebSearch(ctx context.Context, params *ImoveiswebSearchParams, options ...RequestOption) (*Response, error)

ImoveiswebSearch — 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 amount. Credit cost: 1 credit per call.

GET / POST /v2/imoveisweb/search

func (*Client) IndeedCompanyInfo 

func (c *Client) IndeedCompanyInfo(ctx context.Context, params *IndeedCompanyInfoParams, options ...RequestOption) (*Response, error)

IndeedCompanyInfo — Indeed Company Info. Indeed Company Info API. Full employer profile by slug or URL. Browser rendering returns headcount, revenue, industry and FAQ or review blocks. Credit cost: 2 credits per call.

GET / POST /v2/indeed/company/info

func (*Client) IndeedCompanySearch 

func (c *Client) IndeedCompanySearch(ctx context.Context, params *IndeedCompanySearchParams, options ...RequestOption) (*Response, error)

IndeedCompanySearch — Indeed Company Search. Indeed Company Search API. Search fr.indeed.com employer profiles by keyword or URL. Browser rendering returns ratings, industry and profile links. Credit cost: 2 credits per call.

GET / POST /v2/indeed/company/search

func (*Client) IndeedJobInfo 

func (c *Client) IndeedJobInfo(ctx context.Context, params *IndeedJobInfoParams, options ...RequestOption) (*Response, error)

IndeedJobInfo — 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 structured salary. Credit cost: 2 credits per call.

GET / POST /v2/indeed/job/info

func (*Client) IndeedJobSalary 

func (c *Client) IndeedJobSalary(ctx context.Context, params *IndeedJobSalaryParams, options ...RequestOption) (*Response, error)

IndeedJobSalary — Indeed Job Salary. Indeed Job Salary API. Career salary aggregates by job title slug or URL. Browser rendering returns median, percentiles and top paying cities. Credit cost: 2 credits per call.

GET / POST /v2/indeed/job/salary

func (*Client) IndeedJobSearch 

func (c *Client) IndeedJobSearch(ctx context.Context, params *IndeedJobSearchParams, options ...RequestOption) (*Response, error)

IndeedJobSearch — 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 pagination. Credit cost: 2 credits per call.

GET / POST /v2/indeed/job/search

func (*Client) InetProduct 

func (c *Client) InetProduct(ctx context.Context, params *InetProductParams, options ...RequestOption) (*Response, error)

InetProduct — Inet Product. Read one Inet.se product by article number or URL, including SEK price, specs, and warehouse stock. Credit cost: 1 credit per call.

GET / POST /v2/inet/product

func (*Client) InetSearch 

func (c *Client) InetSearch(ctx context.Context, params *InetSearchParams, options ...RequestOption) (*Response, error)

InetSearch — Inet Search. Search Inet.se by keyword or category. Prices are inc-VAT SEK, with the next page URL when more results exist. Credit cost: 1 credit per call.

GET / POST /v2/inet/search

func (*Client) InstagramPostInfo 

func (c *Client) InstagramPostInfo(ctx context.Context, params *InstagramPostInfoParams, options ...RequestOption) (*Response, error)

InstagramPostInfo — Instagram Post Info. Monitor competitors and market trends by scraping Instagram posts for valuable data. Credit cost: 1 credit per call.

GET / POST /v2/instagram/post/info

func (*Client) InstagramUserInfo 

func (c *Client) InstagramUserInfo(ctx context.Context, params *InstagramUserInfoParams, options ...RequestOption) (*Response, error)

InstagramUserInfo — Instagram User Info. Gather user insights efficiently from Instagram for targeted marketing strategies. Credit cost: 1 credit per call.

GET / POST /v2/instagram/user/info

func (*Client) IntermarcheProduct 

func (c *Client) IntermarcheProduct(ctx context.Context, params *IntermarcheProductParams, options ...RequestOption) (*Response, error)

IntermarcheProduct — Intermarché 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. Credit cost: 3 credits per call.

GET / POST /v2/intermarche/product

func (*Client) IntermarcheSearch 

func (c *Client) IntermarcheSearch(ctx context.Context, params *IntermarcheSearchParams, options ...RequestOption) (*Response, error)

IntermarcheSearch — Intermarché Search. Search Intermarché products for a store (shop_id). Try query=lait and shop_id=11301. 3 credits per call. Credit cost: 3 credits per call.

GET / POST /v2/intermarche/search

func (*Client) IntersportProduct 

func (c *Client) IntersportProduct(ctx context.Context, params *IntersportProductParams, options ...RequestOption) (*Response, error)

IntersportProduct — Intersport Product. Read one Intersport product from its URL. You get price, brand, and the product details. Credit cost: 2 credits per call.

GET / POST /v2/intersport/product

func (*Client) IntersportSearch 

func (c *Client) IntersportSearch(ctx context.Context, params *IntersportSearchParams, options ...RequestOption) (*Response, error)

IntersportSearch — Intersport Search. Search Intersport by keyword and page the sports grid. Cards include title, price, and product link. Credit cost: 2 credits per call.

GET / POST /v2/intersport/search

func (*Client) JameseditionProperty 

func (c *Client) JameseditionProperty(ctx context.Context, params *JameseditionPropertyParams, options ...RequestOption) (*Response, error)

JameseditionProperty — JamesEdition Property. Read one JamesEdition listing from its URL. Credit cost: 1 credit per call.

GET / POST /v2/jamesedition/property

func (*Client) JameseditionSearch 

func (c *Client) JameseditionSearch(ctx context.Context, params *JameseditionSearchParams, options ...RequestOption) (*Response, error)

JameseditionSearch — JamesEdition Search. Search JamesEdition luxury homes by keyword or by a results URL. Credit cost: 1 credit per call.

GET / POST /v2/jamesedition/search

func (*Client) Jobs 

func (c *Client) Jobs(ctx context.Context, params *JobsParams, options ...RequestOption) (*Response, error)

Jobs — Jobs. Poll the status, progress (0–100) and result of a job started with is_async=true. Polling is free. Poll until status is terminal: CompletedJob, Error, NotFound or BadRequest.

GET /v1/jobs/{id}

func (*Client) KickUserInfo 

func (c *Client) KickUserInfo(ctx context.Context, params *KickUserInfoParams, options ...RequestOption) (*Response, error)

KickUserInfo — Kick User Info. Retrieve complete public channel data from Kick including streamer profile, follower count, live status, and recent categories. Credit cost: 1 credit per call.

GET / POST /v2/kick/user/info

func (*Client) KijijiAd 

func (c *Client) KijijiAd(ctx context.Context, params *KijijiAdParams, options ...RequestOption) (*Response, error)

KijijiAd — Kijiji Ad. Read one Kijiji ad from its id or URL. You get the asking price, the title, and the city. Credit cost: 1 credit per call.

GET / POST /v2/kijiji/ad

func (*Client) KijijiSearch 

func (c *Client) KijijiSearch(ctx context.Context, params *KijijiSearchParams, options ...RequestOption) (*Response, error)

KijijiSearch — Kijiji Search. Search Kijiji with a results URL or a city and category. Language can be English or French. Page through classified ads. Credit cost: 1 credit per call.

GET / POST /v2/kijiji/search

func (*Client) KrogerProduct 

func (c *Client) KrogerProduct(ctx context.Context, params *KrogerProductParams, options ...RequestOption) (*Response, error)

KrogerProduct — 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 shows one. Credit cost: 2 credits per call.

GET / POST /v2/kroger/product

func (*Client) KrogerSearch 

func (c *Client) KrogerSearch(ctx context.Context, params *KrogerSearchParams, options ...RequestOption) (*Response, error)

KrogerSearch — 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 you pass is not applied. Credit cost: 2 credits per call.

GET / POST /v2/kroger/search

func (*Client) LamudiAd 

func (c *Client) LamudiAd(ctx context.Context, params *LamudiAdParams, options ...RequestOption) (*Response, error)

LamudiAd — Lamudi Ad. Get a full Lamudi listing by URL: price, area, amenities, coordinates, images, and agent (browser rendering, 2 credits). Credit cost: 2 credits per call.

GET / POST /v2/lamudi/ad

func (*Client) LamudiSearch 

func (c *Client) LamudiSearch(ctx context.Context, params *LamudiSearchParams, options ...RequestOption) (*Response, error)

LamudiSearch — Lamudi Search. Search Lamudi Philippines and Indonesia listings. Pass a search URL in query, or use location and filters. Prices, area, rooms, tags, and pagination via browser rendering (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/lamudi/search

func (*Client) LeboncoinAd 

func (c *Client) LeboncoinAd(ctx context.Context, params *LeboncoinAdParams, options ...RequestOption) (*Response, error)

LeboncoinAd — Leboncoin Ad. Extract full details from a Leboncoin ad including price, location, attributes, seller info, and images. Returns structured JSON by default, or raw HTML on demand. Credit cost: 1 credit per call.

GET / POST /v2/leboncoin/ad

func (*Client) LeboncoinSearch 

func (c *Client) LeboncoinSearch(ctx context.Context, params *LeboncoinSearchParams, options ...RequestOption) (*Response, error)

LeboncoinSearch — Leboncoin Search. Scrape Leboncoin search results or category pages by URL, returning paginated listings with price, location, and attributes. Returns structured JSON. return_page_source is deprecated and returns 400. Credit cost: 1 credit per call.

GET / POST /v2/leboncoin/search

func (*Client) LeboncoinSearchAPI 

func (c *Client) LeboncoinSearchAPI(ctx context.Context, params *LeboncoinSearchAPIParams, options ...RequestOption) (*Response, error)

LeboncoinSearchAPI — Leboncoin Search API. Search Leboncoin listings via structured POST API with advanced filters for category, location, price range, seller type, and sorting. Credit cost: 1 credit per call.

POST /v2/leboncoin/search_api

func (*Client) LenovoProduct 

func (c *Client) LenovoProduct(ctx context.Context, params *LenovoProductParams, options ...RequestOption) (*Response, error)

LenovoProduct — Lenovo Product. Extract a Lenovo product page by URL: id, name, price, currency, availability, images, and description (browser rendering, 2 credits). Credit cost: 2 credits per call.

GET / POST /v2/lenovo/product

func (*Client) LenovoSearch 

func (c *Client) LenovoSearch(ctx context.Context, params *LenovoSearchParams, options ...RequestOption) (*Response, error)

LenovoSearch — Lenovo Search. Search Lenovo products by keyword or listing URL. Returns product id, price, currency, series, and availability via browser rendering (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/lenovo/search

func (*Client) LeroymerlinProduct 

func (c *Client) LeroymerlinProduct(ctx context.Context, params *LeroymerlinProductParams, options ...RequestOption) (*Response, error)

LeroymerlinProduct — Leroy Merlin Product. Live Leroy Merlin product detail for France and Romania from a URL or identifier: offers, currency, images, features and store context. Credit cost: 3 credits per call.

GET / POST /v2/leroymerlin/product

func (*Client) LeroymerlinSearch 

func (c *Client) LeroymerlinSearch(ctx context.Context, params *LeroymerlinSearchParams, options ...RequestOption) (*Response, error)

LeroymerlinSearch — Leroy Merlin Search. Live Leroy Merlin search across France and Romania: title, URL, price, currency, brand, seller, rating and pagination. Credit cost: 3 credits per call.

GET / POST /v2/leroymerlin/search

func (*Client) LidlProduct 

func (c *Client) LidlProduct(ctx context.Context, params *LidlProductParams, options ...RequestOption) (*Response, error)

LidlProduct — Lidl Product. Lidl Product API: fetch full product page data from a Lidl URL or ERP id. Returns pricing, images, description, availability and category via Nuxt SSR parsing. Credit cost: 1 credit per call.

GET / POST /v2/lidl/product

func (*Client) LidlSearch 

func (c *Client) LidlSearch(ctx context.Context, params *LidlSearchParams, options ...RequestOption) (*Response, error)

LidlSearch — 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; returns prices, ratings, brand and pagination. Credit cost: 1 credit per call.

GET / POST /v2/lidl/search

func (*Client) LinkedinCompanyInfo 

func (c *Client) LinkedinCompanyInfo(ctx context.Context, params *LinkedinCompanyInfoParams, options ...RequestOption) (*Response, error)

LinkedinCompanyInfo — LinkedIn Company Info. LinkedIn Company Info API. Fetch firmographics by LinkedIn slug, URL, company ID, or reverse domain lookup (guideflow.com). Industry, headcount, HQ, posts, and more. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/company/info

func (*Client) LinkedinJobCount 

func (c *Client) LinkedinJobCount(ctx context.Context, params *LinkedinJobCountParams, options ...RequestOption) (*Response, error)

LinkedinJobCount — LinkedIn Job Count. Obtain real-time job counts on LinkedIn by industry, region, and role for strategic planning. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/job/count

func (*Client) LinkedinJobInfo 

func (c *Client) LinkedinJobInfo(ctx context.Context, params *LinkedinJobInfoParams, options ...RequestOption) (*Response, error)

LinkedinJobInfo — LinkedIn Job Info. Dive into LinkedIn job data and trends for in-depth labor market insights. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/job/info

func (*Client) LinkedinJobSearch 

func (c *Client) LinkedinJobSearch(ctx context.Context, params *LinkedinJobSearchParams, options ...RequestOption) (*Response, error)

LinkedinJobSearch — LinkedIn Job Search. Experience advanced job data extraction from LinkedIn, enhancing your recruitment strategy. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/job/search

func (*Client) LinkedinJobSuggest 

func (c *Client) LinkedinJobSuggest(ctx context.Context, params *LinkedinJobSuggestParams, options ...RequestOption) (*Response, error)

LinkedinJobSuggest — LinkedIn Job Suggest. Get personalized job suggestions based on keywords or locations to streamline your job search. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/job/suggest

func (*Client) LinkedinPostInfo 

func (c *Client) LinkedinPostInfo(ctx context.Context, params *LinkedinPostInfoParams, options ...RequestOption) (*Response, error)

LinkedinPostInfo — LinkedIn Post Info. Simplify LinkedIn post retrieval with our efficient API for enhanced content analysis. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/post/info

func (*Client) LinkedinProductInfo 

func (c *Client) LinkedinProductInfo(ctx context.Context, params *LinkedinProductInfoParams, options ...RequestOption) (*Response, error)

LinkedinProductInfo — LinkedIn Product Info. Gain competitive insights with detailed LinkedIn product information for strategic advantage. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/product/info

func (*Client) LinkedinProfileInfo 

func (c *Client) LinkedinProfileInfo(ctx context.Context, params *LinkedinProfileInfoParams, options ...RequestOption) (*Response, error)

LinkedinProfileInfo — LinkedIn Profile Info. Streamline recruitment and business development by extracting valuable LinkedIn profile insights. Credit cost: 1 credit per call.

GET / POST /v2/linkedin/profile/info

func (*Client) LinkedinadlibraryAd 

func (c *Client) LinkedinadlibraryAd(ctx context.Context, params *LinkedinadlibraryAdParams, options ...RequestOption) (*Response, error)

LinkedinadlibraryAd — LinkedIn Ad Library Ad. Get one LinkedIn Ad Library creative by URL or id: copy, CTA, payer, impressions, and targeting (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/linkedinadlibrary/ad

func (*Client) LinkedinadlibrarySearch 

func (c *Client) LinkedinadlibrarySearch(ctx context.Context, params *LinkedinadlibrarySearchParams, options ...RequestOption) (*Response, error)

LinkedinadlibrarySearch — LinkedIn Ad Library Search. Search the LinkedIn Ad Library by advertiser, keyword, country, and date. Returns ad cards and pagination (2 credits). Credit cost: 2 credits per call.

GET / POST /v2/linkedinadlibrary/search

func (*Client) LoopnetProperty 

func (c *Client) LoopnetProperty(ctx context.Context, params *LoopnetPropertyParams, options ...RequestOption) (*Response, error)

LoopnetProperty — LoopNet Property. Read one LoopNet commercial listing from its URL. Credit cost: 1 credit per call.

GET / POST /v2/loopnet/property

func (*Client) LoopnetSearch 

func (c *Client) LoopnetSearch(ctx context.Context, params *LoopnetSearchParams, options ...RequestOption) (*Response, error)

LoopnetSearch — LoopNet Search. Search LoopNet commercial listings by city or by a results URL. Credit cost: 1 credit per call.

GET / POST /v2/loopnet/search

func (*Client) MaerskTracking 

func (c *Client) MaerskTracking(ctx context.Context, params *MaerskTrackingParams, options ...RequestOption) (*Response, error)

MaerskTracking — Maersk Tracking. Track a Maersk container or BOL: origin, destination, current milestone and full transport-plan events via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/maersk/tracking

func (*Client) ManomanoProduct 

func (c *Client) ManomanoProduct(ctx context.Context, params *ManomanoProductParams, options ...RequestOption) (*Response, error)

ManomanoProduct — 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.amount_with_vat. Credit cost: 2 credits per call.

GET / POST /v2/manomano/product

func (*Client) ManomanoProductOffer 

func (c *Client) ManomanoProductOffer(ctx context.Context, params *ManomanoProductOfferParams, options ...RequestOption) (*Response, error)

ManomanoProductOffer — 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. Credit cost: 1 credit per call.

GET / POST /v2/manomano/product/offer

func (*Client) ManomanoSearch 

func (c *Client) ManomanoSearch(ctx context.Context, params *ManomanoSearchParams, options ...RequestOption) (*Response, error)

ManomanoSearch — 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.next is a boolean. Credit cost: 2 credits per call.

GET / POST /v2/manomano/search

func (*Client) MascusAd 

func (c *Client) MascusAd(ctx context.Context, params *MascusAdParams, options ...RequestOption) (*Response, error)

MascusAd — Mascus Ad. Get full details for a Mascus used equipment listing: specs, price, seller and description. Credit cost: 1 credit per call.

GET / POST /v2/mascus/ad

func (*Client) MascusSearch 

func (c *Client) MascusSearch(ctx context.Context, params *MascusSearchParams, options ...RequestOption) (*Response, error)

MascusSearch — Mascus Search. Search used equipment listings on Mascus from a category URL, with pagination that keeps country and category filters. Credit cost: 1 credit per call.

GET / POST /v2/mascus/search

func (*Client) MediamarktProduct 

func (c *Client) MediamarktProduct(ctx context.Context, params *MediamarktProductParams, options ...RequestOption) (*Response, error)

MediamarktProduct — MediaMarkt Product. Read one MediaMarkt product by id or product URL, in the region you choose. You get price, currency, EAN, and availability. Credit cost: 2 credits per call.

GET / POST /v2/mediamarkt/product

func (*Client) MediamarktSearch 

func (c *Client) MediamarktSearch(ctx context.Context, params *MediamarktSearchParams, options ...RequestOption) (*Response, error)

MediamarktSearch — MediaMarkt Search. Search a MediaMarkt shop by keyword. Set region for Switzerland, Germany, Austria, and the other MediaMarktSaturn countries, then page the results. Credit cost: 2 credits per call.

GET / POST /v2/mediamarkt/search

func (*Client) MicromaniaProduct 

func (c *Client) MicromaniaProduct(ctx context.Context, params *MicromaniaProductParams, options ...RequestOption) (*Response, error)

MicromaniaProduct — Micromania Product. Read one Micromania product from its URL or product id. You get the price, brand, EAN, platform, and stock. Credit cost: 2 credits per call.

GET / POST /v2/micromania/product

func (*Client) MicromaniaSearch 

func (c *Client) MicromaniaSearch(ctx context.Context, params *MicromaniaSearchParams, options ...RequestOption) (*Response, error)

MicromaniaSearch — Micromania Search. Search Micromania for a keyword or a Search-Show URL. Each card has the product id, name, brand, EAN, price, and stock. Credit cost: 2 credits per call.

GET / POST /v2/micromania/search

func (*Client) MobileAd 

func (c *Client) MobileAd(ctx context.Context, params *MobileAdParams, options ...RequestOption) (*Response, error)

MobileAd — 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 webunlocker. Credit cost: 3 credits per call.

GET / POST /v2/mobile/ad

func (*Client) MobileSearch 

func (c *Client) MobileSearch(ctx context.Context, params *MobileSearchParams, options ...RequestOption) (*Response, error)

MobileSearch — 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 credits) Credit cost: 3 credits per call.

GET / POST /v2/mobile/search

func (*Client) MoreleProduct 

func (c *Client) MoreleProduct(ctx context.Context, params *MoreleProductParams, options ...RequestOption) (*Response, error)

MoreleProduct — Morele Product. Read one morele.net product page. Flat JSON with PLN price, EAN, specs, and availability. Credit cost: 1 credit per call.

GET / POST /v2/morele/product

func (*Client) MoreleSearch 

func (c *Client) MoreleSearch(ctx context.Context, params *MoreleSearchParams, options ...RequestOption) (*Response, error)

MoreleSearch — Morele Search. Search morele.net by keyword or search URL. Returns product cards with PLN prices and pagination. Credit cost: 1 credit per call.

GET / POST /v2/morele/search

func (*Client) MrbricolageSuggest 

func (c *Client) MrbricolageSuggest(ctx context.Context, params *MrbricolageSuggestParams, options ...RequestOption) (*Response, error)

MrbricolageSuggest — Mr.Bricolage Suggest. Live Mr.Bricolage product suggestions for a search keyword or EAN, including title, URL, image, price and currency. Credit cost: 3 credits per call.

GET / POST /v2/mrbricolage/suggest

func (*Client) NPIProvider 

func (c *Client) NPIProvider(ctx context.Context, params *NPIProviderParams, options ...RequestOption) (*Response, error)

NPIProvider — NPI Provider. Fetch one NPPES provider or organization by 10-digit NPI or provider-view URL, including addresses and taxonomies. Credit cost: 1 credit per call.

GET / POST /v2/npi/provider

func (*Client) NPISearch 

func (c *Client) NPISearch(ctx context.Context, params *NPISearchParams, options ...RequestOption) (*Response, error)

NPISearch — 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_results is null, and next is set only when the page is full. Credit cost: 1 credit per call.

GET / POST /v2/npi/search

func (*Client) NeweggProduct 

func (c *Client) NeweggProduct(ctx context.Context, params *NeweggProductParams, options ...RequestOption) (*Response, error)

NeweggProduct — Newegg Product. Read a Newegg product from an item number, catalog id, or URL. Returns price, specs, images, and seller. Credit cost: 2 credits per call.

GET / POST /v2/newegg/product

func (*Client) NeweggSearch 

func (c *Client) NeweggSearch(ctx context.Context, params *NeweggSearchParams, options ...RequestOption) (*Response, error)

NeweggSearch — Newegg Search. Search Newegg by keyword or search URL. Returns item numbers, dollar prices, stock, and pagination. Credit cost: 2 credits per call.

GET / POST /v2/newegg/search

func (*Client) NorthdataCompany 

func (c *Client) NorthdataCompany(ctx context.Context, params *NorthdataCompanyParams, options ...RequestOption) (*Response, error)

NorthdataCompany — North Data Company. North Data company profile: register, address, financials and history (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/northdata/company

func (*Client) NorthdataSearch 

func (c *Client) NorthdataSearch(ctx context.Context, params *NorthdataSearchParams, options ...RequestOption) (*Response, error)

NorthdataSearch — North Data Search. Search North Data companies and people by name. Returns suggestion cards and pagination (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/northdata/search

func (*Client) OceanioSearch 

func (c *Client) OceanioSearch(ctx context.Context, params *OceanioSearchParams, options ...RequestOption) (*Response, error)

OceanioSearch — Oceanio Search. Search Ocean.io by domain or company name to find the matching company, similar companies, contacts, and people. Credit cost: 1 credit per call.

GET / POST /v2/oceanio/search

func (*Client) OlxAd 

func (c *Client) OlxAd(ctx context.Context, params *OlxAdParams, options ...RequestOption) (*Response, error)

OlxAd — OLX Ad. Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name. Credit cost: 1 credit per call.

GET / POST /v2/olx/ad

func (*Client) OlxProduct 

func (c *Client) OlxProduct(ctx context.Context, params *OlxProductParams, options ...RequestOption) (*Response, error)

OlxProduct — OLX Product. Read one OLX ad from its id or URL. You get the asking price, the city, and the seller name. Credit cost: 1 credit per call.

GET / POST /v2/olx/product

func (*Client) OlxSearch 

func (c *Client) OlxSearch(ctx context.Context, params *OlxSearchParams, options ...RequestOption) (*Response, error)

OlxSearch — OLX Search. Search OLX Brazil classifieds by keyword and get title, price, location, seller type, and condition as structured JSON in real time. Credit cost: 1 credit per call.

GET / POST /v2/olx/search

func (*Client) OscaroProduct 

func (c *Client) OscaroProduct(ctx context.Context, params *OscaroProductParams, options ...RequestOption) (*Response, error)

OscaroProduct — Oscaro Product. Oscaro Product API. Fetch full auto parts product data from an Oscaro product URL. Returns pricing, brand, reference, images and availability via browser rendering and JSON-LD parsing. Credit cost: 2 credits per call.

GET / POST /v2/oscaro/product

func (*Client) OscaroSearch 

func (c *Client) OscaroSearch(ctx context.Context, params *OscaroSearchParams, options ...RequestOption) (*Response, error)

OscaroSearch — 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 pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/oscaro/search

func (*Client) OvokoAd 

func (c *Client) OvokoAd(ctx context.Context, params *OvokoAdParams, options ...RequestOption) (*Response, error)

OvokoAd — Ovoko Ad. Extract an Ovoko listing from a SKU URL: price, currency, images, seller, quality, vehicle make, part numbers, and warranty. Credit cost: 1 credit per call.

GET / POST /v2/ovoko/ad

func (*Client) OvokoSearch 

func (c *Client) OvokoSearch(ctx context.Context, params *OvokoSearchParams, options ...RequestOption) (*Response, error)

OvokoSearch — Ovoko Search. Search Ovoko used-parts listings from a search URL and retrieve title, price, OEM codes, seller, vehicle text, and pagination. Credit cost: 1 credit per call.

GET / POST /v2/ovoko/search

func (*Client) OwlerCompanyInfo 

func (c *Client) OwlerCompanyInfo(ctx context.Context, params *OwlerCompanyInfoParams, options ...RequestOption) (*Response, error)

OwlerCompanyInfo — Owler Company Info. Retrieve detailed company intelligence from Owler, including revenue, employee count, CEO info, competitors, funding, and industry sectors. Credit cost: 1 credit per call.

GET / POST /v2/owler/company/info

func (*Client) OwlerSearch 

func (c *Client) OwlerSearch(ctx context.Context, params *OwlerSearchParams, options ...RequestOption) (*Response, error)

OwlerSearch — Owler Search. Search for companies on Owler by name or keyword, returning a list of matching companies with slugs, logos, domains, and profile URLs. Credit cost: 1 credit per call.

GET / POST /v2/owler/search

func (*Client) PagesjaunesPageInfo 

func (c *Client) PagesjaunesPageInfo(ctx context.Context, params *PagesjaunesPageInfoParams, options ...RequestOption) (*Response, error)

PagesjaunesPageInfo — PagesJaunes Page Info. Retrieve detailed business information from a PagesJaunes page, including contact details, opening hours, services, payment methods, and SIREN number. Credit cost: 1 credit per call.

GET / POST /v2/pagesjaunes/page/info

func (*Client) PagesjaunesSearch 

func (c *Client) PagesjaunesSearch(ctx context.Context, params *PagesjaunesSearchParams, options ...RequestOption) (*Response, error)

PagesjaunesSearch — PagesJaunes Search. Search PagesJaunes for French local businesses by category and location, returning paginated results with contact details and ratings. Credit cost: 1 credit per call.

GET / POST /v2/pagesjaunes/search

func (*Client) PatreonProfileInfo 

func (c *Client) PatreonProfileInfo(ctx context.Context, params *PatreonProfileInfoParams, options ...RequestOption) (*Response, error)

PatreonProfileInfo — Patreon Profile Info. Retrieve a Patreon creator profile with patron counts, membership tiers, campaign summary, and creator metadata. Credit cost: 1 credit per call.

GET / POST /v2/patreon/profile/info

func (*Client) PatreonSearch 

func (c *Client) PatreonSearch(ctx context.Context, params *PatreonSearchParams, options ...RequestOption) (*Response, error)

PatreonSearch — Patreon Search. Search Patreon creators by keyword and retrieve campaign cards with patron counts, post counts, and profile URLs. Credit cost: 1 credit per call.

GET / POST /v2/patreon/search

func (*Client) PetsmartProduct 

func (c *Client) PetsmartProduct(ctx context.Context, params *PetsmartProductParams, options ...RequestOption) (*Response, error)

PetsmartProduct — PetSmart Product. Read one PetSmart product URL, including the selected size, dollar price, flavor, and item number. Credit cost: 1 credit per call.

GET / POST /v2/petsmart/product

func (*Client) PetsmartSearch 

func (c *Client) PetsmartSearch(ctx context.Context, params *PetsmartSearchParams, options ...RequestOption) (*Response, error)

PetsmartSearch — PetSmart Search. Search PetSmart by keyword or search URL. Page through pet food, litter, and supplies with dollar prices. Credit cost: 1 credit per call.

GET / POST /v2/petsmart/search

func (*Client) PicardProduct 

func (c *Client) PicardProduct(ctx context.Context, params *PicardProductParams, options ...RequestOption) (*Response, error)

PicardProduct — Picard Product. Picard Product API. Fetch full frozen food product data from a Picard URL or reference. Returns pricing, images, description, Nutri-Score, Planet-Score, breadcrumb and reviews. Credit cost: 1 credit per call.

GET / POST /v2/picard/product

func (*Client) PicardSearch 

func (c *Client) PicardSearch(ctx context.Context, params *PicardSearchParams, options ...RequestOption) (*Response, error)

PicardSearch — Picard Search. Picard Search API. Search frozen food listings on picard.fr by keyword or URL. Parses SFCC Search-UpdateGrid HTML; returns prices, Nutri-Score, ratings and pagination. Credit cost: 1 credit per call.

GET / POST /v2/picard/search

func (*Client) PinterestUserInfo 

func (c *Client) PinterestUserInfo(ctx context.Context, params *PinterestUserInfoParams, options ...RequestOption) (*Response, error)

PinterestUserInfo — Pinterest User Info. Access Pinterest user profiles and analytics for targeted marketing and audience insights. Credit cost: 1 credit per call.

GET / POST /v2/pinterest/user/info

func (*Client) PitchbookCompanyInfo 

func (c *Client) PitchbookCompanyInfo(ctx context.Context, params *PitchbookCompanyInfoParams, options ...RequestOption) (*Response, error)

PitchbookCompanyInfo — PitchBook Company Info. Get a PitchBook company profile: overview, funding, competitors and more via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/pitchbook/company/info

func (*Client) PitchbookSearch 

func (c *Client) PitchbookSearch(ctx context.Context, params *PitchbookSearchParams, options ...RequestOption) (*Response, error)

PitchbookSearch — PitchBook Search. Search PitchBook for companies, news and profiles by keyword or search URL via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/pitchbook/search

func (*Client) PointpProduct 

func (c *Client) PointpProduct(ctx context.Context, params *PointpProductParams, options ...RequestOption) (*Response, error)

PointpProduct — Point.P Product. Point.P Product API: scrape live /p/ product pages from a full URL. Get title, images, EAN, pricing, specifications, and breadcrumbs as JSON via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/pointp/product

func (*Client) PointpSearch 

func (c *Client) PointpSearch(ctx context.Context, params *PointpSearchParams, options ...RequestOption) (*Response, error)

PointpSearch — Point.P Search. Point.P Search API: search by keyword or URL and get building-material listings with prices, brands, ratings, units, and pagination as JSON via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/pointp/search

func (*Client) PrnewswireArticle 

func (c *Client) PrnewswireArticle(ctx context.Context, params *PrnewswireArticleParams, options ...RequestOption) (*Response, error)

PrnewswireArticle — PR Newswire Article. Read one PR Newswire press release from its URL. Credit cost: 1 credit per call.

GET / POST /v2/prnewswire/article

func (*Client) PrnewswireSearch 

func (c *Client) PrnewswireSearch(ctx context.Context, params *PrnewswireSearchParams, options ...RequestOption) (*Response, error)

PrnewswireSearch — PR Newswire Search. Search PR Newswire press releases by keyword or by a news-search URL. Credit cost: 1 credit per call.

GET / POST /v2/prnewswire/search

func (*Client) ProducthuntProductInfo 

func (c *Client) ProducthuntProductInfo(ctx context.Context, params *ProducthuntProductInfoParams, options ...RequestOption) (*Response, error)

ProducthuntProductInfo — ProductHunt Product Info. Retrieve product data from ProductHunt, including tagline, categories, screenshots, reviews rating, and social links. Credit cost: 1 credit per call.

GET / POST /v2/producthunt/product/info

func (*Client) ProshopProduct 

func (c *Client) ProshopProduct(ctx context.Context, params *ProshopProductParams, options ...RequestOption) (*Response, error)

ProshopProduct — Proshop Product. Read one proshop.dk product page. Flat JSON with DKK price, EAN, specs, and stock text. Credit cost: 1 credit per call.

GET / POST /v2/proshop/product

func (*Client) ProshopSearch 

func (c *Client) ProshopSearch(ctx context.Context, params *ProshopSearchParams, options ...RequestOption) (*Response, error)

ProshopSearch — Proshop Search. Search proshop.dk by keyword or search URL. Returns product cards with DKK prices and pagination. Credit cost: 1 credit per call.

GET / POST /v2/proshop/search

func (*Client) RappiProduct 

func (c *Client) RappiProduct(ctx context.Context, params *RappiProductParams, options ...RequestOption) (*Response, error)

RappiProduct — 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 card. Credit cost: 1 credit per call.

GET / POST /v2/rappi/product

func (*Client) RappiSearch 

func (c *Client) RappiSearch(ctx context.Context, params *RappiSearchParams, options ...RequestOption) (*Response, error)

RappiSearch — 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. Credit cost: 1 credit per call.

GET / POST /v2/rappi/search

func (*Client) RatemyprofessorsProfessor 

func (c *Client) RatemyprofessorsProfessor(ctx context.Context, params *RatemyprofessorsProfessorParams, options ...RequestOption) (*Response, error)

RatemyprofessorsProfessor — Rate My Professors Professor. Read one Rate My Professors profile, including difficulty and would-take-again when the page shows them. Credit cost: 2 credits per call.

GET / POST /v2/ratemyprofessors/professor

func (*Client) RatemyprofessorsSearch 

func (c *Client) RatemyprofessorsSearch(ctx context.Context, params *RatemyprofessorsSearchParams, options ...RequestOption) (*Response, error)

RatemyprofessorsSearch — Rate My Professors Search. Search Rate My Professors by name. Cards include school, department, difficulty, and would-take-again when the card shows them. Credit cost: 2 credits per call.

GET / POST /v2/ratemyprofessors/search

func (*Client) RealestatecomauSearch 

func (c *Client) RealestatecomauSearch(ctx context.Context, params *RealestatecomauSearchParams, options ...RequestOption) (*Response, error)

RealestatecomauSearch — realestate.com.au 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, rooms, and a property URL. Credit cost: 2 credits per call.

GET / POST /v2/realestatecomau/search

func (*Client) RealtorProperty 

func (c *Client) RealtorProperty(ctx context.Context, params *RealtorPropertyParams, options ...RequestOption) (*Response, error)

RealtorProperty — Realtor Property. Extract full property details from a Realtor.com listing URL, including price, specs, photos, agents, features, and location data. Credit cost: 2 credits per call.

GET / POST /v2/realtor/property

func (*Client) RealtorSearch 

func (c *Client) RealtorSearch(ctx context.Context, params *RealtorSearchParams, options ...RequestOption) (*Response, error)

RealtorSearch — Realtor Search. Search Realtor.com listings from a search URL and retrieve prices, beds, baths, sqft, photos, and property metadata. Credit cost: 2 credits per call.

GET / POST /v2/realtor/search

func (*Client) RedfinProperty 

func (c *Client) RedfinProperty(ctx context.Context, params *RedfinPropertyParams, options ...RequestOption) (*Response, error)

RedfinProperty — 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 fields as one search result. Credit cost: 1 credit per call.

GET / POST /v2/redfin/property

func (*Client) RedfinSearch 

func (c *Client) RedfinSearch(ctx context.Context, params *RedfinSearchParams, options ...RequestOption) (*Response, error)

RedfinSearch — 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 endpoint. Credit cost: 1 credit per call.

GET / POST /v2/redfin/search

func (*Client) ReicheltProduct 

func (c *Client) ReicheltProduct(ctx context.Context, params *ReicheltProductParams, options ...RequestOption) (*Response, error)

ReicheltProduct — Reichelt Product. Read one reichelt.de product URL, including article number, EAN, and the euro price. Credit cost: 1 credit per call.

GET / POST /v2/reichelt/product

func (*Client) ReicheltSearch 

func (c *Client) ReicheltSearch(ctx context.Context, params *ReicheltSearchParams, options ...RequestOption) (*Response, error)

ReicheltSearch — Reichelt Search. Search reichelt.de by keyword or category. Euro prices are rebuilt from the number, including whole-euro amounts. Credit cost: 1 credit per call.

GET / POST /v2/reichelt/search

func (*Client) Request 

func (c *Client) Request(ctx context.Context, method, path string, params map[string]any, options ...RequestOption) (*Response, error)

Request sends any request, including endpoints released after this SDK version. GET parameters travel in the query string; POST parameters travel in a JSON body.

func (*Client) ReverbProduct 

func (c *Client) ReverbProduct(ctx context.Context, params *ReverbProductParams, options ...RequestOption) (*Response, error)

ReverbProduct — 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 browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/reverb/product

func (*Client) ReverbSearch 

func (c *Client) ReverbSearch(ctx context.Context, params *ReverbSearchParams, options ...RequestOption) (*Response, error)

ReverbSearch — Reverb Search. Reverb Search API: search music gear listings by keyword, query string or marketplace URL on Reverb. Returns prices, thumbnails and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/reverb/search

func (*Client) RexelProduct 

func (c *Client) RexelProduct(ctx context.Context, params *RexelProductParams, options ...RequestOption) (*Response, error)

RexelProduct — Rexel Product. Get a Rexel France product page: references, EAN, descriptions, images and specs via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/rexel/product

func (*Client) RexelSearch 

func (c *Client) RexelSearch(ctx context.Context, params *RexelSearchParams, options ...RequestOption) (*Response, error)

RexelSearch — Rexel Search. Search Rexel France by keyword, EAN or search URL. Returns product cards and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/rexel/search

func (*Client) RightmoveProperty 

func (c *Client) RightmoveProperty(ctx context.Context, params *RightmovePropertyParams, options ...RequestOption) (*Response, error)

RightmoveProperty — 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 agent. Credit cost: 2 credits per call.

GET / POST /v2/rightmove/property

func (*Client) RightmoveSearch 

func (c *Client) RightmoveSearch(ctx context.Context, params *RightmoveSearchParams, options ...RequestOption) (*Response, error)

RightmoveSearch — 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, the agent, and a property URL. Credit cost: 2 credits per call.

GET / POST /v2/rightmove/search

func (*Client) RsonlineProduct 

func (c *Client) RsonlineProduct(ctx context.Context, params *RsonlineProductParams, options ...RequestOption) (*Response, error)

RsonlineProduct — RS Online Product. Read one RS Online UK product URL, including the RS stock number, manufacturer part, and pound price. Credit cost: 2 credits per call.

GET / POST /v2/rsonline/product

func (*Client) RsonlineSearch 

func (c *Client) RsonlineSearch(ctx context.Context, params *RsonlineSearchParams, options ...RequestOption) (*Response, error)

RsonlineSearch — RS Online Search. Search RS Online UK by keyword or category. Pound prices keep the amount printed on the page. Credit cost: 2 credits per call.

GET / POST /v2/rsonline/search

func (*Client) SeekJob 

func (c *Client) SeekJob(ctx context.Context, params *SeekJobParams, options ...RequestOption) (*Response, error)

SeekJob — SEEK Job. Read one SEEK Australia job from its URL or numeric id. Credit cost: 2 credits per call.

GET / POST /v2/seek/job

func (*Client) SeekSearch 

func (c *Client) SeekSearch(ctx context.Context, params *SeekSearchParams, options ...RequestOption) (*Response, error)

SeekSearch — SEEK Search. Search SEEK Australia jobs by keyword or by a results URL. Credit cost: 2 credits per call.

GET / POST /v2/seek/search

func (*Client) SelogerAgency 

func (c *Client) SelogerAgency(ctx context.Context, params *SelogerAgencyParams, options ...RequestOption) (*Response, error)

SelogerAgency — SeLoger Agency. Retrieve detailed profile information for a SeLoger real estate agency including contact details, ratings, reviews, and address. Credit cost: 2 credits per call.

GET / POST /v2/seloger/agency

func (*Client) SelogerAgencyRent 

func (c *Client) SelogerAgencyRent(ctx context.Context, params *SelogerAgencyRentParams, options ...RequestOption) (*Response, error)

SelogerAgencyRent — SeLoger Agency Rent. Retrieve paginated rental property listings published by a specific SeLoger agency using its numeric agency ID. Credit cost: 2 credits per call.

GET / POST /v2/seloger/agency/rent

func (*Client) SelogerAgencySale 

func (c *Client) SelogerAgencySale(ctx context.Context, params *SelogerAgencySaleParams, options ...RequestOption) (*Response, error)

SelogerAgencySale — SeLoger Agency Sale. Retrieve paginated sale property listings published by a specific SeLoger agency using its numeric agency ID. Credit cost: 2 credits per call.

GET / POST /v2/seloger/agency/sale

func (*Client) SelogerProperty 

func (c *Client) SelogerProperty(ctx context.Context, params *SelogerPropertyParams, options ...RequestOption) (*Response, error)

SelogerProperty — SeLoger Property. Efficiently extract detailed data from a SeLoger real estate listing including agency info, pricing, photos, description, and property criteria. Credit cost: 2 credits per call.

GET / POST /v2/seloger/property

func (*Client) SelogerSearch 

func (c *Client) SelogerSearch(ctx context.Context, params *SelogerSearchParams, options ...RequestOption) (*Response, error)

SelogerSearch — SeLoger Search. Efficiently extract real estate listings from SeLoger search pages for market insights, property management, and investment analysis. Credit cost: 2 credits per call.

GET / POST /v2/seloger/search

func (*Client) SephoraProduct 

func (c *Client) SephoraProduct(ctx context.Context, params *SephoraProductParams, options ...RequestOption) (*Response, error)

SephoraProduct — Sephora Product. Read one European Sephora product by id or product URL. Set region when you are not on the French shop. Credit cost: 2 credits per call.

GET / POST /v2/sephora/product

func (*Client) SephoraSearch 

func (c *Client) SephoraSearch(ctx context.Context, params *SephoraSearchParams, options ...RequestOption) (*Response, error)

SephoraSearch — 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 page and is not included. Credit cost: 2 credits per call.

GET / POST /v2/sephora/search

func (*Client) ShophouzzProduct 

func (c *Client) ShophouzzProduct(ctx context.Context, params *ShophouzzProductParams, options ...RequestOption) (*Response, error)

ShophouzzProduct — Shophouzz Product. Retrieve full product details from Shophouzz, including title, price, variants, images, vendor, and structured metadata. Credit cost: 1 credit per call.

GET / POST /v2/shophouzz/product

func (*Client) ShopifyApps 

func (c *Client) ShopifyApps(ctx context.Context, params *ShopifyAppsParams, options ...RequestOption) (*Response, error)

ShopifyApps — Shopify Apps. Retrieve structured details about any Shopify App Store listing, including title, logo, screenshots, pricing plans, categories, and description. Credit cost: 1 credit per call.

GET / POST /v2/shopify/apps

func (*Client) ShopifyCatalog 

func (c *Client) ShopifyCatalog(ctx context.Context, params *ShopifyCatalogParams, options ...RequestOption) (*Response, error)

ShopifyCatalog — 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. Credit cost: 1 credit per call.

GET / POST /v2/shopify/catalog

func (*Client) ShopifyCollections 

func (c *Client) ShopifyCollections(ctx context.Context, params *ShopifyCollectionsParams, options ...RequestOption) (*Response, error)

ShopifyCollections — 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. Credit cost: 1 credit per call.

GET / POST /v2/shopify/collections

func (*Client) ShopifyProduct 

func (c *Client) ShopifyProduct(ctx context.Context, params *ShopifyProductParams, options ...RequestOption) (*Response, error)

ShopifyProduct — Shopify Product. Extract full product details from any Shopify store product page, including title, variants, pricing, images, inventory, and options. Credit cost: 1 credit per call.

GET / POST /v2/shopify/product

func (*Client) SimilarwebDomain 

func (c *Client) SimilarwebDomain(ctx context.Context, params *SimilarwebDomainParams, options ...RequestOption) (*Response, error)

SimilarwebDomain — SimilarWeb Domain. Retrieve website traffic and engagement metrics for a domain from the public Similarweb page, including visits, bounce rate, rank, keywords, and traffic sources. Credit cost: 2 credits per call.

GET / POST /v2/similarweb/domain

func (*Client) SimilarwebSearch 

func (c *Client) SimilarwebSearch(ctx context.Context, params *SimilarwebSearchParams, options ...RequestOption) (*Response, error)

SimilarwebSearch — Similarweb Search. Search the public Similarweb page for websites, companies, and mobile apps related to a keyword. Credit cost: 2 credits per call.

GET / POST /v2/similarweb/search

func (*Client) SnapedaProduct 

func (c *Client) SnapedaProduct(ctx context.Context, params *SnapedaProductParams, options ...RequestOption) (*Response, error)

SnapedaProduct — SnapEDA Product. SnapEDA Product API: fetch full part page data from a SnapEDA URL or MPN/manufacturer slug. Returns CAD models, datasheet, RoHS, distributor pricing and availability via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/snapeda/product

func (*Client) SnapedaSearch 

func (c *Client) SnapedaSearch(ctx context.Context, params *SnapedaSearchParams, options ...RequestOption) (*Response, error)

SnapedaSearch — SnapEDA Search. SnapEDA Search API: search electronic parts by keyword or URL on SnapMagic Search (ex-SnapEDA). Returns MPN, manufacturer, pricing, CAD availability and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/snapeda/search

func (*Client) StarbucksMenu 

func (c *Client) StarbucksMenu(ctx context.Context, params *StarbucksMenuParams, options ...RequestOption) (*Response, error)

StarbucksMenu — Starbucks Menu. Full Starbucks menu for one café, with the default-size price of each item. Prices use browser rendering. Credit cost: 3 credits per call.

GET / POST /v2/starbucks/menu

func (*Client) StarbucksProduct 

func (c *Client) StarbucksProduct(ctx context.Context, params *StarbucksProductParams, options ...RequestOption) (*Response, error)

StarbucksProduct — Starbucks Product. One Starbucks item at one café, with a price for every size. Get the café from Search first. Prices use browser rendering. Credit cost: 3 credits per call.

GET / POST /v2/starbucks/product

func (*Client) StarbucksSearch 

func (c *Client) StarbucksSearch(ctx context.Context, params *StarbucksSearchParams, options ...RequestOption) (*Response, error)

StarbucksSearch — 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 Product. Credit cost: 3 credits per call.

GET / POST /v2/starbucks/search

func (*Client) Stats 

func (c *Client) Stats(ctx context.Context, params *StatsParams, options ...RequestOption) (*Response, error)

Stats — Stats. Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant. Enabled per account: HTTP 403 means contact support to activate it.

GET /v2/stats

func (*Client) StockxProduct 

func (c *Client) StockxProduct(ctx context.Context, params *StockxProductParams, options ...RequestOption) (*Response, error)

StockxProduct — StockX Product. Retrieve detailed product information from StockX, including market prices, bid/ask data, size variants, and product metadata. Credit cost: 2 credits per call.

GET / POST /v2/stockx/product

func (*Client) StockxSearch 

func (c *Client) StockxSearch(ctx context.Context, params *StockxSearchParams, options ...RequestOption) (*Response, error)

StockxSearch — 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. Credit cost: 2 credits per call.

GET / POST /v2/stockx/search

func (*Client) StockxTrends 

func (c *Client) StockxTrends(ctx context.Context, params *StockxTrendsParams, options ...RequestOption) (*Response, error)

StockxTrends — StockX Trends. Retrieve trending products on StockX by category, with options to sort by featured, most active, or release date. Credit cost: 2 credits per call.

GET / POST /v2/stockx/trends

func (*Client) StubhubEvent 

func (c *Client) StubhubEvent(ctx context.Context, params *StubhubEventParams, options ...RequestOption) (*Response, error)

StubhubEvent — StubHub Event. Read one StubHub event from its URL or numeric id, including the lowest printed ticket price. Credit cost: 2 credits per call.

GET / POST /v2/stubhub/event

func (*Client) StubhubSearch 

func (c *Client) StubhubSearch(ctx context.Context, params *StubhubSearchParams, options ...RequestOption) (*Response, error)

StubhubSearch — StubHub Search. Search StubHub events by keyword or by a StubHub search URL. The response is the first embedded page. Credit cost: 1 credit per call.

GET / POST /v2/stubhub/search

func (*Client) TargetProduct 

func (c *Client) TargetProduct(ctx context.Context, params *TargetProductParams, options ...RequestOption) (*Response, error)

TargetProduct — Target Product. Get a Target.com product page: price, description, images and variations via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/target/product

func (*Client) TargetSearch 

func (c *Client) TargetSearch(ctx context.Context, params *TargetSearchParams, options ...RequestOption) (*Response, error)

TargetSearch — Target Search. Search Target.com by keyword or search URL. Returns product cards with price, rating and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/target/search

func (*Client) TdlrLicense 

func (c *Client) TdlrLicense(ctx context.Context, params *TdlrLicenseParams, options ...RequestOption) (*Response, error)

TdlrLicense — TDLR License. Fetch one TDLR license by detail id or SearchResultDetail URL, including status, subtype, DBA, and notes. Credit cost: 1 credit per call.

GET / POST /v2/tdlr/license

func (*Client) TdlrSearch 

func (c *Client) TdlrSearch(ctx context.Context, params *TdlrSearchParams, options ...RequestOption) (*Response, error)

TdlrSearch — TDLR License 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. Credit cost: 1 credit per call.

GET / POST /v2/tdlr/search

func (*Client) TedNotice 

func (c *Client) TedNotice(ctx context.Context, params *TedNoticeParams, options ...RequestOption) (*Response, error)

TedNotice — TED Notice. TED notice profile: buyer, lots, deadline, value and documents (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/ted/notice

func (*Client) TedSearch 

func (c *Client) TedSearch(ctx context.Context, params *TedSearchParams, options ...RequestOption) (*Response, error)

TedSearch — TED Search. Search TED procurement notices by keyword or filters. Returns notice cards and pagination (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/ted/search

func (*Client) ThaliaProduct 

func (c *Client) ThaliaProduct(ctx context.Context, params *ThaliaProductParams, options ...RequestOption) (*Response, error)

ThaliaProduct — Thalia Product. Read one Thalia product from its URL. You get price, author or brand, and the product details. Credit cost: 2 credits per call.

GET / POST /v2/thalia/product

func (*Client) ThaliaSearch 

func (c *Client) ThaliaSearch(ctx context.Context, params *ThaliaSearchParams, options ...RequestOption) (*Response, error)

ThaliaSearch — Thalia Search. Search Thalia by keyword and page books, media, and gifts. Cards include title, price, and the product link. Credit cost: 2 credits per call.

GET / POST /v2/thalia/search

func (*Client) TheforkRestaurant 

func (c *Client) TheforkRestaurant(ctx context.Context, params *TheforkRestaurantParams, options ...RequestOption) (*Response, error)

TheforkRestaurant — TheFork Restaurant. Extract a full TheFork restaurant profile from a restaurant page URL, including ratings, tags, photo gallery, opening hours, and AI review summaries via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/thefork/restaurant

func (*Client) TheforkSearch 

func (c *Client) TheforkSearch(ctx context.Context, params *TheforkSearchParams, options ...RequestOption) (*Response, error)

TheforkSearch — TheFork Search. Search TheFork restaurants from a full search or city URL and retrieve ratings, cuisine, prices, availability, review summaries, and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/thefork/search

func (*Client) ThomasnetCompany 

func (c *Client) ThomasnetCompany(ctx context.Context, params *ThomasnetCompanyParams, options ...RequestOption) (*Response, error)

ThomasnetCompany — Thomasnet Company. Get a full Thomasnet supplier profile from a company URL, including contact details, product categories, and business information. Credit cost: 3 credits per call.

GET / POST /v2/thomasnet/company

func (*Client) ThomasnetSearch 

func (c *Client) ThomasnetSearch(ctx context.Context, params *ThomasnetSearchParams, options ...RequestOption) (*Response, error)

ThomasnetSearch — Thomasnet Search. Search Thomasnet suppliers from a search or category URL and get company listings, filters, name suggestions, and pagination. Credit cost: 3 credits per call.

GET / POST /v2/thomasnet/search

func (*Client) TicketmasterEvent 

func (c *Client) TicketmasterEvent(ctx context.Context, params *TicketmasterEventParams, options ...RequestOption) (*Response, error)

TicketmasterEvent — 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. Credit cost: 1 credit per call.

GET / POST /v2/ticketmaster/event

func (*Client) TicketmasterSearch 

func (c *Client) TicketmasterSearch(ctx context.Context, params *TicketmasterSearchParams, options ...RequestOption) (*Response, error)

TicketmasterSearch — Ticketmaster Search. Search Ticketmaster events by keyword. Returns event cards, including Ticketweb partner rows, and pagination. Credit cost: 1 credit per call.

GET / POST /v2/ticketmaster/search

func (*Client) TiktoktopadsAd 

func (c *Client) TiktoktopadsAd(ctx context.Context, params *TiktoktopadsAdParams, options ...RequestOption) (*Response, error)

TiktoktopadsAd — TikTok Top Ads Ad. Get one TikTok Creative Center Top Ad by URL or id: creative, landing page, CTR, and engagement (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/tiktoktopads/ad

func (*Client) TiktoktopadsSearch 

func (c *Client) TiktoktopadsSearch(ctx context.Context, params *TiktoktopadsSearchParams, options ...RequestOption) (*Response, error)

TiktoktopadsSearch — TikTok Top Ads Search. Search TikTok Creative Center Top Ads by region, objective, period, and keyword. Returns ad cards and pagination (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/tiktoktopads/search

func (*Client) TradeaplaneListing 

func (c *Client) TradeaplaneListing(ctx context.Context, params *TradeaplaneListingParams, options ...RequestOption) (*Response, error)

TradeaplaneListing — Trade-A-Plane Listing. Read one Trade-A-Plane aircraft listing from its URL. You get the asking price, the airframe details, and the seller. Credit cost: 2 credits per call.

GET / POST /v2/tradeaplane/listing

func (*Client) TradeaplaneSearch 

func (c *Client) TradeaplaneSearch(ctx context.Context, params *TradeaplaneSearchParams, options ...RequestOption) (*Response, error)

TradeaplaneSearch — Trade-A-Plane Search. Search Trade-A-Plane aircraft listings by keyword and page the results. Cards include title, price, and the listing link. Credit cost: 2 credits per call.

GET / POST /v2/tradeaplane/search

func (*Client) TrustpilotCompanyInfo 

func (c *Client) TrustpilotCompanyInfo(ctx context.Context, params *TrustpilotCompanyInfoParams, options ...RequestOption) (*Response, error)

TrustpilotCompanyInfo — Trustpilot Company Info. Retrieve Trustpilot company profile data, including trust score, star rating, categories, contact info, and review response behavior. Credit cost: 1 credit per call.

GET / POST /v2/trustpilot/company/info

func (*Client) UntappdBeer 

func (c *Client) UntappdBeer(ctx context.Context, params *UntappdBeerParams, options ...RequestOption) (*Response, error)

UntappdBeer — Untappd Beer. Read one Untappd beer, including ABV, IBU, and brewery. Credit cost: 2 credits per call.

GET / POST /v2/untappd/beer

func (*Client) UntappdSearch 

func (c *Client) UntappdSearch(ctx context.Context, params *UntappdSearchParams, options ...RequestOption) (*Response, error)

UntappdSearch — Untappd Search. Search Untappd beers by keyword. Cards include brewery, ABV, and IBU. next is null when Untappd does not expose a next page. Credit cost: 2 credits per call.

GET / POST /v2/untappd/search

func (*Client) UpworkFreelancer 

func (c *Client) UpworkFreelancer(ctx context.Context, params *UpworkFreelancerParams, options ...RequestOption) (*Response, error)

UpworkFreelancer — Upwork Freelancer. Upwork Freelancer API: fetch public freelancer profile data from a profile ID, username or URL. Returns bio, hourly rate, skills, ratings and agency info via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/upwork/freelancer

func (*Client) UpworkJobs 

func (c *Client) UpworkJobs(ctx context.Context, params *UpworkJobsParams, options ...RequestOption) (*Response, error)

UpworkJobs — Upwork Jobs. Upwork Jobs API: search freelance job listings by skill slug or URL. Returns budgets, skills, experience level and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/upwork/jobs

func (*Client) UpworkServices 

func (c *Client) UpworkServices(ctx context.Context, params *UpworkServicesParams, options ...RequestOption) (*Response, error)

UpworkServices — Upwork Services. Upwork Services API: browse Project Catalog listings by category slug or URL. Returns prices, product IDs and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/upwork/services

func (*Client) UpworkServicesInfo 

func (c *Client) UpworkServicesInfo(ctx context.Context, params *UpworkServicesInfoParams, options ...RequestOption) (*Response, error)

UpworkServicesInfo — Upwork Services Info. Upwork Services Info API: fetch Project Catalog product details from a product URL. Returns packages, pricing, seller, media and breadcrumbs via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/upwork/services/info

func (*Client) Usage 

func (c *Client) Usage(ctx context.Context, options ...RequestOption) (*Response, error)

Usage — Usage. Retrieve real-time usage statistics and credit balance for your Piloterr account.

GET /v2/usage

func (*Client) UsaspendingAward 

func (c *Client) UsaspendingAward(ctx context.Context, params *UsaspendingAwardParams, options ...RequestOption) (*Response, error)

UsaspendingAward — 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. Credit cost: 1 credit per call.

GET / POST /v2/usaspending/award

func (*Client) UsaspendingSearch 

func (c *Client) UsaspendingSearch(ctx context.Context, params *UsaspendingSearchParams, options ...RequestOption) (*Response, error)

UsaspendingSearch — 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 display string. Credit cost: 1 credit per call.

GET / POST /v2/usaspending/search

func (*Client) VestiairecollectiveProduct 

func (c *Client) VestiairecollectiveProduct(ctx context.Context, params *VestiairecollectiveProductParams, options ...RequestOption) (*Response, error)

VestiairecollectiveProduct — Vestiaire Collective Product. Fetch one Vestiaire Collective listing by product URL. The response is a flat object with price, size, condition, and seller. Credit cost: 2 credits per call.

GET / POST /v2/vestiairecollective/product

func (*Client) VestiairecollectiveSearch 

func (c *Client) VestiairecollectiveSearch(ctx context.Context, params *VestiairecollectiveSearchParams, options ...RequestOption) (*Response, error)

VestiairecollectiveSearch — Vestiaire Collective Search. Search Vestiaire Collective by keyword or catalog URL. Each card has brand, name, price, size, and a product link. Credit cost: 2 credits per call.

GET / POST /v2/vestiairecollective/search

func (*Client) VintedItem 

func (c *Client) VintedItem(ctx context.Context, params *VintedItemParams, options ...RequestOption) (*Response, error)

VintedItem — 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 with photos, attributes, shipping, pricing, and optional seller profile. Credit cost: 1 credit per call.

GET / POST /v2/vinted/item

func (*Client) VintedSearch 

func (c *Client) VintedSearch(ctx context.Context, params *VintedSearchParams, options ...RequestOption) (*Response, error)

VintedSearch — Vinted Search. Search Vinted second-hand listings by keyword or catalog URL across vinted.fr, vinted.com and other domains. Returns results and pagination. Credit cost: 1 credit per call.

GET / POST /v2/vinted/search

func (*Client) VintedUserInfo 

func (c *Client) VintedUserInfo(ctx context.Context, params *VintedUserInfoParams, options ...RequestOption) (*Response, error)

VintedUserInfo — 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, followers, verification, bundle discounts, and listing counts. Credit cost: 1 credit per call.

GET / POST /v2/vinted/user/info

func (*Client) VivarealProperty 

func (c *Client) VivarealProperty(ctx context.Context, params *VivarealPropertyParams, options ...RequestOption) (*Response, error)

VivarealProperty — Viva Real 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. Credit cost: 1 credit per call.

GET / POST /v2/vivareal/property

func (*Client) VivarealSearch 

func (c *Client) VivarealSearch(ctx context.Context, params *VivarealSearchParams, options ...RequestOption) (*Response, error)

VivarealSearch — Viva Real Search. Search Viva Real by city and operation, sale or rent. Page with pagina. Development cards and 'from' prices are left out. Credit cost: 1 credit per call.

GET / POST /v2/vivareal/search

func (*Client) WaitForJob 

func (c *Client) WaitForJob(ctx context.Context, jobID string, options *WaitForJobOptions) (*Response, error)

WaitForJob polls GET /v1/jobs/{id} until the job reaches a terminal status and returns the last response.

func (*Client) WalmartProduct 

func (c *Client) WalmartProduct(ctx context.Context, params *WalmartProductParams, options ...RequestOption) (*Response, error)

WalmartProduct — Walmart Product. Extract full Walmart product page (PDP) data from a /ip/ URL: pricing, ratings, images, fulfillment, specs, badges, and availability via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/walmart/product

func (*Client) WalmartSearch 

func (c *Client) WalmartSearch(ctx context.Context, params *WalmartSearchParams, options ...RequestOption) (*Response, error)

WalmartSearch — Walmart Search. Scrape Walmart.com search result pages from a full URL and retrieve product cards with pricing, ratings, availability, and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/walmart/search

func (*Client) WalmartSuggest 

func (c *Client) WalmartSuggest(ctx context.Context, params *WalmartSuggestParams, options ...RequestOption) (*Response, error)

WalmartSuggest — Walmart Suggest. Get Walmart.com search autocomplete suggestions for a keyword via browser rendering, with optional US ZIP code localization. Credit cost: 2 credits per call.

GET / POST /v2/walmart/suggest

func (*Client) WebsiteAntibot 

func (c *Client) WebsiteAntibot(ctx context.Context, params *WebsiteAntibotParams, options ...RequestOption) (*Response, error)

WebsiteAntibot — Website Antibot. Detect which anti-bot protection protects a website before you scrape. Get the vendor, confidence level, and matching clues from a single URL check. Credit cost: 1 credit per call.

GET /v2/website/antibot

func (*Client) WebsiteCrawler 

func (c *Client) WebsiteCrawler(ctx context.Context, params *WebsiteCrawlerParams, options ...RequestOption) (*Response, error)

WebsiteCrawler — Website Crawler. Fetch public pages with fast HTTP crawling (no JavaScript). Best first choice for static or server-rendered HTML; use Rendering or WebUnlocker when JS or anti-bot blocks you. Credit cost: 1 credit per call.

GET / POST /v2/website/crawler

func (*Client) WebsiteEmailPhoneExtractor 

func (c *Client) WebsiteEmailPhoneExtractor(ctx context.Context, params *WebsiteEmailPhoneExtractorParams, options ...RequestOption) (*Response, error)

WebsiteEmailPhoneExtractor — Website Email Phone Extractor. Extract emails and phone numbers from websites for comprehensive contact details, including social media profiles across 12+ platforms. Credit cost: 1 credit per call.

GET / POST /v2/website/email_phone_extractor

func (*Client) WebsiteRendering 

func (c *Client) WebsiteRendering(ctx context.Context, params *WebsiteRenderingParams, options ...RequestOption) (*Response, error)

WebsiteRendering — Website Rendering. Render JavaScript-heavy pages in a headless browser and return post-render HTML. Use when Crawler returns empty DOM; escalate to WebUnlocker if bot protection blocks the session. Credit cost: 2 credits per call.

GET / POST /v2/website/rendering

func (*Client) WebsiteScreenshot 

func (c *Client) WebsiteScreenshot(ctx context.Context, params *WebsiteScreenshotParams, options ...RequestOption) (*Response, error)

WebsiteScreenshot — Website Screenshot. Browser-like Screenshot API that captures webpages as PNG/JPEG/WebP or PDF for previews, QA, reporting, monitoring, and archiving no headless setup. Credit cost: 2 credits per call.

GET / POST /v2/website/screenshot

func (*Client) WebsiteTechnology 

func (c *Client) WebsiteTechnology(ctx context.Context, params *WebsiteTechnologyParams, options ...RequestOption) (*Response, error)

WebsiteTechnology — Website Technology. Identify the technologies behind any website CMS, frameworks, analytics, CDN, hosting, and more, for competitive market analysis and technological insight. Credit cost: 1 credit per call.

GET / POST /v2/website/technology

func (*Client) WebsiteWebunlocker 

func (c *Client) WebsiteWebunlocker(ctx context.Context, params *WebsiteWebunlockerParams, options ...RequestOption) (*Response, error)

WebsiteWebunlocker — Website WebUnlocker. Bypass advanced anti-bot systems (Cloudflare, DataDome, Akamai, PerimeterX) on whitelisted domains. Combines browser rendering and unlock tooling; use after Crawler and Rendering fail. Credit cost: 3 credits per call.

GET / POST /v2/website/webunlocker

func (*Client) WeiboPostInfo 

func (c *Client) WeiboPostInfo(ctx context.Context, params *WeiboPostInfoParams, options ...RequestOption) (*Response, error)

WeiboPostInfo — Weibo Post Info. Retrieve one public Weibo post by post id, including text, images, publish time, engagement counts, and author profile. Credit cost: 2 credits per call.

GET / POST /v2/weibo/post/info

func (*Client) WeiboSearch 

func (c *Client) WeiboSearch(ctx context.Context, params *WeiboSearchParams, options ...RequestOption) (*Response, error)

WeiboSearch — Weibo Search. Search public Weibo posts by keywords. Each post includes the author, text, publish time, engagement counts, image, and video link. Credit cost: 2 credits per call.

GET / POST /v2/weibo/search

func (*Client) WelcometothejungleCompany 

func (c *Client) WelcometothejungleCompany(ctx context.Context, params *WelcometothejungleCompanyParams, options ...RequestOption) (*Response, error)

WelcometothejungleCompany — Welcome to the Jungle Company. Welcome to the Jungle company profile: headcount, offices, sectors and website (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/welcometothejungle/company

func (*Client) WelcometothejungleSearch 

func (c *Client) WelcometothejungleSearch(ctx context.Context, params *WelcometothejungleSearchParams, options ...RequestOption) (*Response, error)

WelcometothejungleSearch — Welcome to the Jungle Search. Search Welcome to the Jungle jobs. Returns offer cards and pagination (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/welcometothejungle/search

func (*Client) WellfoundCompanyInfo 

func (c *Client) WellfoundCompanyInfo(ctx context.Context, params *WellfoundCompanyInfoParams, options ...RequestOption) (*Response, error)

WellfoundCompanyInfo — Wellfound Company Info. Retrieve startup and company data from Wellfound (formerly AngelList), including description, funding, team size, hiring status, and social links. Credit cost: 1 credit per call.

GET / POST /v2/wellfound/company/info

func (*Client) XPostInfo 

func (c *Client) XPostInfo(ctx context.Context, params *XPostInfoParams, options ...RequestOption) (*Response, error)

XPostInfo — X Post Info (twitter). X Post Info API: fetch public tweet data (text, likes, retweets, views, media) from a status URL or tweet ID via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/x/post/info

func (*Client) XProfileInfo 

func (c *Client) XProfileInfo(ctx context.Context, params *XProfileInfoParams, options ...RequestOption) (*Response, error)

XProfileInfo — X Profile Info (twitter). X Profile Info API: fetch public X/Twitter profile data (bio, followers, verification, avatars) from a username or URL via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/x/profile/info

func (*Client) YahooSearch 

func (c *Client) YahooSearch(ctx context.Context, params *YahooSearchParams, options ...RequestOption) (*Response, error)

YahooSearch — Yahoo Search. Query Yahoo via API and retrieve structured organic results with country and language. Credit cost: 1 credit per call.

GET / POST /v2/yahoo/search

func (*Client) YellowpagesBusiness 

func (c *Client) YellowpagesBusiness(ctx context.Context, params *YellowpagesBusinessParams, options ...RequestOption) (*Response, error)

YellowpagesBusiness — Yellowpages Business. Extract a full Yellow Pages business profile from a listing URL, including phone, website, categories, and ratings via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/yellowpages/business

func (*Client) YellowpagesSearch 

func (c *Client) YellowpagesSearch(ctx context.Context, params *YellowpagesSearchParams, options ...RequestOption) (*Response, error)

YellowpagesSearch — Yellowpages Search. Search Yellow Pages businesses from a full search URL and retrieve names, phones, addresses, ratings, opening hours, and pagination via browser rendering. Credit cost: 2 credits per call.

GET / POST /v2/yellowpages/search

func (*Client) YelpBusiness 

func (c *Client) YelpBusiness(ctx context.Context, params *YelpBusinessParams, options ...RequestOption) (*Response, error)

YelpBusiness — Yelp Business. Fetch a Yelp business profile from a full business URL with phone, address, website, logo, hours, and claim status. Credit cost: 2 credits per call.

GET / POST /v2/yelp/business

func (*Client) YelpReviews 

func (c *Client) YelpReviews(ctx context.Context, params *YelpReviewsParams, options ...RequestOption) (*Response, error)

YelpReviews — Yelp Reviews. Fetch paginated Yelp reviews for a business with rating, text, author profile, reactions, and attached photos or videos. Credit cost: 2 credits per call.

GET / POST /v2/yelp/reviews

func (*Client) YelpSearch 

func (c *Client) YelpSearch(ctx context.Context, params *YelpSearchParams, options ...RequestOption) (*Response, error)

YelpSearch — Yelp Search. Search Yelp by keyword and location and retrieve paginated business cards with ratings, categories, photos, and sponsored flags. Credit cost: 2 credits per call.

GET / POST /v2/yelp/search

func (*Client) ZapimoveisAd 

func (c *Client) ZapimoveisAd(ctx context.Context, params *ZapimoveisAdParams, options ...RequestOption) (*Response, error)

ZapimoveisAd — Zap Imóveis Ad. Get a full Zap Imóveis listing by URL: price, IPTU, features, coordinates, images, and publisher (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/zapimoveis/ad

func (*Client) ZapimoveisSearch 

func (c *Client) ZapimoveisSearch(ctx context.Context, params *ZapimoveisSearchParams, options ...RequestOption) (*Response, error)

ZapimoveisSearch — Zap Imóveis Search. Search Zap Imóveis listings by city or search URL. Returns prices, IPTU, condominium fees, rooms, and pagination (1 credit). Credit cost: 1 credit per call.

GET / POST /v2/zapimoveis/search

func (*Client) ZazzleProduct 

func (c *Client) ZazzleProduct(ctx context.Context, params *ZazzleProductParams, options ...RequestOption) (*Response, error)

ZazzleProduct — Zazzle Product. Fetch one Zazzle product by its product URL or by a slug that ends in the numeric product id. Credit cost: 2 credits per call.

GET / POST /v2/zazzle/product

func (*Client) ZazzleSearch 

func (c *Client) ZazzleSearch(ctx context.Context, params *ZazzleSearchParams, options ...RequestOption) (*Response, error)

ZazzleSearch — Zazzle Search. Search Zazzle products by keyword. page maps to the pg parameter. Prices are a number plus a display string. Credit cost: 1 credit per call.

GET / POST /v2/zazzle/search

func (*Client) ZillowProperty 

func (c *Client) ZillowProperty(ctx context.Context, params *ZillowPropertyParams, options ...RequestOption) (*Response, error)

ZillowProperty — Zillow Property. Extract full property details from a Zillow homedetails URL, including specs, photos, schools, tax history, and agent attribution. Credit cost: 3 credits per call.

GET / POST /v2/zillow/property

func (*Client) ZillowSearch 

func (c *Client) ZillowSearch(ctx context.Context, params *ZillowSearchParams, options ...RequestOption) (*Response, error)

ZillowSearch — Zillow Search. Search Zillow listings from a search or map URL and retrieve prices, beds, baths, coordinates, and listing status. Credit cost: 3 credits per call.

GET / POST /v2/zillow/search

func (*Client) ZonapropProperty 

func (c *Client) ZonapropProperty(ctx context.Context, params *ZonapropPropertyParams, options ...RequestOption) (*Response, error)

ZonapropProperty — ZonaProp Property. Read one ZonaProp listing from its URL. You get the asking price in USD or ARS, the address, and the publisher. Credit cost: 2 credits per call.

GET / POST /v2/zonaprop/property

func (*Client) ZonapropSearch 

func (c *Client) ZonapropSearch(ctx context.Context, params *ZonapropSearchParams, options ...RequestOption) (*Response, error)

ZonapropSearch — ZonaProp Search. Search ZonaProp for apartments or houses in an Argentine city. Page with pagina. A few featured ads can repeat. Development projects priced 'from' are left out. Credit cost: 2 credits per call.

GET / POST /v2/zonaprop/search

func (*Client) ZooplaProperty 

func (c *Client) ZooplaProperty(ctx context.Context, params *ZooplaPropertyParams, options ...RequestOption) (*Response, error)

ZooplaProperty — Zoopla Property. Extract full property details from a Zoopla listing URL, including price, specs, photo gallery, EPC rating, coordinates, and agent data. Credit cost: 2 credits per call.

GET / POST /v2/zoopla/property

func (*Client) ZooplaSearch 

func (c *Client) ZooplaSearch(ctx context.Context, params *ZooplaSearchParams, options ...RequestOption) (*Response, error)

ZooplaSearch — Zoopla Search. Search Zoopla listings from a search URL and retrieve prices, specs, photos, agency info, and pagination. Credit cost: 2 credits per call.

GET / POST /v2/zoopla/search

func (*Client) ZooplusProduct 

func (c *Client) ZooplusProduct(ctx context.Context, params *ZooplusProductParams, options ...RequestOption) (*Response, error)

ZooplusProduct — Zooplus Product. Read one Zooplus product by id or URL, in the region of that shop. Variants keep their own price and EAN. Credit cost: 1 credit per call.

GET / POST /v2/zooplus/product

func (*Client) ZooplusSearch 

func (c *Client) ZooplusSearch(ctx context.Context, params *ZooplusSearchParams, options ...RequestOption) (*Response, error)

ZooplusSearch — Zooplus Search. Search a Zooplus country shop by keyword. Region defaults to France. Page through food, litter, and accessory cards with local prices. Credit cost: 1 credit per call.

GET / POST /v2/zooplus/search

func (*Client) ZoroProduct 

func (c *Client) ZoroProduct(ctx context.Context, params *ZoroProductParams, options ...RequestOption) (*Response, error)

ZoroProduct — Zoro Product. Get a Zoro product page: title, brand, USD price, Zoro number, manufacturer number, images, and specifications. Credit cost: 2 credits per call.

GET / POST /v2/zoro/product

func (*Client) ZoroSearch 

func (c *Client) ZoroSearch(ctx context.Context, params *ZoroSearchParams, options ...RequestOption) (*Response, error)

ZoroSearch — Zoro Search. Search Zoro by keyword or category URL. Returns product cards with USD price, brand, Zoro number, and pagination. Credit cost: 2 credits per call.

GET / POST /v2/zoro/search

type ClientOptions 

type ClientOptions struct {
	// BaseURL overrides DefaultBaseURL.
	BaseURL string
	// Timeout bounds each request. Zero uses DefaultTimeout; a negative value disables it.
	Timeout time.Duration
	// HTTPClient is copied and used for requests. Redirects are never followed.
	HTTPClient *http.Client
	// Headers are sent with every request.
	Headers map[string]string
	// MaxRetries overrides the number of retries. Zero uses MaxRetries; a negative value disables retries.
	MaxRetries int
	// RetryDelay is the delay before the first retry. Zero uses DefaultRetryDelay.
	RetryDelay time.Duration
}

ClientOptions configures a Client. The zero value is valid.

type CompanyParams 

type CompanyParams struct {
	// The domain name of the company to look up. Accepts multiple formats:
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CompanyParams holds the parameters of Company (GET / POST /v2/company). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ConfigurationError 

type ConfigurationError struct {
	Message string
	Err     error
}

ConfigurationError reports a missing or unusable client configuration.

func (*ConfigurationError) Error 

func (e *ConfigurationError) Error() string

func (*ConfigurationError) Unwrap 

func (e *ConfigurationError) Unwrap() error

type CoolblueProductParams 

type CoolblueProductParams struct {
	// Product link, or the article number.
	Query string `json:"query" api:"query,required"`
	// Shop for a bare article number.
	Region *string `json:"region" api:"region"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CoolblueProductParams holds the parameters of CoolblueProduct (GET / POST /v2/coolblue/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CoolblueSearchParams 

type CoolblueSearchParams struct {
	// Search words, or a Coolblue listing link.
	Query string `json:"query" api:"query,required"`
	// Page number, from 1.
	Page *float64 `json:"page" api:"page"`
	// Shop, when query is words rather than a full link.
	Region *string `json:"region" api:"region"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CoolblueSearchParams holds the parameters of CoolblueSearch (GET / POST /v2/coolblue/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CopartLotParams 

type CopartLotParams struct {
	// Copart lot number or full lot URL.
	Query string `json:"query" api:"query,required"`
	// Regional Copart site when query is a lot number only. Defaults to US.
	Region *string `json:"region" api:"region"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CopartLotParams holds the parameters of CopartLot (GET / POST /v2/copart/lot). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CopartSearchParams 

type CopartSearchParams struct {
	// Search keyword or full Copart search URL.
	Query string `json:"query" api:"query,required"`
	// Copart regional site when query is a keyword or lot number only. Defaults to US.
	Region *string `json:"region" api:"region"`
	// Page number (default: 1).
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CopartSearchParams holds the parameters of CopartSearch (GET / POST /v2/copart/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CostcoProductParams 

type CostcoProductParams struct {
	// Costco product ID or full product URL.
	Query string `json:"query" api:"query,required"`
	// Regional Costco site. Accepts a region code (us, fr, ca, uk, …) or full host (www.costco.fr). Defaults to US (www.costco.com) when omitted.
	Region *string `json:"region" api:"region"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CostcoProductParams holds the parameters of CostcoProduct (GET / POST /v2/costco/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CostcoSearchParams 

type CostcoSearchParams struct {
	// Search keyword or full regional search URL.
	Query string `json:"query" api:"query,required"`
	// Regional Costco site. Accepts a region code (us, fr, ca, uk, …) or full host (www.costco.fr). Defaults to US (www.costco.com) when omitted.
	Region *string `json:"region" api:"region"`
	// 1-based page number override. Uses currentPage (most regions) or page (UK) when rebuilding pagination URLs.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CostcoSearchParams holds the parameters of CostcoSearch (GET / POST /v2/costco/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CrunchbaseCompanyInfoParams 

type CrunchbaseCompanyInfoParams struct {
	// Search for a company by its name, permalink, or full Crunchbase URL.
	Query *string `json:"query" api:"query"`
	// Perform a reverse lookup by domain name to find the associated Crunchbase company profile.
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CrunchbaseCompanyInfoParams holds the parameters of CrunchbaseCompanyInfo (GET / POST /v2/crunchbase/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CrunchbaseEventParams 

type CrunchbaseEventParams struct {
	// Retrieve event data using its Crunchbase permalink or full URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CrunchbaseEventParams holds the parameters of CrunchbaseEvent (GET / POST /v2/crunchbase/event). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CrunchbaseFundingRoundParams 

type CrunchbaseFundingRoundParams struct {
	// The permalink of the specific funding round to retrieve. This is the unique identifier found in the Crunchbase funding round URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CrunchbaseFundingRoundParams holds the parameters of CrunchbaseFundingRound (GET / POST /v2/crunchbase/funding_round). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CrunchbaseFundingRoundsParams 

type CrunchbaseFundingRoundsParams struct {
	// Filter funding rounds announced within the last N days. Default: 1.
	DaysSinceAnnouncement *float64 `json:"days_since_announcement" api:"days_since_announcement"`
	// Filter by funding round type. Accepted values:
	InvestmentType *string `json:"investment_type" api:"investment_type"`
	// Filter rounds by a specific investor using their Crunchbase UUID.
	InvestorIdentifiers *string `json:"investor_identifiers" api:"investor_identifiers"`
	// Filter rounds by a specific funded organization using their Crunchbase UUID.
	FundedOrganizationIdentifier *string `json:"funded_organization_identifier" api:"funded_organization_identifier"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CrunchbaseFundingRoundsParams holds the parameters of CrunchbaseFundingRounds (GET / POST /v2/crunchbase/funding_rounds). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CrunchbasePeopleInfoParams 

type CrunchbasePeopleInfoParams struct {
	// Search for a person by their name, Crunchbase permalink, or full Crunchbase profile URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CrunchbasePeopleInfoParams holds the parameters of CrunchbasePeopleInfo (GET / POST /v2/crunchbase/people/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CrunchbaseSearchParams 

type CrunchbaseSearchParams struct {
	// The search keyword or phrase to query across Crunchbase. Searches both organizations and people.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CrunchbaseSearchParams holds the parameters of CrunchbaseSearch (GET / POST /v2/crunchbase/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CulturaProductParams 

type CulturaProductParams struct {
	// Link of the Cultura product page.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CulturaProductParams holds the parameters of CulturaProduct (GET / POST /v2/cultura/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type CulturaSearchParams 

type CulturaSearchParams struct {
	// Words to search for on Cultura, or the search page link.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. For example, 2 returns the next page of results.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

CulturaSearchParams holds the parameters of CulturaSearch (GET / POST /v2/cultura/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DartyProductParams 

type DartyProductParams struct {
	// Product URL on www.darty.com. The path is under /nav/achat/ and ends in .html.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DartyProductParams holds the parameters of DartyProduct (GET / POST /v2/darty/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DartySearchParams 

type DartySearchParams struct {
	// Keyword or a Darty search URL on www.darty.com.
	Query string `json:"query" api:"query,required"`
	// 1-based page number. Defaults to 1. Page 2 returns the next 30 products.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DartySearchParams holds the parameters of DartySearch (GET / POST /v2/darty/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DatasetsLinkedinCompanyParams 

type DatasetsLinkedinCompanyParams struct {
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DatasetsLinkedinCompanyParams holds the parameters of DatasetsLinkedinCompany (POST /v2/datasets/linkedin/company). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DecathlonProductParams 

type DecathlonProductParams struct {
	// Product link, a /p/... or /products/... path, or a keyword. A keyword opens the first search hit. A search link returns 400.
	Query string `json:"query" api:"query,required"`
	// Country shop when query is a keyword or a path. Default is fr. A full product link picks the shop. Default: "fr".
	Region *string `json:"region" api:"region"`
	// Set to true to get the raw page body in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DecathlonProductParams holds the parameters of DecathlonProduct (GET / POST /v2/decathlon/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DecathlonSearchParams 

type DecathlonSearchParams struct {
	// Keyword, or a Decathlon search link.
	Query string `json:"query" api:"query,required"`
	// Country shop. Default is fr. A full link in query picks the shop, and a conflicting region returns 400. Default: "fr".
	Region *string `json:"region" api:"region"`
	// Page number starting at 1.
	Page *float64 `json:"page" api:"page"`
	// Set to true to get the raw HTML in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DecathlonSearchParams holds the parameters of DecathlonSearch (GET / POST /v2/decathlon/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DigikeyProductParams 

type DigikeyProductParams struct {
	// Full DigiKey product detail URL, or relative path.
	Query string `json:"query" api:"query,required"`
	// DigiKey country TLD when query is a relative path.
	Region *string `json:"region" api:"region"`
	// When true, return rendered HTML as {"result": "..."} instead of JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DigikeyProductParams holds the parameters of DigikeyProduct (GET / POST /v2/digikey/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DigikeySearchParams 

type DigikeySearchParams struct {
	// Keyword, DigiKey result/filter URL, or relative path.
	Query string `json:"query" api:"query,required"`
	// DigiKey country TLD when query is not a full URL.
	Region *string `json:"region" api:"region"`
	// When true, return rendered HTML as {"result": "..."} instead of JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DigikeySearchParams holds the parameters of DigikeySearch (GET / POST /v2/digikey/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DoajArticleParams 

type DoajArticleParams struct {
	// Required. Article id or a doaj.org/article URL. Example: 000004687a3a411cb466625281f2ceb0.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DoajArticleParams holds the parameters of DoajArticle (GET / POST /v2/doaj/article). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DoajJournalParams 

type DoajJournalParams struct {
	// Required. Journal ISSN, journal id, or a doaj.org/toc URL. Example: 2747-173X.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DoajJournalParams holds the parameters of DoajJournal (GET / POST /v2/doaj/journal). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DoajSearchParams 

type DoajSearchParams struct {
	// Required. Keyword or a doaj.org search URL. Example: climate. An article or journal URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Optional. article or journal. Example: journal. Defaults to article. Default: "article".
	Kind *string `json:"kind" api:"kind"`
	// Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 records.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DoajSearchParams holds the parameters of DoajSearch (GET / POST /v2/doaj/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DomainDnsblParams 

type DomainDnsblParams struct {
	// A domain name or IP address to check against DNS-based blacklists (DNSBL).
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DomainDnsblParams holds the parameters of DomainDnsbl (GET / POST /v2/domain/dnsbl). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DomainMaliciousParams 

type DomainMaliciousParams struct {
	// A domain name or IP address to check for malicious activity across multiple threat intelligence sources.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DomainMaliciousParams holds the parameters of DomainMalicious (GET / POST /v2/domain/malicious). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DomainWhoisParams 

type DomainWhoisParams struct {
	// A domain name for which you want to retrieve WHOIS registration information.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DomainWhoisParams holds the parameters of DomainWhois (GET / POST /v2/domain/whois). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DomaincomauPropertyParams 

type DomaincomauPropertyParams struct {
	// Domain listing URL. The path ends with the listing id.
	Query string `json:"query" api:"query,required"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DomaincomauPropertyParams holds the parameters of DomaincomauProperty (GET / POST /v2/domaincomau/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DomaincomauSearchParams 

type DomaincomauSearchParams struct {
	// Suburb with state and postcode, a location slug, or a Domain search URL.
	Query string `json:"query" api:"query,required"`
	// sale, rent, or sold when query is a place. Default: "sale".
	Mode *string `json:"mode" api:"mode"`
	// Page from 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DomaincomauSearchParams holds the parameters of DomaincomauSearch (GET / POST /v2/domaincomau/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type DuckduckgoSearchParams 

type DuckduckgoSearchParams struct {
	// Search query sent to DuckDuckGo Search.
	Query string `json:"query" api:"query,required"`
	// Page number. Page 1 is the first page of results. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Country code, for example us, fr, gb, de, jp.
	Gl *string `json:"gl" api:"gl"`
	// Language code, for example en, fr, de, ja, zh.
	Hl *string `json:"hl" api:"hl"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

DuckduckgoSearchParams holds the parameters of DuckduckgoSearch (GET / POST /v2/duckduckgo/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EbayProductParams 

type EbayProductParams struct {
	// Item id, or an item URL on a supported eBay site.
	Query string `json:"query" api:"query,required"`
	// When true, return raw HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EbayProductParams holds the parameters of EbayProduct (GET / POST /v2/ebay/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EbaySearchParams 

type EbaySearchParams struct {
	// Keyword on www.ebay.com, or a search URL on a supported eBay site.
	Query string `json:"query" api:"query,required"`
	// Page number, sent as _pgn. Default 1 for a keyword. On a URL, the page already in the URL is kept when this is empty. Below 1 returns 400.
	Page *float64 `json:"page" api:"page"`
	// When true, return raw HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EbaySearchParams holds the parameters of EbaySearch (GET / POST /v2/ebay/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ElcorteinglesProductParams 

type ElcorteinglesProductParams struct {
	// Product URL or product id (A… / MP_…).
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ElcorteinglesProductParams holds the parameters of ElcorteinglesProduct (GET / POST /v2/elcorteingles/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ElcorteinglesSearchParams 

type ElcorteinglesSearchParams struct {
	// Search keyword or full El Corte Inglés search URL.
	Query string `json:"query" api:"query,required"`
	// 1-based page number. Overrides /search-nwx/{page}/ when present in the URL (default: from URL or 1).
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ElcorteinglesSearchParams holds the parameters of ElcorteinglesSearch (GET / POST /v2/elcorteingles/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EleclercProductParams 

type EleclercProductParams struct {
	// E.Leclerc product EAN or product page URL.
	Query string `json:"query" api:"query,required"`
	// E.Leclerc store sign code. This selects that store's price and stock.
	StoreID *string `json:"store_id" api:"store_id"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EleclercProductParams holds the parameters of EleclercProduct (GET / POST /v2/eleclerc/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EleclercSearchParams 

type EleclercSearchParams struct {
	// Search keyword or phrase to query on E.Leclerc.
	Query string `json:"query" api:"query,required"`
	// ID of a specific E.Leclerc store to search in.
	StoreID *string `json:"store_id" api:"store_id"`
	// Page number for paginated results. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EleclercSearchParams holds the parameters of EleclercSearch (GET / POST /v2/eleclerc/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EleclercSuggestParams 

type EleclercSuggestParams struct {
	// Search term or EAN to get product suggestions for.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EleclercSuggestParams holds the parameters of EleclercSuggest (GET / POST /v2/eleclerc/suggest). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EmailAnalyzesParams 

type EmailAnalyzesParams struct {
	// The domain name you want to analyze for email infrastructure.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EmailAnalyzesParams holds the parameters of EmailAnalyzes (GET / POST /v2/email/analyzes). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EmailFinderParams 

type EmailFinderParams struct {
	// Full name of the person whose professional email address you want to find.
	Query string `json:"query" api:"query,required"`
	// The company's domain name. Multiple formats are accepted:
	CompanyDomain *string `json:"company_domain" api:"company_domain"`
	// The company name of the person you are looking for.
	CompanyName *string `json:"company_name" api:"company_name"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EmailFinderParams holds the parameters of EmailFinder (GET / POST /v2/email/finder). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EmailVerifyParams 

type EmailVerifyParams struct {
	// The email address you want to verify.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EmailVerifyParams holds the parameters of EmailVerify (GET / POST /v2/email/verify). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EuropagesCompanyParams 

type EuropagesCompanyParams struct {
	// Profile URL copied from a search card, or a slug.
	Query string `json:"query" api:"query,required"`
	// Site when query is a slug. Same values as search. Default fr. Ignored when query is a URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EuropagesCompanyParams holds the parameters of EuropagesCompany (GET / POST /v2/europages/company). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EuropagesSearchParams 

type EuropagesSearchParams struct {
	// Keyword, or a category / search URL on Europages.
	Query string `json:"query" api:"query,required"`
	// Site of a keyword: fr (default), de, co.uk (en, uk, gb), es, it, nl, and the other Europages TLDs. Ignored when query is a URL. German uses /suche/. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Page from 1. Page 2 and after use /pg-N/. 30 companies per page.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EuropagesSearchParams holds the parameters of EuropagesSearch (GET / POST /v2/europages/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EventbriteEventParams 

type EventbriteEventParams struct {
	// Event detail URL or numeric id.
	Query string `json:"query" api:"query,required"`
	// Country TLD when query is a bare id (fr, com, es, com.mx, …). Ignored if query is a full URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EventbriteEventParams holds the parameters of EventbriteEvent (GET / POST /v2/eventbrite/event). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type EventbriteSearchParams 

type EventbriteSearchParams struct {
	// Keyword, or paste a full Eventbrite city / category / search URL.
	Query *string `json:"query" api:"query"`
	// Eventbrite TLD when query is a keyword (fr, com, es, com.mx, co.uk, …). Ignored if query is a full URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Location slug such as france--paris (keyword searches only).
	Location *string `json:"location" api:"location"`
	// Page number.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

EventbriteSearchParams holds the parameters of EventbriteSearch (GET / POST /v2/eventbrite/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ExpediaAdParams 

type ExpediaAdParams struct {
	// An Expedia hotel information URL. The response is one flat hotel. hotel_id comes from .h{id}.Hotel-Information when that pattern is in the URL, and is null otherwise. A destination, a non-Expedia URL, or an empty value returns 400.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ExpediaAdParams holds the parameters of ExpediaAd (GET / POST /v2/expedia/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ExpediaFlightParams 

type ExpediaFlightParams struct {
	// A route or a full Expedia Flights-Search URL. Empty, a route without two airport codes, or a non-Expedia URL returns 400. A full URL is opened as given. price stays the label on the offer. pagination.next is null.
	Query string `json:"query" api:"query,required"`
	// Departure as YYYY-MM-DD for a route. Omit it and the route uses 2026-11-15. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.
	DepartureDate *string `json:"departure_date" api:"departure_date"`
	// Return date as YYYY-MM-DD. Omit it for a one-way trip. A value that is not YYYY-MM-DD returns 400. Ignored when query is a full URL.
	ReturnDate *string `json:"return_date" api:"return_date"`
	// Adult passengers for a route. Omit it and the request uses 1. Ignored when query is a full URL.
	Adults *float64 `json:"adults" api:"adults"`
	// Label copied onto every result as cabin_class. Omit it and each result uses economy. It does not add a cabin filter to the Expedia URL.
	CabinClass *string `json:"cabin_class" api:"cabin_class"`
	// Host for a route. Omit it for www.expedia.com. Allowed: us, ca, uk, au, fr, de, es, it, nl, mx. Any other value returns 400. Ignored when query is a full URL.
	Region *string `json:"region" api:"region"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ExpediaFlightParams holds the parameters of ExpediaFlight (GET / POST /v2/expedia/flight). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ExpediaSearchParams 

type ExpediaSearchParams struct {
	// A valid Expedia hotel search URL. Copy the URL directly from your Expedia search results page.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ExpediaSearchParams holds the parameters of ExpediaSearch (GET / POST /v2/expedia/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FashionphileProductParams 

type FashionphileProductParams struct {
	// Product handle or a fashionphile.com product URL. The request reads products/{handle}.js and returns one flat product. price is the USD amount and price_display is that amount rebuilt as a dollar string.
	Query string `json:"query" api:"query,required"`
	// Default false. true replaces the product object with result, the raw Shopify JSON text.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FashionphileProductParams holds the parameters of FashionphileProduct (GET / POST /v2/fashionphile/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FashionphileSearchParams 

type FashionphileSearchParams struct {
	// Keywords, a Fashionphile search URL, a collection URL, or a products.json URL. Empty returns 400.
	Query string `json:"query" api:"query,required"`
	// Page number starting at 1. Omit it for page 1.
	Page *float64 `json:"page" api:"page"`
	// Default false. true replaces results and pagination with result, the raw Shopify JSON text.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FashionphileSearchParams holds the parameters of FashionphileSearch (GET / POST /v2/fashionphile/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderChewyProductsParams 

type FinderChewyProductsParams struct {
	// Free-text search across product titles and IDs. Optional if at least one filter is provided.
	Search *string `json:"search" api:"search"`
	// Legacy alias of search. Kept for backward compatibility.
	Query *string `json:"query" api:"query"`
	// Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.
	ID *string `json:"id" api:"id"`
	// Filter by website domain. Comma-separated values are accepted.
	Domain *string `json:"domain" api:"domain"`
	// Raw filter expression for advanced filtering. Combined with the shorthand filters using AND.
	Filter *string `json:"filter" api:"filter"`
	// Maximum number of results to return. Default is 10, maximum is 100. Default: 10.
	Limit *float64 `json:"limit" api:"limit"`
	// Number of results to skip for pagination. Default is 0. Default: 0.
	Offset *float64 `json:"offset" api:"offset"`
	// Sort the results. Provide one or several attributes with :asc or :desc, comma-separated.
	Sort *string `json:"sort" api:"sort"`
	// Comma-separated list of fields to return. Defaults to all fields.
	Fields *string `json:"fields" api:"fields"`
	// When true, the response is wrapped in an object containing the total estimated count plus the hits: { count, hits }. When false or omitted, returns the raw hits array. Default: false.
	Count *bool `json:"count" api:"count"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderChewyProductsParams holds the parameters of FinderChewyProducts (GET / POST /v2/finder/chewy-products). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderEleclercStoresParams 

type FinderEleclercStoresParams struct {
	// Filters stores based on a search string. The search is non-case-sensitive and returns all stores whose names contain the specified string.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderEleclercStoresParams holds the parameters of FinderEleclercStores (GET / POST /v2/finder/eleclerc-stores). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderGoogleCountriesParams 

type FinderGoogleCountriesParams struct {
	// Filters countries based on a search string. The search is non-case-sensitive and returns all countries whose names contain the specified string.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderGoogleCountriesParams holds the parameters of FinderGoogleCountries (GET / POST /v2/finder/google-countries). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderGoogleLanguagesParams 

type FinderGoogleLanguagesParams struct {
	// Filters languages based on a search string. The search is non-case-sensitive and returns all languages whose names contain the specified string.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderGoogleLanguagesParams holds the parameters of FinderGoogleLanguages (GET / POST /v2/finder/google-languages). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderGoogleLocationsParams 

type FinderGoogleLocationsParams struct {
	// Restricts your search to locations that contain the supplied string.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderGoogleLocationsParams holds the parameters of FinderGoogleLocations (GET / POST /v2/finder/google-locations). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderLeroymerlinProductsParams 

type FinderLeroymerlinProductsParams struct {
	// Free-text search across product titles and IDs. Optional if at least one filter is provided.
	Search *string `json:"search" api:"search"`
	// Legacy alias of search. Kept for backward compatibility.
	Query *string `json:"query" api:"query"`
	// Filter by one or several internal product IDs. Provide a comma-separated list to match multiple IDs.
	ID *string `json:"id" api:"id"`
	// Filter by website domain. Comma-separated values are accepted.
	Domain *string `json:"domain" api:"domain"`
	// Raw filter expression for advanced filtering. Combined with the shorthand filters using AND.
	Filter *string `json:"filter" api:"filter"`
	// Maximum number of results to return. Default is 10, maximum is 100. Default: 10.
	Limit *float64 `json:"limit" api:"limit"`
	// Number of results to skip for pagination. Default is 0. Default: 0.
	Offset *float64 `json:"offset" api:"offset"`
	// Sort the results. Provide one or several attributes with :asc or :desc, comma-separated.
	Sort *string `json:"sort" api:"sort"`
	// Comma-separated list of fields to return. Defaults to all fields.
	Fields *string `json:"fields" api:"fields"`
	// When true, the response is wrapped in an object containing the total estimated count plus the hits: { count, hits }. When false or omitted, returns the raw hits array. Default: false.
	Count *bool `json:"count" api:"count"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderLeroymerlinProductsParams holds the parameters of FinderLeroymerlinProducts (GET / POST /v2/finder/leroymerlin-products). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderLeroymerlinStoresParams 

type FinderLeroymerlinStoresParams struct {
	// Filters Leroy Merlin stores based on a search string. The search is non-case-sensitive and matches store names, cities, postal codes and store slugs.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderLeroymerlinStoresParams holds the parameters of FinderLeroymerlinStores (GET / POST /v2/finder/leroymerlin-stores). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderLinkedinIndustriesParams 

type FinderLinkedinIndustriesParams struct {
	// Restricts your search to industries that contain the supplied string.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderLinkedinIndustriesParams holds the parameters of FinderLinkedinIndustries (GET / POST /v2/finder/linkedin-industries). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FinderMrbricolageStoresParams 

type FinderMrbricolageStoresParams struct {
	// Filters Mr.Bricolage stores based on a search string. The search is non-case-sensitive and matches store names, cities and postal codes.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FinderMrbricolageStoresParams holds the parameters of FinderMrbricolageStores (GET / POST /v2/finder/mrbricolage-stores). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FiverrProfileInfoParams 

type FiverrProfileInfoParams struct {
	// Fiverr profile URL of the seller you want to extract information from.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FiverrProfileInfoParams holds the parameters of FiverrProfileInfo (GET / POST /v2/fiverr/profile/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FiverrSearchParams 

type FiverrSearchParams struct {
	// A Fiverr search URL for gigs.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FiverrSearchParams holds the parameters of FiverrSearch (GET / POST /v2/fiverr/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FnacProductParams 

type FnacProductParams struct {
	// Product URL (/a{id} or /mp{id}) or the numeric Fnac id. A keyword or a search URL returns 400.
	Query string `json:"query" api:"query,required"`
	// When true, returns the raw HTML instead of the parsed JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FnacProductParams holds the parameters of FnacProduct (GET / POST /v2/fnac/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FnacSearchParams 

type FnacSearchParams struct {
	// Keyword or a Fnac SearchResult URL. A product URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Page number, from 1. Default is 1. Page 2 is sent as PageIndex=2.
	Page *float64 `json:"page" api:"page"`
	// When true, returns the raw HTML instead of the parsed JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FnacSearchParams holds the parameters of FnacSearch (GET / POST /v2/fnac/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FotocasaAdParams 

type FotocasaAdParams struct {
	// Full Fotocasa ad URL (/comprar/ or /alquiler/, ending with /d).
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FotocasaAdParams holds the parameters of FotocasaAd (GET / POST /v2/fotocasa/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FotocasaSearchParams 

type FotocasaSearchParams struct {
	// City name or full Fotocasa search URL.
	Query string `json:"query" api:"query,required"`
	// Used when query is a city name (ignored for full URLs). Default: "buy".
	Operation *string `json:"operation" api:"operation"`
	// Page number (1-based). Default: 1. Page 2 maps to /l/2. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FotocasaSearchParams holds the parameters of FotocasaSearch (GET / POST /v2/fotocasa/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FranchisedirectFranchiseParams 

type FranchisedirectFranchiseParams struct {
	// Required. A Franchise Direct profile URL from search, or the same path beginning with /. A keyword or a listing URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FranchisedirectFranchiseParams holds the parameters of FranchisedirectFranchise (GET / POST /v2/franchisedirect/franchise). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FranchisedirectSearchParams 

type FranchisedirectSearchParams struct {
	// Required. A keyword, or a Franchise Direct listing URL (search, directory, or category). A profile URL such as /coffee-franchises/coffeenow returns 400 on this endpoint. Send that URL to /v2/franchisedirect/franchise.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FranchisedirectSearchParams holds the parameters of FranchisedirectSearch (GET / POST /v2/franchisedirect/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FressnapfProductParams 

type FressnapfProductParams struct {
	// Product URL on www.fressnapf.de.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML. The string false stays false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FressnapfProductParams holds the parameters of FressnapfProduct (GET / POST /v2/fressnapf/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FressnapfSearchParams 

type FressnapfSearchParams struct {
	// Keyword or a fressnapf.de search or category URL.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Example: 2.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML. The string false stays false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FressnapfSearchParams holds the parameters of FressnapfSearch (GET / POST /v2/fressnapf/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FundaPropertyParams 

type FundaPropertyParams struct {
	// Listing URL on www.funda.nl, under /detail/koop or /detail/huur.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FundaPropertyParams holds the parameters of FundaProperty (GET / POST /v2/funda/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type FundaSearchParams 

type FundaSearchParams struct {
	// City, area, or a Funda search URL.
	Query string `json:"query" api:"query,required"`
	// Sale or rent when query is a place.
	Offering *string `json:"offering" api:"offering"`
	// Page from 1. Example: 2. Funda receives this as search_result=2. Page 1 and page 2 return different listings.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

FundaSearchParams holds the parameters of FundaSearch (GET / POST /v2/funda/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type G2ProductInfoParams 

type G2ProductInfoParams struct {
	// Product slug or a www.g2.com product URL.
	Query string `json:"query" api:"query,required"`
	// Keep reviews of one star rating, from 1 to 5. Omit it to read the unfiltered reviews page.
	NpsScore *float64 `json:"nps_score" api:"nps_score"`
	// Return the rendered HTML instead of the parsed product.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

G2ProductInfoParams holds the parameters of G2ProductInfo (GET / POST /v2/g2/product/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GithubUserInfoParams 

type GithubUserInfoParams struct {
	// A GitHub user identifier. Multiple formats are accepted:
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GithubUserInfoParams holds the parameters of GithubUserInfo (GET / POST /v2/github/user/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GlassdoorCompanyInfoParams 

type GlassdoorCompanyInfoParams struct {
	// Company URL or employer id.\n\nExample:\n\n 1692882
	Query string `json:"query" api:"query,required"`
	// Glassdoor TLD when query is not a full URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GlassdoorCompanyInfoParams holds the parameters of GlassdoorCompanyInfo (GET / POST /v2/glassdoor/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GlassdoorCompanySearchParams 

type GlassdoorCompanySearchParams struct {
	// Employer keyword, or a full Glassdoor autocomplete URL.\n\nExample:\n\n airbus
	Query string `json:"query" api:"query,required"`
	// Glassdoor TLD (fr, com, co.uk, …). Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GlassdoorCompanySearchParams holds the parameters of GlassdoorCompanySearch (GET / POST /v2/glassdoor/company/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GlassdoorJobInfoParams 

type GlassdoorJobInfoParams struct {
	// Job listing URL or jl id.\n\nExample:\n\n 1010283388161
	Query string `json:"query" api:"query,required"`
	// Glassdoor TLD when query is not a full URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GlassdoorJobInfoParams holds the parameters of GlassdoorJobInfo (GET / POST /v2/glassdoor/job/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GlassdoorJobSearchParams 

type GlassdoorJobSearchParams struct {
	// Keyword or full Glassdoor job search URL.
	Query string `json:"query" api:"query,required"`
	// Glassdoor TLD when query is not a full URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Page number.
	Page *float64 `json:"page" api:"page"`
	// Glassdoor sortBy value (e.g. date_desc).
	SortBy *string `json:"sort_by" api:"sort_by"`
	// When true, set remoteWorkType=1.
	Remote *bool `json:"remote" api:"remote"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GlassdoorJobSearchParams holds the parameters of GlassdoorJobSearch (GET / POST /v2/glassdoor/job/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoodreadsBookParams 

type GoodreadsBookParams struct {
	// Required. The numeric Goodreads book id from search, or a /book/show/ URL. A title is not accepted.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoodreadsBookParams holds the parameters of GoodreadsBook (GET / POST /v2/goodreads/book). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoodreadsSearchParams 

type GoodreadsSearchParams struct {
	// Required. A book keyword, or a Goodreads search URL (the path contains /search or the query contains q=).
	Query string `json:"query" api:"query,required"`
	// Optional. Page number, starting at 1. Omitted or blank uses page 1. A value below 1 returns 400. When query is already a Goodreads search URL, this number replaces the page parameter in that URL. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoodreadsSearchParams holds the parameters of GoodreadsSearch (GET / POST /v2/goodreads/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleImagesParams 

type GoogleImagesParams struct {
	// The image search query to execute on Google Images.
	Query string `json:"query" api:"query,required"`
	// Google domain to use for the search. Defaults to google.com. Default: "google.com".
	GoogleDomain *string `json:"google_domain" api:"google_domain"`
	// Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).
	Cr *string `json:"cr" api:"cr"`
	// Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).
	Lr *string `json:"lr" api:"lr"`
	// Page number for pagination. Images are returned in batches of 100 per page. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Adult content filter. active enables Google SafeSearch; off disables it. Omit to use Google default.
	Safe *string `json:"safe" api:"safe"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleImagesParams holds the parameters of GoogleImages (GET / POST /v2/google/images). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleJobsParams 

type GoogleJobsParams struct {
	// Job search term or keyword for querying Google job listings.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleJobsParams holds the parameters of GoogleJobs (GET / POST /v2/google/jobs). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleMapsParams 

type GoogleMapsParams struct {
	// Business name or keyword to search for relevant data.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleMapsParams holds the parameters of GoogleMaps (GET / POST /v2/google/maps). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleNewsParams 

type GoogleNewsParams struct {
	// The news search query to execute on Google News. Supports standard Google search operators.
	Query string `json:"query" api:"query,required"`
	// City or region from which the news search should originate. Simulates a search performed from the specified location.
	Location *string `json:"location" api:"location"`
	// Google-encoded location string for precise geographic targeting. Use this instead of location when you need exact control.
	Uule *string `json:"uule" api:"uule"`
	// Google domain to use for the search. Defaults to google.com. Default: "google.com".
	GoogleDomain *string `json:"google_domain" api:"google_domain"`
	// Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).
	Cr *string `json:"cr" api:"cr"`
	// Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).
	Lr *string `json:"lr" api:"lr"`
	// Page number of news results to retrieve. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Maximum number of results to return per page. Default: 10.
	Num *float64 `json:"num" api:"num"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleNewsParams holds the parameters of GoogleNews (GET / POST /v2/google/news). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleSearchAIParams 

type GoogleSearchAIParams struct {
	// The question or search query to send to Google AI Mode. Natural-language questions work best; advanced operators are also accepted.
	Query string `json:"query" api:"query,required"`
	// City or region from which the AI Mode search should originate. Simulates a real user searching from that location.
	Location *string `json:"location" api:"location"`
	// Google-encoded location string for precise geographic targeting. Mutually exclusive with location.
	Uule *string `json:"uule" api:"uule"`
	// Google domain to use for the search. Defaults to google.com. Default: "google.com".
	GoogleDomain *string `json:"google_domain" api:"google_domain"`
	// Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).
	Cr *string `json:"cr" api:"cr"`
	// Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).
	Lr *string `json:"lr" api:"lr"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleSearchAIParams holds the parameters of GoogleSearchAI (GET / POST /v2/google/search/ai). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleSearchAutocompleteParams 

type GoogleSearchAutocompleteParams struct {
	// The partial or complete search query for which you want to retrieve autocomplete suggestions from Google.
	Query string `json:"query" api:"query,required"`
	// Cursor position in the query string where autocomplete suggestions should be generated. Determines which part of the query is being completed. Default: 0.
	Cp *float64 `json:"cp" api:"cp"`
	// Google domain to use for the search. Defaults to google.com. Default: "google.com".
	GoogleDomain *string `json:"google_domain" api:"google_domain"`
	// Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).
	Cr *string `json:"cr" api:"cr"`
	// Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).
	Lr *string `json:"lr" api:"lr"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleSearchAutocompleteParams holds the parameters of GoogleSearchAutocomplete (GET / POST /v2/google/search/autocomplete). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleSearchParams 

type GoogleSearchParams struct {
	// The search query to execute on Google. Supports all standard Google search operators.
	Query string `json:"query" api:"query,required"`
	// Advanced time-range and filter string for Google Search. Used to restrict results by recency.
	Tbs *string `json:"tbs" api:"tbs"`
	// City or region from which the search should originate. Simulates a real user's search from the specified location.
	Location *string `json:"location" api:"location"`
	// Google-encoded location string for precise geographic targeting.
	Uule *string `json:"uule" api:"uule"`
	// Google domain to use for the search. Defaults to google.com. Default: "google.com".
	GoogleDomain *string `json:"google_domain" api:"google_domain"`
	// Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).
	Cr *string `json:"cr" api:"cr"`
	// Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).
	Lr *string `json:"lr" api:"lr"`
	// Page number of search results to retrieve. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Maximum number of results to return per page (e.g. 10, 40, 100). Default: 10.
	Num *float64 `json:"num" api:"num"`
	// Adult content filter. active enables Google SafeSearch; off disables it. Omit to use Google default.
	Safe *string `json:"safe" api:"safe"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleSearchParams holds the parameters of GoogleSearch (GET / POST /v2/google/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleShoppingParams 

type GoogleShoppingParams struct {
	// Product search query on Google Shopping. Use a product name, brand, or category.
	Query string `json:"query" api:"query,required"`
	// Page number of Shopping results. Each page returns about 20 products. There is no num parameter. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// City or region used to localize Shopping results. Simulates a search from that location and generates the UULE parameter automatically.
	Location *string `json:"location" api:"location"`
	// Google-encoded location string (UULE) for precise geo-targeting. Use location instead if you do not already have an encoded value.
	Uule *string `json:"uule" api:"uule"`
	// Google domain to use for the search. Defaults to google.com. Default: "google.com".
	GoogleDomain *string `json:"google_domain" api:"google_domain"`
	// Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).
	Cr *string `json:"cr" api:"cr"`
	// Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).
	Lr *string `json:"lr" api:"lr"`
	// Adult content filter. active enables Google SafeSearch; off disables it. Omit to use Google default.
	Safe *string `json:"safe" api:"safe"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleShoppingParams holds the parameters of GoogleShopping (GET / POST /v2/google/shopping). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleVideosParams 

type GoogleVideosParams struct {
	// The video search query to execute on Google Videos. Supports standard Google search operators.
	Query string `json:"query" api:"query,required"`
	// City or region from which the video search should originate.
	Location *string `json:"location" api:"location"`
	// Google-encoded location string for precise geographic targeting.
	Uule *string `json:"uule" api:"uule"`
	// Google domain to use for the search. Defaults to google.com. Default: "google.com".
	GoogleDomain *string `json:"google_domain" api:"google_domain"`
	// Country to use for the Google search. Two-letter country code (e.g. us for the United States, uk for United Kingdom, or fr for France). Default: "us".
	Gl *string `json:"gl" api:"gl"`
	// Language to use for the Google search. Two or three-letter language code (e.g. en, es, fr), optionally followed by a region code (e.g. en-gb, es-419). Default: "en".
	Hl *string `json:"hl" api:"hl"`
	// Limit results to one or more countries. Use country{XX} with | as delimiter (e.g. countryFR|countryDE).
	Cr *string `json:"cr" api:"cr"`
	// Limit results to one or more languages. Use lang_{xx} with | as delimiter (e.g. lang_fr|lang_de).
	Lr *string `json:"lr" api:"lr"`
	// Page number of video results to retrieve. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Maximum number of video results to return per page. Default: 10.
	Num *float64 `json:"num" api:"num"`
	// Adult content filter. active enables Google SafeSearch; off disables it. Omit to use Google default.
	Safe *string `json:"safe" api:"safe"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleVideosParams holds the parameters of GoogleVideos (GET / POST /v2/google/videos). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleadstransparencyAdParams 

type GoogleadstransparencyAdParams struct {
	// Creative URL from search.
	Query string `json:"query" api:"query,required"`
	// ISO alpha-2. The matching region is returned first.
	Region *string `json:"region" api:"region"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleadstransparencyAdParams holds the parameters of GoogleadstransparencyAd (GET / POST /v2/googleadstransparency/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GoogleadstransparencySearchParams 

type GoogleadstransparencySearchParams struct {
	// Domain name, advertiser name, advertiser id, or a full Ads Transparency URL.
	Query string `json:"query" api:"query,required"`
	// Country. ISO alpha-2 (FR), anywhere, or a Transparency region code (2250 for France, 250 is also accepted).
	Region *string `json:"region" api:"region"`
	// Domain filter. Used when query is not already a domain.
	Domain *string `json:"domain" api:"domain"`
	// Advertiser id, AR followed by digits.
	AdvertiserID *string `json:"advertiser_id" api:"advertiser_id"`
	// Creative format.
	Format *string `json:"format" api:"format"`
	// Comma-separated surfaces.
	Platform *string `json:"platform" api:"platform"`
	// Relative window.
	PresetDate *string `json:"preset_date" api:"preset_date"`
	// Inclusive start date, YYYY-MM-DD or YYYYMMDD.
	StartDate *string `json:"start_date" api:"start_date"`
	// Inclusive end date, YYYY-MM-DD or YYYYMMDD. A single day uses the same value as start_date.
	EndDate *string `json:"end_date" api:"end_date"`
	// Ad topic. Default: commercial. Default: "commercial".
	Topic *string `json:"topic" api:"topic"`
	// Page number, from 1 to 20. Default: 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Page size, from 1 to 100. Default: 40. Default: 40.
	PerPage *float64 `json:"per_page" api:"per_page"`
	// Opaque cursor copied from pagination.next.
	Cursor *string `json:"cursor" api:"cursor"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GoogleadstransparencySearchParams holds the parameters of GoogleadstransparencySearch (GET / POST /v2/googleadstransparency/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GraingerProductParams 

type GraingerProductParams struct {
	// SKU, full Grainger product URL, or relative /product/... path.
	Query string `json:"query" api:"query,required"`
	// Grainger country when query is not a full URL (default: com).
	Region *string `json:"region" api:"region"`
	// When true, return rendered HTML as {"result": "..."} instead of JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GraingerProductParams holds the parameters of GraingerProduct (GET / POST /v2/grainger/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GraingerSearchParams 

type GraingerSearchParams struct {
	// Keyword, full Grainger search/category URL, category path, or SKU.
	Query string `json:"query" api:"query,required"`
	// Grainger country when query is not a full URL (default: com).
	Region *string `json:"region" api:"region"`
	// When true, return rendered HTML as {"result": "..."} instead of JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GraingerSearchParams holds the parameters of GraingerSearch (GET / POST /v2/grainger/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GreenhouseJobParams 

type GreenhouseJobParams struct {
	// Required. board/id or a job URL. Example: discord/8806482002 or https://job-boards.greenhouse.io/discord/jobs/8806482002.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GreenhouseJobParams holds the parameters of GreenhouseJob (GET / POST /v2/greenhouse/job). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GreenhouseSearchParams 

type GreenhouseSearchParams struct {
	// Required. Board token or a job-boards.greenhouse.io board URL. Example: discord. A job URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Optional. Case-insensitive filter on title and location. Example: policy. Omit it to list the whole board.
	Keyword *string `json:"keyword" api:"keyword"`
	// Optional. Page number from 1. Example: 2. Defaults to 1. Page size is 20.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GreenhouseSearchParams holds the parameters of GreenhouseSearch (GET / POST /v2/greenhouse/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GsaelibraryContractParams 

type GsaelibraryContractParams struct {
	// Required. The contractorInfo.do URL from a search contract row. A contract number is also accepted, but GS-07F-0239T alone currently returns 404 because GSA needs the contractor name that search includes in the URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GsaelibraryContractParams holds the parameters of GsaelibraryContract (GET / POST /v2/gsaelibrary/contract). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type GsaelibrarySearchParams 

type GsaelibrarySearchParams struct {
	// Required. A keyword, or a full search URL on gsaelibrary.gsa.gov. The URL must contain searchResults.do or searchText=.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

GsaelibrarySearchParams holds the parameters of GsaelibrarySearch (GET / POST /v2/gsaelibrary/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type HomestraAdParams 

type HomestraAdParams struct {
	// A Homestra property URL or slug.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

HomestraAdParams holds the parameters of HomestraAd (GET / POST /v2/homestra/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type HomestraSearchParams 

type HomestraSearchParams struct {
	// A valid Homestra search URL with optional filters.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

HomestraSearchParams holds the parameters of HomestraSearch (GET / POST /v2/homestra/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type HuggingfaceModelParams 

type HuggingfaceModelParams struct {
	// Required. A public model id (owner/name) or a huggingface.co model URL. Reserved site paths such as models, datasets, or spaces return 400.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

HuggingfaceModelParams holds the parameters of HuggingfaceModel (GET / POST /v2/huggingface/model). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type HuggingfaceSearchParams 

type HuggingfaceSearchParams struct {
	// Required. A model keyword, a huggingface.co/models URL, or the full pagination.next cursor URL from a previous page.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

HuggingfaceSearchParams holds the parameters of HuggingfaceSearch (GET / POST /v2/huggingface/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IdealistaPropertyParams 

type IdealistaPropertyParams struct {
	// Full Idealista property detail URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IdealistaPropertyParams holds the parameters of IdealistaProperty (GET / POST /v2/idealista/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IdealistaProvincesParams 

type IdealistaProvincesParams struct {
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IdealistaProvincesParams holds the parameters of IdealistaProvinces (GET / POST /v2/idealista/provinces). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IdealistaSearchParams 

type IdealistaSearchParams struct {
	// Full Idealista search results URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IdealistaSearchParams holds the parameters of IdealistaSearch (GET / POST /v2/idealista/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IdealoProductParams 

type IdealoProductParams struct {
	// Full Idealo product URL, or a numeric product id.
	Query string `json:"query" api:"query,required"`
	// Region when query is a numeric product id.
	Country *string `json:"country" api:"country"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IdealoProductParams holds the parameters of IdealoProduct (GET / POST /v2/idealo/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IdealoSearchParams 

type IdealoSearchParams struct {
	// Keyword or full Idealo search URL for Spain, France, or Germany.
	Query string `json:"query" api:"query,required"`
	// Region when query is a keyword.
	Country *string `json:"country" api:"country"`
	// Search page. 2 appends ?page=2.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IdealoSearchParams holds the parameters of IdealoSearch (GET / POST /v2/idealo/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IkeaProductParams 

type IkeaProductParams struct {
	// Full IKEA product page URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IkeaProductParams holds the parameters of IkeaProduct (GET / POST /v2/ikea/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IkeaSearchParams 

type IkeaSearchParams struct {
	// Full IKEA search URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IkeaSearchParams holds the parameters of IkeaSearch (GET / POST /v2/ikea/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type Immobilienscout24PropertyParams 

type Immobilienscout24PropertyParams struct {
	// The expose id, or the expose page URL. Default: "168052908".
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML in result instead of the parsed expose.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

Immobilienscout24PropertyParams holds the parameters of Immobilienscout24Property (GET / POST /v2/immobilienscout24/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type Immobilienscout24SearchParams 

type Immobilienscout24SearchParams struct {
	// Where to search. Default: "berlin/berlin".
	Query string `json:"query" api:"query,required"`
	// Rent or buy.
	RealEstateType *string `json:"real_estate_type" api:"real_estate_type"`
	// Page number, starting at 1.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML in result instead of the parsed JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

Immobilienscout24SearchParams holds the parameters of Immobilienscout24Search (GET / POST /v2/immobilienscout24/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type Immoscout24chSearchParams 

type Immoscout24chSearchParams struct {
	// Swiss city or a full ImmoScout24.ch search URL.
	Query string `json:"query" api:"query,required"`
	// rent or buy.
	OfferType *string `json:"offer_type" api:"offer_type"`
	// apartment, house, or all.
	PropertyType *string `json:"property_type" api:"property_type"`
	// Page from 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

Immoscout24chSearchParams holds the parameters of Immoscout24chSearch (GET / POST /v2/immoscout24ch/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ImmoweltPropertyParams 

type ImmoweltPropertyParams struct {
	// Full Immowelt property detail URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ImmoweltPropertyParams holds the parameters of ImmoweltProperty (GET / POST /v2/immowelt/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ImmoweltSearchParams 

type ImmoweltSearchParams struct {
	// Full Immowelt search URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ImmoweltSearchParams holds the parameters of ImmoweltSearch (GET / POST /v2/immowelt/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ImoveiswebPropertyParams 

type ImoveiswebPropertyParams struct {
	// Listing URL from search.
	Query string `json:"query" api:"query,required"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ImoveiswebPropertyParams holds the parameters of ImoveiswebProperty (GET / POST /v2/imoveisweb/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ImoveiswebSearchParams 

type ImoveiswebSearchParams struct {
	// Catalog name or an ImoveisWeb results URL. This is Imobiliária Aquários, not ZonaProp.
	Query string `json:"query" api:"query,required"`
	// Optional catalog when query is not already a catalog name.
	PropertyType *string `json:"property_type" api:"property_type"`
	// Page from 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ImoveiswebSearchParams holds the parameters of ImoveiswebSearch (GET / POST /v2/imoveisweb/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IndeedCompanyInfoParams 

type IndeedCompanyInfoParams struct {
	// Indeed company slug or full /cmp/ URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IndeedCompanyInfoParams holds the parameters of IndeedCompanyInfo (GET / POST /v2/indeed/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IndeedCompanySearchParams 

type IndeedCompanySearchParams struct {
	// Company keyword or full Indeed companies search URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IndeedCompanySearchParams holds the parameters of IndeedCompanySearch (GET / POST /v2/indeed/company/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IndeedJobInfoParams 

type IndeedJobInfoParams struct {
	// Indeed job URL, sponsored SERP click URL or 16-char jk job key.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IndeedJobInfoParams holds the parameters of IndeedJobInfo (GET / POST /v2/indeed/job/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IndeedJobSalaryParams 

type IndeedJobSalaryParams struct {
	// Career salary slug, full /career/.../salaries URL or slug|location pair.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IndeedJobSalaryParams holds the parameters of IndeedJobSalary (GET / POST /v2/indeed/job/salary). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IndeedJobSearchParams 

type IndeedJobSearchParams struct {
	// Keyword, Indeed /jobs URL or SEO search URL on fr.indeed.com (default domain).
	Query string `json:"query" api:"query,required"`
	// 1-based page number (10 results per page). Default: 1.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML as {\"result\": \"...\"} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IndeedJobSearchParams holds the parameters of IndeedJobSearch (GET / POST /v2/indeed/job/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type InetProductParams 

type InetProductParams struct {
	// Article number or product URL. Example: 4306287. A search link returns 400.
	Query string `json:"query" api:"query,required"`
	// Set to true to get the raw HTML in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

InetProductParams holds the parameters of InetProduct (GET / POST /v2/inet/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type InetSearchParams 

type InetSearchParams struct {
	// What to look for. A word such as ssd, or an Inet search or category link. A product link returns 400.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Page 2 uses page=2.
	Page *float64 `json:"page" api:"page"`
	// Set to true to get the raw HTML in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

InetSearchParams holds the parameters of InetSearch (GET / POST /v2/inet/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type InstagramPostInfoParams 

type InstagramPostInfoParams struct {
	// The Instagram post or reel to retrieve. Accepts a full URL or a shortcode.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

InstagramPostInfoParams holds the parameters of InstagramPostInfo (GET / POST /v2/instagram/post/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type InstagramUserInfoParams 

type InstagramUserInfoParams struct {
	// The Instagram user to look up. Accepts a full profile URL or a username.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

InstagramUserInfoParams holds the parameters of InstagramUserInfo (GET / POST /v2/instagram/user/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IntermarcheProductParams 

type IntermarcheProductParams struct {
	// Full Intermarché product URL, or an EAN barcode.
	Query string `json:"query" api:"query,required"`
	// Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example query=Paris).
	ShopID string `json:"shop_id" api:"shop_id,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IntermarcheProductParams holds the parameters of IntermarcheProduct (GET / POST /v2/intermarche/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IntermarcheSearchParams 

type IntermarcheSearchParams struct {
	// Search keyword or full Intermarché search URL.
	Query string `json:"query" api:"query,required"`
	// Intermarché store id. Resolve a city with the [Stores Finder](https://www.piloterr.com/library/finder-intermarche-stores) (for example query=Paris).
	ShopID string `json:"shop_id" api:"shop_id,required"`
	// Page number starting at 1. Use pagination.total_pages from a previous response to iterate.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IntermarcheSearchParams holds the parameters of IntermarcheSearch (GET / POST /v2/intermarche/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IntersportProductParams 

type IntersportProductParams struct {
	// Product URL on intersport.fr, or a root-relative path ending in -p-{id}.
	Query string `json:"query" api:"query,required"`
	// When true, returns the raw HTML instead of the parsed JSON. The response shape is {"result": "<html>..."}. Default false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IntersportProductParams holds the parameters of IntersportProduct (GET / POST /v2/intersport/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type IntersportSearchParams 

type IntersportSearchParams struct {
	// Keyword or an intersport.fr listing URL. A product URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Page number, from 1. Default is 1. Intersport's page query is zero-based, so page 2 is sent as page=1.
	Page *float64 `json:"page" api:"page"`
	// When true, returns the raw HTML instead of the parsed JSON. The response shape is {"result": "<html>..."}. Default false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

IntersportSearchParams holds the parameters of IntersportSearch (GET / POST /v2/intersport/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type JameseditionPropertyParams 

type JameseditionPropertyParams struct {
	// Required. JamesEdition listing URL, for example https://www.jamesedition.com/real_estate/munich-germany/alpine-panorama-above-lake-starnberg-new-build-project-near-munich-17793477. A keyword is rejected.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

JameseditionPropertyParams holds the parameters of JameseditionProperty (GET / POST /v2/jamesedition/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type JameseditionSearchParams 

type JameseditionSearchParams struct {
	// Required. Keyword, for example villa, or a JamesEdition results URL such as https://www.jamesedition.com/real_estate/france. A single listing URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

JameseditionSearchParams holds the parameters of JameseditionSearch (GET / POST /v2/jamesedition/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type JobTimeoutError 

type JobTimeoutError struct {
	JobID        string
	LastResponse *Response
}

JobTimeoutError reports an async job that did not finish before the deadline.

func (*JobTimeoutError) Error 

func (e *JobTimeoutError) Error() string

type JobsParams 

type JobsParams struct {
	// The job_id returned by an endpoint called with is_async=true.
	ID string `json:"id" api:"id,required"`
}

JobsParams holds the parameters of Jobs (GET /v1/jobs/{id}). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type KickUserInfoParams 

type KickUserInfoParams struct {
	// The Kick channel to look up. Accepts a full channel URL or a username/slug.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

KickUserInfoParams holds the parameters of KickUserInfo (GET / POST /v2/kick/user/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type KijijiAdParams 

type KijijiAdParams struct {
	// Full Kijiji listing URL or the numeric listing id.
	Query string `json:"query" api:"query,required"`
	// Locale sent to Kijiji as the siteLocale cookie. en sets en-CA and prints $20. fr sets fr-CA and prints 20 $ on the same ad. Default: "en".
	Language *string `json:"language" api:"language"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

KijijiAdParams holds the parameters of KijijiAd (GET / POST /v2/kijiji/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type KijijiSearchParams 

type KijijiSearchParams struct {
	// Keyword or full Kijiji results URL.
	Query string `json:"query" api:"query,required"`
	// Results page, starting at 1. Page 2 of the City of Toronto bikes search returns a different set of listing ids. When page stays at 1, a page-N segment already present in the URL is kept.
	Page *float64 `json:"page" api:"page"`
	// Locale sent to Kijiji as the siteLocale cookie. en sets en-CA. fr sets fr-CA. French cards print prices like 10,00 $. Default: "en".
	Language *string `json:"language" api:"language"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

KijijiSearchParams holds the parameters of KijijiSearch (GET / POST /v2/kijiji/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type KrogerProductParams 

type KrogerProductParams struct {
	// Kroger product URL or UPC.
	Query string `json:"query" api:"query,required"`
	// Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced.
	LocationID *string `json:"location_id" api:"location_id"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

KrogerProductParams holds the parameters of KrogerProduct (GET / POST /v2/kroger/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type KrogerSearchParams 

type KrogerSearchParams struct {
	// Keyword or a full Kroger search URL.
	Query string `json:"query" api:"query,required"`
	// Page number, 1-based.
	Page *float64 `json:"page" api:"page"`
	// Ignored. Prices stay on the default Rolla store, 02100537 (Kroger, 605 W 4th St, Rolla, MO 65401). The response location_id is the store that was actually priced.
	LocationID *string `json:"location_id" api:"location_id"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

KrogerSearchParams holds the parameters of KrogerSearch (GET / POST /v2/kroger/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LamudiAdParams 

type LamudiAdParams struct {
	// Full Lamudi listing URL. Accepts lamudi.com.ph (/property/) and lamudi.co.id (/properti/).
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LamudiAdParams holds the parameters of LamudiAd (GET / POST /v2/lamudi/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LamudiSearchParams 

type LamudiSearchParams struct {
	// Full Lamudi search URL. Used first when set. Location and path filters are ignored.
	Query *string `json:"query" api:"query"`
	// City or district. Used when query is empty. Builds a Philippines URL (lamudi.com.ph). For Indonesia, pass a search URL in query.
	Location *string `json:"location" api:"location"`
	// Transaction type. Used when query is empty. Default: "sale".
	Operation *string `json:"operation" api:"operation"`
	// Property type. Used when query is empty. Maps to Lamudi slugs (condominium → /condo/, land → /lot/).
	PropertyType *string `json:"property_type" api:"property_type"`
	// Minimum asking price in PHP or IDR.
	MinPrice *float64 `json:"min_price" api:"min_price"`
	// Maximum asking price in PHP or IDR.
	MaxPrice *float64 `json:"max_price" api:"max_price"`
	// Minimum bedroom count.
	MinBedrooms *float64 `json:"min_bedrooms" api:"min_bedrooms"`
	// Maximum bedroom count.
	MaxBedrooms *float64 `json:"max_bedrooms" api:"max_bedrooms"`
	// Minimum bathroom count.
	MinBathrooms *float64 `json:"min_bathrooms" api:"min_bathrooms"`
	// Minimum area in m².
	MinArea *float64 `json:"min_area" api:"min_area"`
	// Maximum area in m².
	MaxArea *float64 `json:"max_area" api:"max_area"`
	// Sort order. Default: "relevance".
	Sort *string `json:"sort" api:"sort"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LamudiSearchParams holds the parameters of LamudiSearch (GET / POST /v2/lamudi/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LeboncoinAdParams 

type LeboncoinAdParams struct {
	// Leboncoin ad ID or full ad URL. Both formats are accepted regardless of return_page_source.
	Query string `json:"query" api:"query,required"`
	// Controls the response format. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LeboncoinAdParams holds the parameters of LeboncoinAd (GET / POST /v2/leboncoin/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LeboncoinSearchAPIParams 

type LeboncoinSearchAPIParams struct {
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LeboncoinSearchAPIParams holds the parameters of LeboncoinSearchAPI (POST /v2/leboncoin/search_api). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LeboncoinSearchParams 

type LeboncoinSearchParams struct {
	// Full Leboncoin search or category URL. Both keyword searches and category browse URLs are supported.
	Query string `json:"query" api:"query,required"`
	// Deprecated. Sending true returns 400. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LeboncoinSearchParams holds the parameters of LeboncoinSearch (GET / POST /v2/leboncoin/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LenovoProductParams 

type LenovoProductParams struct {
	// Full Lenovo product URL (must contain /p/). Bare part numbers are rejected.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LenovoProductParams holds the parameters of LenovoProduct (GET / POST /v2/lenovo/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LenovoSearchParams 

type LenovoSearchParams struct {
	// Keyword or full Lenovo search / category URL.
	Query string `json:"query" api:"query,required"`
	// Store locale when query is a keyword (ignored for full URLs). Default: "fr/fr".
	Locale *string `json:"locale" api:"locale"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LenovoSearchParams holds the parameters of LenovoSearch (GET / POST /v2/lenovo/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LeroymerlinProductParams 

type LeroymerlinProductParams struct {
	// Full Leroy Merlin product URL, or an identifier (SKU / EAN / text).
	Query string `json:"query" api:"query,required"`
	// Leroy Merlin country when query is a keyword or identifier (default: fr). Ignored when query is a full Leroy Merlin URL (country is detected from the domain).
	Region *string `json:"region" api:"region"`
	// Optional store id for local offer context (prices, stock, deliveries). Must exist for the active region. Returns 400 when unknown.
	StoreID *string `json:"store_id" api:"store_id"`
	// When set to true, returns the raw HTML of the product page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is {"return": "<html>..."}. Defaults to false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LeroymerlinProductParams holds the parameters of LeroymerlinProduct (GET / POST /v2/leroymerlin/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LeroymerlinSearchParams 

type LeroymerlinSearchParams struct {
	// Search keyword, SKU/EAN, or full Leroy Merlin search URL.
	Query string `json:"query" api:"query,required"`
	// Leroy Merlin country when query is a keyword or identifier (default: fr). Ignored when query is a full Leroy Merlin URL (country is detected from the domain).
	Region *string `json:"region" api:"region"`
	// 1-based page number for pagination. Defaults to 1 when omitted. Use the pagination.total_pages returned by a previous call to iterate.
	Page *float64 `json:"page" api:"page"`
	// Optional store id for local prices and availability. Must exist for the active region (FR stores with region=fr, RO stores with region=ro). Returns 400 when unknown.
	StoreID *string `json:"store_id" api:"store_id"`
	// When set to true, returns the raw HTML of the page instead of the parsed JSON payload. Useful for debugging or custom parsing. The response shape is {"return": "<html>..."}. Defaults to false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LeroymerlinSearchParams holds the parameters of LeroymerlinSearch (GET / POST /v2/leroymerlin/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LidlProductParams 

type LidlProductParams struct {
	// Lidl product URL or ERP id.
	Query string `json:"query" api:"query,required"`
	// Target country when query is an ERP id only (default: fr). Ignored for full product URLs.
	Region *string `json:"region" api:"region"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LidlProductParams holds the parameters of LidlProduct (GET / POST /v2/lidl/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LidlSearchParams 

type LidlSearchParams struct {
	// Search keyword or full Lidl search URL.
	Query string `json:"query" api:"query,required"`
	// Target country when query is a keyword (default: fr).
	Region *string `json:"region" api:"region"`
	// 1-based page number (default: 1). Lidl paginates by offset (48 items per page).
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LidlSearchParams holds the parameters of LidlSearch (GET / POST /v2/lidl/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinCompanyInfoParams 

type LinkedinCompanyInfoParams struct {
	// LinkedIn company identifier when you already know the page.
	Query *string `json:"query" api:"query"`
	// Company website domain for reverse lookup when you do not have the LinkedIn URL.
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinCompanyInfoParams holds the parameters of LinkedinCompanyInfo (GET / POST /v2/linkedin/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinJobCountParams 

type LinkedinJobCountParams struct {
	// Job title or keyword to count matching postings.
	Keyword *string `json:"keyword" api:"keyword"`
	// Filter by seniority level.
	ExperienceLevel *string `json:"experience_level" api:"experience_level"`
	// Filter by employment type.
	JobType *string `json:"job_type" api:"job_type"`
	// Filter by posting recency.
	When *string `json:"when" api:"when"`
	// Filter by work arrangement.
	Flexibility *string `json:"flexibility" api:"flexibility"`
	// Maximum distance radius (in miles) from the target location (requires geo_id).
	Distance *float64 `json:"distance" api:"distance"`
	// LinkedIn geo ID of the target location.
	GeoID *string `json:"geo_id" api:"geo_id"`
	// LinkedIn numeric company ID to restrict the count to jobs posted by a specific company.
	CompanyID *string `json:"company_id" api:"company_id"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinJobCountParams holds the parameters of LinkedinJobCount (GET / POST /v2/linkedin/job/count). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinJobInfoParams 

type LinkedinJobInfoParams struct {
	// The LinkedIn job posting to retrieve. Accepts a numeric job ID or a full job posting URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinJobInfoParams holds the parameters of LinkedinJobInfo (GET / POST /v2/linkedin/job/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinJobSearchParams 

type LinkedinJobSearchParams struct {
	// Job title or keyword to search for.
	Keyword *string `json:"keyword" api:"keyword"`
	// Filter by seniority level.
	ExperienceLevel *string `json:"experience_level" api:"experience_level"`
	// Filter by employment type.
	JobType *string `json:"job_type" api:"job_type"`
	// Filter by posting date recency.
	When *string `json:"when" api:"when"`
	// Filter by work arrangement.
	Flexibility *string `json:"flexibility" api:"flexibility"`
	// Maximum radius in miles from the target location (requires geo_id).
	Distance *float64 `json:"distance" api:"distance"`
	// LinkedIn geo ID for the target location. Default is 92000000 (worldwide). Default: "92000000".
	GeoID *string `json:"geo_id" api:"geo_id"`
	// LinkedIn numeric company ID to filter results to jobs posted by a specific company.
	CompanyID *string `json:"company_id" api:"company_id"`
	// Page number for paginating through results. Default is 1. Each page returns up to 25 job listings. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinJobSearchParams holds the parameters of LinkedinJobSearch (GET / POST /v2/linkedin/job/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinJobSuggestParams 

type LinkedinJobSuggestParams struct {
	// The keyword prefix to search for job title suggestions or location names.
	Query string `json:"query" api:"query,required"`
	// Set to true to receive location (geo) suggestions instead of keyword suggestions. Default: false.
	Location *bool `json:"location" api:"location"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinJobSuggestParams holds the parameters of LinkedinJobSuggest (GET / POST /v2/linkedin/job/suggest). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinPostInfoParams 

type LinkedinPostInfoParams struct {
	// The LinkedIn post to retrieve. Accepts a numeric post ID or a full post URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinPostInfoParams holds the parameters of LinkedinPostInfo (GET / POST /v2/linkedin/post/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinProductInfoParams 

type LinkedinProductInfoParams struct {
	// The full LinkedIn product page URL to retrieve.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinProductInfoParams holds the parameters of LinkedinProductInfo (GET / POST /v2/linkedin/product/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinProfileInfoParams 

type LinkedinProfileInfoParams struct {
	// The LinkedIn profile to retrieve. Accepts a username, full profile URL, or numeric member ID.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinProfileInfoParams holds the parameters of LinkedinProfileInfo (GET / POST /v2/linkedin/profile/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinadlibraryAdParams 

type LinkedinadlibraryAdParams struct {
	// Ad id or detail URL from search.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinadlibraryAdParams holds the parameters of LinkedinadlibraryAd (GET / POST /v2/linkedinadlibrary/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LinkedinadlibrarySearchParams 

type LinkedinadlibrarySearchParams struct {
	// Full LinkedIn Ad Library search URL, or a keyword when account_owner is empty.
	Query *string `json:"query" api:"query"`
	// Advertiser / company name filter (accountOwner).
	AccountOwner *string `json:"account_owner" api:"account_owner"`
	// Keyword filter on ad copy.
	Keyword *string `json:"keyword" api:"keyword"`
	// Comma-separated ISO country codes, or ALL.
	Countries *string `json:"countries" api:"countries"`
	// Date window: last-30-days, current-month, current-year, last-year, custom-date-range.
	DateOption *string `json:"date_option" api:"date_option"`
	// Start date YYYY-MM-DD when date_option=custom-date-range.
	StartDate *string `json:"start_date" api:"start_date"`
	// End date YYYY-MM-DD when date_option=custom-date-range.
	EndDate *string `json:"end_date" api:"end_date"`
	// Opaque cursor from pagination.cursor / pagination.next.
	Cursor *string `json:"cursor" api:"cursor"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LinkedinadlibrarySearchParams holds the parameters of LinkedinadlibrarySearch (GET / POST /v2/linkedinadlibrary/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LoopnetPropertyParams 

type LoopnetPropertyParams struct {
	// Required. LoopNet listing URL from search, for example https://www.loopnet.com/Listing/484-Amsterdam-Ave-New-York-NY/31379002/. A keyword is rejected.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LoopnetPropertyParams holds the parameters of LoopnetProperty (GET / POST /v2/loopnet/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type LoopnetSearchParams 

type LoopnetSearchParams struct {
	// Required. City and state, for example New York, NY, or a LoopNet search URL such as https://www.loopnet.com/search/commercial-real-estate/new-york-ny/for-sale/. A listing URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

LoopnetSearchParams holds the parameters of LoopnetSearch (GET / POST /v2/loopnet/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MaerskTrackingParams 

type MaerskTrackingParams struct {
	// Container / BOL tracking number, or full Maersk tracking URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the rendered HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MaerskTrackingParams holds the parameters of MaerskTracking (GET / POST /v2/maersk/tracking). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ManomanoProductOfferParams 

type ManomanoProductOfferParams struct {
	// Numeric ManoMano product id from the product endpoint.
	Query string `json:"query" api:"query,required"`
	// ManoMano country. FR, GB, DE, ES, or IT. Default FR. Default: "FR".
	Region *string `json:"region" api:"region"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ManomanoProductOfferParams holds the parameters of ManomanoProductOffer (GET / POST /v2/manomano/product/offer). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ManomanoProductParams 

type ManomanoProductParams struct {
	// Full ManoMano product page URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ManomanoProductParams holds the parameters of ManomanoProduct (GET / POST /v2/manomano/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ManomanoSearchParams 

type ManomanoSearchParams struct {
	// ManoMano category URL or keyword. A keyword is opened on manomano.fr.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ManomanoSearchParams holds the parameters of ManomanoSearch (GET / POST /v2/manomano/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MascusAdParams 

type MascusAdParams struct {
	// Full Mascus listing URL. Usually taken from results[].url in search.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MascusAdParams holds the parameters of MascusAd (GET / POST /v2/mascus/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MascusSearchParams 

type MascusSearchParams struct {
	// Full Mascus category or search URL. The country site comes from the host (mascus.be, mascus.nl, mascus.de, mascus.com, …).
	Query string `json:"query" api:"query,required"`
	// Page number (default: 1). About 40 results per page.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MascusSearchParams holds the parameters of MascusSearch (GET / POST /v2/mascus/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MediamarktProductParams 

type MediamarktProductParams struct {
	// Product URL or article id.  https://www.mediamarkt.ch/fr/product/_apple-iphone-15-2203371.html
	Query string `json:"query" api:"query,required"`
	// Shop code when query is an article id. Example: ch-fr. Default ch-fr.
	Region *string `json:"region" api:"region"`
	// When true, return raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MediamarktProductParams holds the parameters of MediamarktProduct (GET / POST /v2/mediamarkt/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MediamarktSearchParams 

type MediamarktSearchParams struct {
	// Keyword or MediaMarkt URL. Example: iphone
	Query string `json:"query" api:"query,required"`
	// Shop code. Example: ch-fr or de. Default ch-fr. Ignored when query is a full URL.
	Region *string `json:"region" api:"region"`
	// Page number from 1. Example: 1
	Page *float64 `json:"page" api:"page"`
	// When true, return raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MediamarktSearchParams holds the parameters of MediamarktSearch (GET / POST /v2/mediamarkt/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MicromaniaProductParams 

type MicromaniaProductParams struct {
	// Product URL or the numeric Micromania id. A keyword or a search URL returns 400.
	Query string `json:"query" api:"query,required"`
	// When true, returns the raw HTML instead of the parsed JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MicromaniaProductParams holds the parameters of MicromaniaProduct (GET / POST /v2/micromania/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MicromaniaSearchParams 

type MicromaniaSearchParams struct {
	// Keyword or a Micromania Search-Show URL. A product URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Page number, from 1. Default is 1. Page 2 is sent as page=2.
	Page *float64 `json:"page" api:"page"`
	// When true, returns the raw HTML instead of the parsed JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MicromaniaSearchParams holds the parameters of MicromaniaSearch (GET / POST /v2/micromania/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MobileAdParams 

type MobileAdParams struct {
	// Mobile ad URL or numeric ad id.
	Query string `json:"query" api:"query,required"`
	// Language for this ad. The same numeric id stays reachable for fr, es, de, and en.
	Locale *string `json:"locale" api:"locale"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MobileAdParams holds the parameters of MobileAd (GET / POST /v2/mobile/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MobileSearchParams 

type MobileSearchParams struct {
	// Search URL or make/model code (ms=).
	Query string `json:"query" api:"query,required"`
	// Locale label for the results. The cars themselves stay the same for de, fr, and en.
	Locale *string `json:"locale" api:"locale"`
	// Page number, starting at 1. Same effect as page or pageNumber in the Mobile.de URL.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MobileSearchParams holds the parameters of MobileSearch (GET / POST /v2/mobile/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MoreleProductParams 

type MoreleProductParams struct {
	// Morele product URL, or a numeric product id.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MoreleProductParams holds the parameters of MoreleProduct (GET / POST /v2/morele/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MoreleSearchParams 

type MoreleSearchParams struct {
	// Keyword or a full Morele search URL. A product URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Page number starting at 1. Page 2 asks Morele for the next screen of the same search.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MoreleSearchParams holds the parameters of MoreleSearch (GET / POST /v2/morele/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type MrbricolageSuggestParams 

type MrbricolageSuggestParams struct {
	// Search keyword or EAN used to query the Mr.Bricolage live suggest endpoint. Accepts product names, partial titles or numeric identifiers such as EAN barcodes.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

MrbricolageSuggestParams holds the parameters of MrbricolageSuggest (GET / POST /v2/mrbricolage/suggest). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type NPIProviderParams 

type NPIProviderParams struct {
	// Required. 10-digit NPI, example 1972813608, or a provider-view URL such as https://npiregistry.cms.hhs.gov/provider-view/1972813608.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

NPIProviderParams holds the parameters of NPIProvider (GET / POST /v2/npi/provider). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type NPISearchParams 

type NPISearchParams struct {
	// Optional when another criterion is set. Example: Anthony Fauci. Also a 10-digit NPI such as 1972813608, or an NPPES search URL. With enumeration_type=NPI-2 this text is the organization name, for example Mayo Clinic. A provider-view URL is rejected here.
	Query *string `json:"query" api:"query"`
	// Optional. Example: Anthony. Used as the given name when you do not want query to be split.
	FirstName *string `json:"first_name" api:"first_name"`
	// Optional. Example: Fauci. A single-word query such as Smith is used as the last name.
	LastName *string `json:"last_name" api:"last_name"`
	// Optional. Example: Mayo Clinic. You can also pass that name in query with enumeration_type=NPI-2.
	OrganizationName *string `json:"organization_name" api:"organization_name"`
	// Optional. Practice city. Example: Washington.
	City *string `json:"city" api:"city"`
	// Optional. Two-letter state code. Example: DC. Any other value is rejected.
	State *string `json:"state" api:"state"`
	// Optional. Postal code. Example: 20016.
	PostalCode *string `json:"postal_code" api:"postal_code"`
	// Optional. Taxonomy description. Example: Internal Medicine.
	Taxonomy *string `json:"taxonomy" api:"taxonomy"`
	// Optional. NPI-1 for a person or NPI-2 for an organization. Example: NPI-2. NPI-2 treats a text query as an organization name.
	EnumerationType *string `json:"enumeration_type" api:"enumeration_type"`
	// Optional. Page number, starting at 1. Example: 2. Defaults to 1.
	Page *float64 `json:"page" api:"page"`
	// Optional. Page size. Example: 10. Defaults to 10 and cannot exceed 200. next is a URL only when the page contains this many rows.
	Limit *float64 `json:"limit" api:"limit"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

NPISearchParams holds the parameters of NPISearch (GET / POST /v2/npi/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type NeweggProductParams 

type NeweggProductParams struct {
	// Item number, catalog id, or product URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML. The string false stays false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

NeweggProductParams holds the parameters of NeweggProduct (GET / POST /v2/newegg/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type NeweggSearchParams 

type NeweggSearchParams struct {
	// Keyword or a newegg.com search URL.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Example: 2.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML. The string false stays false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

NeweggSearchParams holds the parameters of NeweggSearch (GET / POST /v2/newegg/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type NorthdataCompanyParams 

type NorthdataCompanyParams struct {
	// Company name, North Data id, or a profile URL.
	Query string `json:"query" api:"query,required"`
	// ISO alpha-2, used only when query is a name. Same form as search: FR or FR,DE.
	Countries *string `json:"countries" api:"countries"`
	// fr (default), com or en, de. Ignored when query is a URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

NorthdataCompanyParams holds the parameters of NorthdataCompany (GET / POST /v2/northdata/company). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type NorthdataSearchParams 

type NorthdataSearchParams struct {
	// Company or person name, or a North Data suggest URL.
	Query string `json:"query" api:"query,required"`
	// ISO alpha-2 codes, separated by comma, pipe or space (FR or FR,DE). Empty searches every country. A URL that already has countries wins.
	Countries *string `json:"countries" api:"countries"`
	// Host of a name: fr (default), com or en, de. Ignored when query is a URL. Default: "fr".
	Domain *string `json:"domain" api:"domain"`
	// Only 1. Below 1 returns 400. Above 1 returns 404. At most 15 rows.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

NorthdataSearchParams holds the parameters of NorthdataSearch (GET / POST /v2/northdata/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OceanioSearchParams 

type OceanioSearchParams struct {
	// Domain or company name.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OceanioSearchParams holds the parameters of OceanioSearch (GET / POST /v2/oceanio/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OlxAdParams 

type OlxAdParams struct {
	// OLX listing URL.
	Query string `json:"query" api:"query,required"`
	// Ignored when query is a full URL. The host selects the country.
	Region *string `json:"region" api:"region"`
	// When true, return raw HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OlxAdParams holds the parameters of OlxAd (GET / POST /v2/olx/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OlxProductParams 

type OlxProductParams struct {
	// Full URL of the OLX listing page to retrieve. Must be a valid olx.com.br listing URL. Example 1:
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OlxProductParams holds the parameters of OlxProduct (GET / POST /v2/olx/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OlxSearchParams 

type OlxSearchParams struct {
	// Search keyword or phrase, as you would type it in the OLX search bar. Supports Portuguese terms for Brazilian inventory.
	Query string `json:"query" api:"query,required"`
	// OLX category slug to restrict results to a specific vertical. Common values:
	Category *string `json:"category" api:"category"`
	// Brazilian state abbreviation to filter results geographically.
	State *string `json:"state" api:"state"`
	// City slug to narrow results to a specific municipality. Use lowercase with hyphens.
	City *string `json:"city" api:"city"`
	// Minimum listing price in BRL.
	MinPrice *float64 `json:"min_price" api:"min_price"`
	// Maximum listing price in BRL.
	MaxPrice *float64 `json:"max_price" api:"max_price"`
	// Filter by seller type.
	SellerType *string `json:"seller_type" api:"seller_type"`
	// Sort order for results. Default: "relevance".
	Sort *string `json:"sort" api:"sort"`
	// Page number for paginated results. Default: 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OlxSearchParams holds the parameters of OlxSearch (GET / POST /v2/olx/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OscaroProductParams 

type OscaroProductParams struct {
	// Oscaro product page URL (*-{sku}-p suffix).
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OscaroProductParams holds the parameters of OscaroProduct (GET / POST /v2/oscaro/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OscaroSearchParams 

type OscaroSearchParams struct {
	// Search keyword, search URL, or category listing URL (*-{id}-g).
	Query string `json:"query" api:"query,required"`
	// Target shop when query is a keyword (default: com).
	Region *string `json:"region" api:"region"`
	// 1-based page number override for category listing URLs (default: read from URL or 1). Uses ?page=2 on *-g pages.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OscaroSearchParams holds the parameters of OscaroSearch (GET / POST /v2/oscaro/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OvokoAdParams 

type OvokoAdParams struct {
	// Full Ovoko listing URL. The last path segment must be a SKU slug (example: qbb17557-95c827460c-porsche-macan-...) or a known product prefix.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OvokoAdParams holds the parameters of OvokoAd (GET / POST /v2/ovoko/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OvokoSearchParams 

type OvokoSearchParams struct {
	// Full Ovoko search URL. Only search pages are accepted (not category, catalog, or offer pages).
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OvokoSearchParams holds the parameters of OvokoSearch (GET / POST /v2/ovoko/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OwlerCompanyInfoParams 

type OwlerCompanyInfoParams struct {
	// The company to look up on Owler. Multiple formats are accepted:
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OwlerCompanyInfoParams holds the parameters of OwlerCompanyInfo (GET / POST /v2/owler/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type OwlerSearchParams 

type OwlerSearchParams struct {
	// The company name or keyword to search for on Owler.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

OwlerSearchParams holds the parameters of OwlerSearch (GET / POST /v2/owler/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PagesjaunesPageInfoParams 

type PagesjaunesPageInfoParams struct {
	// A PagesJaunes business page URL or business ID.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PagesjaunesPageInfoParams holds the parameters of PagesjaunesPageInfo (GET / POST /v2/pagesjaunes/page/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PagesjaunesSearchParams 

type PagesjaunesSearchParams struct {
	// A valid PagesJaunes search URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PagesjaunesSearchParams holds the parameters of PagesjaunesSearch (GET / POST /v2/pagesjaunes/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PatreonProfileInfoParams 

type PatreonProfileInfoParams struct {
	// Patreon profile URL or creator vanity name.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PatreonProfileInfoParams holds the parameters of PatreonProfileInfo (GET / POST /v2/patreon/profile/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PatreonSearchParams 

type PatreonSearchParams struct {
	// Search keyword to find Patreon creators.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PatreonSearchParams holds the parameters of PatreonSearch (GET / POST /v2/patreon/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PetsmartProductParams 

type PetsmartProductParams struct {
	// A PetSmart product link.
	Query string `json:"query" api:"query,required"`
	// Set to true to get the raw HTML in result instead of the parsed JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PetsmartProductParams holds the parameters of PetsmartProduct (GET / POST /v2/petsmart/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PetsmartSearchParams 

type PetsmartSearchParams struct {
	// What to look for. A word, or a PetSmart search link.
	Query string `json:"query" api:"query,required"`
	// Which page of results, starting at 1. Page 2 returns a different set of products.
	Page *float64 `json:"page" api:"page"`
	// Set to true to get the raw HTML in result instead of the parsed JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PetsmartSearchParams holds the parameters of PetsmartSearch (GET / POST /v2/petsmart/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PicardProductParams 

type PicardProductParams struct {
	// Picard product URL or numeric reference.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PicardProductParams holds the parameters of PicardProduct (GET / POST /v2/picard/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PicardSearchParams 

type PicardSearchParams struct {
	// Search keyword or full Picard search URL.
	Query string `json:"query" api:"query,required"`
	// 1-based page number (24 results per page via SFCC Search-UpdateGrid). Default: 1.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PicardSearchParams holds the parameters of PicardSearch (GET / POST /v2/picard/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PinterestUserInfoParams 

type PinterestUserInfoParams struct {
	// The Pinterest profile to retrieve. Accepts a full profile URL or a username.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PinterestUserInfoParams holds the parameters of PinterestUserInfo (GET / POST /v2/pinterest/user/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PitchbookCompanyInfoParams 

type PitchbookCompanyInfoParams struct {
	// PitchBook company id or company profile URL.
	Query string `json:"query" api:"query,required"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PitchbookCompanyInfoParams holds the parameters of PitchbookCompanyInfo (GET / POST /v2/pitchbook/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PitchbookSearchParams 

type PitchbookSearchParams struct {
	// Keyword or PitchBook search URL.
	Query string `json:"query" api:"query,required"`
	// Page number for content search (/search?q=...).
	Page *string `json:"page" api:"page"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PitchbookSearchParams holds the parameters of PitchbookSearch (GET / POST /v2/pitchbook/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PointpProductParams 

type PointpProductParams struct {
	// Full Point.P product page URL (/p/...-A{id}).
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of parsed JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PointpProductParams holds the parameters of PointpProduct (GET / POST /v2/pointp/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PointpSearchParams 

type PointpSearchParams struct {
	// Search keyword or full Point.P search results URL.
	Query string `json:"query" api:"query,required"`
	// 1-based page number for pagination. Overrides the page inferred from the URL. Defaults to 1 when omitted.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PointpSearchParams holds the parameters of PointpSearch (GET / POST /v2/pointp/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PrnewswireArticleParams 

type PrnewswireArticleParams struct {
	// Required. PR Newswire release URL, for example https://www.prnewswire.com/news-releases/pumpkin-awarded-11-000-in-donations-to-veterinary-clinics-for-cost-of-care-education-302924942.html. A keyword is rejected.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PrnewswireArticleParams holds the parameters of PrnewswireArticle (GET / POST /v2/prnewswire/article). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type PrnewswireSearchParams 

type PrnewswireSearchParams struct {
	// Required. Keyword, for example apple, or a PR Newswire news-search URL such as https://www.prnewswire.com/search/news/?keyword=apple. A release URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a search URL is kept when this is omitted or 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

PrnewswireSearchParams holds the parameters of PrnewswireSearch (GET / POST /v2/prnewswire/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ProducthuntProductInfoParams 

type ProducthuntProductInfoParams struct {
	// A ProductHunt product URL or product slug.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ProducthuntProductInfoParams holds the parameters of ProducthuntProductInfo (GET / POST /v2/producthunt/product/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ProshopProductParams 

type ProshopProductParams struct {
	// Proshop product id, or a product URL. The id is the last path segment.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ProshopProductParams holds the parameters of ProshopProduct (GET / POST /v2/proshop/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ProshopSearchParams 

type ProshopSearchParams struct {
	// Keyword or a full Proshop search URL with s=. A product URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Page number starting at 1. Proshop sends this as pn.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML as {"result": "..."}.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ProshopSearchParams holds the parameters of ProshopSearch (GET / POST /v2/proshop/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RappiProductParams 

type RappiProductParams struct {
	// Required. Product URL on rappi.com.mx, example https://www.rappi.com.mx/p/santa-clara-leche-deslactosada-semidescremada-1-l-14069, or a numeric master id such as 14069.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RappiProductParams holds the parameters of RappiProduct (GET / POST /v2/rappi/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RappiSearchParams 

type RappiSearchParams struct {
	// Required. Keyword, example leche, or a rappi.com.mx search URL such as https://www.rappi.com.mx/search?query=leche. A product URL or another country host is rejected.
	Query string `json:"query" api:"query,required"`
	// Optional. Only page 1 returns rows. Example: 1. Defaults to 1. Page 2 is rejected because the payload has no next page.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RappiSearchParams holds the parameters of RappiSearch (GET / POST /v2/rappi/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RatemyprofessorsProfessorParams 

type RatemyprofessorsProfessorParams struct {
	// Required. The numeric professor id from search, or a /professor/{id} URL. A name is not accepted.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RatemyprofessorsProfessorParams holds the parameters of RatemyprofessorsProfessor (GET / POST /v2/ratemyprofessors/professor). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RatemyprofessorsSearchParams 

type RatemyprofessorsSearchParams struct {
	// Required. A professor name, or a Rate My Professors search URL whose path contains /search/professors or whose query contains q=.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RatemyprofessorsSearchParams holds the parameters of RatemyprofessorsSearch (GET / POST /v2/ratemyprofessors/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RealestatecomauSearchParams 

type RealestatecomauSearchParams struct {
	// Place or a realestate.com.au results URL.
	Query string `json:"query" api:"query,required"`
	// buy, rent, or sold. Used when query is a place.
	Channel *string `json:"channel" api:"channel"`
	// Page from 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RealestatecomauSearchParams holds the parameters of RealestatecomauSearch (GET / POST /v2/realestatecomau/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RealtorPropertyParams 

type RealtorPropertyParams struct {
	// Full Realtor.com property detail URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RealtorPropertyParams holds the parameters of RealtorProperty (GET / POST /v2/realtor/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RealtorSearchParams 

type RealtorSearchParams struct {
	// Full Realtor.com search results URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RealtorSearchParams holds the parameters of RealtorSearch (GET / POST /v2/realtor/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RedfinPropertyParams 

type RedfinPropertyParams struct {
	// Redfin home link. Use the url returned by search.
	Query string `json:"query" api:"query,required"`
	// Market id. Required only when the home link does not already include region_id.
	RegionID *float64 `json:"region_id" api:"region_id"`
	// Required with region_id when the home link has no region_type.
	RegionType *float64 `json:"region_type" api:"region_type"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RedfinPropertyParams holds the parameters of RedfinProperty (GET / POST /v2/redfin/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RedfinSearchParams 

type RedfinSearchParams struct {
	// Redfin for-sale link for a city, neighborhood, or county.
	Query string `json:"query" api:"query,required"`
	// Page of the for-sale feed, from 1.
	Page *float64 `json:"page" api:"page"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RedfinSearchParams holds the parameters of RedfinSearch (GET / POST /v2/redfin/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ReicheltProductParams 

type ReicheltProductParams struct {
	// A reichelt.de or reichelt.com product link. A search link returns 400.
	Query string `json:"query" api:"query,required"`
	// Set to true to get the raw HTML in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ReicheltProductParams holds the parameters of ReicheltProduct (GET / POST /v2/reichelt/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ReicheltSearchParams 

type ReicheltSearchParams struct {
	// What to look for. A word such as 1n4148, or a reichelt.de search or category link. A product link returns 400.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Page 2 is PAGE=1 on the shop.
	Page *float64 `json:"page" api:"page"`
	// Set to true to get the raw HTML in result.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ReicheltSearchParams holds the parameters of ReicheltSearch (GET / POST /v2/reichelt/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RequestOption 

type RequestOption func(*requestOptions)

RequestOption customizes one request.

func WithHeader 

func WithHeader(name, value string) RequestOption

WithHeader adds a header to one request.

func WithMaxRetries 

func WithMaxRetries(n int) RequestOption

WithMaxRetries overrides the number of retries for one request (0 disables them).

func WithMethod 

func WithMethod(method string) RequestOption

WithMethod selects GET or POST. Operations default to GET when they support it.

type Response 

type Response struct {
	StatusCode  int
	Header      http.Header
	ContentType string
	// Body holds the raw bytes: JSON text, or a file such as an image or PDF.
	Body []byte
	// IsJSON reports whether the body is JSON (Content-Type application/json or +json).
	IsJSON bool
}

Response is a buffered, successful API response.

func (*Response) Decode 

func (r *Response) Decode(v any) error

Decode unmarshals a JSON body into v.

func (*Response) Map 

func (r *Response) Map() (map[string]any, error)

Map decodes a JSON object body.

type ResponseDecodingError 

type ResponseDecodingError struct {
	Message  string
	Response *Response
	Err      error
}

ResponseDecodingError reports a success response that could not be decoded.

func (*ResponseDecodingError) Error 

func (e *ResponseDecodingError) Error() string

func (*ResponseDecodingError) Unwrap 

func (e *ResponseDecodingError) Unwrap() error

type ReverbProductParams 

type ReverbProductParams struct {
	// Reverb listing URL or numeric listing id.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ReverbProductParams holds the parameters of ReverbProduct (GET / POST /v2/reverb/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ReverbSearchParams 

type ReverbSearchParams struct {
	// Search keyword, query string, or full Reverb marketplace URL.
	Query string `json:"query" api:"query,required"`
	// 1-based page number override (default: read from URL or 1).
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ReverbSearchParams holds the parameters of ReverbSearch (GET / POST /v2/reverb/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RexelProductParams 

type RexelProductParams struct {
	// Rexel France product URL containing /p/{id}.
	Query string `json:"query" api:"query,required"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RexelProductParams holds the parameters of RexelProduct (GET / POST /v2/rexel/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RexelSearchParams 

type RexelSearchParams struct {
	// Keyword, EAN, or Rexel France search URL.
	Query string `json:"query" api:"query,required"`
	// Page number (1-based). Page 1 omits page in the URL.
	Page *string `json:"page" api:"page"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RexelSearchParams holds the parameters of RexelSearch (GET / POST /v2/rexel/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RightmovePropertyParams 

type RightmovePropertyParams struct {
	// Rightmove property URL or the numeric id.
	Query string `json:"query" api:"query,required"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RightmovePropertyParams holds the parameters of RightmoveProperty (GET / POST /v2/rightmove/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RightmoveSearchParams 

type RightmoveSearchParams struct {
	// UK place name or a Rightmove search URL.
	Query string `json:"query" api:"query,required"`
	// Results page, from 1.
	Page *float64 `json:"page" api:"page"`
	// Optional. Default false. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RightmoveSearchParams holds the parameters of RightmoveSearch (GET / POST /v2/rightmove/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RsonlineProductParams 

type RsonlineProductParams struct {
	// A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.
	Query string `json:"query" api:"query,required"`
	// Default false. true replaces the product object with result, the rendered HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RsonlineProductParams holds the parameters of RsonlineProduct (GET / POST /v2/rsonline/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type RsonlineSearchParams 

type RsonlineSearchParams struct {
	// A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.
	Query string `json:"query" api:"query,required"`
	// Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400.
	Page *float64 `json:"page" api:"page"`
	// Default false. true replaces results and pagination with result, the rendered HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

RsonlineSearchParams holds the parameters of RsonlineSearch (GET / POST /v2/rsonline/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SeekJobParams 

type SeekJobParams struct {
	// Required. SEEK job URL or numeric id, for example 95568355 or https://www.seek.com.au/job/95568355. A keyword is rejected.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SeekJobParams holds the parameters of SeekJob (GET / POST /v2/seek/job). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SeekSearchParams 

type SeekSearchParams struct {
	// Required. Job keyword, for example nurse, or a SEEK results URL such as https://www.seek.com.au/nurse-jobs. A /job/<id> URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Optional. Page number starting at 1. Example: 2. Omitted means page 1. A page already present in a results URL is kept when this is omitted or 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SeekSearchParams holds the parameters of SeekSearch (GET / POST /v2/seek/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SelogerAgencyParams 

type SelogerAgencyParams struct {
	// A valid SeLoger agency profile URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SelogerAgencyParams holds the parameters of SelogerAgency (GET / POST /v2/seloger/agency). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SelogerAgencyRentParams 

type SelogerAgencyRentParams struct {
	// A valid SeLoger agency ID.
	Query string `json:"query" api:"query,required"`
	// Page number for paginating through the agency's rental listings. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SelogerAgencyRentParams holds the parameters of SelogerAgencyRent (GET / POST /v2/seloger/agency/rent). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SelogerAgencySaleParams 

type SelogerAgencySaleParams struct {
	// A valid SeLoger agency ID.
	Query string `json:"query" api:"query,required"`
	// Page number for paginating through the agency's sale listings. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SelogerAgencySaleParams holds the parameters of SelogerAgencySale (GET / POST /v2/seloger/agency/sale). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SelogerPropertyParams 

type SelogerPropertyParams struct {
	// A valid SeLoger property listing URL.
	Query string `json:"query" api:"query,required"`
	// Whether to return the raw HTML source of the property page instead of parsed JSON data. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SelogerPropertyParams holds the parameters of SelogerProperty (GET / POST /v2/seloger/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SelogerSearchParams 

type SelogerSearchParams struct {
	// A valid SeLoger search results URL. Any SeLoger search page URL with filters is supported: location, property type, price range, surface, and number of rooms can all be embedded in the URL.
	Query string `json:"query" api:"query,required"`
	// Whether to return the raw HTML source of the search results page instead of parsed JSON data. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SelogerSearchParams holds the parameters of SelogerSearch (GET / POST /v2/seloger/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SephoraProductParams 

type SephoraProductParams struct {
	// A Sephora product URL. A product id such as 831955 also works.  https://www.sephora.fr/p/midnight-espresso---eau-de-parfum-au-cafe-831955.html
	Query string `json:"query" api:"query,required"`
	// Shop when query is only an id. Use fr for France or de for Germany. Leave empty for France.
	Region *string `json:"region" api:"region"`
	// Return the rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SephoraProductParams holds the parameters of SephoraProduct (GET / POST /v2/sephora/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SephoraSearchParams 

type SephoraSearchParams struct {
	// A product word, for example mascara. Or paste a full Sephora search URL.
	Query string `json:"query" api:"query,required"`
	// Shop code. Use fr for France or de for Germany. Leave empty for France. A full URL picks the shop.
	Region *string `json:"region" api:"region"`
	// Page number, starting at 1. Use 2 for the next page of products.
	Page *float64 `json:"page" api:"page"`
	// Return the rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SephoraSearchParams holds the parameters of SephoraSearch (GET / POST /v2/sephora/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SerializationError 

type SerializationError struct {
	Param   string
	Message string
	Err     error
}

SerializationError reports a parameter that is missing or cannot be sent.

func (*SerializationError) Error 

func (e *SerializationError) Error() string

func (*SerializationError) Unwrap 

func (e *SerializationError) Unwrap() error

type ShophouzzProductParams 

type ShophouzzProductParams struct {
	// Full URL of the Shophouzz product page to retrieve details for.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ShophouzzProductParams holds the parameters of ShophouzzProduct (GET / POST /v2/shophouzz/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ShopifyAppsParams 

type ShopifyAppsParams struct {
	// URL of the Shopify App Store listing to scrape.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ShopifyAppsParams holds the parameters of ShopifyApps (GET / POST /v2/shopify/apps). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ShopifyCatalogParams 

type ShopifyCatalogParams struct {
	// Shop domain or a URL on that shop.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1.
	Page *float64 `json:"page" api:"page"`
	// How many items to return on this page.
	Limit *float64 `json:"limit" api:"limit"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ShopifyCatalogParams holds the parameters of ShopifyCatalog (GET / POST /v2/shopify/catalog). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ShopifyCollectionsParams 

type ShopifyCollectionsParams struct {
	// Shop domain or a URL on that shop.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1.
	Page *float64 `json:"page" api:"page"`
	// How many items to return on this page.
	Limit *float64 `json:"limit" api:"limit"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ShopifyCollectionsParams holds the parameters of ShopifyCollections (GET / POST /v2/shopify/collections). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ShopifyProductParams 

type ShopifyProductParams struct {
	// URL of a Shopify product page to scrape.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ShopifyProductParams holds the parameters of ShopifyProduct (GET / POST /v2/shopify/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SimilarwebDomainParams 

type SimilarwebDomainParams struct {
	// A domain name to retrieve traffic and engagement metrics for.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SimilarwebDomainParams holds the parameters of SimilarwebDomain (GET / POST /v2/similarweb/domain). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SimilarwebSearchParams 

type SimilarwebSearchParams struct {
	// Domain name or keyword to search for in the Similarweb database.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SimilarwebSearchParams holds the parameters of SimilarwebSearch (GET / POST /v2/similarweb/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SnapedaProductParams 

type SnapedaProductParams struct {
	// SnapEDA part page URL or MPN/manufacturer slug.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw rendered HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SnapedaProductParams holds the parameters of SnapedaProduct (GET / POST /v2/snapeda/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type SnapedaSearchParams 

type SnapedaSearchParams struct {
	// Search keyword or full SnapEDA / SnapMagic search URL.
	Query string `json:"query" api:"query,required"`
	// 1-based page number override (default: read from URL or 1). SnapEDA returns 20 results per page.
	Page *float64 `json:"page" api:"page"`
	// When true, return the raw rendered HTML as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

SnapedaSearchParams holds the parameters of SnapedaSearch (GET / POST /v2/snapeda/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StarbucksMenuParams 

type StarbucksMenuParams struct {
	// Café number from Search, short (9230) or full (9230-154245).
	StoreNumber *string `json:"store_number" api:"store_number"`
	// Same café number, or a menu URL that contains storeNumber. Used when store_number is empty.
	Query *string `json:"query" api:"query"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StarbucksMenuParams holds the parameters of StarbucksMenu (GET / POST /v2/starbucks/menu). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StarbucksProductParams 

type StarbucksProductParams struct {
	// Product and form, or a Starbucks product URL.
	Query string `json:"query" api:"query,required"`
	// Café number from Search, short (9230) or full (9230-154245). Required when the product URL has no storeNumber.
	StoreNumber *string `json:"store_number" api:"store_number"`
	// Form when query is only a product number. Usually hot or iced.
	FormCode *string `json:"form_code" api:"form_code"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StarbucksProductParams holds the parameters of StarbucksProduct (GET / POST /v2/starbucks/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StarbucksSearchParams 

type StarbucksSearchParams struct {
	// Store-locator URL, or a lat,lng pair. Required when lat and lng are empty.
	Query *string `json:"query" api:"query"`
	// Latitude. Send it with lng. If both are set, they replace any coordinates found in query.
	Lat *float64 `json:"lat" api:"lat"`
	// Longitude. Send it with lat.
	Lng *float64 `json:"lng" api:"lng"`
	// Optional place label sent with the coordinates, for example New York, NY. Coordinates are still required.
	Place *string `json:"place" api:"place"`
	// Optional amenity filter. Separate codes with commas. ON keeps cafés that offer mobile order.
	Features *string `json:"features" api:"features"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StarbucksSearchParams holds the parameters of StarbucksSearch (GET / POST /v2/starbucks/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StatsParams 

type StatsParams struct {
	// API family to check, for example website. Provide at least engine or path.
	Engine *string `json:"engine" api:"engine"`
	// Specific endpoint to check, for example /v2/website/crawler. If you also pass engine, use an endpoint from that API.
	Path *string `json:"path" api:"path"`
}

StatsParams holds the parameters of Stats (GET /v2/stats). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StockxProductParams 

type StockxProductParams struct {
	// A StockX product slug.
	Query string `json:"query" api:"query,required"`
	// Country code for localized pricing and availability. Default: "US".
	Country *string `json:"country" api:"country"`
	// Currency code for price display. Default: "USD".
	Currency *string `json:"currency" api:"currency"`
	// Language code for localized content. Default: "en-US".
	Language *string `json:"language" api:"language"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StockxProductParams holds the parameters of StockxProduct (GET / POST /v2/stockx/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StockxSearchParams 

type StockxSearchParams struct {
	// Search query for StockX products. Can be a product name, brand, SKU, or slug.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StockxSearchParams holds the parameters of StockxSearch (GET / POST /v2/stockx/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StockxTrendsParams 

type StockxTrendsParams struct {
	// StockX product category to retrieve trending items for.
	Query string `json:"query" api:"query,required"`
	// Sort order for trending results. Default: "featured".
	SortBy *string `json:"sort_by" api:"sort_by"`
	// Country code for localized trending data. Default: "US".
	Country *string `json:"country" api:"country"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StockxTrendsParams holds the parameters of StockxTrends (GET / POST /v2/stockx/trends). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StubhubEventParams 

type StubhubEventParams struct {
	// Required. StubHub event URL or numeric id, for example 162387399 or https://www.stubhub.com/harlem-globetrotters-marseille-tickets-3-31-2027/event/162387399/. A keyword is rejected.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StubhubEventParams holds the parameters of StubhubEvent (GET / POST /v2/stubhub/event). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type StubhubSearchParams 

type StubhubSearchParams struct {
	// Required. Keyword, for example nba, or a StubHub search URL such as https://www.stubhub.com/secure/search/?q=nba. An event URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Optional. Only page 1 returns events. Example: 1. Page 2 and above return 404 because the search document has no further page. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

StubhubSearchParams holds the parameters of StubhubSearch (GET / POST /v2/stubhub/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TargetProductParams 

type TargetProductParams struct {
	// Target product URL or bare TCIN.
	Query string `json:"query" api:"query,required"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TargetProductParams holds the parameters of TargetProduct (GET / POST /v2/target/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TargetSearchParams 

type TargetSearchParams struct {
	// Keyword or Target search URL.
	Query string `json:"query" api:"query,required"`
	// Page number (1-based).
	Page *string `json:"page" api:"page"`
	// When true, return rendered HTML instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TargetSearchParams holds the parameters of TargetSearch (GET / POST /v2/target/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TdlrLicenseParams 

type TdlrLicenseParams struct {
	// Required. Detail id, example AIRREF00000564, or the SearchResultDetail URL from search.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TdlrLicenseParams holds the parameters of TdlrLicense (GET / POST /v2/tdlr/license). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TdlrSearchParams 

type TdlrSearchParams struct {
	// Optional when city, county, or postal_code is set. Person or business name, example SMITH. A detail URL is rejected.
	Query *string `json:"query" api:"query"`
	// Optional on the request, required for a useful search. License type code, example AIRREF for air conditioning contractors. ALL or blank searches every type.
	LicenseType *string `json:"license_type" api:"license_type"`
	// Optional. Business city. Example: Austin. One of query, city, county, or postal_code is required.
	City *string `json:"city" api:"city"`
	// Optional. Business county. Example: TRAVIS.
	County *string `json:"county" api:"county"`
	// Optional. Business ZIP. Example: 78701.
	PostalCode *string `json:"postal_code" api:"postal_code"`
	// Optional. Page number starting at 1. Example: 2. Defaults to 1. Each page has 25 rows.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TdlrSearchParams holds the parameters of TdlrSearch (GET / POST /v2/tdlr/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TedNoticeParams 

type TedNoticeParams struct {
	// Publication number, or a TED notice URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TedNoticeParams holds the parameters of TedNotice (GET / POST /v2/ted/notice). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TedSearchParams 

type TedSearchParams struct {
	// Keyword, publication number, or a TED search URL.
	Query *string `json:"query" api:"query"`
	// Notice code such as cn-standard or can-standard. Combined with AND.
	NoticeType *string `json:"notice_type" api:"notice_type"`
	// Buyer country, ISO alpha-2 or alpha-3. FR becomes FRA. A country name returns 400.
	Country *string `json:"country" api:"country"`
	// Place of performance: country code or NUTS code such as FRK24.
	Place *string `json:"place" api:"place"`
	// CPV code or prefix. Digits and an optional star, for example 72000000 or 30*.
	Cpv *string `json:"cpv" api:"cpv"`
	// Buyer name, matched as a phrase.
	Buyer *string `json:"buyer" api:"buyer"`
	// Page from 1. next is always null: pass page + 1. A page past the last one returns 404.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TedSearchParams holds the parameters of TedSearch (GET / POST /v2/ted/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ThaliaProductParams 

type ThaliaProductParams struct {
	// Product URL or Thalia article id.
	Query string `json:"query" api:"query,required"`
	// When true, returns {"result": "<html>..."} instead of the parsed JSON. Default false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ThaliaProductParams holds the parameters of ThaliaProduct (GET / POST /v2/thalia/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ThaliaSearchParams 

type ThaliaSearchParams struct {
	// Keyword or a thalia.de search URL (/suche or a category URL). A product URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Page number, from 1. Sent to Thalia as the query parameter p. Default 1.
	Page *float64 `json:"page" api:"page"`
	// When true, returns {"result": "<html>..."} instead of the parsed JSON. Default false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ThaliaSearchParams holds the parameters of ThaliaSearch (GET / POST /v2/thalia/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TheforkRestaurantParams 

type TheforkRestaurantParams struct {
	// Full TheFork restaurant page URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TheforkRestaurantParams holds the parameters of TheforkRestaurant (GET / POST /v2/thefork/restaurant). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TheforkSearchParams 

type TheforkSearchParams struct {
	// Full TheFork search or city listing URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TheforkSearchParams holds the parameters of TheforkSearch (GET / POST /v2/thefork/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ThomasnetCompanyParams 

type ThomasnetCompanyParams struct {
	// Full Thomasnet company profile URL from your browser.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ThomasnetCompanyParams holds the parameters of ThomasnetCompany (GET / POST /v2/thomasnet/company). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ThomasnetSearchParams 

type ThomasnetSearchParams struct {
	// Full Thomasnet search URL from your browser.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ThomasnetSearchParams holds the parameters of ThomasnetSearch (GET / POST /v2/thomasnet/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TicketmasterEventParams 

type TicketmasterEventParams struct {
	// Required. Slugged event URL, example https://www.ticketmaster.com/suns-vs-jazz-kids-day-phoenix-arizona-01-24-2027/event/19006507A7257EEA. A short /event/{discoveryId} link has no slug and cannot be resolved.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TicketmasterEventParams holds the parameters of TicketmasterEvent (GET / POST /v2/ticketmaster/event). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TicketmasterSearchParams 

type TicketmasterSearchParams struct {
	// Required. Keyword, example jazz, or a ticketmaster.com search URL such as https://www.ticketmaster.com/search?q=jazz. An event URL is rejected.
	Query string `json:"query" api:"query,required"`
	// Optional. Page number starting at 1. Example: 2. Defaults to 1. On ticketmaster.com the page query is zero-based, so API page 2 is page=1 on the site.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TicketmasterSearchParams holds the parameters of TicketmasterSearch (GET / POST /v2/ticketmaster/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TiktoktopadsAdParams 

type TiktoktopadsAdParams struct {
	// Ad id or detail URL from search.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TiktoktopadsAdParams holds the parameters of TiktoktopadsAd (GET / POST /v2/tiktoktopads/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TiktoktopadsSearchParams 

type TiktoktopadsSearchParams struct {
	// Full TikTok Top Ads search URL, or a keyword.
	Query *string `json:"query" api:"query"`
	// Brand or product keyword.
	Keyword *string `json:"keyword" api:"keyword"`
	// ISO country code (country_code).
	Region *string `json:"region" api:"region"`
	// Campaign objective id (URL param object).
	Objective *string `json:"objective" api:"objective"`
	// Lookback window: 7, 30, or 180. Default: "30".
	Period *string `json:"period" api:"period"`
	// Sort: for_you, reach/impression, ctr/like.
	OrderBy *string `json:"order_by" api:"order_by"`
	// Industry key filter.
	Industry *string `json:"industry" api:"industry"`
	// Page number.
	Page *float64 `json:"page" api:"page"`
	// Page size (max 20).
	PerPage *float64 `json:"per_page" api:"per_page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TiktoktopadsSearchParams holds the parameters of TiktoktopadsSearch (GET / POST /v2/tiktoktopads/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TradeaplaneListingParams 

type TradeaplaneListingParams struct {
	// Listing URL that includes listing_id.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TradeaplaneListingParams holds the parameters of TradeaplaneListing (GET / POST /v2/tradeaplane/listing). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TradeaplaneSearchParams 

type TradeaplaneSearchParams struct {
	// Keyword, or a Trade-A-Plane search URL without listing_id.
	Query string `json:"query" api:"query,required"`
	// aircraft or engine when query is a keyword. Ignored when query is a URL.
	ListingType *string `json:"listing_type" api:"listing_type"`
	// Page from 1. Sent as s-page.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TradeaplaneSearchParams holds the parameters of TradeaplaneSearch (GET / POST /v2/tradeaplane/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type TransportError 

type TransportError struct {
	Message string
	Err     error
}

TransportError reports a failure before a complete HTTP response was received, including client-side timeouts and context cancellation (see Unwrap).

func (*TransportError) Error 

func (e *TransportError) Error() string

func (*TransportError) Unwrap 

func (e *TransportError) Unwrap() error

type TrustpilotCompanyInfoParams 

type TrustpilotCompanyInfoParams struct {
	// A Trustpilot company URL or domain name.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

TrustpilotCompanyInfoParams holds the parameters of TrustpilotCompanyInfo (GET / POST /v2/trustpilot/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UntappdBeerParams 

type UntappdBeerParams struct {
	// Required. The numeric Untappd beer id from search, or a beer URL under /b/ or /beer/. A keyword is not accepted.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UntappdBeerParams holds the parameters of UntappdBeer (GET / POST /v2/untappd/beer). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UntappdSearchParams 

type UntappdSearchParams struct {
	// Required. A beer keyword, or an Untappd search URL whose path is /search.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UntappdSearchParams holds the parameters of UntappdSearch (GET / POST /v2/untappd/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UpworkFreelancerParams 

type UpworkFreelancerParams struct {
	// Upwork freelancer profile ID, username, or full profile URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UpworkFreelancerParams holds the parameters of UpworkFreelancer (GET / POST /v2/upwork/freelancer). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UpworkJobsParams 

type UpworkJobsParams struct {
	// Upwork skill slug or full freelance-jobs URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UpworkJobsParams holds the parameters of UpworkJobs (GET / POST /v2/upwork/jobs). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UpworkServicesInfoParams 

type UpworkServicesInfoParams struct {
	// Full Upwork Project Catalog product URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UpworkServicesInfoParams holds the parameters of UpworkServicesInfo (GET / POST /v2/upwork/services/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UpworkServicesParams 

type UpworkServicesParams struct {
	// Upwork Project Catalog category slug or full services URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UpworkServicesParams holds the parameters of UpworkServices (GET / POST /v2/upwork/services). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UsaspendingAwardParams 

type UsaspendingAwardParams struct {
	// Required. Generated award id or a usaspending.gov/award URL. Example: CONT_AWD_GSFC0198106DNAS526555_8000_-NONE-_-NONE-.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UsaspendingAwardParams holds the parameters of UsaspendingAward (GET / POST /v2/usaspending/award). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type UsaspendingSearchParams 

type UsaspendingSearchParams struct {
	// Required. Keyword or a usaspending.gov search URL. Example: software. An award URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Optional. One group: contract (default when omitted), grant, idv, or loan. Example: grant.
	AwardType *string `json:"award_type" api:"award_type"`
	// Optional. Page number from 1. Example: 2. Defaults to 1. Each page has 10 awards. total_results stays null.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

UsaspendingSearchParams holds the parameters of UsaspendingSearch (GET / POST /v2/usaspending/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type VestiairecollectiveProductParams 

type VestiairecollectiveProductParams struct {
	// A vestiairecollective.com product URL ending in the item id and .shtml. The response is one flat listing. price is the number on the page and price_display is that amount as written. A keyword or a search URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Default false. true replaces the listing with result, the rendered HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

VestiairecollectiveProductParams holds the parameters of VestiairecollectiveProduct (GET / POST /v2/vestiairecollective/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type VestiairecollectiveSearchParams 

type VestiairecollectiveSearchParams struct {
	// A keyword or a vestiairecollective.com search or category URL. Empty, another host, or a product URL returns 400. A keyword searches www.vestiairecollective.com. A full URL keeps its host. Each card has price as a number and price_display as the label on the card.
	Query string `json:"query" api:"query,required"`
	// Page number starting at 1. Omit it for page 1, which has no /p-N/ segment. Page 2 requests /p-2/ and sets pagination.page to 2. pagination.next is the next catalog URL, or null on the last page. A value below 1 returns 400.
	Page *float64 `json:"page" api:"page"`
	// Default false. true replaces results and pagination with result, the rendered HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

VestiairecollectiveSearchParams holds the parameters of VestiairecollectiveSearch (GET / POST /v2/vestiairecollective/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type VintedItemParams 

type VintedItemParams struct {
	// Vinted item URL or numeric item ID.
	Query string `json:"query" api:"query,required"`
	// Force the Vinted domain when query is a bare item ID only.
	Region *string `json:"region" api:"region"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

VintedItemParams holds the parameters of VintedItem (GET / POST /v2/vinted/item). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type VintedSearchParams 

type VintedSearchParams struct {
	// Search keyword or full Vinted catalog URL. Filters from the URL query string are forwarded to the internal Vinted API.
	Query string `json:"query" api:"query,required"`
	// Page number. Default 1.
	Page *float64 `json:"page" api:"page"`
	// Results per page. Default 24.
	PerPage *float64 `json:"per_page" api:"per_page"`
	// Optional sort order.
	Order *string `json:"order" api:"order"`
	// Force the Vinted domain when query is a keyword only.
	Region *string `json:"region" api:"region"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

VintedSearchParams holds the parameters of VintedSearch (GET / POST /v2/vinted/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type VintedUserInfoParams 

type VintedUserInfoParams struct {
	// Vinted member profile URL, direct API URL, or numeric user ID.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

VintedUserInfoParams holds the parameters of VintedUserInfo (GET / POST /v2/vinted/user/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type VivarealPropertyParams 

type VivarealPropertyParams struct {
	// Viva Real listing URL under /imovel/ with an id- number.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

VivarealPropertyParams holds the parameters of VivarealProperty (GET / POST /v2/vivareal/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type VivarealSearchParams 

type VivarealSearchParams struct {
	// City, City plus UF, or a Viva Real search URL.
	Query string `json:"query" api:"query,required"`
	// Sale or rent when query is a city. Default: "sale".
	Operation *string `json:"operation" api:"operation"`
	// Optional type when query is a city.
	PropertyType *string `json:"property_type" api:"property_type"`
	// Page from 1. Placeholder 2. Viva Real receives this as pagina=2. Page 1 and page 2 return different listings. A few featured ids can repeat. Most ids on page 2 are new.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

VivarealSearchParams holds the parameters of VivarealSearch (GET / POST /v2/vivareal/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WaitForJobOptions 

type WaitForJobOptions struct {
	Interval   time.Duration
	Timeout    time.Duration
	OnProgress func(job map[string]any)
}

WaitForJobOptions configures WaitForJob. The zero value polls after 3 s, then 1.5x longer each time up to 60 s, for up to 12 hours.

type WalmartProductParams 

type WalmartProductParams struct {
	// Full Walmart product page URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WalmartProductParams holds the parameters of WalmartProduct (GET / POST /v2/walmart/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WalmartSearchParams 

type WalmartSearchParams struct {
	// Full Walmart search results URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WalmartSearchParams holds the parameters of WalmartSearch (GET / POST /v2/walmart/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WalmartSuggestParams 

type WalmartSuggestParams struct {
	// Search keyword for Walmart autocomplete suggestions.
	Query string `json:"query" api:"query,required"`
	// Optional US ZIP code to localize Walmart store and inventory context for suggestions.
	Zipcode *string `json:"zipcode" api:"zipcode"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WalmartSuggestParams holds the parameters of WalmartSuggest (GET / POST /v2/walmart/suggest). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WebsiteAntibotParams 

type WebsiteAntibotParams struct {
	// Full URL or domain name to analyze for anti-bot protection. Must be a valid hostname.
	Query string `json:"query" api:"query,required"`
	// Maximum request timeout in seconds. Defaults to 15.
	Timeout *float64 `json:"timeout" api:"timeout"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WebsiteAntibotParams holds the parameters of WebsiteAntibot (GET /v2/website/antibot). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WebsiteCrawlerParams 

type WebsiteCrawlerParams struct {
	// A public website URL to fetch with the Crawler engine (HTTP only, no JavaScript). Must include http:// or https://.
	Query string `json:"query" api:"query,required"`
	// Controls whether the crawler should follow HTTP redirects. Default: true.
	AllowRedirects *bool `json:"allow_redirects" api:"allow_redirects"`
	// Controls whether the response returns the raw, unprocessed HTML source of the page. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WebsiteCrawlerParams holds the parameters of WebsiteCrawler (GET / POST /v2/website/crawler). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WebsiteEmailPhoneExtractorParams 

type WebsiteEmailPhoneExtractorParams struct {
	// A website URL to crawl for contact information. Must include the http:// or https:// protocol. The crawler will follow internal links ("a" anchors) to find contact details across the site.
	Query string `json:"query" api:"query,required"`
	// An ISO 3166-1 alpha-2 country code used to improve the accuracy of phone number validation and parsing.
	CountryCode *string `json:"country_code" api:"country_code"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WebsiteEmailPhoneExtractorParams holds the parameters of WebsiteEmailPhoneExtractor (GET / POST /v2/website/email_phone_extractor). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WebsiteRenderingParams 

type WebsiteRenderingParams struct {
	// A public website URL to render in a headless browser. Must include http:// or https://.
	Query string `json:"query" api:"query,required"`
	// Number of seconds to wait after page load before returning the rendered HTML. Useful for pages with delayed rendering or animations. Default: 0.
	WaitInSeconds *float64 `json:"wait_in_seconds" api:"wait_in_seconds"`
	// A CSS or XPath selector to wait for before returning the rendered HTML. The headless browser will hold the response until the specified element appears in the DOM.
	WaitFor *string `json:"wait_for" api:"wait_for"`
	// Controls whether the headless browser should block ad requests during rendering. Default: false.
	BlockAds *bool `json:"block_ads" api:"block_ads"`
	// Maximum number of seconds to wait for the page to fully load before returning whatever has been rendered so far. Default: 30.
	Timeout *float64 `json:"timeout" api:"timeout"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WebsiteRenderingParams holds the parameters of WebsiteRendering (GET / POST /v2/website/rendering). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WebsiteScreenshotParams 

type WebsiteScreenshotParams struct {
	// The URL of the webpage to capture. Examples:  https://www.amazon.com/s?k=pokemon
	URL string `json:"url" api:"url,required"`
	// The output format of the screenshot. Allowed values: jpeg, jpg, pdf, png, webp. Default: "png".
	Format *string `json:"format" api:"format"`
	// The device type to emulate for the screenshot. Allowed values: galaxy_fold4, galaxy_s23, galaxy_s23_ultra, galaxy_s8, huawei_mate_50_pro, huawei_p60_pro, ipad, iphone_12, iphone_13_mini, iphone_13_pro_max, iphone_14_pro, iphone_14_pro_max, iphone_x, pixel_5, pixel_6a, pixel_7_pro, redmi_note_11, re…
	Device *string `json:"device" api:"device"`
	// Capture the entire page instead of just the visible viewport. Default: false.
	FullPage *bool `json:"full_page" api:"full_page"`
	// Scroll the page to fully load lazy-loaded elements before capturing a full-page screenshot. Default: false.
	FullPageScroll *bool `json:"full_page_scroll" api:"full_page_scroll"`
	// Time in milliseconds for scrolling before capturing the full page. Default: 400.
	FullPageScrollDuration *float64 `json:"full_page_scroll_duration" api:"full_page_scroll_duration"`
	// The width of the browser viewport in pixels. Default: 1280.
	ViewportWidth *float64 `json:"viewport_width" api:"viewport_width"`
	// The height of the browser viewport in pixels. Default: 1024.
	ViewportHeight *float64 `json:"viewport_height" api:"viewport_height"`
	// The scale factor for high-resolution screenshots. Default: 1.
	ScaleFactor *float64 `json:"scale_factor" api:"scale_factor"`
	// Generate images with custom quality settings. Default: "80".
	ImageQuality *string `json:"image_quality" api:"image_quality"`
	// Capture a specific element on the page instead of the full viewport.
	Selector *string `json:"selector" api:"selector"`
	// Cache the response. Default: false.
	Cache *bool `json:"cache" api:"cache"`
	// Cache the response for a custom TTL (in seconds). Default: 2592000.
	CacheTTL *float64 `json:"cache_ttl" api:"cache_ttl"`
	// A comma-separated list of elements to hide before capturing (e.g., ads, popups).
	RemoveSelectors *string `json:"remove_selectors" api:"remove_selectors"`
	// Automatically remove cookie banners before capturing. Default: false.
	RemoveCookieBanners *bool `json:"remove_cookie_banners" api:"remove_cookie_banners"`
	// Automatically remove ads before capturing. Default: false.
	RemoveAds *bool `json:"remove_ads" api:"remove_ads"`
	// Comma-separated list of resource types to block (e.g., “image,stylesheet,font”). Allowed values: document, eventsource, fetch, font, image, manifest, media, other, script, stylesheet, texttrack, websocket, xhr.
	BlockResources *string `json:"block_resources" api:"block_resources"`
	// Comma-separated list of URL patterns to block (e.g., “analytics,tracking,advertisement”).
	BlockUrls *string `json:"block_urls" api:"block_urls"`
	// Delay in seconds before capturing the screenshot. Default: 0.
	Delay *float64 `json:"delay" api:"delay"`
	// Define when to capture. Allowed values: domcontentloaded, load, networkidle0, networkidle2.
	WaitUntil []string `json:"wait_until" api:"wait_until"`
	// Wait for a specific element to appear before taking the screenshot.
	WaitForSelector *string `json:"wait_for_selector" api:"wait_for_selector"`
	// Specify a proxy server to route your request through.
	Proxy *string `json:"proxy" api:"proxy"`
	// AWS S3 secret access key.
	S3SecretKey *string `json:"s3_secret_key" api:"s3_secret_key"`
	// AWS S3 access key ID.
	S3AccessKeyID *string `json:"s3_access_key_id" api:"s3_access_key_id"`
	// The S3 bucket name where the screenshot will be uploaded.
	S3Bucket *string `json:"s3_bucket" api:"s3_bucket"`
	// The filename for the S3 object (auto-generated if not provided).
	S3ObjectKey *string `json:"s3_object_key" api:"s3_object_key"`
	// AWS S3 region for storage.
	S3Region *string `json:"s3_region" api:"s3_region"`
	// Leave this field empty for AWS S3. Only specify a value if required. S3-compatible storage services are supported, for example, use https://<accountId>.r2.cloudflarestorage.com for Cloudflare R2.
	StorageEndpoint *string `json:"storage_endpoint" api:"storage_endpoint"`
	// Use S3 storage for screenshots. The S3 URL will be returned in the response. Default: false.
	S3URL *bool `json:"s3_url" api:"s3_url"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WebsiteScreenshotParams holds the parameters of WebsiteScreenshot (GET / POST /v2/website/screenshot). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WebsiteTechnologyParams 

type WebsiteTechnologyParams struct {
	// A website URL to analyze for technology stack detection. Must include the http:// or https:// protocol.
	Query string `json:"query" api:"query,required"`
	// Controls the level of detail returned in the technology detection response. Default: "expert".
	Mode *string `json:"mode" api:"mode"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WebsiteTechnologyParams holds the parameters of WebsiteTechnology (GET / POST /v2/website/technology). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WebsiteWebunlockerParams 

type WebsiteWebunlockerParams struct {
	// A public website URL to unlock with the WebUnlocker engine. Must include http:// or https://. The target domain must be on Piloterr's approved whitelist.
	Query string `json:"query" api:"query,required"`
	// Controls whether the WebUnlocker engine should follow HTTP redirects. Default: true.
	AllowRedirects *bool `json:"allow_redirects" api:"allow_redirects"`
	// Controls whether the response returns the raw, unprocessed HTML source of the page. Default: false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WebsiteWebunlockerParams holds the parameters of WebsiteWebunlocker (GET / POST /v2/website/webunlocker). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WeiboPostInfoParams 

type WeiboPostInfoParams struct {
	// Weibo post id.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WeiboPostInfoParams holds the parameters of WeiboPostInfo (GET / POST /v2/weibo/post/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WeiboSearchParams 

type WeiboSearchParams struct {
	// Keywords to search, such as AI.
	Query string `json:"query" api:"query,required"`
	// Page number, starting at 1. Default 1. Page 2 is the next slice of the same keywords. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WeiboSearchParams holds the parameters of WeiboSearch (GET / POST /v2/weibo/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WelcometothejungleCompanyParams 

type WelcometothejungleCompanyParams struct {
	// Slug, company name, or a Welcome to the Jungle company URL.
	Query string `json:"query" api:"query,required"`
	// fr (default) or en. en-gb and en-us count as en. Chooses the language of the profile text and URL. Default: "fr".
	Language *string `json:"language" api:"language"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WelcometothejungleCompanyParams holds the parameters of WelcometothejungleCompany (GET / POST /v2/welcometothejungle/company). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WelcometothejungleSearchParams 

type WelcometothejungleSearchParams struct {
	// Job keyword or a Welcome to the Jungle jobs-search URL.
	Query string `json:"query" api:"query,required"`
	// fr (default) or en. en-gb and en-us count as en. A /fr/ or /en/ path in the URL overrides this. Default: "fr".
	Language *string `json:"language" api:"language"`
	// Page from 1, 30 offers. A page value already in the URL overrides this.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WelcometothejungleSearchParams holds the parameters of WelcometothejungleSearch (GET / POST /v2/welcometothejungle/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type WellfoundCompanyInfoParams 

type WellfoundCompanyInfoParams struct {
	// A Wellfound company URL or company slug.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

WellfoundCompanyInfoParams holds the parameters of WellfoundCompanyInfo (GET / POST /v2/wellfound/company/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type XPostInfoParams 

type XPostInfoParams struct {
	// X tweet to retrieve. Accepts a full status URL or numeric tweet ID.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

XPostInfoParams holds the parameters of XPostInfo (GET / POST /v2/x/post/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type XProfileInfoParams 

type XProfileInfoParams struct {
	// X profile to look up. Accepts a username, @handle, or profile URL.
	Query string `json:"query" api:"query,required"`
	// When true, return the raw HTML page source as {"result": "..."} instead of structured JSON. Defaults to false.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

XProfileInfoParams holds the parameters of XProfileInfo (GET / POST /v2/x/profile/info). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type YahooSearchParams 

type YahooSearchParams struct {
	// Search query sent to Yahoo Search.
	Query string `json:"query" api:"query,required"`
	// Page number. Page 1 is the first page of results. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Country code, for example us, fr, gb, de, jp.
	Gl *string `json:"gl" api:"gl"`
	// Language code, for example en, fr, de, ja, zh.
	Hl *string `json:"hl" api:"hl"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

YahooSearchParams holds the parameters of YahooSearch (GET / POST /v2/yahoo/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type YellowpagesBusinessParams 

type YellowpagesBusinessParams struct {
	// Full Yellow Pages business listing URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

YellowpagesBusinessParams holds the parameters of YellowpagesBusiness (GET / POST /v2/yellowpages/business). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type YellowpagesSearchParams 

type YellowpagesSearchParams struct {
	// Full Yellow Pages search URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

YellowpagesSearchParams holds the parameters of YellowpagesSearch (GET / POST /v2/yellowpages/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type YelpBusinessParams 

type YelpBusinessParams struct {
	// Full Yelp business URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

YelpBusinessParams holds the parameters of YelpBusiness (GET / POST /v2/yelp/business). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type YelpReviewsParams 

type YelpReviewsParams struct {
	// Yelp business ID / encid.
	Query string `json:"query" api:"query,required"`
	// Page number. Each page returns up to 10 reviews. Default: 1. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

YelpReviewsParams holds the parameters of YelpReviews (GET / POST /v2/yelp/reviews). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type YelpSearchParams 

type YelpSearchParams struct {
	// Full Yelp search URL with find_desc and find_loc query parameters.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

YelpSearchParams holds the parameters of YelpSearch (GET / POST /v2/yelp/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZapimoveisAdParams 

type ZapimoveisAdParams struct {
	// Full Zap Imóveis listing URL. Accepts /imovel/ and /lancamentos/.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZapimoveisAdParams holds the parameters of ZapimoveisAd (GET / POST /v2/zapimoveis/ad). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZapimoveisSearchParams 

type ZapimoveisSearchParams struct {
	// City, City, UF, neighborhood, or full Zap Imóveis search URL.
	Query string `json:"query" api:"query,required"`
	// Transaction type. Used when query is a city. Ignored as a path builder when query is a full URL. Default: "sale".
	Operation *string `json:"operation" api:"operation"`
	// Property type. Used when query is a city.
	PropertyType *string `json:"property_type" api:"property_type"`
	// Page number (1-based). Default: 1. Values above 1 set pagina on the URL. Default: 1.
	Page *float64 `json:"page" api:"page"`
	// Minimum asking price in BRL.
	MinPrice *float64 `json:"min_price" api:"min_price"`
	// Maximum asking price in BRL.
	MaxPrice *float64 `json:"max_price" api:"max_price"`
	// Minimum area in m².
	MinArea *float64 `json:"min_area" api:"min_area"`
	// Maximum area in m².
	MaxArea *float64 `json:"max_area" api:"max_area"`
	// Minimum bedroom count.
	MinBedrooms *float64 `json:"min_bedrooms" api:"min_bedrooms"`
	// Minimum bathroom count.
	MinBathrooms *float64 `json:"min_bathrooms" api:"min_bathrooms"`
	// Minimum parking spaces.
	MinParking *float64 `json:"min_parking" api:"min_parking"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZapimoveisSearchParams holds the parameters of ZapimoveisSearch (GET / POST /v2/zapimoveis/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZazzleProductParams 

type ZazzleProductParams struct {
	// Required. Product URL or slug ending in the numeric product id. Example: https://www.zazzle.com/branded_logo_two_tone_coffee_mug-256528848440338952.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZazzleProductParams holds the parameters of ZazzleProduct (GET / POST /v2/zazzle/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZazzleSearchParams 

type ZazzleSearchParams struct {
	// Required. Keyword or a zazzle.com/s search URL. Example: coffee mug. A product URL returns 400.
	Query string `json:"query" api:"query,required"`
	// Optional. Page number from 1. Example: 2. Maps to the Zazzle pg parameter. Defaults to 1.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZazzleSearchParams holds the parameters of ZazzleSearch (GET / POST /v2/zazzle/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZillowPropertyParams 

type ZillowPropertyParams struct {
	// Full Zillow homedetails URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZillowPropertyParams holds the parameters of ZillowProperty (GET / POST /v2/zillow/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZillowSearchParams 

type ZillowSearchParams struct {
	// Full Zillow search or map results URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZillowSearchParams holds the parameters of ZillowSearch (GET / POST /v2/zillow/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZonapropPropertyParams 

type ZonapropPropertyParams struct {
	// ZonaProp listing URL under /propiedades/clasificado/.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZonapropPropertyParams holds the parameters of ZonapropProperty (GET / POST /v2/zonaprop/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZonapropSearchParams 

type ZonapropSearchParams struct {
	// Place or a ZonaProp search URL.
	Query string `json:"query" api:"query,required"`
	// Sale or rent when query is a place.
	Operation *string `json:"operation" api:"operation"`
	// Kind of property. Default departamentos.
	PropertyType *string `json:"property_type" api:"property_type"`
	// Page from 1. ZonaProp writes this into the path as -pagina-N.html.
	Page *float64 `json:"page" api:"page"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZonapropSearchParams holds the parameters of ZonapropSearch (GET / POST /v2/zonaprop/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZooplaPropertyParams 

type ZooplaPropertyParams struct {
	// Full Zoopla property detail URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZooplaPropertyParams holds the parameters of ZooplaProperty (GET / POST /v2/zoopla/property). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZooplaSearchParams 

type ZooplaSearchParams struct {
	// Full Zoopla search results URL.
	Query string `json:"query" api:"query,required"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZooplaSearchParams holds the parameters of ZooplaSearch (GET / POST /v2/zoopla/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZooplusProductParams 

type ZooplusProductParams struct {
	// A product link, a /shop/.../{id} path, or the product number.
	Query string `json:"query" api:"query,required"`
	// Which country shop when query is a number or a path. fr is France (default). de is Germany. uk is the United Kingdom. Default: "fr".
	Region *string `json:"region" api:"region"`
	// Set to true to get the raw HTML in result instead of the product.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZooplusProductParams holds the parameters of ZooplusProduct (GET / POST /v2/zooplus/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZooplusSearchParams 

type ZooplusSearchParams struct {
	// What to look for. A word, or a Zooplus search link.
	Query string `json:"query" api:"query,required"`
	// Which country shop. fr is France (default, www.zooplus.fr). de is Germany (www.zooplus.de). uk is the United Kingdom (www.zooplus.co.uk). Default: "fr".
	Region *string `json:"region" api:"region"`
	// Which page of results, starting at 1. Page 2 uses p=2 and returns different products.
	Page *float64 `json:"page" api:"page"`
	// Set to true to get the raw HTML in result instead of the product list.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZooplusSearchParams holds the parameters of ZooplusSearch (GET / POST /v2/zooplus/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZoroProductParams 

type ZoroProductParams struct {
	// Zoro product URL, or a path that contains /i/G....
	Query string `json:"query" api:"query,required"`
	// When true, return the rendered HTML as {"result": "..."} instead of JSON.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZoroProductParams holds the parameters of ZoroProduct (GET / POST /v2/zoro/product). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

type ZoroSearchParams 

type ZoroSearchParams struct {
	// Keyword, or a Zoro search or category URL. Empty, another host, or a product URL returns 400. A keyword builds /search?q=.... Each card has price as a USD number and price_display as the dollar string.
	Query string `json:"query" api:"query,required"`
	// Page number starting at 1. Omit it for page 1. Page 2 adds page=2, sets pagination.page to 2, and returns the next cards. pagination.next is the next page URL, or null on the last page. A value below 1 returns 400.
	Page *float64 `json:"page" api:"page"`
	// Default false. true replaces results and pagination with result, the rendered HTML.
	ReturnPageSource *bool `json:"return_page_source" api:"return_page_source"`
	// Comma-separated list of fields to keep in the response, with dot notation for nested fields (e.g. name,location.city). Does not change the credit cost.
	Fields *string `json:"fields" api:"fields"`
	// Process the request asynchronously: the response is a job_id to poll on /v1/jobs/{id} (see waitForJob). Default: false.
	IsAsync *bool `json:"is_async" api:"is_async"`
	// Return HTTP 200 even when an error occurs; the error is then in the response body. Default: false.
	SoftFail *bool `json:"soft_fail" api:"soft_fail"`
}

ZoroSearchParams holds the parameters of ZoroSearch (GET / POST /v2/zoro/search). Required fields are plain values; optional fields are pointers (use piloterr.String, piloterr.Float, piloterr.Bool) or nil slices and maps.

Source Files

View all Source files

Directories

Path Synopsis
examples
binary command
json command
request command
wait-for-job command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.