{ "openapi": "3.0.1", "info": { "title": "EU ETS Voyage Carbon Exposure Evidence", "description": "Calculate deterministic EU ETS voyage exposure from buyer-supplied vessel, route, and fuel facts using pinned official fixtures. Get gas, fuel, segment, truth-ledger, confidence, limitation, and receipt evidence without provider calls or an automatic legal decision.", "version": "1.5", "x-build-id": "iigAfJhg79gbmqhys" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zinin~voyage-carbon-compliance-evidence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zinin-voyage-carbon-compliance-evidence", "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/zinin~voyage-carbon-compliance-evidence/runs": { "post": { "operationId": "runs-sync-zinin-voyage-carbon-compliance-evidence", "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/zinin~voyage-carbon-compliance-evidence/run-sync": { "post": { "operationId": "run-sync-zinin-voyage-carbon-compliance-evidence", "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": [ "schemaVersion", "mode", "requestId", "reportingYear", "ruleVersion", "vessel", "portCalls", "legs", "berthRecords", "priceInput", "scenario" ], "properties": { "schemaVersion": { "title": "schemaVersion", "type": "string", "description": "Contract version for validation and output interpretation. Enter `1.1.0`; other values are rejected before any Dataset delivery." }, "mode": { "title": "mode", "enum": [ "decision", "synthetic_demo" ], "type": "string", "description": "Choose `decision` for buyer-supplied voyage facts or `synthetic_demo` for the fixed no-charge example. Runtime enforces the fields allowed in each mode." }, "requestId": { "title": "requestId", "maxLength": 64, "type": "string", "description": "Buyer correlation ID copied into the evidence receipt. Decision mode requires `rq_` plus 32 lowercase hexadecimal characters; demo mode uses `public-demo-v1`." }, "reportingYear": { "title": "reportingYear", "minimum": 2024, "maximum": 9999, "type": "integer", "description": "EU ETS reporting year for the voyage decision, from 2024 onward. Runtime pins the surrender rule and phase-in percentage for the year and rejects any mismatch against `ruleVersion`." }, "ruleVersion": { "title": "ruleVersion", "pattern": "^[A-Za-z0-9._:-]{1,64}$", "maxLength": 64, "type": "string", "description": "Pinned rule-set label for `reportingYear`, for example `eu-ets-maritime-2026-v2`. Runtime rejects the request unless this matches the year's pinned rule exactly." }, "vessel": { "title": "vessel", "required": [ "imoNumber", "grossTonnage", "shipCategory", "excludedClass", "article12Treatment" ], "type": "object", "description": "Buyer-declared vessel facts used for in-scope screening. Required and validated only in `decision` mode; `synthetic_demo` mode uses `null`.", "properties": { "imoNumber": { "type": "string", "pattern": "^[0-9]{7}$", "title": "imoNumber", "description": "Seven-digit IMO ship identification number used to identify the vessel in the decision record.", "editor": "textfield" }, "grossTonnage": { "type": "integer", "minimum": 1, "maximum": 1000000, "title": "grossTonnage", "description": "Vessel gross tonnage. Runtime rejects vessels under 5,000 GT as out of the supported scope.", "editor": "number" }, "shipCategory": { "type": "string", "enum": [ "cargo", "passenger", "offshore", "general_cargo", "other" ], "title": "shipCategory", "description": "Vessel category. Only `cargo` and `passenger` are supported calculation branches; the rest are recognized but rejected.", "editor": "select" }, "excludedClass": { "type": "string", "enum": [ "none", "warship", "naval_auxiliary", "fish_catching", "fish_processing", "wooden_primitive", "non_mechanically_propelled", "government_noncommercial" ], "title": "excludedClass", "description": "EU ETS scope-exclusion class. Use `none` for an in-scope vessel; any other value is rejected before Dataset delivery.", "editor": "select" }, "article12Treatment": { "type": "string", "enum": [ "none_declared", "ice_class", "island_passenger_ro_pax", "transnational_public_service", "outermost_region", "captured_or_permanently_bound", "unknown" ], "title": "article12Treatment", "description": "Article 12 special-treatment declaration. Use `none_declared` for the ordinary path; every other value is a recognized but unsupported branch.", "editor": "select" } }, "additionalProperties": false }, "portCalls": { "title": "portCalls", "minItems": 2, "maxItems": 9, "type": "array", "description": "Ordered array of 2–9 buyer-supplied port-call facts. IDs must be unique and are referenced by voyage legs and optional berth-consumption records.", "items": { "type": "object", "additionalProperties": false, "required": [ "portCallId", "unlocode", "memberStatePort", "isPortOfCall", "specialTreatment", "startedAt", "endedAt" ], "properties": { "portCallId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$", "title": "portCallId", "description": "Unique port-call identifier used by legs and berth records. Use 1–64 letters, digits, dots, underscores, colons, or hyphens, beginning with a letter or digit.", "editor": "textfield" }, "unlocode": { "type": "string", "pattern": "^[A-Z0-9]{5}$", "title": "unlocode", "description": "Five-character uppercase UN/LOCODE for the observed port, such as `NLRTM` or `USNYC`. It supports route-scope and evidence interpretation.", "editor": "textfield" }, "memberStatePort": { "type": "boolean", "title": "memberStatePort", "description": "Set true only when the supplied port fact is a qualifying EU ETS Member State port; this flag affects the voyage-scope calculation.", "editor": "checkbox" }, "isPortOfCall": { "type": "boolean", "title": "isPortOfCall", "description": "Set true when this stop qualifies as a port of call under the buyer's evidence. False keeps the stop visible while excluding it from ordinary port-call treatment.", "editor": "checkbox" }, "specialTreatment": { "type": "string", "enum": [ "ordinary", "excluded_stop", "neighbouring_container_transhipment", "unknown" ], "title": "specialTreatment", "description": "Regulatory treatment asserted for this stop: ordinary, excluded stop, neighbouring container transhipment, or unknown. Unknown produces a review gap rather than silent certainty.", "editor": "select" }, "startedAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "startedAt", "description": "UTC start of the port-call interval in exact `YYYY-MM-DDTHH:mm:ssZ` form. It must precede the matching end time and align with linked activity.", "editor": "textfield" }, "endedAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "endedAt", "description": "UTC end of the port-call interval in exact `YYYY-MM-DDTHH:mm:ssZ` form. It bounds berth activity and voyage chronology checks.", "editor": "textfield" } } } }, "legs": { "title": "legs", "minItems": 1, "maxItems": 8, "type": "array", "description": "Ordered array of 1–8 voyage legs linking the supplied port calls. Each leg includes its UTC interval and bounded fuel-consumption evidence.", "items": { "type": "object", "additionalProperties": false, "required": [ "legId", "departurePortCallId", "arrivalPortCallId", "departureAt", "arrivalAt", "fuelRecords" ], "properties": { "legId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$", "title": "legId", "description": "Unique voyage-leg identifier used in the evidence ledger. Use 1–64 letters, digits, dots, underscores, colons, or hyphens, beginning with a letter or digit.", "editor": "textfield" }, "departurePortCallId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$", "title": "departurePortCallId", "description": "Exact `portCallId` of this leg's departure stop. The referenced port call must exist in `portCalls` and precede the arrival stop.", "editor": "textfield" }, "arrivalPortCallId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$", "title": "arrivalPortCallId", "description": "Exact `portCallId` of this leg's arrival stop. The referenced port call must exist in `portCalls` and follow the departure stop.", "editor": "textfield" }, "departureAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "departureAt", "description": "UTC departure timestamp in exact `YYYY-MM-DDTHH:mm:ssZ` form. Runtime checks it against the linked port calls and fuel-consumption intervals.", "editor": "textfield" }, "arrivalAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "arrivalAt", "description": "UTC arrival timestamp in exact `YYYY-MM-DDTHH:mm:ssZ` form. It must be later than departure and consistent with the linked port-call chronology.", "editor": "textfield" }, "fuelRecords": { "type": "array", "minItems": 1, "maxItems": 4, "items": { "type": "object", "additionalProperties": false, "required": [ "recordId", "consumptionStartAt", "consumptionEndAt", "fuelType", "massTonnes", "dataTruth" ], "properties": { "recordId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$", "title": "recordId", "description": "Unique identifier for this leg fuel-consumption record. Use 1–64 letters, digits, dots, underscores, colons, or hyphens, beginning with a letter or digit.", "editor": "textfield" }, "consumptionStartAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "consumptionStartAt", "description": "UTC start of the fuel-consumption interval in exact `YYYY-MM-DDTHH:mm:ssZ` form. The interval must fall within the associated voyage leg.", "editor": "textfield" }, "consumptionEndAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "consumptionEndAt", "description": "UTC end of the fuel-consumption interval in exact `YYYY-MM-DDTHH:mm:ssZ` form. It must follow the start and stay within the associated voyage leg.", "editor": "textfield" }, "fuelType": { "type": "string", "enum": [ "HFO", "LFO", "MDO_MGO", "LNG", "BIO_LNG", "LPG_BUTANE", "LPG_PROPANE", "METHANOL", "BIOFUEL", "OTHER" ], "title": "fuelType", "description": "Fuel category for the supplied mass value. Choose the exact enum matching the evidence; unsupported calculation paths fail closed instead of guessing factors.", "editor": "select" }, "massTonnes": { "type": "string", "pattern": "^(0|[1-9][0-9]*)(?:\\.[0-9]{0,5}[1-9])?$", "title": "massTonnes", "description": "Fuel mass in metric tonnes as a non-negative decimal string, for example `12.5`, with at most six significant fractional positions under the closed contract.", "editor": "textfield" }, "dataTruth": { "type": "string", "enum": [ "measured", "buyer_reported", "estimated" ], "title": "dataTruth", "description": "Evidence quality for this fuel record: measured, buyer-reported, or estimated. The value is preserved so confidence and review gaps remain explicit.", "editor": "select" } } }, "title": "fuelRecords", "description": "Array of 1–4 fuel-consumption evidence records for this leg. Intervals, fuel types, masses, and evidence quality feed the emissions calculation.", "editor": "json" } } } }, "berthRecords": { "title": "berthRecords", "maxItems": 18, "type": "array", "description": "Optional array of up to 18 berth fuel-consumption records linked to port calls. Supply an empty array when no berth consumption evidence is available.", "items": { "type": "object", "additionalProperties": false, "required": [ "recordId", "portCallId", "consumptionStartAt", "consumptionEndAt", "fuelType", "massTonnes", "dataTruth" ], "properties": { "recordId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$", "title": "recordId", "description": "Unique identifier for this berth-consumption record. Use 1–64 letters, digits, dots, underscores, colons, or hyphens, beginning with a letter or digit.", "editor": "textfield" }, "portCallId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$", "title": "portCallId", "description": "Exact `portCallId` where the berth consumption occurred. The referenced port call must exist and contain the supplied consumption interval.", "editor": "textfield" }, "consumptionStartAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "consumptionStartAt", "description": "UTC start of berth fuel consumption in exact `YYYY-MM-DDTHH:mm:ssZ` form. It must fall within the linked port-call interval.", "editor": "textfield" }, "consumptionEndAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "consumptionEndAt", "description": "UTC end of berth fuel consumption in exact `YYYY-MM-DDTHH:mm:ssZ` form. It must follow the start and remain within the linked port call.", "editor": "textfield" }, "fuelType": { "type": "string", "enum": [ "HFO", "LFO", "MDO_MGO", "LNG", "BIO_LNG", "LPG_BUTANE", "LPG_PROPANE", "METHANOL", "BIOFUEL", "OTHER" ], "title": "fuelType", "description": "Fuel category for the berth-consumption mass. Choose the exact enum supported by the pinned calculation rules; unsupported paths fail closed.", "editor": "select" }, "massTonnes": { "type": "string", "pattern": "^(0|[1-9][0-9]*)(?:\\.[0-9]{0,5}[1-9])?$", "title": "massTonnes", "description": "Berth fuel mass in metric tonnes as a non-negative decimal string, for example `1.25`, using the precision permitted by the closed contract.", "editor": "textfield" }, "dataTruth": { "type": "string", "enum": [ "measured", "buyer_reported", "estimated" ], "title": "dataTruth", "description": "Evidence quality for this berth record: measured, buyer-reported, or estimated. It is retained in the output confidence and review-gap evidence.", "editor": "select" } } } }, "priceInput": { "title": "priceInput", "required": [ "currency", "usdPerAllowance", "priceDate", "priceObservedAt", "dataTruth" ], "type": "object", "description": "Optional buyer-supplied EU allowance price used for cost estimation. Set null when no price evidence is supplied for this decision.", "properties": { "currency": { "type": "string", "enum": [ "USD" ], "title": "currency", "description": "Allowance price currency; only USD is supported by the closed contract.", "editor": "select" }, "usdPerAllowance": { "type": "string", "pattern": "^(0|[1-9][0-9]*)(?:\\.[0-9]{0,5}[1-9])?$", "title": "usdPerAllowance", "description": "EU allowance price in USD as a non-negative decimal string, up to 100,000.", "editor": "textfield" }, "priceDate": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "title": "priceDate", "description": "Calendar date of the observed price in exact `YYYY-MM-DD` form; runtime requires it inside `reportingYear`.", "editor": "textfield" }, "priceObservedAt": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$", "title": "priceObservedAt", "description": "UTC timestamp the price was observed, in exact `YYYY-MM-DDTHH:mm:ssZ` form; its date must equal `priceDate` and cannot be in the future.", "editor": "textfield" }, "dataTruth": { "type": "string", "enum": [ "buyer_reported", "estimated" ], "title": "dataTruth", "description": "Evidence quality for the price. Unlike fuel records, `measured` is not an accepted value here.", "editor": "select" } }, "additionalProperties": false }, "scenario": { "title": "scenario", "required": [ "alternativeFuelMassMultiplier" ], "type": "object", "description": "Optional what-if fuel-mass multiplier scenario. Set null to use the buyer-supplied facts exactly as reported, with no multiplier applied.", "properties": { "alternativeFuelMassMultiplier": { "type": "string", "pattern": "^(0|[1-9][0-9]*)(?:\\.[0-9]{0,5}[1-9])?$", "title": "alternativeFuelMassMultiplier", "description": "Alternative-fuel mass multiplier as a decimal string from 0.5 through 1.5.", "editor": "textfield" } }, "additionalProperties": false } } }, "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 } } } } } } } } } }