{
  "openapi": "3.0.1",
  "info": {
    "title": "Vietnam Shopping Products Scraper",
    "description": "Scrape products by keyword from Tiki, Lazada, Chợ Tốt and Google Shopping. Returns URL, title, price, sale price, discount, image, brand, seller, rating and sold count. Supports language/price filters, sorting and URL dedup across sources.",
    "version": "1.0",
    "x-build-id": "glAaHBFWquFqmAsGU"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/getdataforu~products-shopping/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-getdataforu-products-shopping",
        "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/getdataforu~products-shopping/runs": {
      "post": {
        "operationId": "runs-sync-getdataforu-products-shopping",
        "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/getdataforu~products-shopping/run-sync": {
      "post": {
        "operationId": "run-sync-getdataforu-products-shopping",
        "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",
        "required": [
          "queries"
        ],
        "properties": {
          "queries": {
            "title": "Search keywords",
            "type": "array",
            "description": "List of keywords. Each keyword is scraped on every selected source.",
            "items": {
              "type": "string"
            }
          },
          "sources": {
            "title": "Sources",
            "type": "array",
            "description": "tiki/lazada/chotot = free JSON API (reliable over plain HTTP). bing = experimental (HTML, usually needs proxy/Playwright).",
            "items": {
              "type": "string",
              "enum": [
                "tiki",
                "lazada",
                "chotot",
                "bing"
              ],
              "enumTitles": [
                "Tiki",
                "Lazada",
                "Chợ Tốt"
              ]
            },
            "default": [
              "tiki",
              "lazada",
              "chotot"
            ]
          },
          "maxItems": {
            "title": "Max total products (whole run)",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Cap on the TOTAL products for the whole run, split evenly across sources (round-robin) with cross-fill. 0 = unlimited (use maxItemsPerQuery). Set 100 to get at most 100 products.",
            "default": 0
          },
          "maxItemsPerQuery": {
            "title": "Max products per keyword per source",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Limit per (keyword × source). Ignored when maxItems (total) is set.",
            "default": 40
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "newest",
              "best_selling",
              "price_asc",
              "price_desc"
            ],
            "type": "string",
            "description": "Result ordering. Applied at the source where supported (Tiki/Lazada), plus a final client-side sort for price/best-selling. Chợ Tốt only supports default order.",
            "default": "relevance"
          },
          "minPrice": {
            "title": "Min price (VND)",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep products with selling price >= this value. 0 = no minimum.",
            "default": 0
          },
          "maxPrice": {
            "title": "Max price (VND)",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep products with selling price <= this value. 0 = no maximum.",
            "default": 0
          },
          "productLanguage": {
            "title": "Product language",
            "enum": [
              "any",
              "vi",
              "en"
            ],
            "type": "string",
            "description": "Keep only products whose title matches this language. 'any' = no language filter; 'vi' = Vietnamese titles; 'en' = English (Latin, no Vietnamese diacritics). Foreign scripts (Chinese/Thai/...) are dropped for vi/en.",
            "default": "vi"
          },
          "country": {
            "title": "Country (cc)",
            "type": "string",
            "description": "Two-letter country code for regional search (e.g. vn for Vietnam). Used by Bing Shopping when enabled.",
            "default": "vn"
          },
          "language": {
            "title": "Language (hl)",
            "type": "string",
            "description": "Interface language code for regional search (e.g. vi for Vietnamese). Used by Bing Shopping when enabled.",
            "default": "vi"
          },
          "maxRequestsPerCrawl": {
            "title": "Max HTTP requests",
            "minimum": 1,
            "type": "integer",
            "description": "Hard cap on HTTP requests per run (safety guard against runaway loops).",
            "default": 100
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Tiki/Chợ Tốt usually work without a proxy. Enable Apify Proxy (RESIDENTIAL) for Lazada/Bing if blocked.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}