Autocomplete prospects

Autocomplete Prospects

curl --request GET \
  --url https://api.explorium.ai/v1/prospects/autocomplete \
  --header 'api_key: <api-key>'

import requests

url = "https://api.explorium.ai/v1/prospects/autocomplete"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.explorium.ai/v1/prospects/autocomplete', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.explorium.ai/v1/prospects/autocomplete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.explorium.ai/v1/prospects/autocomplete"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.explorium.ai/v1/prospects/autocomplete")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.explorium.ai/v1/prospects/autocomplete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "query": "united",
    "label": "United States",
    "value": "us"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

prospects

autocomplete

Autocomplete Prospects

curl --request GET \
  --url https://api.explorium.ai/v1/prospects/autocomplete \
  --header 'api_key: <api-key>'

import requests

url = "https://api.explorium.ai/v1/prospects/autocomplete"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.explorium.ai/v1/prospects/autocomplete', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.explorium.ai/v1/prospects/autocomplete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.explorium.ai/v1/prospects/autocomplete"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.explorium.ai/v1/prospects/autocomplete")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.explorium.ai/v1/prospects/autocomplete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "query": "united",
    "label": "United States",
    "value": "us"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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.

How It Works

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.

Query Parameters

Parameter	Type	Description
`field`	String	The field for which autocomplete is requested (e.g., `country`, `job_department`).
`query`	String	Partial text input to generate suggestions.

Example Request (cURL)

Bash

curl -X GET \
  "https://api.explorium.ai/v1//prospects/autocomplete?field=country&query=unit" \
  -H "API_KEY: your_api_key_here"

Supported Autocomplete Fields & Example Inputs

Filter	Description	Example Input
`country`	Autocomplete for country names	`"Uni"` → United States, United Kingdom
`country_code`	Autocomplete for country codes (ISO 2-letter)	`"US"` → United States
`region_country_code`	Autocomplete for region-based country codes	`"EU"` → European Union countries
`city_region_country`	Free-text location input that includes city, region, or country	`"berlin, germany"` or `"california, us"`
`google_category`	Google’s business category classification	`"E-com"` → E-commerce
`naics_category`	Industry classification based on NAICS codes	`"541512"` → Computer Systems Design Services
`linkedin_category`	Industry classification from LinkedIn data	`"Retail"` → Retail Industry
`company_name`	Free-text match or partial match on company name	`"micros"` → Microsoft, MicroStrategy
`company_size`	Autocomplete for company sizes (by number of employees)	`"500"` → Companies with ~500 employees
`company_revenue`	Revenue-based classification (K, M, B, T for thousands to trillions)	`"100M"` → $100 Million+
`job_title`	Autocomplete for job titles	`"Soft"` → Software Engineer, Software Developer
`job_department`	Autocomplete for job departments	`"Eng"` → Engineering, Product Engineering
`job_level`	Job seniority levels	`"Senior"` → Senior Manager, Senior Engineer

Example Response

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"
  }
]

Best Practices

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,

business_intent_topics,

city_region,

skills,

interests

query

string

semantic_search

boolean

Response

Successful Response

query

string

required

label

string

required

value

string

required

Prospects Statistics Prospect Events

⌘I

Explorium AgentSource

Partners

Description

Body Params - Try Me Example

Authorizations

Query Parameters

Response

​Description

​Body Params - Try Me Example

Authorizations

Query Parameters

Response

Description

Body Params - Try Me Example