{ "openapi": "3.0.1", "info": { "title": "AptDeco Scraper", "description": "Scrape used furniture listings from AptDeco (aptdeco.com). Search products with category, condition, color, brand, state, and price filters; browse categories; fetch products by ID.", "version": "1.0", "x-build-id": "i7ahzG7weYn6Jf0Ss" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~aptdeco-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-aptdeco-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~aptdeco-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-aptdeco-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~aptdeco-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-aptdeco-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", "byCategory", "byIds" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "Free-text product query, e.g. `sofa`, `dining table`, `mid century`.", "default": "sofa" }, "category": { "title": "Category", "enum": [ "", "Beds", "Chairs", "Décor", "Lighting", "Outdoor & Garden", "Rugs", "Sofas", "Storage", "Tables" ], "type": "string", "description": "Product category (mode=byCategory or as a search filter).", "default": "" }, "subcategory": { "title": "Subcategory", "type": "string", "description": "Subcategory within the selected category, e.g. `Sleeper Sofas` (Sofas), `Coffee Tables` (Tables), `Armchairs` (Chairs)." }, "ids": { "title": "Product IDs (mode=byIds)", "type": "array", "description": "AptDeco product IDs, e.g. `6981876`.", "default": [], "items": { "type": "string" } }, "condition": { "title": "Condition", "enum": [ "", "good", "satisfactory", "new", "floorDisplayModel", "ageWorn" ], "type": "string", "description": "Restrict by item condition.", "default": "" }, "color": { "title": "Color", "enum": [ "", "Beige", "Black", "Blue", "Brown", "Dark Brown", "Dark Gray", "Gold", "Gray", "Green", "Light Brown", "Light Gray", "Light Green", "Natural", "Orange", "Patterned / Multi", "Pink", "Purple", "Red", "Silver", "Transparent", "White", "Yellow" ], "type": "string", "description": "Restrict by item color.", "default": "" }, "brand": { "title": "Brand", "type": "string", "description": "Restrict by manufacturer/brand, e.g. `West Elm`, `Restoration Hardware`, `Article`. Any brand name is accepted." }, "state": { "title": "State", "enum": [ "", "Alabama", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "District of Columbia", "Florida", "Georgia", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" ], "type": "string", "description": "Restrict by US state where the item is located.", "default": "" }, "region": { "title": "Region", "enum": [ "", "northeast", "sfBayArea" ], "type": "string", "description": "Restrict by AptDeco's service region.", "default": "" }, "greaterMetroArea": { "title": "Metro area", "type": "string", "description": "Restrict by metro area, e.g. `New York City`, `Philadelphia`, `San Francisco`, `Chicago`, `Miami`, `Atlanta`. Any metro area name is accepted." }, "sellingType": { "title": "Selling type", "enum": [ "", "individualPieces", "set" ], "type": "string", "description": "Restrict by how the item is listed.", "default": "" }, "priceMin": { "title": "Price (min)", "minimum": 0, "maximum": 100000, "type": "number", "description": "Drop items priced below this (USD)." }, "priceMax": { "title": "Price (max)", "minimum": 0, "maximum": 100000, "type": "number", "description": "Drop items priced above this (USD)." }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceAsc", "priceDesc" ], "type": "string", "description": "Result ordering.", "default": "relevance" }, "containsKeyword": { "title": "Contains keyword", "type": "string", "description": "Client-side filter: only emit items whose title, description, brand, seller, color, or material contains this text." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 } } }, "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 } } } } } } } } } }