Getting Started with Litescrape's APIs

Required Google Place ID. Every response is fetched live.

Google interface and result language.

Two-letter country localization code.

A Google domain such as google.com or google.co.uk.

Required hexadecimal Maps feature ID. Follow posts_link from a Maps place response.

Google interface and result language.

Two-letter country localization code.

A Google domain such as google.com or google.co.uk.

Continue a posts response with its opaque token.

Required Google Maps photo ID. Follow photo_meta_link from a Maps place response.

Google interface and result language.

Two-letter country localization code.

A Google domain such as google.com or google.co.uk.

Google Search query, up to 2,048 characters.

• Required unless ludocid, kgmid, or page_token is supplied.
• Maximum characters: 2048

Return organic results only, skipping AI Overview and all other result groups.

• Keeps search metadata and parameters. Omits cross-module position_absolute.

Google local CID used to search for one entity.

• Maximum characters: 128
• Pattern: ^\d+$

Google Knowledge Graph machine ID, such as /m/0k8z.

• Maximum characters: 512

Human-readable city-level location encoded to UULE by Litescrape.

• Conflicts with uule and lat/lon.
• Maximum characters: 512

Pre-encoded Google location value.

• Conflicts with location and lat/lon.
• Maximum characters: 2048

Latitude from -90 through 90.

• Requires lon and conflicts with location and uule.
• Minimum: -90
• Maximum: 90

Longitude from -180 through 180.

• Requires lat and conflicts with location and uule.
• Minimum: -180
• Maximum: 180

Decimal search-bias radius in meters.

• Requires location or lat/lon.
• Desktop: 1–199; tablet/mobile: 1–1,000.
• Minimum: 1
• Maximum: 1000

Opaque Knowledge Graph or local-pack signature.

• Maximum characters: 4096

Opaque cached Google search context.

• Maximum characters: 4096

Google layout or expansion control.

• Maximum characters: 4096

Opaque Google filter token.

• Maximum characters: 4096

Google result color presentation.

Opaque token from pagination.next_page_token. Send it alone to fetch the next page with the original search parameters.

• Prefer page_token to repeating the same search with start=10, start=20, or another offset.
• Send the token as soon as possible and no later than 5 minutes after receiving it.
• Available for ordinary Google Search, including fast mode; not available for tbm verticals.
• search_metadata.continuation is followed for a direct request.
• If Google omits a required link or the deadline expires, the request fails without billing.

Results use google.com. Use gl, hl, cr, lr or geography for localization.

Lowercase two-letter country localization code.

• Pattern: ^[a-z]{2}$

Google interface and result language code.

• Pattern: ^[a-z]{2,3}(?:-[A-Za-z]{2,8})?$

One or more countryXX restrictions joined with |.

• Pattern: ^country[A-Z]{2}(?:\|country[A-Z]{2})*$

One or more lang_xx restrictions joined with |.

• Pattern: ^lang_[a-z]{2,3}(?:\|lang_[a-z]{2,3})*$

Google native date or search filter string.

• Maximum characters: 4096

Google adult-content filtering.

Google auto-correction control.

Google similar-result filtering control.

Google personalization control; 0 asks for non-personalized results.

Google personalization peek flag, forwarded unchanged.

Google vertical: lcl, vid, nws, shop, or pts. For image searches, use /api/google/images.

Non-negative Google result offset.

• Prefer page_token to repeating the same search with start=10, start=20, or another offset.
• Minimum: 0

Request device profile and radius bound.

Best-effort first-page result count, 1 to 10.

• Minimum: 1
• Maximum: 10

Includes or excludes as_sitesearch.

• Requires as_sitesearch.

Exact phrase query.

• Maximum characters: 2048

Excluded phrase query.

• Maximum characters: 2048

Require results that link to this URL.

• Maximum characters: 4096

Inclusive range lower bound.

• Requires as_nhi.
• Minimum: 0

Inclusive range upper bound.

• Requires as_nlo.
• Minimum: 0

Any-of search terms.

• Maximum characters: 2048

Additional all-of search terms.

• Maximum characters: 2048

Quick range d, w, m, or y with an optional positive count.

• Pattern: ^[dwmy](?:[1-9][0-9]*)?$

Find pages related to this URL.

• Maximum characters: 4096

Site hostname to include or exclude.

• Maximum characters: 253

Original query associated with an autocomplete selection.

• Maximum characters: 2048

Google gs_lp value associated with an autocomplete selection.

• Maximum characters: 4096

Google client identifier such as gws-wiz-serp.

• Maximum characters: 64
• Pattern: ^[A-Za-z0-9._-]+$

Google Search query, up to 2,048 characters.

• Required unless ludocid or kgmid is supplied.
• Maximum characters: 2048

Google local CID used to search for one entity.

• Maximum characters: 128
• Pattern: ^\d+$

Google Knowledge Graph machine ID, such as /m/0k8z.

• Maximum characters: 512

Human-readable city-level location encoded to UULE by Litescrape.

• Conflicts with uule and lat/lon.
• Maximum characters: 512

Pre-encoded Google location value.

• Conflicts with location and lat/lon.
• Maximum characters: 2048

Latitude from -90 through 90.

• Requires lon and conflicts with location and uule.
• Minimum: -90
• Maximum: 90

Longitude from -180 through 180.

• Requires lat and conflicts with location and uule.
• Minimum: -180
• Maximum: 180

Decimal search-bias radius in meters.

• Requires location or lat/lon.
• Desktop: 1–199; tablet/mobile: 1–1,000.
• Minimum: 1
• Maximum: 1000

Opaque Knowledge Graph or local-pack signature.

• Maximum characters: 4096

Opaque cached Google search context.

• Maximum characters: 4096

Google layout or expansion control.

• Maximum characters: 4096

Opaque Google filter token.

• Maximum characters: 4096

Google result color presentation.

Results use google.com. Use gl, hl, cr, lr or geography for localization.

Lowercase two-letter country localization code.

• Pattern: ^[a-z]{2}$

Google interface and result language code.

• Pattern: ^[a-z]{2,3}(?:-[A-Za-z]{2,8})?$

One or more countryXX restrictions joined with |.

• Pattern: ^country[A-Z]{2}(?:\|country[A-Z]{2})*$

One or more lang_xx restrictions joined with |.

• Pattern: ^lang_[a-z]{2,3}(?:\|lang_[a-z]{2,3})*$

Google native date or search filter string.

• Maximum characters: 4096

Google adult-content filtering.

Google auto-correction control.

Google similar-result filtering control.

Google personalization control; 0 asks for non-personalized results.

Google personalization peek flag, forwarded unchanged.

Google vertical: lcl, vid, nws, shop, or pts. For image searches, use /api/google/images.

Non-negative Google result offset.

• Minimum: 0

Request device profile and radius bound.

Best-effort first-page result count, 1 to 10.

• Minimum: 1
• Maximum: 10

Includes or excludes as_sitesearch.

• Requires as_sitesearch.

Exact phrase query.

• Maximum characters: 2048

Excluded phrase query.

• Maximum characters: 2048

Require results that link to this URL.

• Maximum characters: 4096

Inclusive range lower bound.

• Requires as_nhi.
• Minimum: 0

Inclusive range upper bound.

• Requires as_nlo.
• Minimum: 0

Any-of search terms.

• Maximum characters: 2048

Additional all-of search terms.

• Maximum characters: 2048

Quick range d, w, m, or y with an optional positive count.

• Pattern: ^[dwmy](?:[1-9][0-9]*)?$

Find pages related to this URL.

• Maximum characters: 4096

Site hostname to include or exclude.

• Maximum characters: 253

Original query associated with an autocomplete selection.

• Maximum characters: 2048

Google gs_lp value associated with an autocomplete selection.

• Maximum characters: 4096

Google client identifier such as gws-wiz-serp.

• Maximum characters: 64
• Pattern: ^[A-Za-z0-9._-]+$

Product query, up to 2,048 characters with no controls. Optional when a shoprs token is supplied.

Google refinement token from a previous response, up to 4,096 characters. An explicit refinement replaces the one it carries.

Result offset from 0 through 1,000.

1 through 100. Responses are capped to this count and transparently consume Google’s fixed 40-product pages when needed.

Lower price bound, 0 through 1,000,000,000. Excludes the other refinements.

Upper price bound, at or above min_price. Excludes the other refinements.

Price low to high, price high to low, rating high to low, or Google’s default relevance. Combines with one refinement.

Only products with free shipping. Excludes the other refinements.

Only products Google marks as on sale. Excludes the other refinements.

Only products from small businesses. Excludes the other refinements.

Named search origin, up to 512 characters and 63 UTF-8 bytes once encoded. Conflicts with uule.

Canonical Google location token, up to 2,048 characters. Conflicts with location.

Validated first-party Google domain.

Two-letter country code, normalized to lowercase.

Language code such as en, en-GB, or de.

Google returns its real layout for the selected device.

Text prompt for a new or continued Gemini conversation, up to 32,000 characters.

• Text only. Use subsequent_request_token to continue a conversation. Uploads, Google account cookies and model selection are not accepted.
• Minimum characters: 1
• Maximum characters: 32000

Gemini web interface language code. Defaults to en; request a reply language in the prompt.

• Pattern: ^[a-zA-Z]{2,3}(?:-[a-zA-Z]{2,4})?$

Return a subsequent_request_token for continuing this conversation. Defaults to false.

• Set to true on the first request and on each follow-up that needs another token.

Token from the previous reply. Send it with your next prompt using the same API key.

• Use the newest token for each follow-up. Tokens expire one hour after they are issued; an upstream conversation can become unavailable sooner.
• Treat tokens as sensitive. Invalid, expired or unavailable continuations fail without starting a new conversation and are not billed.
• Minimum characters: 1
• Maximum characters: 32768

The question to ask Google AI Mode, up to 2,048 characters with no controls.

Named search origin, up to 512 characters and 63 UTF-8 bytes once Google-encoded. Conflicts with uule.

Canonical Google location token, up to 2,048 characters. Conflicts with location.

Return a subsequent_request_token so this answer can be followed up.

Continue a conversation from a previous continuable response. Requires a new question, and cannot be combined with image_url. Expires after 30 minutes.

Public http or https image to include in the prompt, up to 2,048 characters and 20 MB. Google Lens receives the image; the answer still comes from AI Mode.

Validated first-party Google domain the request is served from.

Two-letter country localization, normalized to lowercase.

Language code such as en, en-GB, or de.

Google returns its real layout for the selected device.

The search term this product was found with, up to 2,048 characters. Google resolves the product viewer against it as well as the identifiers.

Product cluster ID from a shopping result, 1 to 20 decimal digits. Optional when a prds token is supplied.

• Every Shopping result with a gpcid includes a ready-made litescrape_product_link.

Headline merchant offer document ID from the same shopping result, 1 to 20 decimal digits. Goes with gpcid rather than prds.

Image document ID from the same shopping result, 1 to 20 decimal digits. Goes with gpcid rather than prds.

Google product selector token from a previous response, up to 2,048 characters. Conflicts with gpcid and the identifiers above.

Named search origin, up to 512 characters and 63 UTF-8 bytes once encoded. Conflicts with uule.

Canonical Google location token, up to 2,048 characters. Conflicts with location.

Validated first-party Google domain.

Two-letter country code, normalized to lowercase.

Language code such as en, en-GB, or de.

Google returns its real layout for the selected device.

Bing search query after trimming.

• Accepted length: 1 through 2,048 characters.
• Control characters are rejected.
• Bing query syntax such as quoted phrases and exclusions remains available.

Selects the Bing web-search engine.

Named city-level origin used to localize the Bing request.

• Maximum length: 256 characters.
• Control characters are rejected.

Latitude from -90 through 90.

• May be supplied independently or with lon.

Longitude from -180 through 180.

• May be supplied independently or with lat.

Case-insensitive Bing language-country market token.

• Format: two-letter language and country, such as en-US.
• Cannot be combined with cc.

Case-insensitive two-letter country of origin.

• Format: US or GB.
• Cannot be combined with mkt.

One-based native offset for organic results.

• Range: 1 through 9,007,199,254,740,991.
• Prefer litescrape_pagination.next when it is returned.

Bing adult-content policy; values are case-insensitive.

Native Bing display or date filter expression.

• Maximum length: 8,192 characters.
• Control characters are rejected.

Selects desktop, tablet, or mobile result behavior.

The business, category, address, or natural-language query to search. Required when type is search.

• Examples: coffee shops in Austin, dentist near Denver

Chooses a result search or an exact place response. Required for query and filter searches.

• Use place when sending an exact-place data sequence.

A complete viewport containing latitude, longitude, and either zoom or radius.

• Format: @lat,lon,14z or @lat,lon,5000m

A named geographic location resolved by the API. Cannot be combined with ll or lat/lon.

• Requires z or m.

Latitude for a coordinate-based viewport. Must be supplied with lon and either z or m.

Longitude for a coordinate-based viewport. Must be supplied with lat and either z or m.

Google Maps zoom level for location or lat/lon geography.

• Accepted range: 3 through 30.
• Cannot be combined with m.

Search radius in meters for location or lat/lon geography.

• Accepted range: 1 through 15,028,132.
• Cannot be combined with z.

Uses the supplied geography as a nearby-search scope.

• Requires ll, location, or a lat/lon pair.

A Google Maps protobuf parameter sequence for search filters or an exact place.

• Maximum length: 8,192 characters.
• Exact-place data requires type=place.

A Google place identifier used to resolve one exact place or request live foot traffic.

• Cannot be combined with data_cid or exact-place data on the primary Maps endpoint.
• It is the only required parameter on /api/google/maps/popular-times.
• Every response is fetched live; places without published data return popular_times: null.

A decimal Google CID used to resolve one exact place.

• Cannot be combined with place_id or exact-place data.

Language used for Google Maps labels and returned text.

• Examples: en, es, fr, de

Two-letter country code used for regional result localization.

• Examples: us, gb, ca, au

Validated Google domain used for the request.

• Examples: google.com, google.co.uk, google.ca

Minimum price level for returned places.

• Must be non-negative and cannot exceed max_price.

Maximum price level for returned places.

• Must be non-negative and cannot be lower than min_price.

Preferred minimum Google rating.

• Google treats this as a relevance preference.

Filters by the current open state.

• Cannot be combined with open_on_day or open_at_hour.

Filters for places open on a specific day.

Filters for places open at a specific hour using 24-hour time.

• Accepted range: 0 through 23.
• Requires open_on_day.

Native Maps result offset: 0, 20, 40, and so on. Each request returns up to 20 places and each successful request costs one credit.

• Use pagination.next when it is present instead of constructing the next request manually.

One or more Apple Maps unique place identifiers.

• Separate multiple identifiers with commas.
• Accepted batch size: 1 through 50 unsigned 64-bit decimal IDs.
• Example: 4372355869446211302.

Controls Apple Maps language and regional formatting.

• Examples: en-US, fr-FR, ja-JP, and zh-TW.

Hexadecimal Google Maps feature identifier.

• Format: 0x123:0x456
• Exactly one of data_id or place_id is required.

Google place identifier for the business whose reviews should be returned.

• Exactly one of place_id or data_id is required.

Language used for returned review labels and place context.

Lowercase two-letter country code used for regional localization.

Controls the order of returned reviews.

Returns reviews associated with a topic ID from the topics response group.

• Cannot be combined with query.

Returns reviews matching a free-text query.

• Cannot be combined with topic_id.

Requested number of unique reviews to return.

• Initial unfiltered requests accept 1 through 100; the default remains eight.
• Requests return one response with up to the requested number of available reviews.
• Filtered and continuation requests accept 1 through 20.

Includes additional review-provider icon and scale metadata when available.

Opaque continuation token from pagination.next_page_token.

• Pass the token back unchanged.
• Continuation requests default to ten reviews unless num is provided.

Job search query, for example software engineer jobs in New York.

• Minimum characters: 1
• Maximum characters: 512

One-based results page. Use next_page from the response to continue.

• Minimum: 1

Copy next_page_token with next_page and the same query to fetch the next batch directly.

• Minimum characters: 1
• Maximum characters: 32768
• Pattern: ^[A-Za-z0-9+/=_-]+$

Google interface language, for example en, de, fr, es or pt-BR.

• Pattern: ^[a-z]{2,3}(?:-[A-Za-z]{2,8})?$

Two-letter country code.

• Pattern: ^[a-z]{2}$

Canonical Google location, such as London,England,United Kingdom. Use one of location, uule or lat/lon.

• Minimum characters: 1
• Maximum characters: 512

Explicit Google UULE location value. Mutually exclusive with location and coordinates.

• Minimum characters: 1
• Maximum characters: 2048

Latitude of the search origin. Requires lon.

• Minimum: -90
• Maximum: 90

Longitude of the search origin. Requires lat.

• Minimum: -180
• Maximum: 180

Coordinate accuracy radius in meters, requiring lat/lon. This locates the search origin; it is not a job-distance filter.

• Minimum: 1
• Maximum: 199

Opaque Google refinement value returned in available_filters. Copy its q and uds together; filter choices vary by query and market.

• Minimum characters: 1
• Maximum characters: 16384

Google search refinement string, for example qdr:w for the past week. Keep it unchanged through pagination.

• Minimum characters: 1
• Maximum characters: 2048

Return available Google Jobs filters with the q and uds parameters needed to apply each one.

Job title, keywords or company. Omit to browse using only location and filters.

• Minimum characters: 1
• Maximum characters: 512

One-based results page. Use next_page from the response to continue.

• Minimum: 1

Free-text city, state, country or postal code. Use location_id and location_type for an exact location instead.

• Minimum characters: 1
• Maximum characters: 512

Copy next_page_token with its next_page and the same search parameters to continue.

• Minimum characters: 1
• Maximum characters: 32768
• Pattern: ^[A-Za-z0-9+/=_-]+$

Glassdoor location ID, for example 1132348 for New York. Omit for nationwide search.

• Minimum: 1

Location type: C city, S state, N country. Required with location_id.

Restrict the free-text location to this two-letter country, for example GB for London, England. Requires location.

• Pattern: ^[A-Z]{2}$

Distance in miles; 0 means the exact location. Defaults to 25.

• Minimum: 0
• Maximum: 100

Employment type. Use job_types to select multiple types.

Employment attribute codes as a JSON array, for example ["CF3CP","NJXCK"]. Mutually exclusive with job_type. Codes are returned by include_filters.

• Minimum items: 1
• Maximum items: 100

Maximum posting age in days.

• Minimum: 1
• Maximum: 30

Minimum annual salary in the search location's currency.

• Minimum: 0

Maximum annual salary in the search location's currency.

• Minimum: 0

True selects work-from-home or remote jobs. False includes all workplace types.

True selects Easy Apply jobs. False includes all application types.

Seniority filter.

Glassdoor employer ID; include_filters returns matching employer IDs.

• Minimum: 1

Employer size categories as a JSON array: 1 tiny, 2 small, 3 medium, 4 large, 5 huge.

• Minimum items: 1
• Maximum items: 100

Glassdoor industry ID; available values depend on the search and are returned by include_filters.

• Minimum: 1

Glassdoor occupation category, such as 1007 Engineering. See include_filters.

• Minimum: 1

Refine the search to a city ID from include_filters.

• Minimum: 1

Minimum employer rating.

• Minimum: 0
• Maximum: 5

Relevance, oldest first, or newest first.

Return available filters, values, counts and employer names in available_filters.

Job title, keywords, company or Indeed query syntax. Omit to browse using only location and filters.

• Minimum characters: 1
• Maximum characters: 512

One-based results page. Use next_page from the response to continue.

• Minimum: 1

Continuation token from next_page_token. Use it with next_page and unchanged search parameters.

• Minimum characters: 1
• Maximum characters: 32768
• Pattern: ^[A-Za-z0-9+/=_-]+$

City, state, ZIP code, or Remote.

• Minimum characters: 1
• Maximum characters: 512

Search radius in radius_unit units; 0 means exact location.

• Minimum: 0
• Maximum: 100

Distance unit for the location radius.

Two-letter Indeed market, for example US, CA, GB, DE or AU.

• Pattern: ^[A-Z]{2}$

Indeed locale, such as fr-CA or de-DE. Defaults to en-{country}; set the language for non-English searches.

• Pattern: ^[a-z]{2,3}-[A-Z]{2}$

Jobs requested per page. Results may contain fewer jobs; use next_page_token to continue.

• Minimum: 1
• Maximum: 100

Result ordering.

Maximum age in days since the job appeared on Indeed.

• Minimum: 1

Employment type filter.

Filter for remote or hybrid jobs.

Require Indeed Apply.

Education level filter.

Require jobs marked No Experience Required.

Filter for entry, mid or senior level jobs.

Minimum annualized base salary in the market's currency.

• Minimum: 0

Maximum annualized base salary in the market's currency.

• Minimum: 0

Minimum required experience in months.

• Minimum: 0

Maximum required experience in months.

• Minimum: 0

Language of the job posting, independent of the response locale.

• Pattern: ^[a-z]{2,3}$

Encoded Indeed employer keys as a JSON array. Names are not keys; company names can be searched in q using company:name.

• Minimum items: 1
• Maximum items: 100

Require all of these Indeed attribute codes (JSON array), covering skills, benefits, shifts, licenses, clearances and employment types. Codes and labels are included on returned jobs.

• Minimum items: 1
• Maximum items: 100

Require any of these Indeed attribute codes (JSON array), combined with all other supplied filters.

• Minimum items: 1
• Maximum items: 100

Case-insensitive phrase in title or description.

• Minimum characters: 1
• Maximum characters: 512

One-based results page. Use next_page from the response to continue.

• Minimum: 1

Employer board name from jobs.ashbyhq.com/{board}, for example ashby.

• Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$

Case-insensitive phrase in primary or secondary locations.

• Minimum characters: 1
• Maximum characters: 512

Case-insensitive department name.

• Minimum characters: 1
• Maximum characters: 512

Exact team name, case-insensitive.

• Minimum characters: 1
• Maximum characters: 512

Employer's workplace type.

Country from a primary or secondary postal address, for example USA. Exact case-insensitive match.

• Minimum characters: 1
• Maximum characters: 512

State or province from a primary or secondary postal address. Exact case-insensitive match.

• Minimum characters: 1
• Maximum characters: 512

City from a primary or secondary postal address. All supplied address filters must match the same address.

• Minimum characters: 1
• Maximum characters: 512

True selects remote jobs. False selects non-remote jobs.

Employment type.

Results per page.

• Minimum: 1
• Maximum: 100

Include published compensation tiers and salary ranges.

Job title, keywords or company; omit to browse.

• Minimum characters: 1
• Maximum characters: 512

One-based results page. Use next_page from the response to continue.

• Minimum: 1

Company slug, such as google.

• Pattern: ^[a-z0-9][a-z0-9-]{0,127}$

Levels.fyi location slug, such as united-states; not a free-text city name.

• Pattern: ^[a-z0-9][a-z0-9-]{0,127}$

Result ordering.

Companies per page; jobs are grouped by company.

• Minimum: 1
• Maximum: 20

Maximum matching jobs included for each company.

• Minimum: 1
• Maximum: 15

Company slugs as a JSON array; mutually exclusive with company. A single company advances jobs instead of company groups.

• Minimum items: 1
• Maximum items: 100

City, state or country slugs as a JSON array, such as ["united-states","canada"]. Mutually exclusive with location.

• Minimum items: 1
• Maximum items: 100

Job-family slugs as a JSON array, such as ["software-engineer"].

• Minimum items: 1
• Maximum items: 100

Standard seniority levels as a JSON array.

• Minimum items: 1
• Maximum items: 100

Employment types as a JSON array.

• Minimum items: 1
• Maximum items: 100

Work arrangements as a JSON array.

• Minimum items: 1
• Maximum items: 100

Minimum annual base compensation in USD.

• Minimum: 0

Minimum median annual total compensation in USD; may include Levels.fyi estimates.

• Minimum: 0

Company types as a JSON array.

• Minimum items: 1
• Maximum items: 100

Company sizes as a JSON array: seed 1–50, early 51–200, mid 201–1,000, large 1,001–10,000, enterprise 10,001+ employees.

• Minimum items: 1
• Maximum items: 100

Company valuation ranges in USD as a JSON array of [minimum, maximum] pairs.

• Minimum items: 1
• Maximum items: 100

Benefit IDs as a JSON array, for example 58 remote work, 4 retirement plan, 35 paid time off, 22 health insurance.

• Minimum items: 1
• Maximum items: 100

Maximum posting age in posted_within_unit units.

• Minimum: 1

Unit for posted_within.

Redfin property URL ending in /home/<property_id>.

• Maximum characters: 2048

Minimum listing price in US dollars.

• Minimum: 0

Maximum listing price in US dollars.

• Minimum: 0

Minimum number of bedrooms.

• Minimum: 0
• Maximum: 20

Maximum number of bedrooms.

• Minimum: 0
• Maximum: 20

Minimum number of bathrooms.

• Minimum: 0
• Maximum: 20

Minimum interior area in square feet.

• Minimum: 0

Maximum interior area in square feet.

• Minimum: 0

Redfin city, ZIP, county or neighborhood search URL. Existing URL filters are retained unless overridden.

• Supply one location: a region URL, region_id with region_type, or map_bounds.
• Maximum characters: 2048

Redfin region identifier; requires region_type.

• Greater than: 0

Region kind: 1 neighborhood, 2 ZIP region, 5 county, 6 city, 11 state.

• A ZIP region identifier differs from the ZIP code. Use a Redfin ZIP search URL if the region identifier is unknown.

Map rectangle as north,east,south,west.

Listing status. Defaults to for_sale when no URL is supplied.

Sold listings from the last N days; requires status=sold. Defaults to 180 for sold searches.

• Minimum: 1
• Maximum: 365

Restrict results to one property type.

Result ordering. Defaults to recommended when no URL is supplied.

Maximum homes returned. Narrow the region or map bounds when results reach this limit.

• The response does not advertise pagination or a total count. If search_information.possibly_truncated is true, narrow the location or filters.
• Minimum: 1
• Maximum: 350

City, ZIP code, neighborhood or street address. Required on the first page; omit with page_token.

• Minimum characters: 1
• Maximum characters: 200

Find regions or addresses. Defaults to regions; omit with page_token.

• Region suggestions include Zillow region IDs. Address suggestions return names; this route does not return property ZPIDs or coordinates.

Suggestions per page, from 1 to 100. Defaults to 10; omit with page_token.

• Follow pagination.next or send pagination.next_page_token as page_token. Each lookup supports up to 1,000 suggestions; if pagination.possibly_truncated is true, refine q.
• Minimum: 1
• Maximum: 100

Opaque next_page_token from the preceding response. Send it alone to continue the same lookup.

• Continue the same query, suggestion type and page size without repeating previously returned suggestions. If pagination.next is null while has_more is true, send page_token through POST JSON.
• Minimum characters: 1
• Maximum characters: 32768

Zillow property identifier. Supply zpid or url.

• Greater than: 0

Zillow homedetails URL. Supply url or zpid.

• Supply exactly one of url or zpid. Apartment building URLs are not property-detail URLs.
• Maximum characters: 2048

Minimum listing price in US dollars.

• For rental searches, prices are monthly rent in US dollars.
• Minimum: 0

Maximum listing price in US dollars.

• Minimum: 0

Minimum number of bedrooms.

• Minimum: 0
• Maximum: 20

Maximum number of bedrooms.

• Minimum: 0
• Maximum: 20

Minimum number of bathrooms.

• Minimum: 0
• Maximum: 20

Minimum interior area in square feet.

• Minimum: 0

Maximum interior area in square feet.

• Minimum: 0

City, ZIP code, neighborhood or address. Supply q or map_bounds.

• Supply exactly one of q or map_bounds.
• Minimum characters: 1
• Maximum characters: 200

Map rectangle as north,east,south,west.

Listing status.

Restrict results to one property type.

Order of matching listings.

Result page, starting at 1; Zillow caps searches at 20 pages.

• Follow pagination.next for another page. A search exposes at most 20 pages.
• Minimum: 1
• Maximum: 20

Job title, keywords, or company to search for.

• Minimum characters: 1
• Maximum characters: 512

One-based results page. Use next_page from the response to continue.

• Minimum: 1

City and state or ZIP code, for example New York, NY.

• Minimum characters: 1
• Maximum characters: 512

Search radius in miles. Use 5000 for any distance.

• Minimum: 0
• Maximum: 5000

Maximum posting age in days.

• Minimum: 1

Employment types as a JSON array.

• Minimum items: 1
• Maximum items: 100

On-site, remote-only, or hybrid jobs.

Lower bound for the job's maximum annualized pay, in the location's currency.

• Minimum: 0

Upper bound for the job's maximum annualized pay.

• Minimum: 0

Experience/seniority class.

Require ZipRecruiter's quick application.

Image search query, up to 2,048 characters.

• Minimum characters: 1
• Maximum characters: 2048

Language of the Google Images interface.

• Pattern: ^[a-z]{2,3}(?:-[A-Za-z]{2,8})?$

Two-letter country code used to localize results.

• Pattern: ^[a-z]{2}$

Set active to filter explicit images, or off to disable SafeSearch.

Google image filters, such as isz:l for large images, itp:photo for photographs, or ic:trans for transparent images.

• Maximum characters: 4096

Google's page offset. For the next page, use pagination.next_start from the response and keep the same query and filters. This offset is independent of num and the number of returned images.

• Minimum: 0
• Maximum: 1000

Maximum number of images returned from this page, from 1 to 100. This limits the parsed response; Google may supply fewer images.

• Minimum: 1
• Maximum: 100

Device profile used for the image search.

eBay marketplace hostname.

Search keywords. Required unless category_id is supplied.

• Minimum characters: 1
• Maximum characters: 500

eBay category ID.

• Minimum: 1
• Maximum: 2147483647

Result page, starting at 1.

• Minimum: 1
• Maximum: 2147483647

Requested results per page. eBay may adjust the page size.

Sort: 12 best match, 1 ending soonest, 10 newly listed, 7 nearest, 15/16 total price ascending/descending, 2/3 item price ascending/descending, 18/19 condition new/used first. Availability depends on marketplace.

Minimum item price.

• Minimum: 0

Maximum item price.

• Minimum: 0

Auction, Buy It Now (BIN), or accepts offers (BO).

Condition IDs joined with |, such as 1000|3000.

• Pattern: ^[0-9]{1,4}(\|[0-9]{1,4}){0,9}$

Destination postal code used by eBay for shipping estimates.

• Minimum characters: 1
• Maximum characters: 20

eBay item-location country ID, e.g. 1 US, 2 Canada, 3 UK.

Exclude automatic spelling corrections.

Comma-separated filters: FR, RPA, AS, Savings, SaleItems, Lots, Charity, AV, FS, LPickup.

• Maximum characters: 100

Comma-separated eBay seller usernames.

• Maximum characters: 1000

Include (1) or exclude (2) the sellers in _sasl.

eBay aspect filters as key=value pairs joined with &, with multiple values joined by |. Percent-encoded names are accepted.

• Maximum characters: 4000

Result layout.

Item location relative to the marketplace.

eBay marketplace hostname.

12-digit eBay listing ID from search results or an /itm/ URL.

• Pattern: ^[0-9]{12}$

Country code for eBay's localized interface, e.g. US, JP, CA.

Interface language override; requires locale and ebay.com.

• Maximum characters: 12
• Pattern: ^[a-z]{2,3}(?:-[A-Za-z]{2,4})?$

Two-letter destination country code for shipping calculations.

eBay marketplace hostname.

Seller username for type=user, or the store URL slug for type=store.

• Pattern: ^[A-Za-z0-9][A-Za-z0-9_.*-]{0,99}$

Public seller profile type.

Result page, starting at 1.

• Minimum: 1
• Maximum: 2147483647

Products per page.

Sort: 12 best match, 1 ending soonest, 7 nearest, 10 newly listed, 15/16 total price ascending/descending.

All listings (0), Buy It Now (1), or auctions (2).

Condition IDs joined with |: 3 new, 4 used, 10 unspecified.

• Maximum characters: 20
• Pattern: ^(?:3|4|10)(?:\|(?:3|4|10))*$

Only products with free shipping.

Storefront language, such as en, de, or zh-TW. Maximum 32 characters.

• Maximum characters: 32
• Pattern: ^[a-zA-Z]{2,3}(?:[-_][a-zA-Z0-9]{2,8}){0,3}$

Two-letter country code.

• Pattern: ^[a-zA-Z]{2}$

Optional query with 1 to 2,048 UTF-8 bytes of printable text. Excludes category. Omit it to browse the storefront. On the games endpoint, q uses shared Android app search; omit q or choose games_category to browse games.

• Minimum characters: 1
• Maximum characters: 2048

Chart identifier such as topselling_free, topselling_paid, or topgrossing. Excludes q and all pagination selectors. Apps and games charts require phone or an omitted store_device.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Use the returned next_page_token with the same parameters. Excludes chart, section_page_token, and see_more_token.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Continue one result group using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Open a result collection using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Native app category identifier, such as MEDICAL. Excludes q and an explicit store_device.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Omit for the default phone storefront. An explicit selection excludes q and category.

Children's age range. Requires apps_category=FAMILY.

Storefront language, such as en, de, or zh-TW. Maximum 32 characters.

• Maximum characters: 32
• Pattern: ^[a-zA-Z]{2,3}(?:[-_][a-zA-Z0-9]{2,8}){0,3}$

Two-letter country code.

• Pattern: ^[a-zA-Z]{2}$

Optional query with 1 to 2,048 UTF-8 bytes of printable text. Excludes category. Omit it to browse the storefront. On the games endpoint, q uses shared Android app search; omit q or choose games_category to browse games.

• Minimum characters: 1
• Maximum characters: 2048

Chart identifier such as topselling_free, topselling_paid, or topgrossing. Excludes q and all pagination selectors. Apps and games charts require phone or an omitted store_device.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Use the returned next_page_token with the same parameters. Excludes chart, section_page_token, and see_more_token.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Continue one result group using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Open a result collection using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Native game category identifier, such as GAME_PUZZLE. Excludes q and an explicit store_device.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Omit for the default phone storefront. An explicit selection excludes q and category.

Storefront language, such as en, de, or zh-TW. Maximum 32 characters.

• Maximum characters: 32
• Pattern: ^[a-zA-Z]{2,3}(?:[-_][a-zA-Z0-9]{2,8}){0,3}$

Two-letter country code.

• Pattern: ^[a-zA-Z]{2}$

Optional query with 1 to 2,048 UTF-8 bytes of printable text. Excludes category. Omit it to browse the storefront. On the games endpoint, q uses shared Android app search; omit q or choose games_category to browse games.

• Minimum characters: 1
• Maximum characters: 2048

Chart identifier such as topselling_free, topselling_paid, or topgrossing. Excludes q and all pagination selectors. Apps and games charts require phone or an omitted store_device.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Use the returned next_page_token with the same parameters. Excludes chart, section_page_token, and see_more_token.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Continue one result group using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Open a result collection using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Native book category identifier, such as coll_1689 for children's books. Excludes q.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Children's age range. Requires books_category=coll_1689.

1 for free books or 2 for paid books. Requires q.

• Minimum: 1
• Maximum: 2

Storefront language, such as en, de, or zh-TW. Maximum 32 characters.

• Maximum characters: 32
• Pattern: ^[a-zA-Z]{2,3}(?:[-_][a-zA-Z0-9]{2,8}){0,3}$

Two-letter country code.

• Pattern: ^[a-zA-Z]{2}$

Optional query with 1 to 2,048 UTF-8 bytes of printable text. Excludes category. Omit it to browse the storefront. On the games endpoint, q uses shared Android app search; omit q or choose games_category to browse games.

• Minimum characters: 1
• Maximum characters: 2048

Chart identifier such as topselling_free, topselling_paid, or topgrossing. Excludes q and all pagination selectors. Apps and games charts require phone or an omitted store_device.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Use the returned next_page_token with the same parameters. Excludes chart, section_page_token, and see_more_token.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Continue one result group using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Open a result collection using its returned token and the same parameters. Excludes the other pagination selectors and chart.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Native movie category identifier, such as FAMILY for family movies. Excludes q.

• Minimum characters: 1
• Maximum characters: 128
• Pattern: ^[a-zA-Z0-9_-]+$

Children's age range. Requires movies_category=FAMILY.

Storefront language, such as en, de, or zh-TW. Maximum 32 characters.

• Maximum characters: 32
• Pattern: ^[a-zA-Z]{2,3}(?:[-_][a-zA-Z0-9]{2,8}){0,3}$

Two-letter country code.

• Pattern: ^[a-zA-Z]{2}$

Native Google Play product identifier, with 1 to 512 letters, digits, underscores, dots, or hyphens.

• Minimum characters: 1
• Maximum characters: 512
• Pattern: ^[a-zA-Z0-9_.-]+$

Product catalog containing this identifier.

Native season identifier, such as tvseason-OVPad1njPzI.P. Requires store=tv.

• Minimum characters: 1
• Maximum characters: 512
• Pattern: ^[a-zA-Z0-9_.-]+$

Storefront language, such as en, de, or zh-TW. Maximum 32 characters.

• Maximum characters: 32
• Pattern: ^[a-zA-Z]{2,3}(?:[-_][a-zA-Z0-9]{2,8}){0,3}$

Two-letter country code.

• Pattern: ^[a-zA-Z]{2}$

Native Google Play product identifier, with 1 to 512 letters, digits, underscores, dots, or hyphens.

• Minimum characters: 1
• Maximum characters: 512
• Pattern: ^[a-zA-Z0-9_.-]+$

Product catalog containing this identifier.

Platform associated with the reviews.

Only reviews with this rating, from 1 through 5.

• Minimum: 1
• Maximum: 5

1 for relevant, 2 for newest, or 3 for rating.

• Minimum: 1
• Maximum: 3

Number of reviews, from 1 through 199.

• Minimum: 1
• Maximum: 199

Returned review continuation. Preserve product, store, language, country, platform, rating, sort order, and count.

• Minimum characters: 1
• Maximum characters: 65536
• Pattern: ^[a-zA-Z0-9_=+/:.-]+$

Two-letter Apple storefront country. UK is accepted as an alias for GB.

• Pattern: ^[a-zA-Z]{2}$

Search term with 1 to 2,048 UTF-8 bytes of printable text, and at most 4,096 bytes after URL encoding.

• Minimum characters: 1
• Maximum characters: 2048

Language-region code, such as en-us or fr-fr.

• Pattern: ^[a-zA-Z]{2,3}-[a-zA-Z]{2}$

Maximum results after filtering, from 1 through 200.

• Minimum: 1
• Maximum: 200

Exclude explicit results when true.

Use developer to match developer names, ignoring case.

Filter results by a native genre identifier, from 1 through 2,147,483,647.

• Minimum: 1
• Maximum: 2147483647

mobile for iPhone apps, tablet for iPad apps, or desktop for Mac apps.

Two-letter Apple storefront country. UK is accepted as an alias for GB.

• Pattern: ^[a-zA-Z]{2}$

Positive decimal Apple app identifier, up to 20 digits.

• Pattern: ^[1-9][0-9]{0,19}$

App product type. Only app is supported.

Two-letter Apple storefront country. UK is accepted as an alias for GB.

• Pattern: ^[a-zA-Z]{2}$

Positive decimal Apple app identifier, up to 20 digits.

• Pattern: ^[1-9][0-9]{0,19}$

mostrecent or mosthelpful. Apple's Mac storefront always returns newest first.

One-based page number, from 1 through 2,147,483,647. Exhausted pages return an empty review list.

• Minimum: 1
• Maximum: 2147483647

Text or search operators to send to Yahoo.

• Minimum characters: 1
• Maximum characters: 2000

Yahoo regional search host, for example fr.search.yahoo.com. A regional prefix such as fr is also accepted.

One-based starting result. Web pages usually advance by 10; image pages usually advance by 60.

• Minimum: 1
• Maximum: 10001

Device profile used for the Yahoo result page.

Country code for regional results, such as us or uk.

• Pattern: ^[a-z]{2}$

Restrict matches to a language, such as lang_fr, lang_zh_chs, or lang_zh_cht. Enables Yahoo's language filter.

• Pattern: ^lang_(?:[a-z]{2}|zh_chs|zh_cht)$

Adult-content filtering: r for strict, i for moderate, p for unfiltered.

Comma-separated domain suffixes to search, such as .com,.org.

• Maximum characters: 500

Document format to match, such as pdf, txt, or all formats.

• Maximum characters: 80

Yahoo display token controlling result module placement and expansion.

• Maximum characters: 1000

Yahoo related-topic destination token, passed through as a string.

• Maximum characters: 4096

Text or search operators to send to Yahoo.

• Minimum characters: 1
• Maximum characters: 2000

Yahoo regional search host, for example fr.search.yahoo.com. A regional prefix such as fr is also accepted.

One-based starting result. Web pages usually advance by 10; image pages usually advance by 60.

• Minimum: 1
• Maximum: 10001

Device profile used for the Yahoo result page.