{ "openapi": "3.0.1", "info": { "title": "HS Code Lookup API", "description": "Unofficial HS code lookup API: find the UK commodity code or US HTS code for a product description or a code, with the official description, the 6-digit HS code and the duty rate. Reads the public UK Trade Tariff and the US Harmonized Tariff Schedule.", "version": "0.1", "x-build-id": "agGknLa3VMzLqN3uy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sourcing-data-studio~hs-code-lookup-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sourcing-data-studio-hs-code-lookup-api", "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/sourcing-data-studio~hs-code-lookup-api/runs": { "post": { "operationId": "runs-sync-sourcing-data-studio-hs-code-lookup-api", "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/sourcing-data-studio~hs-code-lookup-api/run-sync": { "post": { "operationId": "run-sync-sourcing-data-studio-hs-code-lookup-api", "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": [ "searchQueries" ], "properties": { "searchQueries": { "title": "Products or codes to look up", "minItems": 1, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "One entry per lookup. Each entry is either a short product description in English (for example: phone case, usb cable, laptop) or a tariff code of 4, 6, 8 or 10 digits (for example: 8517, 851713, 85171300 or 8517130000; dots are allowed, as in 8517.13.00). A code is looked up directly. A description is searched in the tariff, and the best matching codes are returned; in the US tariff only lines that contain every word of the description count as a match. Use plain product words, not brand names or model numbers. Write codes as text, so that a leading zero is kept. At most 100 entries per run.", "items": { "type": "string" } }, "tariffs": { "title": "Tariffs to search", "uniqueItems": true, "type": "array", "description": "Which national tariff to read. UK is the UK Trade Tariff (10-digit commodity codes, UK third-country duty and UK import VAT). US is the US Harmonized Tariff Schedule (10-digit HTS codes, US general duty rate). Choose both to get one set of results per tariff for every entry. The first 6 digits of a code are the same in every country; the remaining digits and the duty rate are national.", "items": { "type": "string", "enum": [ "UK", "US" ], "enumTitles": [ "UK Trade Tariff", "US Harmonized Tariff Schedule" ] }, "default": [ "UK" ] }, "maxResultsPerQuery": { "title": "Maximum results per entry", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many tariff results to save for each entry and each tariff, from 1 to 20. A declarable 10-digit code gives one result; a 10-digit grouping code also returns the lines below it. A shorter code or a product description can match several tariff lines; the best matches are saved first. Use 1 when you only want the top match, and 5 or more when you want to compare candidate codes.", "default": 5 }, "maxItems": { "title": "Maximum results in total", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of tariff results to save and pay for in this run, across all entries and tariffs. The run stops as soon as this many results are saved.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy servers used for the requests. Both sources are open government services that answer direct requests, so no proxy is needed and the default is no proxy. Change this only if your network cannot reach the sources directly. A proxy is never used to get around a refusal: a request that a source refused is not asked for again from another address.", "default": { "useApifyProxy": false } }, "maxRequestRetries": { "title": "Retries per request", "minimum": 0, "maximum": 6, "type": "integer", "description": "How many times a failed request is asked for again, with a growing wait between attempts. A request that a source refuses with HTTP 401, 403 or 407 is not asked for again. After HTTP 429 (too many requests) the Actor waits as long as the source asks and asks again from the same address, unless the source says that no request is left. When a source refuses or fails several requests in a row, the run stops asking that source, whatever this setting. Failed requests are never charged.", "default": 3 }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Print detailed debug messages to the run log.", "default": false }, "feedback": { "title": "Feedback for the developer", "maxLength": 1000, "type": "string", "description": "Optional. Tell us which field, tariff or country you need next, or what went wrong. It is saved with the run summary. Do not include personal data. AI agents may also use this field to report problems." } } }, "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 } } } } } } } } } }