{ "openapi": "3.0.1", "info": { "title": "UN Comtrade International Trade Data Scraper", "description": "Scrape international trade statistics: import and export values between countries by commodity (HS code), annual or monthly. Clean labelled rows with country names, ISO codes, commodity descriptions, trade value in USD, net weight and quantity. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "byVGgdZeVhLoKGB0S" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~un-comtrade-trade-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-un-comtrade-trade-data-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/scrapers_lat~un-comtrade-trade-data-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-un-comtrade-trade-data-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/scrapers_lat~un-comtrade-trade-data-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-un-comtrade-trade-data-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": { "reporters": { "title": "Reporter countries", "type": "array", "description": "Countries that report the trade (the exporter for exports, the importer for imports). Enter one or more as a country name, ISO code (e.g. USA, DEU, CHN) or numeric code. One run covers every reporter you list.", "items": { "type": "string" } }, "partners": { "title": "Partner countries", "type": "array", "description": "The trade counterpart countries. Use 'World' to get each reporter's total trade, or list specific partners by name or ISO code (e.g. China, Canada, MEX).", "items": { "type": "string" } }, "flow": { "title": "Trade flow", "enum": [ "export", "import", "both", "reexport", "reimport" ], "type": "string", "description": "Which flow to return: exports, imports, both, or re-exports / re-imports.", "default": "export" }, "frequency": { "title": "Frequency", "enum": [ "annual", "monthly" ], "type": "string", "description": "Annual totals or monthly figures. For monthly, enter periods as YYYYMM (e.g. 202401).", "default": "annual" }, "periods": { "title": "Periods (years or months)", "type": "array", "description": "Years (e.g. 2023) for annual, or months as YYYYMM (e.g. 202401) for monthly. List several to compare over time.", "items": { "type": "string" } }, "commodityCodes": { "title": "Commodity HS codes", "type": "array", "description": "Harmonized System (HS) commodity codes to return. Use 'TOTAL' for all goods, a 2-digit chapter (e.g. 27 = mineral fuels, 85 = electronics) or a more detailed code. List several to break trade down by product.", "items": { "type": "string" } }, "maxRecords": { "title": "Max Records To Scrape", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of trade records to return across the whole run." }, "apiToken": { "title": "UN Comtrade access key (optional)", "type": "string", "description": "Optional. Leave empty to use the free public preview (recent data). Provide your own free UN Comtrade subscription key to unlock full historical data and higher volume." } } }, "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 } } } } } } } } } }