{ "openapi": "3.0.1", "info": { "title": "Shopify Store Data API", "description": "Get any Shopify store's products, prices, collections, theme and installed apps from just its domain. Fast plain-HTTP scraper for competitor research, price monitoring and Shopify lead generation.", "version": "0.1", "x-build-id": "1G49HpZtM9baOyJdv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kingly_contest_7cb~shopify-store-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kingly_contest_7cb-shopify-store-data-api", "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/kingly_contest_7cb~shopify-store-data-api/runs": { "post": { "operationId": "runs-sync-kingly_contest_7cb-shopify-store-data-api", "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/kingly_contest_7cb~shopify-store-data-api/run-sync": { "post": { "operationId": "run-sync-kingly_contest_7cb-shopify-store-data-api", "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": [ "domains" ], "properties": { "domains": { "title": "Store domains", "type": "array", "description": "Store domains or URLs, one per line, e.g. allbirds.com or https://www.gymshark.com. Custom domains and .myshopify.com domains both work. Non-Shopify domains are reported as such and are not charged.", "items": { "type": "string" } }, "includeProducts": { "title": "Include products", "type": "boolean", "description": "Fetch products from the public /products.json feed (variants, prices, compare-at prices, availability, images, tags, vendor, type, dates). Each product is one dataset row. Price stats on the store row are computed from these products.", "default": true }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Stop after this many products per store. Use 0 to skip products. Large stores can have 10,000+ products.", "default": 250 }, "includeCollections": { "title": "Include collections", "type": "boolean", "description": "Add the store's collections (title, handle, URL, product count) to the store row.", "default": true }, "maxCollectionsPerStore": { "title": "Max collections per store", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Stop after this many collections per store.", "default": 250 }, "includeCollectionProducts": { "title": "Include product handles per collection", "type": "boolean", "description": "For each collection, also list the product handles in it. Costs one extra request per collection, so keep max collections low when this is on.", "default": false }, "maxProductsPerCollection": { "title": "Max product handles per collection", "minimum": 1, "maximum": 250, "type": "integer", "description": "Only used when 'Include product handles per collection' is on.", "default": 30 }, "includeAppsAndTheme": { "title": "Detect theme and apps", "type": "boolean", "description": "Read the theme (name, schema name, version, Theme Store ID) from the Shopify.theme object and fingerprint 70+ apps and pixels (Klaviyo, Judge.me, Yotpo, Recharge, Gorgias, Rebuy, Afterpay, Klarna, Meta Pixel, TikTok Pixel, GTM and more) from the storefront HTML.", "default": true }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many stores to process at the same time. Pages within one store are fetched one by one to stay polite.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Most Shopify stores work without a proxy. Turn on Apify Proxy if you scrape many stores and start seeing HTTP 429 (rate limit) errors.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }