{ "openapi": "3.0.1", "info": { "title": "UK Importers and Exporters: HMRC Trade Data", "description": "Find UK businesses that imported or exported goods by HS code and month, look companies up, and get alerts on traders new to a commodity. HMRC UK Trade Info data under the OGL. Names that are not clearly an organisation's are left out. Not affiliated with HMRC.", "version": "0.1", "x-build-id": "eo7vfhgZI9JlSARBO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yappman~uk-importers-exporters/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yappman-uk-importers-exporters", "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/yappman~uk-importers-exporters/runs": { "post": { "operationId": "runs-sync-yappman-uk-importers-exporters", "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/yappman~uk-importers-exporters/run-sync": { "post": { "operationId": "run-sync-yappman-uk-importers-exporters", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "lookup", "alert" ], "type": "string", "description": "search: the traders of some HS codes in a month or range; lookup: what named companies imported or exported; alert: traders new to your HS codes each month HMRC publishes.", "default": "search" }, "hsCodes": { "title": "HS codes (search, alert)", "maxItems": 20, "type": "array", "description": "1 to 20 codes of 2, 4, 6 or 8 digits (HS chapter, heading, subheading or CN8).", "items": { "type": "string" } }, "companies": { "title": "Companies (lookup)", "maxItems": 20, "type": "array", "description": "1 to 20 company names (or part of one, at least 3 characters) or HMRC trader ids. Names that are not clearly an organisation's are never returned.", "items": { "type": "string" } }, "flows": { "title": "Flows", "type": "array", "description": "Imports, exports or both.", "items": { "type": "string", "enum": [ "imports", "exports" ], "enumTitles": [ "Imports", "Exports" ] }, "default": [ "imports", "exports" ] }, "monthFrom": { "title": "Month from", "type": "string", "description": "YYYY-MM. With monthTo, up to 12 months from 2016-01. Search default: the latest month HMRC has published. Lookup default: the 12 months to it." }, "monthTo": { "title": "Month to", "type": "string", "description": "YYYY-MM, with monthFrom." }, "alertId": { "title": "Alert id (alert)", "type": "string", "description": "1 to 40 characters of a-z, 0-9 and -. The alert's state lives in your own key-value store uk-traders-alert-." }, "lookbackMonths": { "title": "Look-back months (alert)", "minimum": 1, "maximum": 24, "type": "integer", "description": "A trader counts as new when it has not traded your codes for this many months.", "default": 12 }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on rows returned, and so on what you are charged. Prefilled at 20; raise it for more. When left out (an API call), it is 1,000.", "default": 1000 } } }, "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 } } } } } } } } } }