{ "openapi": "3.0.1", "info": { "title": "Flipkart Scraper — Products, Prices, Specs & Reviews", "description": "Scrape Flipkart products by keyword, category or URL: prices, MRP, ratings, specs, sellers, delivery and reviews. Each product and review is charged once.", "version": "0.3", "x-build-id": "VTOZM4LnX3GAf1mnk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zapticx~flipkart-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zapticx-flipkart-product-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/zapticx~flipkart-product-scraper/runs": { "post": { "operationId": "runs-sync-zapticx-flipkart-product-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/zapticx~flipkart-product-scraper/run-sync": { "post": { "operationId": "run-sync-zapticx-flipkart-product-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "One keyword per line. Each keyword is searched separately and paged automatically.", "items": { "type": "string" } }, "startUrls": { "title": "Flipkart URLs", "type": "array", "description": "Flipkart search, category (/pr) and product (/p/) URLs. Filters in a URL are kept.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "productIds": { "title": "Product IDs", "type": "array", "description": "Flipkart product IDs, the pid value in a product URL.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many unique products in the run. Reviews have their own limit.", "default": 20 }, "maxProductsPerQuery": { "title": "Maximum products per keyword or URL", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop each keyword or listing URL at this count.", "default": 20 }, "sort": { "title": "Sort by", "enum": [ "relevance", "popularity", "price_asc", "price_desc", "recency_desc" ], "type": "string", "description": "Applies to keywords, and to URLs with no sort of their own.", "default": "relevance" }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Opens each product page for specifications, seller, delivery, variants and manufacturer details. Adds one charge per product.", "default": false }, "includeSpecifications": { "title": "Include specifications", "type": "boolean", "description": "Adds specification tables when the source provides them.", "default": true }, "includeSeller": { "title": "Include seller details", "type": "boolean", "description": "Adds seller name and seller ratings when the source provides them.", "default": true }, "includeReviews": { "title": "Include customer reviews", "type": "boolean", "description": "Adds reviews as separate records. A review shared by product variants is delivered and charged once.", "default": false }, "maxReviewsPerProduct": { "title": "Maximum reviews per product", "minimum": 1, "maximum": 500, "type": "integer", "description": "Reviews are read 10 per page.", "default": 10 }, "maxReviews": { "title": "Maximum reviews in the run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard limit on review records, and on what they cost.", "default": 200 }, "reviewSort": { "title": "Sort reviews", "enum": [ "MOST_HELPFUL", "MOST_RECENT", "POSITIVE_FIRST", "NEGATIVE_FIRST" ], "type": "string", "description": "Order in which reviews are read.", "default": "MOST_HELPFUL" }, "deduplicateProducts": { "title": "Remove duplicate products", "type": "boolean", "description": "A product found by several sources is delivered and charged once.", "default": true }, "maxPagesPerQuery": { "title": "Maximum pages per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Safety limit on result pages. Flipkart usually serves up to 25 pages per keyword.", "default": 20 }, "maxPagesPerCategory": { "title": "Maximum pages per URL", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Safety limit on result pages for each URL. Flipkart usually serves up to 25 pages per URL.", "default": 20 }, "maxRequests": { "title": "Maximum API requests", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard limit on API calls in one run, retries included.", "default": 500 }, "requestsPerSecond": { "title": "Requests per second", "minimum": 1, "maximum": 5, "type": "integer", "description": "Pace of requests. Lower is gentler on the site.", "default": 2 }, "maxConcurrency": { "title": "Targets in parallel", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many keywords, feeds or products run at once.", "default": 3 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "Temporary failures only.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait for one response.", "default": 30 }, "debugLog": { "title": "Debug logging", "type": "boolean", "description": "Adds detail to the log. Credentials are never logged.", "default": false }, "dataSource": { "title": "Data source", "enum": [ "public-pages", "affiliate-api" ], "type": "string", "description": "Public pages need no credentials. The Affiliate API is experimental, has not been tested with live credentials, and needs your own Flipkart Affiliate account.", "default": "public-pages" }, "inStockOnly": { "title": "In-stock products only (Affiliate API)", "type": "boolean", "description": "Applies to Affiliate API feeds only.", "default": false }, "categories": { "title": "Affiliate category feeds", "type": "array", "description": "Affiliate API only. Feed names such as bags_wallets_belts.", "items": { "type": "string" } }, "affiliateTrackingId": { "title": "Flipkart Affiliate tracking ID", "type": "string", "description": "Your own tracking ID from the Flipkart Affiliate dashboard." }, "affiliateToken": { "title": "Flipkart Affiliate API token", "type": "string", "description": "Your own API token. It is stored encrypted and never logged." } } }, "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 } } } } } } } } } }