{ "openapi": "3.0.1", "info": { "title": "Satellite Map Imagery Capture API (For all XYZ Tile Servers)", "description": "Capture, stitch and export satellite map imagery from all XYZ Tile Servers as PNG and GeoTIFF Google Maps, Bing Maps, ESRI and more.\nDownload permitted XYZ map imagery and export stitched PNG and georeferenced BigTIFF files from any compatible tile server.", "version": "1.0", "x-build-id": "o1pqvdQLUXy1bp1KY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/t_wasfy~satellite-map-imagery-capture-api-for-all-xyz-tile-servers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-t_wasfy-satellite-map-imagery-capture-api-for-all-xyz-tile-servers", "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/t_wasfy~satellite-map-imagery-capture-api-for-all-xyz-tile-servers/runs": { "post": { "operationId": "runs-sync-t_wasfy-satellite-map-imagery-capture-api-for-all-xyz-tile-servers", "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/t_wasfy~satellite-map-imagery-capture-api-for-all-xyz-tile-servers/run-sync": { "post": { "operationId": "run-sync-t_wasfy-satellite-map-imagery-capture-api-for-all-xyz-tile-servers", "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": [ "tileUrl", "confirmTileServerPermission", "minLat", "minLon", "maxLat", "maxLon" ], "properties": { "tileUrl": { "title": "Permitted XYZ tile URL", "type": "string", "description": "Must contain {z}, {x}, and {y}. EOX Sentinel-2 Cloudless 2024 is provided for testing." }, "confirmTileServerPermission": { "title": "I confirm this tile server permits this use", "type": "boolean", "description": "Required. The user is responsible for checking the tile server license and terms.", "default": false }, "minLat": { "title": "South / min latitude", "type": "number", "description": "Southern latitude of the requested bounding box in WGS84 decimal degrees." }, "minLon": { "title": "West / min longitude", "type": "number", "description": "Western longitude of the requested bounding box in WGS84 decimal degrees." }, "maxLat": { "title": "North / max latitude", "type": "number", "description": "Northern latitude of the requested bounding box in WGS84 decimal degrees." }, "maxLon": { "title": "East / max longitude", "type": "number", "description": "Eastern longitude of the requested bounding box in WGS84 decimal degrees." }, "zoom": { "title": "XYZ zoom", "minimum": 0, "maximum": 24, "type": "integer", "description": "XYZ/Web Mercator zoom level used to calculate the requested tile grid.", "default": 12 }, "outputFormats": { "title": "Output formats", "type": "array", "description": "Select the streamed EPSG:3857 BigTIFF and optionally a PNG preview.", "items": { "type": "string", "enum": [ "png", "geotiff" ], "enumTitles": [ "PNG mosaic", "GeoTIFF/BigTIFF EPSG:3857" ] }, "default": [ "geotiff", "png" ] }, "maxTiles": { "title": "Maximum tile safety limit", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The GeoTIFF is streamed directly to disk as BigTIFF; this limit protects the tile server and Actor runtime.", "default": 500 }, "maxConcurrency": { "title": "Parallel downloads", "minimum": 1, "maximum": 16, "type": "integer", "description": "Maximum number of tile requests processed concurrently.", "default": 4 }, "rateLimitMs": { "title": "Delay per request in milliseconds", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum per-worker delay before each tile request to reduce load on the permitted server.", "default": 100 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time in seconds to wait for an individual tile response.", "default": 30 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of retry attempts after a tile request or image validation failure.", "default": 2 }, "headers": { "title": "Optional HTTP headers", "type": "object", "description": "Do not place secrets here unless your Actor storage and access are configured appropriately." } } }, "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 } } } } } } } } } }