{ "openapi": "3.0.1", "info": { "title": "Census Trade Scraper", "version": "1.0", "x-build-id": "J1OwDYOqZgdL02vyq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fortuitous_pirate~census-trade-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fortuitous_pirate-census-trade-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/fortuitous_pirate~census-trade-scraper/runs": { "post": { "operationId": "runs-sync-fortuitous_pirate-census-trade-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/fortuitous_pirate~census-trade-scraper/run-sync": { "post": { "operationId": "run-sync-fortuitous_pirate-census-trade-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", "required": [ "startMonth" ], "properties": { "tradeType": { "title": "Trade Type", "enum": [ "imports", "exports", "both" ], "type": "string", "description": "Type of trade data to retrieve", "default": "both" }, "dataLevel": { "title": "Data Level", "enum": [ "hs", "porths", "naics", "enduse" ], "type": "string", "description": "Level of detail for trade data", "default": "hs" }, "hsCode": { "title": "HS Code", "type": "string", "description": "Harmonized System code to filter by (2, 4, 6, or 10 digits). Leave empty for all commodities. Examples: 87 (vehicles), 8703 (motor cars), 870310 (snow vehicles)", "default": "8703" }, "countryCode": { "title": "Country Code", "type": "string", "description": "Census country code (e.g., 5700=China, 2010=Mexico, 1220=Canada). Leave empty for all countries or 'TOTAL'.", "default": "5700" }, "portCode": { "title": "Port Code", "type": "string", "description": "2-digit port district code. Only used with 'By Port & HS Code' level. Leave empty for all ports." }, "startMonth": { "title": "Start Month", "type": "string", "description": "Start of date range (YYYY-MM format, e.g., 2023-01). Data available from 2013-01.", "default": "2024-01" }, "endMonth": { "title": "End Month", "type": "string", "description": "End of date range (YYYY-MM format). Leave empty for single month." }, "aggregationLevel": { "title": "HS Aggregation Level", "enum": [ "", "HS2", "HS4", "HS6", "HS10" ], "type": "string", "description": "Level of commodity detail (HS2=broad categories, HS10=most detailed)", "default": "HS4" }, "includeQuantity": { "title": "Include Quantity Data", "type": "boolean", "description": "Include quantity and unit of measure in output", "default": true }, "includeYearToDate": { "title": "Include Year-to-Date", "type": "boolean", "description": "Include cumulative year-to-date values", "default": false }, "maxRecords": { "title": "Max Records", "type": "integer", "description": "Maximum records to return (0 = unlimited). API may limit large queries.", "default": 10 }, "apiKey": { "title": "Census API Key", "type": "string", "description": "Optional Census API key for higher rate limits (get free at api.census.gov/data/key_signup.html)" } } }, "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 } } } } } } } } } }