Skip to documentation
Docs
Sign in Get an API key API key
Browse documentation
For AI agents

Connect your agent to live platform data.

Open in
Zepto API Capability

List ads

Read observed Zepto advertising placements for home, search or category contexts at a selected delivery context.

Capability ID zepto.ads
Maximum runtime 180 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

page_type is HOME, SEARCH or CATEGORY and defaults to HOME. For SEARCH provide the query or a supported search page URL. For CATEGORY provide category/subcategory identity or a supported category context.

For location-specific placements, provide store_id, a six-digit pincode, or both latitude and longitude. limit accepts 1 to 100 placements.

category_id string optional

Category ID (relevant when page_type is CATEGORY).

latitude number optional

Latitude for location-based store resolution. From -90 to 90.

Example 12.96902
limit integer optional

Maximum number of ad placements to return. From 1 to 100. Default: `20`.

Example 5
longitude number optional

Longitude for location-based store resolution. From -180 to 180.

Example 77.75395
page_type string optional

Type of page to fetch ads for. Allowed values: `HOME`, `SEARCH`, `CATEGORY`. Default: `HOME`.

Example HOME
Available values HOMESEARCHCATEGORY
pincode string optional

Six-digit Indian pincode. When provided, Upscrape resolves coordinates and the Zepto delivery store automatically.

query string optional

Search query (relevant when page_type is SEARCH).

store_id string optional

Zepto store ID. Defaults to the public Bangalore sample store.

subcategory_id string optional

Subcategory ID (relevant when page_type is CATEGORY).

url string optional

Direct URL to a Zepto page for ad context.

Response

Successful output is returned in results[0].data.

Returned placement rows can include product, page, widget, rank, sponsorship, campaign and tracking fields. Treat them as observed placement metadata for that request.

campaign_name, ads_response_id, ucl_id and placement/container identifiers do not establish globally unique campaigns, lifetime or complete advertising coverage.

An explicitly empty terminal SEARCH layout can return zero results. Do not generalize that empty-result rule to HOME or CATEGORY without corresponding evidence.

Illustrative sample The example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

PathObserved typeExample
captured_at string 2026-09-24T09:55:30.754879767Z
count integer 3
location object 8 fields
location.eta_minutes integer 6
location.eta_serviceable boolean true
location.latitude number 12.96902
location.longitude number 77.75395
location.secondary_store_ids array 1 items
location.serviceable boolean true
location.store_id string b4dc8d65-ed2e-4142-81b6-373982b13500
location.store_ids array 2 items
page_type string HOME
results array 3 items
results array 3 items

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

Overview, pricing and sample data for every endpoint: Zepto API