{ "openapi": "3.0.1", "info": { "title": "1stDibs Scraper", "description": "Scrape 1stDibs - the leading online marketplace for antique, vintage, and contemporary furniture, jewelry & watches, art, and fashion. Search by keyword or browse by category and get item details including price, seller, condition, and images.", "version": "1.0", "x-build-id": "vtSIvf7NrS0oD1TBe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~1stdibs-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-1stdibs-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/crawlerbros~1stdibs-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-1stdibs-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/crawlerbros~1stdibs-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-1stdibs-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "browseCategory" ], "type": "string", "description": "What to scrape.", "default": "search" }, "keyword": { "title": "Search keyword", "type": "string", "description": "Search term — e.g. rolex watch, mid century chair, oil painting.", "default": "rolex watch" }, "category": { "title": "Category (mode=browseCategory)", "enum": [ "new-arrivals", "furniture", "furniture-seating", "furniture-lighting", "furniture-tables", "art", "jewelry", "jewelry-watches", "fashion", "fashion-handbags", "sale" ], "type": "string", "description": "Category to browse.", "default": "jewelry-watches" }, "period": { "title": "Period / era (mode=browseCategory)", "enum": [ "", "18th-century-and-earlier", "18th-century", "19th-century", "early-1900s", "early-20th-century", "1910s", "1920s", "1930s", "1940s", "mid-20th-century", "1950s", "1960s", "1970s", "late-20th-century", "1980s", "1990s", "20th-century", "21st-century-and-contemporary" ], "type": "string", "description": "Filter by era, using 1stDibs' own facet taxonomy. Only applies in Browse by category mode against categories that support it (all except New Arrivals and Saturday Sale, where it's ignored). Cannot be combined with `style`, `material`, or `origin` in Browse by category mode (the site drops the filters when combined as path segments) — if any of those are also set, they're ignored in favor of `period`.", "default": "" }, "location": { "title": "Item ships from (mode=browseCategory)", "enum": [ "", "europe", "usa-north-america", "canada-north-america", "asia", "australia", "united-kingdom-europe", "france-europe", "italy-europe", "germany-europe", "spain-europe", "switzerland-europe", "netherlands-europe", "belgium-europe", "denmark-europe", "sweden-europe" ], "type": "string", "description": "Filter by seller/item location, using 1stDibs' own \"Item Ships From\" facet. Browse by category mode only — ignored in Search mode. Not supported for the New Arrivals or Saturday Sale categories (ignored there). Cannot be combined with `period`, `style`, `material`, or `origin` in Browse by category mode (the site drops the filters when combined as path segments) — if any of those are also set, `location` is ignored in favor of it.", "default": "" }, "style": { "title": "Style / aesthetic movement (mode=browseCategory)", "enum": [ "", "abstract", "abstract-expressionist", "art-deco", "art-nouveau", "artisan", "arts-and-crafts", "baroque", "color-field", "contemporary", "edwardian", "empire", "expressionist", "folk-art", "georgian", "hollywood-regency", "impressionist", "industrial", "louis-xv", "louis-xvi", "mid-century-modern", "minimalist", "modern", "native-american", "neoclassical", "old-masters", "photorealist", "pop-art", "post-impressionist", "post-war", "realist", "regency", "retro", "revival", "rococo", "rustic", "scandinavian-modern", "street-art", "surrealist", "victorian" ], "type": "string", "description": "Filter by design style, using 1stDibs' own facet taxonomy. Only applies in Browse by category mode against Furniture, Jewelry & Watches, and Art categories (and their subcategories) — ignored for New Arrivals, Saturday Sale, Fashion, and Fashion — Handbags, which don't support it. Not every style applies to every category (e.g. Louis XV is furniture-only, Edwardian is jewelry-only, Abstract is art-only) — if the chosen style doesn't apply to the chosen category, it's ignored. Cannot be combined with `period` or `origin` in Browse by category mode (the site drops both filters when combined as path segments) — if either is also set, `style` is ignored in favor of it. Cannot be combined with `location` either — if both are set, `style` wins.", "default": "" }, "material": { "title": "Material (mode=browseCategory)", "enum": [ "", "acrylic", "animal-skin", "bamboo", "brass", "bronze", "canvas", "ceramic", "chrome", "cotton", "crystal", "fabric", "glass", "gold", "hardwood", "ink", "iron", "leather", "linen", "marble", "metal", "oil-paint", "paint", "paper", "photography", "plastic", "porcelain", "print", "rattan", "silk", "silver", "steel", "stone", "velvet", "watercolor", "wicker", "wood" ], "type": "string", "description": "Filter by material, using 1stDibs' own facet taxonomy. Only applies in Browse by category mode against Furniture (and its subcategories) and Art — ignored for New Arrivals, Saturday Sale, Jewelry & Watches, and Fashion, which don't support it. Not every material applies to every category. Cannot be combined with `period`, `style`, or `origin` in Browse by category mode (the site drops the whole category scope when combined as path segments) — if any of those are also set, `material` is ignored. Cannot be combined with `location` either — if both are set, `material` wins.", "default": "" }, "origin": { "title": "Place of origin", "enum": [ "", "european", "italian", "asian", "north-american", "french", "american", "scandinavian", "danish" ], "type": "string", "description": "Filter by the item's country/region of manufacture, using 1stDibs' own \"Place of Origin\" facet — distinct from `location`, which is where the seller ships from. Applies in both Search and Browse by category modes. In Browse by category mode only Furniture (and its Seating/Lighting/Tables subcategories) and Fashion (and Fashion — Handbags) support it — ignored for New Arrivals, Jewelry, Jewelry & Watches, Art, and Saturday Sale, which don't. Cannot be combined with `period`, `style`, or `material` in Browse by category mode (the site drops the whole category scope when combined as path segments) — if any of those are also set, `origin` is ignored. Cannot be combined with `location` either — if both are set, `origin` wins. Cannot be combined with `gender` — if both are set, `gender` wins.", "default": "" }, "gender": { "title": "Gender (mode=browseCategory)", "enum": [ "", "mens", "womens" ], "type": "string", "description": "Filter by gender, using 1stDibs' own facet taxonomy. Only applies in Browse by category mode against Jewelry, Jewelry — Watches, Fashion, and Fashion — Handbags — ignored for New Arrivals, Furniture, Art, and Saturday Sale, which don't support it. Cannot be combined with `period`, `location`, `style`, `material`, or `origin` in Browse by category mode (the site 404s or drops the whole category scope when combined as path segments) — if any of those are also set, they're ignored in favor of `gender`.", "default": "" }, "color": { "title": "Color", "enum": [ "", "beige", "black", "blue", "brown", "gold", "gray", "green", "orange", "pink", "purple", "red", "silver", "white", "yellow" ], "type": "string", "description": "Filter by item color, using 1stDibs' own facet taxonomy. Applies in both Search and Browse by category modes. In Browse by category mode only Furniture (and its Seating/Lighting/Tables subcategories), Art, and Fashion (and Fashion — Handbags) support it — ignored for New Arrivals, Jewelry, Jewelry — Watches, and Saturday Sale, which don't. Unlike period/location/style/material/gender, color is a plain query filter and can be freely combined with any of them.", "default": "" }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only return items with a live markdown (1stDibs' own \"On Sale\" facet). Applies in both Search and Browse by category modes and freely combines with every other filter — except the New Arrivals category, which doesn't support it (ignored there).", "default": false }, "returnableOnly": { "title": "Returnable items only", "type": "boolean", "description": "Only return items eligible for free returns (1stDibs' own \"Returnable\" facet). Applies in both Search and Browse by category modes, against every category (including New Arrivals and Saturday Sale), and freely combines with every other filter.", "default": false }, "topSellerOnly": { "title": "Top sellers only", "type": "boolean", "description": "Only return items from 1stDibs-designated Top Seller storefronts (1stDibs' own \"Top Seller Listings\" facet). Applies in both Search and Browse by category modes, against every category (including New Arrivals and Saturday Sale), and freely combines with every other filter.", "default": false }, "customizableOnly": { "title": "Customizable items only", "type": "boolean", "description": "Only return items 1stDibs marks as available made-to-order or customizable on request (the site's own \"Customizable Items Only\" facet). Applies in both Search and Browse by category modes and freely combines with every other filter — except the Art, Fashion, and Fashion — Handbags categories, which don't support it (ignored there).", "default": false }, "strategicPartnerOnly": { "title": "Strategic Partner listings only", "type": "boolean", "description": "Only return items from 1stDibs-designated Strategic Partner storefronts (the site's own \"Strategic Partner Listings\" facet). Applies in both Search and Browse by category modes and freely combines with every other filter — except the New Arrivals, Art, Fashion, and Fashion — Handbags categories, which don't support it (ignored there).", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "price-low", "price-high" ], "type": "string", "description": "Result ordering.", "default": "relevance" }, "minPrice": { "title": "Minimum price", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Filter: minimum item price, in the currency selected below." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Filter: maximum item price, in the currency selected below." }, "currency": { "title": "Price currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "CHF", "MXN", "DKK", "SEK", "NOK" ], "type": "string", "description": "Currency to report item prices in (and to apply minPrice/maxPrice against). 1stDibs pre-computes these conversions server-side; if a specific item doesn't carry a conversion for the chosen currency its price falls back to USD.", "default": "USD" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of items to return.", "default": 60 }, "includeItemDetails": { "title": "Include extended item details", "type": "boolean", "description": "Fetch each item's own product page for additional fields: full description, condition, dimensions, materials, place of origin, reference number, full photo gallery, and category-specific specs (e.g. ring size, metal, stone, medium). Roughly doubles the number of requests and increases run time.", "default": false } } }, "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 } } } } } } } } } }