{ "openapi": "3.0.1", "info": { "title": "US Customs Rulings Watch: HTS Code Monitor", "description": "Search or monitor US customs binding rulings by HTS code or keyword and get new, modified and revoked rulings as clean JSON; not affiliated with U.S. Customs and Border Protection.", "version": "0.0", "x-build-id": "OHe0NWDtsY3FdXXfN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/persistent_parrot~us-customs-rulings-watch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-persistent_parrot-us-customs-rulings-watch", "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/persistent_parrot~us-customs-rulings-watch/runs": { "post": { "operationId": "runs-sync-persistent_parrot-us-customs-rulings-watch", "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/persistent_parrot~us-customs-rulings-watch/run-sync": { "post": { "operationId": "run-sync-persistent_parrot-us-customs-rulings-watch", "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": [ "search", "monitor", "lookup" ], "type": "string", "description": "Search: rulings matching your HTS codes and keywords. Monitor: the first run saves a baseline; later runs return only rulings that are new, modified or revoked. Lookup: fetch the rulings you name.", "default": "search" }, "htsCodes": { "title": "HTS codes", "type": "array", "description": "Search and monitor modes (max 50). 4, 6, 8 or 10 digits, dots optional: 6402, 640299 and 6402.99 all work. A code shorter than 10 digits also finds its sub-codes (6402 finds 6402.99.9065). A 10-digit code finds only rulings that list that exact number; a ruling filed only under the 8-digit line is found by the 8-digit code.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Search and monitor modes (max 20). Words or phrases of 2 to 100 characters, matched by CBP's own search. Blank entries are ignored.", "default": [], "items": { "type": "string" } }, "rulingNumbers": { "title": "Ruling numbers", "type": "array", "description": "Lookup mode only (max 200). For example N349485, H338307 or 088031. Invalid numbers are listed in the OUTPUT record.", "default": [], "items": { "type": "string" } }, "fromDate": { "title": "Rulings dated since", "type": "string", "description": "Only rulings dated on this day or later (YYYY-MM-DD). Leave empty to include every date." }, "maxResultsPerTerm": { "title": "Max results per term", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Stop paging a code or keyword after this many rulings. Newest first. For a monitor, keep the default 100 or higher so a busy day does not push new rulings out of view.", "default": 100 }, "maxRows": { "title": "Max rows", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Cost control: the most rows one run delivers. In monitor mode every code is still searched; extra new or changed rulings are held back and reported on the next run.", "default": 1000 }, "includeText": { "title": "Include ruling text", "type": "boolean", "description": "Add the body of each ruling letter with the letter header and address block dropped and the requester's name, address numbers, emails and phone numbers removed (see README Privacy). Slower (one extra request per ruling) and billed as a separate event.", "default": false }, "firstRunDays": { "title": "First monitor run: days back", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Monitor mode, first run only: report rulings dated within this many days; older ones are stored silently as the baseline.", "default": 30 }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Monitor mode only. Names the saved baseline; runs with the same name share one baseline. Empty = derived from your codes and keywords plus the scheduled task ID, so two tasks never share state.", "default": "" } } }, "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 } } } } } } } } } }