{
  "openapi": "3.0.1",
  "info": {
    "title": "iFood Scraper - Brazil Restaurants, Menus & Reviews",
    "description": "Extract public iFood restaurant and grocery-store details, menu prices and reviews in Brazil. Search by city, CEP, cuisine or merchant link. Pay per delivered row plus a run-start fee.",
    "version": "0.3",
    "x-build-id": "78Ic6PxaAfJQ0Fm65"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lentic_clockss~ifood-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lentic_clockss-ifood-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/lentic_clockss~ifood-scraper/runs": {
      "post": {
        "operationId": "runs-sync-lentic_clockss-ifood-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/lentic_clockss~ifood-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-lentic_clockss-ifood-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": "Mode",
            "enum": [
              "auto",
              "city",
              "category",
              "mercado",
              "merchant",
              "menu",
              "dish",
              "reviews",
              "discoverCities",
              "discoverCategories",
              "discoverVerticals",
              "nearMe",
              "chain",
              "home",
              "browse",
              "startUrls"
            ],
            "type": "string",
            "description": "Leave on Auto to select a mode from the target fields. Empty input starts a pizza search in Sao Paulo with at most 3 rows; select a mode explicitly for menus, dishes, reviews or discovery.",
            "default": "auto"
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "List of iFood merchant, city or category URLs. Each URL has its own maxResults allowance.",
            "items": {
              "type": "string"
            }
          },
          "merchantUrl": {
            "title": "Merchant URL",
            "pattern": "^(https?://)?([A-Za-z0-9-]+\\.)*ifood\\.com\\.br(/.*)?$",
            "type": "string",
            "description": "An iFood merchant URL in the form https://www.ifood.com.br/delivery/{city}/{slug}/{uuid}. Use this instead of merchantUuid."
          },
          "citySlug": {
            "title": "City slug",
            "type": "string",
            "description": "City and state slug, such as sao-paulo-sp or rio-de-janeiro-rj. Supported place-based modes use Sao Paulo when no other location is supplied."
          },
          "searchTerm": {
            "title": "Search term",
            "type": "string",
            "description": "Words to search for, such as pizza or hamburguer. Use Portuguese terms for local searches."
          },
          "categorySlug": {
            "title": "Category / search vertical",
            "type": "string",
            "description": "Cuisine or vertical to search, such as pizza, japonesa or mercado. Used by category mode."
          },
          "chainName": {
            "title": "Chain name",
            "type": "string",
            "description": "Chain or brand name to search for, such as Burger King. Used by chain mode."
          },
          "cep": {
            "title": "CEP",
            "pattern": "^\\s*\\d{5}-?\\d{3}\\s*$",
            "type": "string",
            "description": "Eight-digit Brazilian postal code, with or without a hyphen. Used to choose the search location."
          },
          "address": {
            "title": "Address",
            "type": "string",
            "description": "Brazilian location or address text used to locate the search area."
          },
          "latitude": {
            "title": "Latitude",
            "type": "number",
            "description": "Delivery latitude. Provide longitude as well when specifying coordinates."
          },
          "longitude": {
            "title": "Longitude",
            "type": "number",
            "description": "Delivery longitude. Provide latitude as well when specifying coordinates."
          },
          "maxResults": {
            "title": "Max results per URL or target",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum rows per start URL, or for the single target in other modes; all row types share that allowance, with requests above 70 collected in parts of at most 70 rows. The default is 70, subject to the run cost limit and Free-plan limits of 200 rows per run and 10 runs.",
            "default": 70
          },
          "merchantUuid": {
            "title": "Merchant UUID",
            "type": "string",
            "description": "Merchant identifier from an iFood merchant URL. Use this instead of merchantUrl."
          },
          "merchantSlug": {
            "title": "Merchant slug",
            "type": "string",
            "description": "Optional merchant-name segment from an iFood merchant URL."
          },
          "itemId": {
            "title": "Item / dish id",
            "type": "string",
            "description": "Item identifier for dish mode. Supply merchantUrl or merchantUuid as well."
          },
          "dishUuid": {
            "title": "Alternative dish ID",
            "type": "string",
            "description": "Alternative item identifier for dish mode. Supply merchantUrl or merchantUuid as well."
          },
          "pageId": {
            "title": "Browse pageId",
            "type": "string",
            "description": "Known iFood browse-page identifier. Required for browse mode."
          },
          "includeMenuItems": {
            "title": "Include menu items",
            "type": "boolean",
            "description": "Include separate menu item rows with merchant data. Off by default; each delivered row is billed and counts toward maxResults.",
            "default": false
          },
          "includeReviews": {
            "title": "Include reviews",
            "type": "boolean",
            "description": "Include separate review rows with merchant data. Off by default; each delivered review is billed and counts toward maxResults.",
            "default": false
          },
          "includeDishes": {
            "title": "Include dish cards from search",
            "type": "boolean",
            "description": "Include separate dish rows from search. Off by default; each delivered dish is billed and counts toward maxResults.",
            "default": false
          },
          "enrichMenus": {
            "title": "Enrich menus from list",
            "type": "boolean",
            "description": "Request menu item rows for merchants found in listings. Off by default; each delivered item is billed and counts toward maxResults.",
            "default": false
          },
          "enrichDetails": {
            "title": "Enrich merchant details",
            "type": "boolean",
            "description": "Request additional merchant details, such as delivery fees, address, contact number and business registration. Fields may be absent when not available.",
            "default": false
          },
          "maxEnrich": {
            "title": "Max merchants to enrich",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum number of listed merchants for which to request additional details or menu rows.",
            "default": 5
          },
          "loadMoreRounds": {
            "title": "Additional search pages",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Additional search pages after the first page, subject to the row limit.",
            "default": 0
          },
          "reviewPage": {
            "title": "Reviews start page",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "First review page to request. Page numbering starts at 1.",
            "default": 1
          },
          "reviewPageSize": {
            "title": "Reviews page size",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Number of reviews requested per page, subject to the remaining row allowance.",
            "default": 30
          },
          "sortBy": {
            "title": "Sort",
            "type": "string",
            "description": "Optional sorting value supported by iFood for the selected search."
          },
          "mainCategoryFilter": {
            "title": "Main category filter",
            "type": "string",
            "description": "Keep merchants whose main category contains this text."
          },
          "includeVerticals": {
            "title": "Include verticals",
            "type": "array",
            "description": "Keep merchants matching these vertical keywords, such as mercado or farmacia.",
            "items": {
              "type": "string"
            }
          },
          "cursor": {
            "title": "Continue from cursor",
            "type": "object",
            "description": "Continuation object from a prior response, if available. Usually leave empty; normal runs continue larger requests automatically."
          },
          "proxyCountry": {
            "title": "Country setting",
            "type": "string",
            "description": "Keep br for Brazil. This setting does not select a different marketplace.",
            "default": "br"
          },
          "workerBaseUrl": {
            "title": "Developer test setting",
            "type": "string",
            "description": "Leave empty. Used only by the developer for testing."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}