{ "openapi": "3.0.1", "info": { "title": "Sitemap — Multi-Site URL Inventory", "description": "Inventory public sitemap indexes and XML/gzip documents across sites with deduplicated URLs, lastmod, source provenance and explicit coverage caps. $0.05 per 1,000 URLs, no start fee.", "version": "0.1", "x-build-id": "h9POeiRbgVpXz7Bup" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jpmarketdata~sitemap-multi-site-url-inventory/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jpmarketdata-sitemap-multi-site-url-inventory", "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/jpmarketdata~sitemap-multi-site-url-inventory/runs": { "post": { "operationId": "runs-sync-jpmarketdata-sitemap-multi-site-url-inventory", "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/jpmarketdata~sitemap-multi-site-url-inventory/run-sync": { "post": { "operationId": "run-sync-jpmarketdata-sitemap-multi-site-url-inventory", "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", "properties": { "sitemapUrls": { "title": "Site roots or sitemap URLs", "minItems": 1, "maxItems": 5, "type": "array", "description": "One to five public HTTP(S) roots, sitemap indexes, XML or XML.gz URLs. Robots checked before every source and redirect. $0.00005 per delivered URL.", "items": { "type": "string" }, "default": [ "https://onescales.com/sitemap.xml" ] }, "maxUrls": { "title": "Maximum unique URLs", "minimum": 1, "maximum": 10000, "type": "integer", "description": "One to10,000 deduplicated URL rows across sources; default1,000. Caps and pending sitemap references are reported. $0.00005 per delivered URL.", "default": 1000 }, "maxSitemaps": { "title": "Maximum sitemap documents", "minimum": 1, "maximum": 50, "type": "integer", "description": "One to50 XML sitemap/index documents in total. Every selected root is validated, then breadth-first traversal is bounded. $0.00005 per delivered URL.", "default": 50 }, "maxDepth": { "title": "Maximum index depth", "minimum": 1, "maximum": 8, "type": "integer", "description": "One to8 nested index levels. Cycles are deduplicated; pending documents at depth cap are reported. $0.00005 per delivered URL.", "default": 8 }, "includeContains": { "title": "URL contains any", "maxItems": 10, "type": "array", "description": "Optional case-sensitive substrings. Empty includes all safe published URLs. No URL pages are opened. $0.00005 per delivered URL.", "items": { "type": "string" }, "default": [] }, "excludeContains": { "title": "URL excludes all", "maxItems": 10, "type": "array", "description": "Optional case-sensitive URL substrings to exclude after include filter. Empty excludes none. $0.00005 per delivered URL.", "items": { "type": "string" }, "default": [] } } }, "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 } } } } } } } } } }