{ "openapi": "3.0.1", "info": { "title": "Pinkoi Scraper - Product, Price & New Listing Watch", "description": "Pinkoi scraper: search keywords or shop ids to one row per listing with price and original price in 12 currencies (USD, JPY, TWD...), discount, rating, reviews, shop, photo, workshop and digital flags. For design-marketplace price and new-listing watching.", "version": "0.1", "x-build-id": "bmRWq5EkWe1MKHoq9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/superslowsloth~pinkoi-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-superslowsloth-pinkoi-products", "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/superslowsloth~pinkoi-products/runs": { "post": { "operationId": "runs-sync-superslowsloth-pinkoi-products", "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/superslowsloth~pinkoi-products/run-sync": { "post": { "operationId": "run-sync-superslowsloth-pinkoi-products", "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 terms", "type": "array", "description": "What you would type into the Pinkoi search box, one term per line (for example tote bag, ceramic mug or notebook). Each term is searched across all of Pinkoi, in any language Pinkoi's search understands. A listing that two terms both find is returned once, under the first. When you also give shop IDs, each term is searched inside each of those shops instead.", "items": { "type": "string" } }, "shopIds": { "title": "Shop IDs", "type": "array", "description": "Pinkoi shops whose whole catalogue you want, one per line. A shop ID is the last part of its address: for https://www.pinkoi.com/store/omhandmade it is omhandmade (the full address is accepted too). Letters, digits, - and _ only; an ID is lower case. With search terms as well, each term is searched inside each shop. A shop ID that does not exist returns no rows and is not charged.", "items": { "type": "string" } }, "maxItems": { "title": "Max listings per search term or shop", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Return at most this many listings for each search term (or shop). A page holds 30 listings plus the sponsored ones Pinkoi mixes in, so up to 60. Up to 10,000 are accepted; Pinkoi lists nothing past its 1,000th page.", "default": 100 }, "sort": { "title": "Sort order", "enum": [ "popular", "newest", "price-asc", "price-desc" ], "type": "string", "description": "The order Pinkoi lists the results in, the same choices as its own sort menu. 'Most popular' is its default. 'Newest' is Pinkoi's 'Most recent' sort, for catching new listings. The price sorts are Pinkoi's own and are not exact: neighbouring listings can be slightly out of order.", "default": "popular" }, "currency": { "title": "Currency", "enum": [ "USD", "TWD", "JPY", "EUR", "GBP", "HKD", "CNY", "THB", "SGD", "MYR", "AUD", "CAD" ], "type": "string", "description": "The currency Pinkoi shows the prices in. Pinkoi converts every price into it, so the same listing has a different number in each currency. Without a choice Pinkoi would use the currency of the proxy's country, so this is always set; US dollars by default.", "default": "USD" }, "language": { "title": "Language", "enum": [ "en", "zh-TW", "zh-CN", "zh-HK", "ja", "th" ], "type": "string", "description": "The language of the listing titles and shop names, and of the product links. The same listing reads differently in each language (an English title in 'English', the Chinese one in 'Traditional Chinese (Taiwan)'). It does not change which listings are found.", "default": "en" }, "includeSponsored": { "title": "Include sponsored listings", "type": "boolean", "description": "Pinkoi mixes sponsored listings into its results (the is_sponsored field). Turn this off to return only organic listings. Sponsored listings that are skipped are not charged and do not count toward Max listings.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Use Apify's automatic datacenter proxy (the default). Pinkoi's search API answered Apify datacenter addresses with HTTP 200 when this actor was built; the residential group was not needed. A refused request is retried from a fresh address.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }