{ "openapi": "3.0.1", "info": { "title": "Palmstreet Scraper - Products, Prices & Sellers", "description": "Scrape Palmstreet listings by keyword, marketplace URL or seller handle: full product detail, variants, prices, stock, shipping and seller profiles.", "version": "1.0", "x-build-id": "EEh6NHmYeYkfQSgn7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lofomachines~palmstreet-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lofomachines-palmstreet-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/lofomachines~palmstreet-scraper/runs": { "post": { "operationId": "runs-sync-lofomachines-palmstreet-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/lofomachines~palmstreet-scraper/run-sync": { "post": { "operationId": "run-sync-lofomachines-palmstreet-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": { "searchTerms": { "title": "Search keywords", "type": "array", "description": "What to search for on Palmstreet, one keyword per line. Leave empty to cover the whole marketplace.", "items": { "type": "string" } }, "startUrls": { "title": "Palmstreet URLs", "type": "array", "description": "Paste Palmstreet addresses: a seller page such as https://palmstreet.app/u/Koryn, or a search such as https://palmstreet.app/products?q=pothos", "items": { "type": "string" } }, "sellerUsernames": { "title": "Seller handles", "type": "array", "description": "Seller names to look up directly, without pasting a full address.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum listings per input", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Upper limit of listings returned for each keyword, address or seller.", "default": 200 }, "categories": { "title": "Categories to include", "type": "array", "description": "Leave empty for everything, or focus on specific parts of the marketplace.", "items": { "type": "string", "enum": [ "rare_plants_v2", "pottery_v2", "crystals_v2", "trading_card", "reptile_v2", "invertebrate", "beauty", "jewelry", "crochet", "art_collectibles", "home_goods", "handbag", "apparel", "shipping_upgrade" ], "enumTitles": [ "Rare plants", "Pottery & planters", "Crystals & minerals", "Trading cards", "Reptiles", "Invertebrates", "Beauty", "Jewelry", "Crochet & handmade", "Art & collectibles", "Home goods", "Handbags", "Apparel", "Shipping upgrades" ] }, "default": [] }, "sortBy": { "title": "Sort results by", "enum": [ "relevance", "newest", "oldest", "price_low", "price_high" ], "type": "string", "description": "How the returned listings should be ordered.", "default": "relevance" }, "includeSoldOut": { "title": "Include sold-out listings", "type": "boolean", "description": "Off by default, so only listings that are currently available are returned.", "default": false }, "includeFullDetails": { "title": "Fetch extra listing details (slower)", "type": "boolean", "description": "Off by default, because the fast pass already returns prices, variants, stock, shipping, images and the full seller profile. Turning this on adds tags, option matrices, gifting and instalment availability, but costs one extra request per listing.", "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 } } } } } } } } } }