{ "openapi": "3.0.1", "info": { "title": "UK Tyre Price & Fitment Monitor", "description": "The whole priced tyre shelf for any UK fitment size: brand, pattern, fitted and mail-order price, EU label grades, noise, season, runflat, load and speed rating, shelf position and earliest fitting date. Delta mode returns only the lines that moved.", "version": "0.1", "x-build-id": "ZHHzEDAegHIjX0Ll2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zhorex~tyre-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zhorex-tyre-price-monitor", "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/zhorex~tyre-price-monitor/runs": { "post": { "operationId": "runs-sync-zhorex-tyre-price-monitor", "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/zhorex~tyre-price-monitor/run-sync": { "post": { "operationId": "run-sync-zhorex-tyre-price-monitor", "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": [ "size_sweep", "size_index" ], "type": "string", "description": "'Sweep sizes' returns the full priced shelf for each fitment size you list — one request per size, no paging. 'Size index' returns every size the retailer catalogues (782 of them) so you can pick the ones you actually sell.", "default": "size_sweep" }, "sizes": { "title": "Tyre sizes", "type": "array", "description": "Fitment sizes in any common notation — 205/55R16, 205-55-16 or '205 55 16' all work. Each size is one request and returns that whole shelf (about 20-25 distinct tyres). Leave empty and it sweeps the five most common UK car fitments as a demo.", "items": { "type": "string" } }, "postcodes": { "title": "Postcodes (optional)", "type": "array", "description": "Adds a postcode to each request. Tested honestly: the earliest fitting date came back IDENTICAL for London (SW1A1AA) and Edinburgh (EH11AA), so do not expect a per-area signal — this exists so you can reproduce exactly what a customer in a given area is quoted, and it multiplies your rows by the number of postcodes.", "items": { "type": "string" } }, "deltaMode": { "title": "Delta mode — only the lines that MOVED", "type": "boolean", "description": "Turn this on for a repricing cron. The first run records a baseline (billed at the ordinary row rate, never the change rate); every later run returns and bills ONLY what moved — fitted price up or down with the delta, a promotion change, a shelf-position shift of three slots or more, and fitments withdrawn from a shelf they were on. Unchanged lines are never returned and never charged.", "default": false }, "deltaStateKey": { "title": "Delta stream name", "type": "string", "description": "Names an independent delta stream so several monitors don't collide (e.g. 'my-core-sizes' vs 'winter-range'). Only used when Delta mode is on.", "default": "default" }, "proxyConfiguration": { "title": "Proxy (optional)", "type": "object", "description": "Not needed from a residential IP, where this was verified with no challenge and no rate limiting. If the retailer ever refuses your runs with a 403, the run says so explicitly (it does not return an empty shelf) and a GB DATACENTER proxy group is the fix — residential is not required.", "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 } } }, "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 } } } } } } } } } }