{
"openapi": "3.0.1",
"info": {
"title": "District Stores Scraper: India Store Locator, Malls & Offers",
"description": "Store locator data for 23,500+ branded retail outlets in India from District (by Zomato): every store in a city, of a brand or in a mall, with phone, address, GPS, hours, mall and floor, ratings, live bank and card offers and promo codes. No login.",
"version": "0.1",
"x-build-id": "SQMVNTc5LkIn7oDUF"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/yugenox~district-stores-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-yugenox-district-stores-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/yugenox~district-stores-scraper/runs": {
"post": {
"operationId": "runs-sync-yugenox-district-stores-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/yugenox~district-stores-scraper/run-sync": {
"post": {
"operationId": "run-sync-yugenox-district-stores-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"mode": {
"title": "What to scrape",
"enum": [
"city",
"brand",
"nearby",
"mall",
"search",
"storeUrls",
"allIndia"
],
"type": "string",
"description": "Every store in a city: all District stores in the cities you list (District's live listing plus its complete store directory).
Every outlet of a brand: all outlets of the brands you list, across India or only in the cities you list.
Stores near a place: the nearest outlet of each brand around a city, area or coordinates, nearest first (set a radius to get every outlet inside it).
Every store in a mall: the tenant list of malls and markets, with floors.
Search: District's own store search near each place.
Specific stores: district.in/stores/… links.
All of India: the whole store directory (about 23,500 stores).",
"default": "city"
},
"locations": {
"title": "Cities or places",
"type": "array",
"description": "Cities (\"Mumbai\", \"Delhi NCR\", \"Gurgaon\", \"Bengaluru\", \"Pune\"), areas (\"Koramangala, Bengaluru\") or coordinates (\"19.0760, 72.8777\"). Used by city, nearby and search; optional for brand (limits it to these cities) and mall (every mall and market with District stores in each place).",
"items": {
"type": "string"
}
},
"brands": {
"title": "Brands",
"type": "array",
"description": "For Every outlet of a brand: brand names as District writes them, e.g. \"Lenskart\", \"Levi's\", \"Tanishq\", \"Bata\", \"H&M\", \"Decathlon\". In the other modes this is a filter: only these brands are kept.",
"items": {
"type": "string"
}
},
"malls": {
"title": "Malls or markets",
"type": "array",
"description": "For Every store in a mall: mall names (\"Ambience Mall Gurgaon\", \"Phoenix Marketcity Kurla\"), district.in/hub/… links, or District mall ids.",
"items": {
"type": "string"
}
},
"keywords": {
"title": "Search terms",
"type": "array",
"description": "For Search: what you would type in District's store search, e.g. \"sneakers\", \"eyewear\", \"Lenskart\". District returns up to ~20 stores per term and place.",
"items": {
"type": "string"
}
},
"storeUrls": {
"title": "Store links",
"type": "array",
"description": "For Specific stores: district.in/stores/… links (the part after /stores/ also works).",
"items": {
"type": "string"
}
},
"categories": {
"title": "Categories",
"type": "array",
"description": "Only stores in any of these categories. Works in every mode except Specific stores.",
"items": {
"type": "string",
"enum": [
"apparel",
"footwear",
"accessories",
"jewellery",
"beauty",
"salon-wellness",
"home-furniture",
"electronics",
"eyewear",
"bags-luggage",
"watches",
"sports",
"kids",
"gifting"
],
"enumTitles": [
"Apparel",
"Footwear",
"Accessories (bags, watches, eyewear, luggage)",
"Jewellery",
"Beauty",
"Salon & wellness",
"Home & furniture",
"Electronics",
"Eyewear",
"Bags & luggage",
"Watches",
"Sports & outdoors",
"Baby & kids",
"Gifting & gourmet"
]
}
},
"maxItems": {
"title": "Max stores",
"minimum": 0,
"type": "integer",
"description": "Stop after this many stores in total. 0 = no limit.",
"default": 100
},
"maxItemsPerQuery": {
"title": "Max stores per city / brand / place / mall",
"minimum": 0,
"type": "integer",
"description": "Cap for each city, brand, place, mall or search term, so one big query does not use up the whole run. 0 = no limit.",
"default": 0
},
"coverWholeCity": {
"title": "Sweep the whole city",
"type": "boolean",
"description": "City mode: read District's live listing at every area of the city (Mumbai has 36, Delhi NCR 40) as well as the centre. It adds rating, mall, floor, promo codes and time-slot discounts for more stores, and finds stores newer than District's directory.",
"default": true
},
"maxDistanceKm": {
"title": "Radius (km)",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "Nearby mode: only stores within this distance, and every outlet inside the circle (not just the nearest one per brand). Empty = the nearest outlet of each brand, up to 600 brands."
},
"includeDetails": {
"title": "Full store details",
"type": "boolean",
"description": "Open each store's page for phone, full address, postcode, opening hours, description, photos, payment methods and every live offer with its terms. Turn off in nearby, mall or search for a faster listing-only run. Always on in the other modes.",
"default": true
},
"includeCatalogue": {
"title": "Include product catalogue",
"type": "boolean",
"description": "Add the store's catalogue: named collections with product names and images, where the brand publishes one (e.g. Nike's \"New Arrivals\").",
"default": false
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 60,
"type": "integer",
"description": "Parallel requests. 20 is fast and safe.",
"default": 20
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Apify Proxy's automatic (datacenter) group works and is the cheapest. The actor retries blocked requests on fresh IPs on its own.",
"default": {
"useApifyProxy": true
}
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}