Skip to main content
GET
/
autocomplete
Autocomplete
curl --request GET \
  --url https://htsapi.com/v1/autocomplete \
  --header 'Authorization: Bearer <token>'
{
  "suggestions": [
    {
      "code": "<string>",
      "description": "<string>",
      "score": 123
    }
  ]
}
Fast prefix search for UI typeahead. Returns suggestions based on code or description matches. Optimized for real-time search experiences.

​
Parameters

ParameterTypeRequiredDescription
qstringYesSearch query (min 2 chars, max 200 chars)
limitintegerNoMaximum number of results (default: 10, max: 20)

​
Example Request

curl -X GET "https://htsapi.com/v1/autocomplete?q=telephone&limit=10" \
  -H "Authorization: Bearer hts_your_api_key"

​
Example Response

{
  "suggestions": [
    {
      "code": "8517.12.00",
      "description": "Telephone sets, including telephones for cellular networks or for other wireless networks",
      "score": 95
    },
    {
      "code": "8517.11.00",
      "description": "Base stations",
      "score": 80
    },
    {
      "code": "8517.62.00",
      "description": "Machines for the reception, conversion and transmission or regeneration of voice, images or other data",
      "score": 75
    }
  ]
}

​
Behavior

  • Code queries: If the query starts with a number, searches by code prefix
  • Text queries: If the query starts with text, performs full-text search on descriptions
  • Scoring: Results are scored by relevance (higher is better)

​
Use Cases

  • Typeahead search boxes
  • Quick code lookup
  • Search suggestions
  • Real-time search experiences

Authorizations

​
Authorization
string
header
required

API key as Bearer token. Format: Bearer hts_your_api_key

Query Parameters

​
q
string
required

Search query (minimum 2 characters)

Required string length: 2 - 200
​
limit
integer
default:10

Maximum number of results (default: 10, max: 20)

Required range: 1 <= x <= 20

Response

Autocomplete suggestions

​
suggestions
object[]