{ "openapi": "3.0.1", "info": { "title": "Faire Scraper | Wholesale Products & Brands", "description": "Scrape Faire.com wholesale marketplace: products, brands, categories & discover search. Extract product tokens, MOQ, retail/tester prices, ratings, brand pages. Export Excel, CSV, JSON. Guest preview — no retailer login required.", "version": "0.2", "x-build-id": "wzTHSEDrjYLnzeX8S" }, "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": [ "categories", "category", "discover", "brand", "product", "suppliers" ], "type": "string", "description": "categories | category | discover | brand | product | suppliers", "default": "category" }, "country": { "title": "Country (ISO3)", "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 country. Auto-maps proxyCountry (USA→US, GBR→GB, …).", "default": "USA" }, "locale": { "title": "Locale", "type": "string", "description": "Locale for taxonomy / pages (e.g. en)", "default": "en" }, "categoryPath": { "title": "Category path", "type": "string", "description": "e.g. Pets or Home Decor/subcategory/Kitchen & Tabletop (also accepts pipe form). Lowercase keywords like ceramic planters are treated as discover search.", "default": "Home Decor" }, "discoverSlug": { "title": "Discover slug", "type": "string", "description": "Discover slug / keyword surface, e.g. candles" }, "keyword": { "title": "Keyword (alias)", "type": "string", "description": "Alias of discoverSlug" }, "brandToken": { "title": "Brand token", "type": "string", "description": "b_*" }, "productToken": { "title": "Product token", "type": "string", "description": "p_*" }, "sortBy": { "title": "Sort", "type": "string", "description": "category cat-nav sort hint: featured | new | price_asc | price_desc (best-effort)" }, "filterKeys": { "title": "Filter keys", "type": "array", "description": "cat-nav filter_keys list (from Faire filter panel)", "items": { "type": "string" } }, "brandFilters": { "title": "Brand filters", "type": "string", "description": "Brand page filters= query value, e.g. category:home_living|kitchen_tabletop" }, "page": { "title": "Start page", "minimum": 1, "type": "integer", "description": "Listing start page (?page=N)", "default": 1 }, "pageSize": { "title": "Page size", "minimum": 1, "maximum": 120, "type": "integer", "description": "cat-nav page size", "default": 60 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Cap for autoPaginate / brand pagination", "default": 10 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum records to return (Store Test default is 1; free plan capped at 200)", "default": 1 }, "autoPaginate": { "title": "Auto paginate", "type": "boolean", "description": "Page until empty / maxResults / maxPages", "default": true }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Fetch /api/v2/product for list cards (default on — fills name/prices)", "default": true }, "enrichLimit": { "title": "Enrich limit", "minimum": 0, "type": "integer", "description": "0 = min(maxResults, 80)", "default": 0 }, "includeRelated": { "title": "Include related products", "type": "boolean", "description": "On product mode, also pull related/similar tokens when present", "default": true }, "crawlSubcategories": { "title": "Prefer subcategory seeds", "type": "boolean", "description": "categories mode: prefer deeper paths", "default": false }, "topLevelOnly": { "title": "Top-level categories only", "type": "boolean", "description": "categories mode: only emit top-level nodes", "default": false }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Batch Faire URLs (category/discover/brand/product/suppliers). Mixed URLs are processed in one run.", "items": { "type": "string" } }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Derived ISO2 egress country. Caller values are ignored and replaced from the final normalized country.", "default": "US" }, "workerBaseUrl": { "title": "Worker base URL override", "type": "string", "description": "Optional https Cloud Run override (allowlisted)" } } }, "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 } } } } } } } } } }