Input Parameters - Autocomplete API

Detailed information on the input parameters for the Autocomplete API

Required Parameters

api_key

TypeDescriptionDefaultExample
StringYour secret API key.

Your API Key must be included in either the request header or the api_key parameter. For more information about request authentication, see the Authentication page.


field

TypeDescription
Enum (String)The field that the API will generate autocomplete suggestions for.

Autocomplete suggestions will be generated based on the corresponding field(s) in the Person Schema.

For example, setting field=industry will generate autocomplete suggestions for the industry, job_company_industry, and experience.company.industry person fields.

See the table below for the supported Autocomplete field values and their corresponding Person fields:

🚧

Warning: Beta Feature

The following is currently in beta and the information in this section as well as API functionality are subject to change.

Please report any issues or feedback to [email protected] and/or to your Data Consultant.

When the beta flag is set to true, you can use the Autocomplete API with websites.

Autocomplete field ValueCorresponding Person Fields
websitejob_company_website
experience.company.website

Optional Parameters

text

TypeDescriptionDefault
StringThe starting text to use for autocompletion.""

Example

Let's see how the Autocomplete API behaves when we progressively build out tesla in the text field. Each call below represents a separate Autocomplete API call, where we keep updating the text field while keeping all other input parameters the same. For each call, we show the input parameters and the top returned result.

📘

Note: Click the Triangles To Expand Each of the API Calls Below

Each call demonstrates the input parameters and the top result that the Autocomplete API returns.

API Call 1:

text = ""

Input Parameters:

params = {
    "field": "company",
    "text": "",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

"data": [
    {
      "count": 501510,
      "name": "ibm",
      "meta": {
        "website": "ibm.com",
        "industry": "information technology and services",
        "location": "new york, new york, united states"
      }
    },

API Call 2:

text = "t"

Input Parameters:

params = {
    "field": "company",
    "text": "t",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 361642,
      "name": "tata consultancy services",
      "meta": {
        "website": "tcs.com",
        "industry": "information technology and services",
        "location": "bombay, maharashtra, india"
      }
    },

API Call 3:

text = "te"

Input Parameters:

params = {
    "field": "company",
    "text": "te",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 102762,
      "name": "tech mahindra",
      "meta": {
        "website": "techmahindra.com",
        "industry": "information technology and services",
        "location": "pune, maharashtra, india"
      }
    },

API Call 4:

text = "tes"

Input Parameters:

params = {
    "field": "company",
    "text": "tes",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 49735,
      "name": "tesco",
      "meta": {
        "website": "tescoplc.com",
        "industry": "retail",
        "location": "welwyn garden city, hertfordshire, united kingdom"
      }
    },

API Call 5:

text = "tesl"

Input Parameters:

params = {
    "field": "company",
    "text": "tesl",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 39992,
      "name": "tesla",
      "meta": {
        "website": "tesla.com",
        "industry": "automotive",
        "location": "palo alto, california, united states"
      }
    },

API Call 6:

text = "tesla"

Input Parameters:

params = {
    "field": "company",
    "text": "tesla",
    "pretty": true,
    "api_key": API_KEY,
}

Top Autocomplete Result:

  "data": [
    {
      "count": 39992,
      "name": "tesla",
      "meta": {
        "website": "tesla.com",
        "industry": "automotive",
        "location": "palo alto, california, united states"
      }
    },

size

TypeDescriptionDefaultExample
IntegerThe number of results that the API should return. Must be between 1 and 100.1025

titlecase

TypeDescriptionDefaultExample
BooleanAll text in API responses returns as lowercase by default. Setting titlecase to true will titlecase any records returned instead.falsetrue

pretty

TypeDescriptionDefaultExample
BooleanWhether the output should have human-readable indentation.falsetrue

beta

🚧

Warning: Beta Feature

The following is currently in beta and the information in this section as well as API functionality are subject to change.

Please report any issues or feedback to [email protected] and/or to your Data Consultant.

TypeDescriptionDefaultExample
BooleanWhen set to true, enables the beta Autocomplete API. The beta version is a Typesense-powered version of Autocomplete that improves query performance and matching logic.falsetrue

In addition to the logic overhaul based on a rebuilt Typsense-powered backend, the Autocomplete beta endpoint also includes type tolerance for inputs to improve UX.

The beta places our Job Title Enrichment API and Skill Enrichment API logic in front of the field=title and field=skill Autocomplete to allow for better matching logic.

If you enable the beta, you can also use field=website to Autocomplete websites.