{ "openapi": "3.0.1", "info": { "title": "Facebook Marketplace Scraper", "description": "Scrape facebook marketplace with highly targeted/customized search queries and filters. Export and download data to CSV/JSON etc.", "version": "1.0", "x-build-id": "f4ku6H3PRu20ch1Ha" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/inquisitive_sarangi~facebook-marketplace-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-inquisitive_sarangi-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/inquisitive_sarangi~facebook-marketplace-scraper/runs": { "post": { "operationId": "runs-sync-inquisitive_sarangi-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/inquisitive_sarangi~facebook-marketplace-scraper/run-sync": { "post": { "operationId": "run-sync-inquisitive_sarangi-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", "required": [ "proxy", "lat", "lng", "radius" ], "properties": { "listingUrls": { "title": "Listing urls", "uniqueItems": true, "type": "array", "description": "Using no-empty listing urls list, all fields except proxy will be ignored.", "default": [], "items": { "type": "string" } }, "searchUrls": { "title": "Search urls", "uniqueItems": true, "type": "array", "description": "Supported pattern: /^https://www.facebook.com/marketplace/(\\d+|\\w+)/(search|vehicles|propertyrentals|apparel|electronics|entertainment|family|free|garden|hobbies|home|home-improvements|instruments|office-supplies|pets|propertyforsale|sports|toys)/?(?query=.+)/. For category based search urls(/category/), the actors uses lat/lng/radius setting from input.", "default": [], "items": { "type": "string" } }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your scraper. For searchUrls, it has been observed that apify proxies has a low chance of success. Please use a different residential proxy." }, "maxPage": { "title": "Max Page Limit", "minimum": 0, "type": "integer", "description": "0 means no limit", "default": 0 }, "local": { "title": "Show price in local currency", "type": "boolean", "description": "If enabled, output prices in targeted location currency, otherwise USD", "default": false }, "extendItem": { "title": "Get item extended data", "type": "boolean", "description": "if enabled we fetch item details", "default": false }, "search": { "title": "Custom Search(Overrides category, if set)", "type": "string", "description": "Can be used to custom search where searchurl not supported. Acceptable pattern: {location}/{query}. eg. nyc/ps5 or ps5. If set, category will be ignored. For missing {location} part, lat/lng/radius will be used instead to target a location. You can also add below filters, if they applies for your search.", "default": "nyc/ps5" }, "category": { "title": "Category", "enum": [ "", "vehicles", "propertyrentals", "apparel", "electronics", "entertainment", "family", "free", "garden", "hobbies", "home", "home-improvements", "instruments", "office-supplies", "pets", "propertyforsale", "sports", "toys" ], "type": "string", "description": "Select your category", "default": "" }, "lat": { "title": "Latitude", "type": "string", "description": "N/E(+), S/W(-)" }, "lng": { "title": "Longitude", "type": "string", "description": "N/E(+), S/W(-)" }, "radius": { "title": "Radius", "enum": [ "1", "2", "5", "10", "20", "40", "60", "65", "80", "100", "250", "500" ], "type": "string", "description": "Select area radius", "default": "65" }, "itemCondition": { "title": "Condition", "uniqueItems": true, "type": "array", "description": "Options: new|used_like_new|used_good|used_fair. NOTE: not applicable to property rentals", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Price Min.", "minimum": 0, "maximum": 2147483647, "type": "integer", "description": "Prices are in units of target location currency. Eg. for target location US, unit is in USD", "default": 0 }, "maxPrice": { "title": "Price Max.", "minimum": 1, "maximum": 2147483647, "type": "integer", "description": "Prices are in units of target location currency. eg for target location US, unit is in USD", "default": 2147483647 }, "sortBy": { "title": "Sort By", "enum": [ "", "price_ascend", "price_descend", "creation_time_ascend", "creation_time_descend", "distance_ascend", "distance_descend", "mileage_ascend", "mileage_descend", "year_ascend", "year_descend" ], "type": "string", "description": "Attribute by which you may want to sort the listings.", "default": "" }, "topLevelVehicleType": { "title": "Type", "enum": [ "", "car_truck", "motorcycle", "powersport", "boat", "commercial", "trailer", "rv_camper", "other" ], "type": "string", "description": "Type of vehicle.", "default": "" }, "minMileage": { "title": "Mileage Min.", "type": "integer", "description": "Mileage Min." }, "maxMileage": { "title": "Mileage Max.", "type": "integer", "description": "Mileage Max." }, "carType": { "title": "Body Style", "uniqueItems": true, "type": "array", "description": "Options: convertible|coupe|hatchback|minivan|sedan|wagon|suv|truck|small_car|other, NOTE: not applicable to propery rentals", "default": [], "items": { "type": "string" } }, "transmissionType": { "title": "Transmission", "enum": [ "", "automatic", "manual" ], "type": "string", "description": "Type of transmission", "default": "" }, "minYear": { "title": "Year Min.", "minimum": 1900, "maximum": 2147483647, "type": "integer", "description": "Year Min" }, "maxYear": { "title": "Year Max.", "minimum": 1900, "maximum": 2147483647, "type": "integer", "description": "Year Max" }, "make": { "title": "Make", "enum": [ "", "Acura", "Alfa Romeo", "Aston Martin", "Audi", "BMW", "Bentley", "Buick", "CODA", "Cadillac", "Chevrolet", "Chrysler", "Daewoo", "Daihatsu", "Dodge", "Eagle", "Ferrari", "Fiat", "Fisker", "Ford", "Freightliner", "GMC", "Genesis", "Geo", "Honda", "Hummer", "Hyundai", "Infiniti", "Isuzu", "Jaguar", "Jeep", "Kia", "Lamborghini", "Land Rover", "Lexus", "Lincoln", "Lotus", "Lucid", "MINI", "Maserati", "Maybach", "Mazda", "McLaren", "Mercedes-Benz", "Mercury", "Mitsubishi", "Nissan", "Oldsmobile", "Panoz", "Plymouth", "Polestar", "Pontiac", "Porsche", "Ram", "Rivian", "Rolls-Royce", "SRT", "Saab", "Saturn", "Scion", "Smart", "Subaru", "Suzuki", "Tesla", "Toyota", "Volkswagen", "Volvo", "A.P.C Motor Company", "Adly", "Aermacchi", "AJP", "AJS", "Alcyon", "Alta", "Ambassador", "American IronHorse", "American Lifan", "Apollo", "Aprilia", "ARC", "Arch", "Arctic Cat", "Ariane", "Ariel", "Arlen Ness", "Armor", "Armstrong", "Artisan", "ASPT", "Bajaj", "Baotian", "Barossa", "Bashan", "Battistinis", "Beeline", "Benelli", "Beta", "Better", "Bianchi", "Big Bear Choppers", "Big Dog Motorcycles", "Bimota", "Bintelli", "Blata", "BMC", "Boom", "Borile", "Boss Hoss", "Bourget", "Bown", "Boxer", "Brammo", "Branson", "Bridgestone", "Brixton", "Brough Superior", "BSA", "BTS", "Buell", "Bullit", "Bultaco", "Butler", "Cagiva", "California Motorcycle Company", "California Scooter Company", "Campagna", "Can-Am", "Cannondale", "Casal", "Cazador", "CCM", "CFMOTO", "CH Racing", "Champ", "Chang Jiang", "Chicago Scooter Co", "Chunlan", "Cimatti", "Citycoco", "Club Car", "Cobra", "Coleman", "Condor", "Confederate", "Conquest Trikes", "Coolster", "Cotton", "Cougar", "Coventry Eagle", "CPI", "Cushman", "CZ", "Daelim", "Daix", "Dayang", "Demon X", "Derbi", "Di Blasi", "Diamo", "Dichao", "Direct Bikes", "DKW", "Dnepr", "Dong Fang", "Dot", "Douglas", "Dresda", "Ducati", "E-TON", "E-Z-Go", "Easy-Rider", "EBR", "Eclipse", "Electric Motion", "Electricycle", "Energica", "Eped", "Erider", "Erik Buell Racing", "Excelsior Henderson", "Fantic", "Feiying", "Fenian", "Fosti", "Francis-Barnett", "Garelli", "Gas Gas", "Geely", "Genata", "Generic", "Genuine Scooter Company", "Ghezzi-Brian", "Giantco", "Gilera", "Greeves", "Grinnall", "Hanway", "Hao Nuo", "Haotian", "Harley-Davidson", "Harris", "Hartford", "Hellbound Steel", "Herald", "Hesketh", "Himo", "Hisun", "Honchin", "Hongdu", "Honley", "Horex", "Huatian", "Huoniao", "Husaberg", "Husqvarna", "Huvo", "Hyosung", "Ice Bear", "Indian", "Iron Eagle Motorcycle", "Isomoto", "Italika", "Italjet", "Itom", "IZH", "James", "Jawa", "Jbwco", "JCM", "Jialing", "Jianshe", "Jincheng", "Jinfeng", "Jinlun", "John Deere", "Johnny Pag", "Jonway", "Jotagas", "Juicy Bike", "Kalex", "Kangchao", "Kawasaki", "Kayo", "Keeway", "Kinroad-Rock", "KTM", "Kymco", "Lambretta", "Lance", "Lanying", "Laverda", "Lehman", "Lehman Trikes", "Leike", "Lem", "Levis", "Lexmoto", "Lifan", "Linhai", "Lintex", "LML", "Loncin", "Longjia", "Lyric", "Magni", "Maico", "Malaguti", "Martin", "Masai", "Mash", "Matchless", "Mavizen", "Maxus", "MBK", "Megelli", "Metisse", "Mig", "Mikilon", "Mini Moto", "Mobylette", "Modenas", "Mondial", "Montesa", "Morini", "Moto Guzzi", "Moto Morini", "Moto-Hispania", "Moto-Martin", "Moto-Parilla", "Moto-Roma", "Motobecane", "Motobi", "Motor Trike", "Motorini", "Motus", "Munch", "Mutt", "MV Agusta", "MZ", "Neco", "New Hudson", "New Imperial", "New Map", "Nippi", "Nipponia", "NIU", "Norton", "NSU", "NVT", "Omega", "Oset", "Ossa", "Pannonia", "Panther", "Paramount Custom Cycles", "Paton", "Peace Sports", "Peirspeed", "Pembleton", "Peripoli", "Petronas", "Peugeot", "PGO", "Piaggio", "Pioneer", "Pitster Pro", "Polaris", "Polini", "Por", "Precision Cycle Works", "Puch", "Pulse", "Qingqi", "Quadro", "Quantya", "Raleigh", "Red Horse", "Regent", "Revtech", "Rewaco", "Rhino", "Rickman", "Ridley", "Rieju", "Roadsmith", "Roehr", "Rokon", "Romarsh", "Romeo", "Rovigo", "Roxon", "Royal Alloy", "Royal Enfield", "Rudge", "Rumi", "Sachs", "Sanglas", "Sanya", "Saxon", "Schwinn", "Scomadi", "Scorpa", "Scott", "Secma", "Seeley", "Segway", "Senke", "SFM", "Sherco", "Shineray", "Siamoto", "Silk", "Simson", "Sinnis", "Skygo", "Skyjet", "Skyteam", "Slam", "Slingshot", "Smc", "Spirit", "Spondon", "SSR Motorsports", "Stacyc", "Star Motorcycles", "Starway", "Stomp", "Sucker Punch Sallys", "Sukida", "Sumo", "Sunbeam", "Super Soco", "Superbyke", "Swift", "SWM", "SYM", "Taizhou Zhongneng", "Tamoretti", "Tao Motor", "Tao Tao", "Terrot", "TGB", "Thoroughbred Motorsports", "Thumpstar", "Thunder Mountain", "Titan", "TM", "Tmec", "Tomos", "TOR", "Track", "Trailmaster", "Triton", "Triumph", "UBCO", "UM", "Ural", "Urban", "Vanderhall", "Vectrix", "Velocette", "Velosolex", "Vespa", "Victoria", "Victory", "Vincent", "Vitacci", "Vor", "Voxan", "Vyrus", "Wangye", "Wild West", "WK Bikes", "Wolf Brand Scooters", "Wuyang", "Xgjao", "Xispa", "Xtreme Motor Co.", "Yamaha", "Yamasaki", "Yamoto", "YCF", "Yiben", "Yuan", "Zenardi", "Zennco", "Zero", "Zero Engineering", "Zhejiang", "Znen", "Zodiac", "Zongshen", "Zontes", "Zoom", "Zündapp", "Zycoo" ], "type": "string", "description": "Make of vehicle", "default": "" }, "vehicleExteriorColors": { "title": "Exterior Colors", "uniqueItems": true, "type": "array", "description": "Options: black|charcoal|grey|white|off_white|tan|beige|yellow|gold|brown|orange|red|burgundy|pink|purple|blue|turquoise|green|silver|other", "default": [], "items": { "type": "string" } }, "vehicleInteriorColors": { "title": "Interior Colors", "uniqueItems": true, "type": "array", "description": "Options: black|charcoal|grey|white|off_white|tan|beige|yellow|gold|brown|orange|red|burgundy|pink|purple|blue|turquoise|green|silver|other", "default": [], "items": { "type": "string" } }, "propertyType": { "title": "Rental Type", "uniqueItems": true, "type": "array", "description": "Options: apartment-condo|house|private_room-shared_room|builder_floor", "default": [], "items": { "type": "string" } }, "isC2CListingOnly": { "title": "Listings from individuals only", "type": "boolean", "description": "Is listed by individual", "default": false }, "minBedrooms": { "title": "Min Bedrooms", "enum": [ "", "1", "2", "3", "4", "5", "6" ], "type": "string", "description": "Enter minimum required bedrooms", "default": "" }, "minBathrooms": { "title": "Min Bathrooms", "enum": [ "", "4", "6", "8", "12", "16", "20" ], "type": "string", "description": "Enter minimum required bathrooms", "default": "" }, "minAreaSize": { "title": "Min Area", "minimum": 0, "maximum": 2147483647, "type": "integer", "description": "Enter minimum required Area: 0 represents no min. area" }, "maxAreaSize": { "title": "Max Area", "minimum": 0, "maximum": 2147483647, "type": "integer", "description": "Enter maximum required Area: 0 represents no max. area" }, "deliveryMethod": { "title": "Delivery method", "enum": [ "", "local_pick_up", "shipping" ], "type": "string", "description": "Not applicable to Property Rentals/Home Sales", "default": "" }, "maxConcurrency": { "title": "Max Concurrency", "type": "integer", "description": "Depends on your apify plan limits, max allowed upto 25", "default": 5 }, "maxRequestsPerMinute": { "title": "Max request per minute", "type": "integer", "description": "Max allowed upto 600", "default": 200 } } }, "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 } } } } } } } } } }