{ "openapi": "3.0.1", "info": { "title": "Faire Scraper | Products, Brands & Categories", "description": "Extract guest-visible Faire products, brands, categories, retail prices and reviews for your selected market. Pay per delivered row plus a start fee; export JSON, CSV or Excel.", "version": "0.2", "x-build-id": "RbOEgfh7ZHE0ekcUf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~faire-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-faire-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~faire-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-faire-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~faire-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-faire-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", "categories", "category", "discover", "brand", "product", "suppliers" ], "type": "string", "description": "Leave on Auto to select a mode from your target field, or choose one explicitly. Category tree and Suppliers need no target.", "default": "auto" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Faire links: a category, discover search, brand, product or suppliers page. Each link sets its own mode and target; several links are collected one by one in the same run.", "items": { "type": "string" } }, "categoryPath": { "title": "Category path", "type": "string", "description": "A Faire category, e.g. Pets or Home Decor/Kitchen & Tabletop. A plain phrase like ceramic planters is matched to a category, or searched when no category matches." }, "discoverSlug": { "title": "Keyword", "type": "string", "description": "A search keyword, e.g. candles." }, "keyword": { "title": "Keyword (alias)", "type": "string", "description": "Search phrase used when discoverSlug is empty." }, "brandToken": { "title": "Brand token", "pattern": "^([bB]_[A-Za-z0-9]+)?$", "type": "string", "description": "A brand ID from a Faire brand link, e.g. b_8yruuuqrma." }, "productToken": { "title": "Product token", "pattern": "^([pP]_[A-Za-z0-9]+)?$", "type": "string", "description": "A product ID from a Faire product link, e.g. p_vafjzd5w6a." }, "maxResults": { "title": "Max results per URL or target", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Most rows for each start URL or selected category, search, brand, product, or supplier target. Default 70; larger numbers are collected in parts of 70. Product, variant, review, related-product, brand, and category rows all count together. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor (limits set by the Actor developer).", "default": 70 }, "country": { "title": "Market", "enum": [ "USA", "GBR", "CAN", "AUS", "DEU", "FRA", "ITA", "ESP", "NLD", "BEL", "IRL", "NZL", "JPN", "KOR", "SGP", "PHL", "MEX", "BRA", "IND", "ARE", "SAU", "CHE", "AUT", "DNK", "SWE", "NOR", "FIN", "POL", "PRT", "HKG", "TWN" ], "type": "string", "description": "Faire market to read prices and availability for.", "default": "USA" }, "includeReviews": { "title": "Include product reviews", "type": "boolean", "description": "Add each available product review as a separately billed row within maxResults. Outside product mode, enrichDetails must be enabled; supplier brand rows have no product reviews.", "default": false }, "expandVariants": { "title": "Expand purchase options", "type": "boolean", "description": "Add each available purchase option as a separately billed variant row within maxResults.", "default": false }, "includeRelated": { "title": "Include related products", "type": "boolean", "description": "In product mode, add available related products as separately billed rows within maxResults. Related products may be unavailable.", "default": false }, "sortBy": { "title": "Sort", "type": "string", "description": "Requested category sort, such as featured, new, price_asc or price_desc. The source may not apply every sort option." }, "filterKeys": { "title": "Filter keys", "type": "array", "description": "Category filter keys copied from Faire's filter panel. The source determines which filters apply.", "items": { "type": "string" } }, "brandFilters": { "title": "Brand filters", "type": "string", "description": "Filter value from a Faire brand-page URL, for example category:home_living|kitchen_tabletop." }, "page": { "title": "Start page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Listing page to start from, between 1 and 500.", "default": 1 }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 120, "type": "integer", "description": "Requested number of products per listing page, between 1 and 120. This is not the limit on delivered rows.", "default": 60 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Requested listing-page limit. Row-based collection may use additional pages; use maxResults to limit delivered rows.", "default": 10 }, "autoPaginate": { "title": "Auto paginate", "type": "boolean", "description": "Request additional listing pages. Row-based collection may continue paging to fill maxResults even when this is disabled.", "default": true }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Add available product or brand details to listing rows, such as names, prices and images. Enabled by default.", "default": true }, "enrichLimit": { "title": "Enrich limit", "minimum": 0, "type": "integer", "description": "Maximum number of listing rows to enrich with details. Zero uses the smaller of the row allowance and 80.", "default": 0 }, "crawlSubcategories": { "title": "Prefer deeper categories", "type": "boolean", "description": "In categories mode, prefer deeper category paths.", "default": false }, "topLevelOnly": { "title": "Top-level categories only", "type": "boolean", "description": "In categories mode, return only top-level categories.", "default": false }, "locale": { "title": "Locale", "type": "string", "description": "Language hint for category names and pages, for example en. This does not translate search terms.", "default": "en" }, "workerBaseUrl": { "title": "Developer testing", "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 } } } } } } } } } }