Reference - Autocomplete API

Reference information for the Autocomplete API

Endpoint

The endpoint for the Autocomplete API is: https://api.peopledatalabs.com/v5/autocomplete.

Billing and Access

By default, all active API keys have free access to the Autocomplete API.

When monitoring usage, each call to the Autocomplete API displays as one autocomplete credit, regardless of the records available.

Rate Limiting

Our default limit for self-serve customers is 60 requests/min and 1000 requests/day. For enterprise customers, we offer rate limits up to 1200 requests/minute. For any users interested in higher rate limits, please reach out to us.

Input Parameters

📘

For more details see Input Parameters - Autocomplete API.

You can also click on the individual parameter names in the table below to view more information.

Parameter NameRequiredDescriptionDefaultExample
fieldYesThe field that autocomplete will be calculated for.Nonetitle
textNoText that is used as the seed for autocompletion.""tesl
sizeNoNumber of results returned for autocompletion. Must be between 1 and 100.10100
prettyNoWhether the output should have human-readable indentation.FalseTrue
api_keyNoNot required as part of the request parameters, but if not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.NoneNice try - don't share your API keys!

Output Response

📘

For more details see Output Response - Autocomplete API

You can also click the field names in the table below to view more information.

Field NameTypeDescription
fieldsArray (String)The list of fields in the Person Schema that the Autocomplete API has returned suggestions for. These are pre-determined based on the value used for the field input parameter.
dataArray (Object)The list of suggestions returned by the Autocomplete API. Results are sorted in descending order based on the data.count subfield (with highest counts first). The size of the list is determined by the size input parameter.
data.countIntThe number of records in our Person Dataset (resume slice) for this Autocomplete API suggestion. This field is used for sorting elements in the data array.
data.nameStringThe plain text name of the Autocomplete API suggestion (for example, company name/school name/location name/title and so forth.) The prefix of this field will match the value of the text input parameter.
data.metaObjectA set of additional fields returned for each result in the data array. The metadata fields depend on the field input parameter. See the mapping between field values (input parameter) and meta (output fields) here.
statusIntAPI Response Code

Abridged Response Data Structure

Here is the structure of an example response from the Autocomplete API (when querying with field = 'company', text = "goog".) (See a full example response in the next section)

{
  "data": [
     {
      "name": "google",
      "count": 248006,
      "meta": {
        "website": "google.com",
        "location_name": "mountain view, california, united states",
        "industry": "internet",
        "id": "google"
      }
    },
   ...
  ],
  "fields": [
    "job_company_name",
    "experience.company.name"
  ],
  "status": 200
}

Full Example Response (Autocomplete API - School Index)

Input Query (click to toggle)
import json

# See https://github.com/peopledatalabs/peopledatalabs-python
from peopledatalabs import PDLPY

# Create a client, specifying an API key
client = PDLPY(
    api_key="YOUR API KEY",
)

params = {
    "field": "school",
    "text": "stanf",
    "size": 10,
    "pretty": True
}

json_response = client.autocomplete(**params).json()

print(json_response)

Output Response (full):

{
  "data": [
    {
      "name": "stanford university",
      "count": 434677,
      "meta": {
        "website": "stanford.edu",
        "location_name": "stanford, california, united states",
        "id": "1W561qgHMjuYX4YWF1sIrQ_0"
      }
    },
    {
      "name": "stanford university graduate school of business",
      "count": 44080,
      "meta": {
        "website": "gsb.stanford.edu",
        "location_name": "stanford, california, united states",
        "id": "HSBJxyTEjoUZ0HB0QMYNhg_0"
      }
    },
    {
      "name": "stanford law school",
      "count": 10425,
      "meta": {
        "website": "law.stanford.edu",
        "location_name": "stanford, california, united states",
        "id": "7oB8xssxBNsgj55NVNgX8w_0"
      }
    },
    {
      "name": "stanford university school of medicine",
      "count": 9788,
      "meta": {
        "website": "med.stanford.edu",
        "location_name": "palo alto, california, united states",
        "id": "Bx27PJ2pdlcuFt305W0--g_0"
      }
    },
    {
      "name": "stanford continuing studies",
      "count": 5248,
      "meta": {
        "website": "continuingstudies.stanford.edu",
        "location_name": "stanford, california, united states",
        "id": "Ij6aIDqpy2vcAEvsy84d7A_0"
      }
    },
    {
      "name": "stanford university graduate school of education",
      "count": 1943,
      "meta": {
        "website": "ed.stanford.edu",
        "location_name": "stanford, california, united states",
        "id": "7memxNXEkFjKfVFzugGARw_0"
      }
    },
    {
      "name": "stanford university school of engineering",
      "count": 1557,
      "meta": {
        "website": "engineering.stanford.edu",
        "location_name": "stanford, california, united states",
        "id": "EmDZlGWe-NO97qziNWDZlQ_0"
      }
    },
    {
      "name": "stanford graduate school of business executive education",
      "count": 1197,
      "meta": {
        "website": null,
        "location_name": "united states",
        "id": "gAhTlHvSnTzbG9v8GIBzHg_0"
      }
    },
    {
      "name": "stanfield secondary school",
      "count": 326,
      "meta": {
        "website": "stanfield.k12.or.us",
        "location_name": "stanfield, oregon, united states",
        "id": "eeSTd4RdDZx8blKM9CsHdw_0"
      }
    },
    {
      "name": "stanford online high school",
      "count": 325,
      "meta": {
        "website": "ohs.stanford.edu",
        "location_name": "stanford, california, united states",
        "id": "dZ7tnAE3--3kiSjm6xauSQ_0"
      }
    }
  ],
  "fields": [
    "education.school.name"
  ],
  "status": 200
}

Did this page help you?