{ "openapi": "3.0.1", "info": { "title": "Open Catchment Accessibility Analyzer", "description": "Analyze service coverage and accessibility around any location using OpenStreetMap. Generate distance-based catchment metrics and export results as Dataset, CSV, XLSX, and summary JSON for planning and site selection.", "version": "0.2", "x-build-id": "Uh8lqOZNQUlnQIfhO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/adinfosys-labs~open-catchment-accessibility-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-adinfosys-labs-open-catchment-accessibility-analyzer", "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/adinfosys-labs~open-catchment-accessibility-analyzer/runs": { "post": { "operationId": "runs-sync-adinfosys-labs-open-catchment-accessibility-analyzer", "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/adinfosys-labs~open-catchment-accessibility-analyzer/run-sync": { "post": { "operationId": "run-sync-adinfosys-labs-open-catchment-accessibility-analyzer", "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": [ "anchors" ], "properties": { "studyName": { "title": "Study name", "type": "string", "description": "A label used in outputs.", "default": "Catchment study" }, "timeLimitSeconds": { "title": "Time limit (seconds)", "type": "integer", "description": "Hard runtime budget.", "default": 180 }, "anchors": { "title": "Anchors (JSON)", "type": "string", "description": "JSON array of anchors. Example: [{\"anchor_id\":\"A1\",\"anchor_name\":\"Example\",\"anchor_type\":\"anchor\",\"lat\":40.1776,\"lon\":44.5126}]", "default": "[{\"anchor_id\":\"A1\",\"anchor_name\":\"Example anchor\",\"anchor_type\":\"anchor\",\"lat\":40.1776,\"lon\":44.5126}]" }, "radiiMeters": { "title": "Radii (meters) (JSON)", "type": "string", "description": "JSON array of radii in meters.", "default": "[300,500,1000]" }, "serviceCategories": { "title": "Service categories (JSON)", "type": "string", "description": "JSON array of category IDs.", "default": "[\"businesses\",\"pharmacy\"]" }, "maxResultsPerCategory": { "title": "Max results per category", "type": "integer", "description": "Maximum number of OSM results per category (cap to keep Overpass fast).", "default": 120 }, "splitBusinesses": { "title": "Split businesses", "type": "boolean", "description": "If enabled, expands 'businesses' into business_retail/food/services/office.", "default": false }, "outputMode": { "title": "Output mode", "enum": [ "summary", "raw" ], "type": "string", "description": "raw = entities list; summary = metrics table.", "default": "raw" }, "outputFormats": { "title": "Output formats (JSON)", "type": "string", "description": "JSON array of formats.", "default": "[\"dataset\",\"csv\",\"xlsx\",\"summaryJson\"]" }, "includeGeometries": { "title": "Include geometries (GeoJSON)", "type": "boolean", "description": "If enabled, exports services.geojson and catchments.geojson outputs.", "default": 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 } } }, "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 } } } } } } } } } }