{ "openapi": "3.0.1", "info": { "title": "Garmin Connect IQ Scraper", "description": "Scrape the Garmin Connect IQ Store - watch faces, apps, widgets, data fields and audio for Garmin devices. Search by keyword, browse by category or compatible device, fetch by URL, and get app details: developer, downloads, ratings, reviews, price, screenshots, supported devices and changelogs.", "version": "1.0", "x-build-id": "Zp2Rebb3ZnWLbWTPw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~garmin-connect-iq-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-garmin-connect-iq-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~garmin-connect-iq-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-garmin-connect-iq-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~garmin-connect-iq-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-garmin-connect-iq-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", "browseByCategory", "browseByDevice", "byUrl" ], "type": "string", "description": "What to fetch.", "default": "search" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text keyword, e.g. `running`, `analog watch face`, `heart rate` (mode=search).", "default": "running" }, "category": { "title": "Category", "enum": [ "all", "watchFaces", "apps", "widgets", "dataFields", "audio" ], "type": "string", "description": "App type to browse or constrain the search to (mode=browseByCategory).", "default": "all" }, "device": { "title": "Device", "enum": [ "fenix8pro", "fenix8-51mm", "fenix8s-51mm", "fenix8-43mm", "fenixE", "fenix7pro", "fenix7spro", "fenix7xpro", "fenix7", "fenix7s", "fenix7X", "fenix6p", "fenix6", "fenix6xp", "epixpro47", "epixpro51", "epix2", "FR970", "forerunner965", "forerunner955", "forerunner945", "forerunner265", "forerunner265s", "forerunner255", "forerunner255s", "forerunner245", "fr165", "forerunner55", "forerunner45", "forerunner235", "venu3", "venu3s", "venu2", "venu2plus", "venusq2", "venusq2music", "venu", "vivoactive5", "vivoactive4", "vivoactive4s", "Instinct3-45mm-a", "Instinct3-50mm-s", "instinct2", "instinct2x", "instinct2S", "instinct-crossover", "approachs70", "approachs62", "descentmk3", "descentmk2", "DescentG1", "d2mach1", "D2mach1pro", "enduro3", "enduro2", "tactix7", "marqII", "edge1050", "edge1040", "edge840", "edge540" ], "type": "string", "description": "Garmin device to browse apps for (mode=browseByDevice). Curated list of popular devices." }, "appUrls": { "title": "App URLs (mode=byUrl)", "type": "array", "description": "Connect IQ app page URLs, e.g. `https://apps.garmin.com/en-US/apps/7cfcead6-aded-4a4b-b024-df4fe641f0f8`. Bare app UUIDs are also accepted.", "default": [], "items": { "type": "string" } }, "minRating": { "title": "Min rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Drop apps rated below this (1-5)." }, "containsKeyword": { "title": "Contains keyword", "type": "string", "description": "Only emit apps whose name, description or developer contains this substring." }, "sortType": { "title": "Sort by", "enum": [ "trending", "mostPopular", "hotFresh" ], "type": "string", "description": "Listing order for browse/search modes.", "default": "trending" }, "countryCode": { "title": "Country", "enum": [ "US", "GB", "DE", "FR", "IT", "ES", "NL", "SE", "NO", "DK", "PL", "TR", "JP", "KR", "SG", "AU", "NZ", "CA", "MX", "BR", "IN", "ZA", "CN", "AE" ], "type": "string", "description": "Country used for store localization and pricing.", "default": "US" }, "includeCompatibleDevices": { "title": "Resolve compatible devices", "type": "boolean", "description": "Resolve the compatible-device part numbers to human-readable device names.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also emit per-app review records (capped by maxItems).", "default": false }, "reviewsPerApp": { "title": "Reviews per app", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum review records to fetch per app when `includeReviews` is on.", "default": 10 }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy (lazily used only if direct access is blocked)." } } }, "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 } } } } } } } } } }