{
  "openapi": "3.0.1",
  "info": {
    "title": "Facebook Marketplace Scraper ($0.44/1K): ZIP & Strict Radius",
    "description": "Scrape Facebook Marketplace by keyword around any town, ZIP code or coordinates with a strict radius (distance on every row). Price, place, photos, seller, date; details, deal score, sold listings, vehicles, monitoring of new, cheaper and sold items, alerts. No login.",
    "version": "0.0",
    "x-build-id": "82pq1xcS3bbDgSLsl"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tsutseisoftware~facebook-marketplace-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tsutseisoftware-facebook-marketplace-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/tsutseisoftware~facebook-marketplace-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tsutseisoftware-facebook-marketplace-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/tsutseisoftware~facebook-marketplace-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tsutseisoftware-facebook-marketplace-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": "Words to search for, as typed into the search box of Marketplace (\"iphone 15\", \"mountain bike\", \"skoda octavia\"). Each line is a separate search around every location. Empty = browse the chosen categories.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Where to search, one per line: a town (\"Ostrava\", \"Austin, TX, US\", \"Paris, France\"), a postal code with its country (\"70200, CZ\", \"10001, US\", \"SW1A, GB\") or coordinates (\"49.8407, 18.2787\"). Towns of every country are known; when a name exists in several countries, the actor stops and asks you to add the country instead of guessing. The resolved place is written to the log.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "type": "string",
            "description": "Default country for the locations that do not name one: a two-letter code (CZ, US, DE, GB) or the English name. Needed for postal codes without a country."
          },
          "radius": {
            "title": "Radius",
            "minimum": 1,
            "maximum": 805,
            "type": "integer",
            "description": "How far from each location to search (in the unit below). Facebook itself does not keep to the radius for logged-out visitors; with \"Strict radius\" the actor measures every listing and leaves out (and does not charge) those farther away.",
            "default": 40
          },
          "radiusUnit": {
            "title": "Radius unit",
            "enum": [
              "km",
              "mi"
            ],
            "type": "string",
            "description": "Unit of the radius.",
            "default": "km"
          },
          "strictRadius": {
            "title": "Strict radius",
            "type": "boolean",
            "description": "Leave out listings farther than the radius. Distance is measured from the listing's town (from its exact coordinates with \"Add listing details\"); every row has distanceKm and distanceMiles. Listings left out are not charged.",
            "default": true
          },
          "includeUnknownDistance": {
            "title": "Keep listings whose town is unknown",
            "type": "boolean",
            "description": "A listing whose town can't be placed (a small village, a misspelled name) has no distance. On = keep it (distance empty), off = leave it out.",
            "default": true
          },
          "coverWholeRadius": {
            "title": "Cover the whole radius with several searches",
            "type": "boolean",
            "description": "One search reaches about 60 km around a point. For a bigger radius (up to 500 km), turn this on: the whole area is searched and duplicates are removed. Takes longer; pages without a listing inside the radius are charged as \"Extra page\".",
            "default": false
          },
          "categories": {
            "title": "Categories",
            "type": "array",
            "description": "Search only in these categories (combined with the keywords), or browse them when there are no keywords. \"Vehicles\" without keywords uses the vehicle filters below.",
            "items": {
              "type": "string",
              "enum": [
                "apparel",
                "classifieds",
                "electronics",
                "entertainment",
                "family",
                "free",
                "garden",
                "hobbies",
                "home",
                "home-improvements",
                "instruments",
                "office-supplies",
                "pets",
                "propertyrentals",
                "sports",
                "toys",
                "vehicles"
              ],
              "enumTitles": [
                "Apparel",
                "Classifieds",
                "Electronics",
                "Entertainment",
                "Family",
                "Free stuff",
                "Garden & outdoor",
                "Hobbies",
                "Home goods",
                "Home improvement supplies",
                "Musical instruments",
                "Office supplies",
                "Pet supplies",
                "Property rentals",
                "Sporting goods",
                "Toys & games",
                "Vehicles"
              ]
            }
          },
          "startUrls": {
            "title": "Marketplace URLs",
            "type": "array",
            "description": "Search or category pages copied from the browser, with their place and filters (e.g. https://www.facebook.com/marketplace/prague/search?query=bike&maxPrice=5000), and listing URLs (https://www.facebook.com/marketplace/item/123456789/, read with their details). Each search URL costs about $0.003 extra (charged as extra pages). A URL whose town Facebook does not know (it would search around San Francisco) is skipped.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "integer",
            "description": "In the currency of the place (CZK in Czechia, USD in the US...)."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "integer",
            "description": "In the currency of the place."
          },
          "conditions": {
            "title": "Condition",
            "type": "array",
            "description": "Only listings in these conditions. Empty = any.",
            "items": {
              "type": "string",
              "enum": [
                "new",
                "used_like_new",
                "used_good",
                "used_fair"
              ],
              "enumTitles": [
                "New",
                "Used - like new",
                "Used - good",
                "Used - fair"
              ]
            }
          },
          "daysSinceListed": {
            "title": "Listed in the last",
            "enum": [
              "any",
              "1",
              "7",
              "30"
            ],
            "type": "string",
            "description": "Age of the listings.",
            "default": "any"
          },
          "deliveryMethod": {
            "title": "Delivery",
            "enum": [
              "all",
              "local_pickup",
              "shipping"
            ],
            "type": "string",
            "description": "How the item can be handed over.",
            "default": "all"
          },
          "availability": {
            "title": "Availability",
            "enum": [
              "available",
              "sold"
            ],
            "type": "string",
            "description": "\"Sold\" returns listings marked as sold or pending (reserved; `isPending`): what items really sold for. Facebook does not show the seller of sold listings.",
            "default": "available"
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "best_match",
              "newest",
              "price_low",
              "price_high",
              "distance"
            ],
            "type": "string",
            "description": "Order of the results (as on Facebook).",
            "default": "best_match"
          },
          "exactMatch": {
            "title": "Exact keyword match",
            "type": "boolean",
            "description": "Facebook's own \"exact match\": no loosely related results.",
            "default": false
          },
          "vehicleTypes": {
            "title": "Vehicle types",
            "type": "array",
            "description": "Kinds of vehicles.",
            "items": {
              "type": "string",
              "enum": [
                "car_truck",
                "motorcycle",
                "powersport",
                "rv_camper",
                "trailer",
                "boat",
                "commercial",
                "other"
              ],
              "enumTitles": [
                "Cars & trucks",
                "Motorcycles",
                "Powersports",
                "RVs & campers",
                "Trailers",
                "Boats",
                "Commercial & industrial",
                "Other"
              ]
            }
          },
          "bodyStyles": {
            "title": "Body styles",
            "type": "array",
            "description": "Body styles of cars.",
            "items": {
              "type": "string",
              "enum": [
                "coupe",
                "truck",
                "sedan",
                "hatchback",
                "suv",
                "convertible",
                "wagon",
                "minivan",
                "small_car",
                "other"
              ],
              "enumTitles": [
                "Coupe",
                "Truck",
                "Sedan",
                "Hatchback",
                "SUV",
                "Convertible",
                "Wagon",
                "Minivan",
                "Small car",
                "Other"
              ]
            }
          },
          "vehicleMinYear": {
            "title": "Year from",
            "minimum": 1900,
            "maximum": 2100,
            "type": "integer",
            "description": "Model year from. Facebook filters by it; the actor also leaves out listings whose year it knows (from the title or the details) outside the range. Listings without vehicle data (parts, many listings outside the US) stay in."
          },
          "vehicleMaxYear": {
            "title": "Year to",
            "minimum": 1900,
            "maximum": 2100,
            "type": "integer",
            "description": "Model year up to (see Year from)."
          },
          "vehicleMinMileage": {
            "title": "Mileage from",
            "minimum": 0,
            "type": "integer",
            "description": "In the unit of the country (km or miles). Like the year: listings without a known mileage stay in."
          },
          "vehicleMaxMileage": {
            "title": "Mileage up to",
            "minimum": 0,
            "type": "integer",
            "description": "In the unit of the country (km or miles)."
          },
          "vehicleTransmission": {
            "title": "Transmission",
            "enum": [
              "any",
              "automatic",
              "manual"
            ],
            "type": "string",
            "description": "Gearbox.",
            "default": "any"
          },
          "titleKeywords": {
            "title": "Title must contain",
            "type": "array",
            "description": "Only listings whose title contains these words (without diacritics, any case). See \"Keywords must match\".",
            "items": {
              "type": "string"
            }
          },
          "keywordsMode": {
            "title": "Keywords must match",
            "enum": [
              "any",
              "all"
            ],
            "type": "string",
            "description": "For \"Title must contain\" and \"Text must contain\".",
            "default": "any"
          },
          "excludeKeywords": {
            "title": "Title must not contain",
            "type": "array",
            "description": "Leave out listings whose title contains any of these words (\"case\", \"broken\", \"parts\", \"wanted\").",
            "items": {
              "type": "string"
            }
          },
          "titleMustContainQuery": {
            "title": "Title must contain the search words",
            "type": "boolean",
            "description": "Leave out listings whose title does not contain every word of their search keyword (Facebook adds loosely related items).",
            "default": false
          },
          "descriptionKeywords": {
            "title": "Text must contain",
            "type": "array",
            "description": "Only listings whose title or description contains these words. Needs \"Add listing details\"; the details of a listing it leaves out are read and charged (as details, not as a listing). A listing whose details could not be read is left out (the filter cannot be checked).",
            "items": {
              "type": "string"
            }
          },
          "excludeDescriptionKeywords": {
            "title": "Text must not contain",
            "type": "array",
            "description": "Leave out listings whose title or description contains any of these words. Needs \"Add listing details\"; the details of a listing it leaves out are read and charged (as details, not as a listing).",
            "items": {
              "type": "string"
            }
          },
          "postedWithinHours": {
            "title": "Posted in the last N hours",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings created at most this many hours ago (precise; with \"Sort by\" newest the run stops at older listings)."
          },
          "postedFrom": {
            "title": "Posted from",
            "type": "string",
            "description": "Only listings created on this day or later."
          },
          "postedTo": {
            "title": "Posted to",
            "type": "string",
            "description": "Only listings created on this day or earlier."
          },
          "freeOnly": {
            "title": "Only free items",
            "type": "boolean",
            "description": "Only listings with the price 0 / \"Free\".",
            "default": false
          },
          "onlyDiscounted": {
            "title": "Only reduced listings",
            "type": "boolean",
            "description": "Only listings whose seller lowered the price (Facebook shows the old price crossed out).",
            "default": false
          },
          "excludePlaceholderPrices": {
            "title": "Exclude placeholder prices",
            "type": "boolean",
            "description": "Leave out listings with prices sellers type instead of a real one (1, 123, 1234, 999 999...).",
            "default": false
          },
          "excludeOutlierPrices": {
            "title": "Exclude implausible prices",
            "type": "boolean",
            "description": "Leave out listings priced below 20 % or above 500 % of the usual price of comparable listings.",
            "default": false
          },
          "maxPriceVsMedianPercent": {
            "title": "Deals: max price vs. usual price (%)",
            "minimum": -100,
            "type": "integer",
            "description": "Only listings priced at most this much above (positive) or below (negative) the median price of comparable listings of the same search, e.g. -20 = at least 20 % cheaper than usual."
          },
          "minDealScore": {
            "title": "Deals: min deal score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only listings with at least this deal score (50 = the usual price, higher = cheaper, 100 = free)."
          },
          "hideDuplicateListings": {
            "title": "Hide duplicate listings",
            "type": "boolean",
            "description": "The same seller posting the same title several times: keep the first only.",
            "default": false
          },
          "excludeSellers": {
            "title": "Exclude sellers",
            "type": "array",
            "description": "Seller names or seller IDs (sellerId of a row) to leave out.",
            "items": {
              "type": "string"
            }
          },
          "onlySellers": {
            "title": "Only these sellers",
            "type": "array",
            "description": "Watch-list: only listings of these seller names or IDs.",
            "items": {
              "type": "string"
            }
          },
          "sellerTypes": {
            "title": "Seller type",
            "type": "array",
            "description": "Needs \"Add listing details\".",
            "items": {
              "type": "string",
              "enum": [
                "private",
                "dealership",
                "business"
              ],
              "enumTitles": [
                "Private person",
                "Dealership (vehicles)",
                "Business"
              ]
            }
          },
          "customFilters": {
            "title": "Custom filters",
            "type": "array",
            "description": "Rules on any output field, all must hold, e.g. [{\"field\": \"distanceKm\", \"op\": \"lte\", \"value\": 10}, {\"field\": \"imageCount\", \"op\": \"gte\", \"value\": 3}]. Ops: includes, notIncludes, equals, notEquals, gt, gte, lt, lte, exists, notExists."
          },
          "skipListingsFromDataset": {
            "title": "Skip listings of an earlier run",
            "type": "string",
            "description": "Run ID or dataset ID of an earlier run of this actor: its listings are left out."
          },
          "includeDetails": {
            "title": "Add listing details (add-on)",
            "type": "boolean",
            "description": "Reads the listing page: description, all photos, exact coordinates (and the distance from them), condition, attributes, vehicle data (make, model, mileage, fuel, transmission, colour, owners, VIN), shipping, the seller's rating and profile. Off = what the search shows (title, price, town, photo, seller, date).",
            "default": false
          },
          "includeSellerPhoto": {
            "title": "Add seller profile photo (add-on)",
            "type": "boolean",
            "description": "With \"Add listing details\": the seller's profile picture (sellerPhotoUrl). Extra charge \"Seller photo\" per saved listing that has one. The photo is personal data of the seller: use it lawfully (see the FAQ).",
            "default": false
          },
          "includeAllPhotos": {
            "title": "All photos",
            "type": "boolean",
            "description": "With details: every photo of the listing.",
            "default": true
          },
          "maxPhotos": {
            "title": "Max photos",
            "minimum": 0,
            "type": "integer",
            "description": "Keep at most this many photo URLs per listing. 0 = all.",
            "default": 0
          },
          "descriptionMaxLength": {
            "title": "Description length limit",
            "minimum": 0,
            "type": "integer",
            "description": "Cut descriptions after this many characters. 0 = the whole text.",
            "default": 0
          },
          "convertCurrency": {
            "title": "Convert prices to",
            "enum": [
              "",
              "USD",
              "EUR",
              "GBP",
              "CZK",
              "PLN",
              "HUF",
              "CHF",
              "SEK",
              "NOK",
              "DKK",
              "CAD",
              "AUD",
              "NZD",
              "JPY",
              "RON",
              "BGN",
              "TRY",
              "MXN",
              "BRL",
              "INR",
              "ZAR",
              "SGD",
              "HKD",
              "ILS",
              "PHP",
              "THB",
              "MYR",
              "IDR",
              "KRW",
              "CNY"
            ],
            "type": "string",
            "description": "Adds priceConverted in this currency (daily rates of the European Central Bank). Empty = no conversion.",
            "default": ""
          },
          "compact": {
            "title": "Compact output",
            "type": "boolean",
            "description": "Only the main fields: title, price, place, distance, date, condition, photo, seller, deal score, URL.",
            "default": false
          },
          "fields": {
            "title": "Output fields",
            "type": "array",
            "description": "Only these fields (plus id, url, title, source, scrapedAt). Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "id",
                "source",
                "url",
                "title",
                "price",
                "currency",
                "priceText",
                "priceUsd",
                "originalPrice",
                "discountPercent",
                "isFree",
                "isPlaceholderPrice",
                "priceConverted",
                "convertedCurrency",
                "city",
                "state",
                "locationName",
                "locationId",
                "country",
                "latitude",
                "longitude",
                "locationPrecision",
                "distanceKm",
                "distanceMiles",
                "withinRadius",
                "postedAt",
                "listingAgeHours",
                "categoryId",
                "categoryName",
                "condition",
                "conditionLabel",
                "deliveryTypes",
                "shippingOffered",
                "shippingPrice",
                "isSold",
                "isPending",
                "isLive",
                "status",
                "sellerName",
                "sellerId",
                "sellerProfileUrl",
                "sellerType",
                "sellerRating",
                "sellerRatingCount",
                "sellerJoinedAt",
                "sellerPhotoUrl",
                "imageUrl",
                "imageUrls",
                "imageCount",
                "hasVideo",
                "description",
                "attributes",
                "vehicleYear",
                "vehicleMake",
                "vehicleModel",
                "vehicleTrim",
                "vehicleMileage",
                "vehicleMileageUnit",
                "vehicleTransmission",
                "vehicleFuelType",
                "vehicleExteriorColor",
                "vehicleInteriorColor",
                "vehicleOwners",
                "vehicleCondition",
                "vehicleTitleStatus",
                "vehicleVin",
                "vehicleFeatures",
                "searchQuery",
                "searchLocation",
                "searchCategory",
                "searchRadiusKm",
                "searchUrl",
                "position",
                "comparableCount",
                "comparableMedianPrice",
                "priceVsMedianPercent",
                "dealScore",
                "detailsIncluded",
                "firstSeenAt",
                "changeType",
                "changedFields",
                "previousPrice",
                "priceChange",
                "priceChangePercent",
                "removedAt",
                "removedReason",
                "isRepost",
                "repostOf",
                "scrapedAt"
              ]
            }
          },
          "excludeEmptyFields": {
            "title": "Leave out empty fields",
            "type": "boolean",
            "description": "Drop fields without a value from every row (smaller exports).",
            "default": false
          },
          "maxItems": {
            "title": "Max listings",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of listings saved. You pay per saved listing. 0 = no limit.",
            "default": 100
          },
          "maxItemsPerSearch": {
            "title": "Max listings per search",
            "minimum": 0,
            "type": "integer",
            "description": "Limit for each keyword × location (or URL) separately. 0 = no limit.",
            "default": 0
          },
          "maxPagesPerSearch": {
            "title": "Max pages per search",
            "minimum": 0,
            "type": "integer",
            "description": "Read at most this many pages (about 24 listings each) of every search. 0 = no limit.",
            "default": 0
          },
          "onlyNewOrChanged": {
            "title": "Monitoring: only new or changed listings",
            "type": "boolean",
            "description": "Return new listings, and listings whose price, title or status changed (with previousPrice and the change in %).",
            "default": false
          },
          "monitoringKey": {
            "title": "Monitoring key",
            "type": "string",
            "description": "Name of the remembered state; use a different key for every saved search. Empty = \"default\"."
          },
          "onlyPriceDrops": {
            "title": "Monitoring: only price drops",
            "type": "boolean",
            "description": "Of the changed listings, return only those whose price went down.",
            "default": false
          },
          "minPriceDropPercent": {
            "title": "Monitoring: min price drop (%)",
            "minimum": 0,
            "type": "integer",
            "description": "Of the changed listings, return only those whose price went down by at least this many %."
          },
          "includeRemovedListings": {
            "title": "Monitoring: report sold and removed listings",
            "type": "boolean",
            "description": "Listings of the previous run that are gone: the actor checks each one and returns it with removedReason sold, pending, removed or noLongerMatches. Turned on for an existing monitoring key, it reports from the run after: the first run remembers what to report the listings with.",
            "default": false
          },
          "includeUnchanged": {
            "title": "Monitoring: include unchanged listings",
            "type": "boolean",
            "description": "Return unchanged listings too (changeType \"unchanged\"; charged as listings).",
            "default": false
          },
          "onlyNew": {
            "title": "Monitoring: only new listings",
            "type": "boolean",
            "description": "Return new listings only, not changed ones.",
            "default": false
          },
          "skipReposts": {
            "title": "Monitoring: skip reposted listings",
            "type": "boolean",
            "description": "A listing the seller posted again (seen before under another ID) is marked isRepost; on = leave it out.",
            "default": false
          },
          "skipFirstRun": {
            "title": "Monitoring: silent first run",
            "type": "boolean",
            "description": "The first run only remembers the listings and returns nothing; later runs return what is new.",
            "default": false
          },
          "monitoringEarlyStop": {
            "title": "Monitoring: stop at known listings",
            "type": "boolean",
            "description": "With \"Sort by\" newest: stop a search at the first page of listings that are all known (fast, cheap checks every few minutes).",
            "default": false
          },
          "ignoreChangesIn": {
            "title": "Monitoring: ignore changes in",
            "type": "array",
            "description": "Changes of these fields do not count.",
            "items": {
              "type": "string",
              "enum": [
                "title",
                "price",
                "isSold",
                "isPending"
              ],
              "enumTitles": [
                "Title",
                "Price",
                "Sold",
                "Pending"
              ]
            }
          },
          "resetMonitoring": {
            "title": "Monitoring: start again",
            "type": "boolean",
            "description": "Forget the remembered listings of this Monitoring key.",
            "default": false
          },
          "telegramBotToken": {
            "title": "Telegram bot token",
            "type": "string",
            "description": "Token of your bot from @BotFather."
          },
          "telegramChatId": {
            "title": "Telegram chat ID",
            "type": "string",
            "description": "Chat to send to."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "Incoming webhook (https://hooks.slack.com/...)."
          },
          "discordWebhookUrl": {
            "title": "Discord webhook URL",
            "type": "string",
            "description": "Webhook of your Discord channel (https://discord.com/api/webhooks/...). In Discord: channel settings → Integrations → Webhooks → Copy Webhook URL. Stored encrypted."
          },
          "webhookUrl": {
            "title": "Webhook URL",
            "type": "string",
            "description": "Any HTTPS URL (Zapier, Make, n8n, your server): receives the listings as JSON."
          },
          "whatsappAccessToken": {
            "title": "WhatsApp access token",
            "type": "string",
            "description": "Access token of the WhatsApp Cloud API of your Meta business account, used with \"WhatsApp phone number ID\" and \"WhatsApp recipient number\" (step by step in the README, section \"WhatsApp notifications: setup\"). For scheduled runs use a permanent token of a system user: Business settings → System users → Generate token, with the permissions whatsapp_business_messaging and whatsapp_business_management; the token of WhatsApp → API Setup expires within hours. Stored encrypted."
          },
          "whatsappPhoneNumberId": {
            "title": "WhatsApp phone number ID",
            "type": "string",
            "description": "ID of your WhatsApp business number that sends the message (not the number itself), e.g. 106540352242922. In your Meta app: WhatsApp → API Setup → Phone number ID."
          },
          "whatsappTo": {
            "title": "WhatsApp recipient number",
            "type": "string",
            "description": "Phone number that gets the message, in international format with the country code (e.g. +420601234567); up to 5 numbers separated by commas or new lines, each gets its own message and the notification is charged once per run. A test number of Meta sends only to numbers you added and confirmed under API Setup → To. Stored encrypted."
          },
          "whatsappTemplateName": {
            "title": "WhatsApp template name",
            "type": "string",
            "description": "Name of your approved message template (WhatsApp Manager → Message templates, e.g. apify_results), recommended: WhatsApp delivers a template message at any time. Its body gets the run summary with the first results in {{1}} and the dataset link in {{2}} (a template with only {{1}} gets both in {{1}}). Empty: a plain text message, which WhatsApp delivers only when the recipient wrote to your business number in the last 24 hours, so a scheduled run usually needs a template. Meta charges your business account for template messages (step by step in the README, section \"WhatsApp notifications: setup\")."
          },
          "whatsappTemplateLanguage": {
            "title": "WhatsApp template language",
            "type": "string",
            "description": "Language code of the template exactly as WhatsApp Manager → Message templates shows it next to the template, e.g. en_US, en_GB, cs, sk, pl or de. Used only with \"WhatsApp template name\".",
            "default": "en_US"
          },
          "notificationLimit": {
            "title": "Max listings per notification",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many listings the message lists.",
            "default": 10
          },
          "notifyOnlyChanges": {
            "title": "Notify only when something was found",
            "type": "boolean",
            "description": "No message after a run that saved nothing.",
            "default": true
          },
          "retryFromNewIp": {
            "title": "Retry refused requests from a new IP address",
            "type": "boolean",
            "description": "When Facebook keeps refusing a request, ask again from a new IP address (up to 3 per request). Each new address is charged as \"New IP retry\". Off = a refused request is skipped.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Facebook needs a residential proxy. It is set by default and its cost is included in the price. Any country works: the place is set by the location, not by the proxy.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          },
          "sendErrorReports": {
            "title": "Send error reports",
            "type": "boolean",
            "description": "When a run fails, send the developer a short error report: the error and your input with secrets left out (tokens, webhooks and e-mails are hidden). Your results are never sent. Reports are deleted after at most 120 hours. Turn off to send nothing.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}