{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Deal Alert", "description": "Monitor Facebook Marketplace for new listings and price drops. Track keywords or categories by location, radius, and price, and get only the deals that are new or cheaper.", "version": "1.0", "x-build-id": "AoN6gLLmwaiIHabN6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrdoe~facebook-marketplace-deal-alert/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrdoe-facebook-marketplace-deal-alert", "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/mrdoe~facebook-marketplace-deal-alert/runs": { "post": { "operationId": "runs-sync-mrdoe-facebook-marketplace-deal-alert", "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/mrdoe~facebook-marketplace-deal-alert/run-sync": { "post": { "operationId": "run-sync-mrdoe-facebook-marketplace-deal-alert", "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": [ "location" ], "properties": { "searchQuery": { "title": "Search keyword", "type": "string", "description": "What to look for on Facebook Marketplace, e.g. \"bicycle\", \"herman miller chair\", \"iphone 15\". Provide this or a Category (or both).", "default": "bicycle" }, "category": { "title": "Category slug (optional)", "type": "string", "description": "Restrict the search to one Marketplace category, using the slug from the category page URL (facebook.com/marketplace//), e.g. \"bikes\", \"furniture\", \"vehicles\". Leave blank to search all categories." }, "location": { "title": "Location", "type": "string", "description": "The Facebook Marketplace location slug to search around, taken from the Marketplace URL (facebook.com/marketplace//), e.g. \"austin\", \"los-angeles\", \"nyc\".", "default": "austin" }, "radius": { "title": "Search radius (km)", "minimum": 1, "type": "integer", "description": "How far around the location to search, in kilometres. Facebook applies this approximately around the location's centre.", "default": 65 }, "minPrice": { "title": "Minimum price (optional)", "minimum": 0, "type": "integer", "description": "Only return listings at or above this price." }, "maxPrice": { "title": "Maximum price (optional)", "minimum": 0, "type": "integer", "description": "Only return listings at or below this price." }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop once this many listings have been written to the dataset. Keep it low for a quick check; raise it for a first full snapshot of a saved search.", "default": 10 }, "monitorMode": { "title": "Monitor mode - only new listings and price drops", "type": "boolean", "description": "When on, the run compares the search against what previous runs already saw and returns only listings that are new or that dropped in price. When off, every matching listing is returned and the current prices are recorded as the baseline for the next run. Turn this on for scheduled runs.", "default": false }, "fetchDetails": { "title": "Include full listing details", "type": "boolean", "description": "Also open each listing for its full description, exact currency, condition, category, and complete photo set. Turn off for a faster, lighter run with only the fields shown on the results page.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "A residential proxy is required - Facebook Marketplace does not serve results to datacenter traffic. The default uses Apify's residential proxy in the United States.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }