{ "openapi": "3.0.1", "info": { "title": "Panama Canal Advisories to Shipping Scraper", "description": "Scrape every ACP Advisory to Shipping: draft restrictions, transit slot and booking rule changes, and monthly canal operations summaries, filterable by year, advisory number and keyword.", "version": "0.0", "x-build-id": "L9K8sL8u3c3Q3zGDD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arman-bd~panama-canal-advisories-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arman-bd-panama-canal-advisories-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/arman-bd~panama-canal-advisories-scraper/runs": { "post": { "operationId": "runs-sync-arman-bd-panama-canal-advisories-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/arman-bd~panama-canal-advisories-scraper/run-sync": { "post": { "operationId": "run-sync-arman-bd-panama-canal-advisories-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", "properties": { "yearFrom": { "title": "Year from", "minimum": 0, "type": "integer", "description": "Keep only advisories published in this year or later, taken from the advisory's own ADV-NN-YYYY number, not the upload date. 0 means no lower bound.", "default": 0 }, "yearTo": { "title": "Year to", "minimum": 0, "type": "integer", "description": "Keep only advisories published in this year or earlier. 0 means no upper bound, so this year's advisories are always included.", "default": 0 }, "advisoryNumberFrom": { "title": "Advisory number from", "minimum": 0, "type": "integer", "description": "Drop advisories numbered below this. Numbering restarts each year (ADV-01 is the first advisory of its year), so this filters within a year rather than across the whole archive. 0 means no filter.", "default": 0 }, "keywords": { "title": "Keyword filter", "type": "array", "description": "Keep only advisories whose title contains at least one of these words or phrases (e.g. 'draft', 'booking', 'transit', 'maximum authorized draft'). Case-insensitive, matched against the title with hyphens treated as spaces. Leave empty to keep every advisory.", "items": { "type": "string" } }, "downloadPdf": { "title": "Verify PDFs", "type": "boolean", "description": "HEAD-request each matching PDF to confirm it still resolves and to record its size and content type. Roughly doubles run time since it is one extra request per advisory. Leave off for a fast index-only pull.", "default": false }, "maxAdvisories": { "title": "Max advisories", "minimum": 0, "type": "integer", "description": "Stop after this many advisories, newest (by year, then advisory number) first. 0 means return every advisory that matches the other filters. The whole archive is a few hundred records at most.", "default": 0 } } }, "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 } } } } } } } } } }