Skip to main content
GET
/
v1
/
prospects
/
autocomplete
Autocomplete Prospects
curl --request GET \
  --url https://api.explorium.ai/v1/prospects/autocomplete \
  --header 'api_key: <api-key>'
[
  {
    "query": "united",
    "label": "United States",
    "value": "us"
  }
]

​
Description

The Prospects Autocomplete endpoint provides real-time suggestions for prospects-related fields, helping users quickly find relevant categories, locations, and industries based on partial text input. This is useful for creating dynamic search fields and enhancing user experience in filtering interfaces.
  • Input: Specify a field type (country, region_country_code, etc.) and provide a partial query string.
  • Processing: The system searches through indexed datasets to return the most relevant suggestions.
  • Output: A structured response containing suggested values for the given input.
ParameterTypeDescription
fieldStringThe field for which autocomplete is requested (e.g., country, job_department).
queryStringPartial text input to generate suggestions.
Bash
curl -X GET \
  "https://api.explorium.ai/v1//prospects/autocomplete?field=country&query=unit" \
  -H "API_KEY: your_api_key_here"
FilterDescriptionExample Input
countryAutocomplete for country names"Uni" → United States, United Kingdom
country_codeAutocomplete for country codes (ISO 2-letter)"US" → United States
region_country_codeAutocomplete for region-based country codes"EU" → European Union countries
city_region_countryFree-text location input that includes city, region, or country"berlin, germany" or "california, us"
google_categoryGoogle’s business category classification"E-com" → E-commerce
naics_categoryIndustry classification based on NAICS codes"541512" → Computer Systems Design Services
linkedin_categoryIndustry classification from LinkedIn data"Retail" → Retail Industry
company_nameFree-text match or partial match on company name"micros" → Microsoft, MicroStrategy
company_sizeAutocomplete for company sizes (by number of employees)"500" → Companies with ~500 employees
company_revenueRevenue-based classification (K, M, B, T for thousands to trillions)"100M" → $100 Million+
job_titleAutocomplete for job titles"Soft" → Software Engineer, Software Developer
job_departmentAutocomplete for job departments"Eng" → Engineering, Product Engineering
job_levelJob seniority levels"Senior" → Senior Manager, Senior Engineer
JSON
[
  {
    "query": "unit",
    "label": "United States",
    "value": "us"
  },
  {
    "query": "unit",
    "label": "United Kingdom",
    "value": "gb"
  },
  {
    "query": "unit",
    "label": "United Arab Emirates",
    "value": "ae"
  },
  {
    "query": "unit",
    "label": "Tanzania, United Republic Of",
    "value": "tz"
  },
  {
    "query": "unit",
    "label": "United States Minor Outlying Islands",
    "value": "um"
  }
]
  • Use precise queries to get the most relevant autocomplete results.
  • Optimize search fields by implementing real-time feedback mechanisms.
  • Restrict field selection to avoid unnecessary queries and improve API efficiency.
  • Combine with filtering APIs to refine user selections dynamically.
Explore the sections above for additional query examples and integration guidelines.

​
Body Params - Try Me Example

field: country
query: unit

Authorizations

​
api_key
string
header
required

Query Parameters

​
field
enum<string>
required

Enum for autocomplete types.

Available options:
country,
country_code,
region_country_code,
google_category,
naics_category,
linkedin_category,
company_tech_stack_tech,
company_tech_stack_categories,
job_title,
company_size,
company_revenue,
number_of_locations,
company_age,
job_department,
job_level,
city_region_country,
company_name
​
query
string
default:""

Response

Successful Response

​
query
string
required
​
label
string
required
​
value
string
required
⌘I