{ "openapi": "3.0.1", "info": { "title": "Faire Scraper - Wholesale Brands, Supplier Leads & Products", "description": "Extract wholesale brand leads and product data from Faire.com. Search by keyword or category, filter by brand values, country, and minimum products. Get contacts, minimums, ratings, and pricing.", "version": "1.0", "x-build-id": "CbRMkddFGOlTjky9O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~faire-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-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/parsebird~faire-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-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/parsebird~faire-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to browse on Faire, e.g. candles, ceramic mugs. Each query collects the brands behind the matching products.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Faire category names or slugs (home-decor, jewelry, kitchen-and-dining, beauty-and-wellness, food-and-drink, pets, ...), or a full category path pasted from a Faire URL.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Any Faire URLs: brand pages (/brand/...), product pages (/product/...), category or search pages. The type is auto-detected from the URL.", "items": { "type": "string" } }, "brandUrls": { "title": "Brand URLs or tokens", "type": "array", "description": "Enrich specific brands directly. Accepts full brand URLs, or brand tokens (b_...), one per line.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or tokens", "type": "array", "description": "Scrape specific Faire products as product records. Accepts full product URLs (/product/...), or product tokens (p_...), one per line.", "items": { "type": "string" } }, "scrapeAllBrands": { "title": "Scrape all brands", "type": "boolean", "description": "Discover brands at scale from Faire's public brand sitemaps, then apply the filters below. Can return well over 100,000 brands — always set Max results and use a run timeout.", "default": false }, "brandValues": { "title": "Brand values", "type": "array", "description": "Keep only brands that carry these values on their Faire profile.", "items": { "type": "string", "enum": [ "women-owned", "eco-friendly", "hand-made", "organic", "gives-back", "small-batch", "not-sold-on-amazon" ], "enumTitles": [ "Women-owned", "Eco-friendly", "Hand-made", "Organic", "Gives back", "Small-batch", "Not sold on Amazon" ] } }, "country": { "title": "Country", "type": "string", "description": "Keep only brands shipping from this country, e.g. United States." }, "state": { "title": "State / region", "type": "string", "description": "Keep only brands based in this state or region, e.g. CA." }, "minProducts": { "title": "Minimum active products", "minimum": 0, "type": "integer", "description": "Keep only brands with at least this many active products on Faire.", "default": 0 }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Keep only brands whose name or description contains this word." }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Cap on brand (and product) records returned. Set to 0 for no limit — only do this together with a run timeout, since Faire has 100,000+ brands.", "default": 20 }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Output only brands that are new, or whose product count or minimum order changed, since the last run. Pair this with an Apify Schedule for ongoing monitoring.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Faire is protected by Cloudflare. Residential proxies are strongly recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }