{ "openapi": "3.0.1", "info": { "title": "UN Comtrade International Trade Statistics Scraper", "description": "Scrape the United Nations Comtrade free preview API for international trade flows. Pull imports, exports, re-imports and re-exports between reporters and partners by HS commodity code and year, including value, quantity, net weight, gross weight and customs procedure.", "version": "0.0", "x-build-id": "fwMgW4mD9ul42HLG0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~un-comtrade-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-un-comtrade-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/parseforge~un-comtrade-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-un-comtrade-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/parseforge~un-comtrade-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-un-comtrade-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": { "reporterCode": { "title": "Reporter code", "type": "string", "description": "UN M49 reporter code. 0 = World, 842 = USA, 156 = China, 276 = Germany, 392 = Japan, 826 = United Kingdom, 250 = France. Comma-separate to query multiple.", "default": "842" }, "partnerCode": { "title": "Partner code", "type": "string", "description": "UN M49 partner code. Leave empty for all partners (returns one row per partner, ~100+ rows). Use 0 for the single World-aggregate row, 842 for USA, 156 for China, 276 for Germany. Comma-separate for multiple.", "default": "" }, "partner2Code": { "title": "Second partner code (3-way trade)", "type": "string", "description": "UN M49 code for second partner — used for 3-way trade analysis (e.g. Mexico exports to USA via Canada). Leave empty for none.", "default": "" }, "period": { "title": "Period", "type": "string", "description": "Year(s). Single year (2023) or comma-separated (2021,2022,2023).", "default": "2023" }, "cmdCode": { "title": "Commodity code (HS)", "type": "string", "description": "HS commodity code. TOTAL = all commodities, 27 = Mineral fuels, 84 = Machinery, 85 = Electrical machinery, 87 = Vehicles. 2- or 6-digit. Comma-separate for multiple.", "default": "TOTAL" }, "clCode": { "title": "Commodity classification", "enum": [ "HS", "H6", "H5", "H4", "H3", "H2", "H1", "H0" ], "type": "string", "description": "UN Comtrade commodity classification family. HS = current Harmonized System (default), H6/H5/H4/H3/H2/H1/H0 = HS revisions 2022/2017/2012/2007/2002/1996/1988.", "default": "HS" }, "flowCode": { "title": "Flow direction", "enum": [ "M", "X", "RM", "RX" ], "type": "string", "description": "M = imports, X = exports, RM = re-imports, RX = re-exports.", "default": "M" }, "customsCode": { "title": "Customs procedure code", "type": "string", "description": "Customs code. C00 = TOTAL all customs procedures.", "default": "C00" }, "motCode": { "title": "Mode of transport", "type": "string", "description": "Mode of transport. 0 = TOTAL all modes.", "default": "0" }, "aggregateBy": { "title": "Aggregate by", "type": "string", "description": "UN Comtrade aggregation setting (comma-separated dimension names, e.g. 'reporterCode,cmdCode'). Leave empty for raw rows.", "default": "" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" } } }, "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 } } } } } } } } } }