/us_hts/lines/search

POST /api/us_hts/lines/search

Price: 20 credits

Search US Harmonized Tariff Schedule lines by keyword — returns matching tariff lines with their HTS code, description, units of quantity and duty rates

How to use it

Use this to find an HTS code when you only have a product name, then pass the code to us_hts/lines for its full subtree. The keyword matches the line descriptions only, and very common English words such as 'other', 'and', 'the' and 'for' are index stop-words that come back empty rather than over-matched — search a distinctive noun instead. A code fragment such as 0901.11 also works as a keyword.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Word or HTS code fragment matched against the tariff line descriptions (examples: "coffee", "titanium", "0901.11"; minLength: 1)
• count integer required — Number of tariff lines to return (min: 1)

Response

• @type string (default: "UsHtsLine")
• hts_number string (default: "")
• description string required
• indent integer nullable
• is_group_caption boolean (default: false)
• units array (default: [])
• general_rate string nullable
• special_rate string nullable
• other_rate string nullable
• quota_quantity string nullable
• additional_duties string nullable
• footnotes array (default: [])
  • @type string (default: "UsHtsFootnote")
  • value string required
  • marker string nullable
  • columns array (default: [])
  • footnote_type string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.