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 per minute and 1,000 requests per day. For enterprise customers, we offer rate limits of up to 1,200 requests per minute. If you are 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 on them.

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 on them.

Abridged Response Data Structure

Here is an example response from the Autocomplete API when querying for field = "company" and 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)

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
}