{ "openapi": "3.0.1", "info": { "title": "UK Trade Data - Imports & Exports by Commodity 2000-2026", "description": "HMRC overseas trade statistics (OGL v3, no key): UK imports and exports by commodity (CN8/HS6/HS4/HS2), country and port, monthly from 2000 to the latest published month. Value in GBP, net mass and supplementary units, with server-side filtering and aggregation.", "version": "0.0", "x-build-id": "0KPTd2Vd8gbD8FRz7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~uk-trade-info/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-uk-trade-info", "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/j0401~uk-trade-info/runs": { "post": { "operationId": "runs-sync-j0401-uk-trade-info", "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/j0401~uk-trade-info/run-sync": { "post": { "operationId": "run-sync-j0401-uk-trade-info", "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": { "mode": { "title": "Mode", "enum": [ "", "summary", "search", "aggregate", "months" ], "type": "string", "description": "summary = latest month totals by flow; search = OTS detail rows; aggregate = one row per group; months = the published months. Leave blank to auto-route: filters -> search, groupBy -> aggregate, no filters -> summary." }, "month": { "title": "Month", "type": "string", "description": "Month in YYYY-MM or YYYYMM (e.g. \"2026-08\"). Blank = the latest published month." }, "monthFrom": { "title": "Month from", "type": "string", "description": "First month of a range (YYYY-MM). Use with monthTo. Blank with monthTo set = the 12 months ending at monthTo." }, "monthTo": { "title": "Month to", "type": "string", "description": "Last month of a range (YYYY-MM). Blank = the latest published month; monthTo alone covers the 12 months ending there." }, "commodity": { "title": "Commodity code", "type": "string", "description": "CN8 (8 digits), HS6 (6), HS4 (4) or HS2 (2) code, e.g. \"22042110\", \"220421\", \"2204\" or \"22\"." }, "country": { "title": "Country", "type": "string", "description": "ISO alpha-2 code (e.g. \"DE\", \"FR\") or an exact country name." }, "flow": { "title": "Flow", "enum": [ "", "import", "export", "EU Imports", "EU Exports", "Non-EU Imports", "Non-EU Exports" ], "type": "string", "description": "import = EU + non-EU imports; export = EU + non-EU exports; or one exact flow." }, "port": { "title": "Port", "type": "string", "description": "Port ID or port code, e.g. \"7\" or \"DOV\" (Dover)." }, "groupBy": { "title": "Aggregate by", "enum": [ "", "flow", "country", "commodity", "port", "month" ], "type": "string", "description": "Aggregate dimension. flow = EU/non-EU imports and exports; country / port / commodity / month roll up the selected rows. month defaults to the last 12 published months when no month range is given. Blank defaults to flow." }, "maxResults": { "title": "Max records", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap the number of search records pushed (0 = the default 50, maximum 5000). Aggregate returns every group.", "default": 50 } } }, "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 } } } } } } } } } }