Skip to main content
GET
Autocomplete
Fast prefix search for UI typeahead. Returns suggestions based on code or description matches. Optimized for real-time search experiences.

Parameters

Example Request

Example Response

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 your_hts_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[]