{
  "openapi": "3.0.1",
  "info": {
    "title": "Regional Grocery Prices: Giant Eagle, Hannaford & Schnucks",
    "description": "Price, stock & unit price at Giant Eagle, Hannaford, Schnucks, ShopRite, Stop & Shop, Giant Food, Price Chopper, Weis, Tops, Ingles, Save A Lot, Stater Bros, Raley's, Fresh Market, Big Y, Rouses, Food City, Smart & Final, Grocery Outlet, 99 Ranch & Loblaws. Free comparisons & tracking.",
    "version": "0.1",
    "x-build-id": "8ZjTuG9flWpQbepB1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/niches~regional-grocery-prices/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-niches-regional-grocery-prices",
        "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/niches~regional-grocery-prices/runs": {
      "post": {
        "operationId": "runs-sync-niches-regional-grocery-prices",
        "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/niches~regional-grocery-prices/run-sync": {
      "post": {
        "operationId": "run-sync-niches-regional-grocery-prices",
        "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": [
          "searches",
          "zipCodes"
        ],
        "properties": {
          "searches": {
            "title": "Product searches",
            "type": "array",
            "description": "One product search per line, such as milk, eggs or jasmine rice. Up to 20 searches, sent to each selected chain at each location.",
            "items": {
              "type": "string"
            }
          },
          "zipCodes": {
            "title": "ZIP codes (or Loblaws postal codes)",
            "type": "array",
            "description": "Up to 10 five-digit US ZIP codes. For Loblaws use Canadian postal codes such as M5V 2T6. Missing coverage is reported; a distant shop is never substituted. USD and CAD comparisons stay separate.",
            "items": {
              "type": "string"
            }
          },
          "chains": {
            "title": "Regional grocery chains",
            "type": "array",
            "description": "Select one or more chains. Price Chopper includes Market 32 and the Kansas City chain. Loblaws is optional, uses Instacart Canada, and needs a Canadian postal code.",
            "items": {
              "type": "string",
              "enum": [
                "giant-eagle",
                "hannaford",
                "schnucks",
                "shoprite",
                "stop-and-shop",
                "giant-food",
                "price-chopper",
                "weis-markets",
                "tops",
                "ingles",
                "save-a-lot",
                "stater-bros",
                "raleys",
                "the-fresh-market",
                "big-y",
                "rouses",
                "food-city",
                "smart-and-final",
                "grocery-outlet",
                "99-ranch",
                "loblaws"
              ],
              "enumTitles": [
                "Giant Eagle",
                "Hannaford",
                "Schnucks",
                "ShopRite",
                "Stop & Shop",
                "Giant Food",
                "Price Chopper & Market 32",
                "Weis Markets",
                "Tops Markets",
                "Ingles",
                "Save A Lot",
                "Stater Bros.",
                "Raley's",
                "The Fresh Market",
                "Big Y",
                "Rouses Markets",
                "Food City",
                "Smart & Final",
                "Grocery Outlet",
                "99 Ranch Market",
                "Loblaws"
              ]
            },
            "default": [
              "giant-eagle",
              "hannaford",
              "schnucks",
              "shoprite",
              "stop-and-shop",
              "giant-food"
            ]
          },
          "maxProductsPerChain": {
            "title": "Product cap per chain, search and location",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum delivered products per chain for each search and location, across its banners. Default 10, maximum 500. The visible source results may be fewer; this is not a full catalog export.",
            "default": 10
          },
          "onlyRelated": {
            "title": "Skip results sharing no search word",
            "type": "boolean",
            "description": "Skip and do not charge products whose name and brand contain none of the search words. Case and accents are ignored. This is word overlap, not a guarantee of the same product or size.",
            "default": true
          },
          "trackPrices": {
            "title": "Track price changes",
            "type": "boolean",
            "description": "Compare each delivered product with the last completed history for its chain, shop, location and fulfillment. Previous price, change and price-drop flags are free.",
            "default": true
          },
          "trackingName": {
            "title": "Optional tracking list name",
            "maxLength": 80,
            "type": "string",
            "description": "Use a short name such as weekly-groceries for a separate price history. Leave blank for the default history. Run one job at a time per history."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}