---
title: "Typeahead"
method: GET
path: "/typeahead"
tags: ["typeahead"]
---

# Typeahead

`GET /typeahead`

## Request

- Base URL: `https://api.dataforb2b.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.dataforb2b.ai/typeahead`
- Auth: none declared

Unified autocomplete for search filters.

Pass `type=<category>` to select what to search. Each returned result is
billed at 0.01 credit (i.e. 0.1 credit per 10 results); empty result sets
are free.

## Query parameters

- `type` 'company' | 'people_industry' | 'company_industry' | 'category' | 'location' | 'city' | 'region' | 'school' | 'title' | 'skill' | 'investor', required: Supported typeahead categories.
- `q` string, required: Search query
- `limit` integer: Max results (1-20)

## Headers

- `api-key` string, nullable

## Response `200`

Successful Response

- TypeaheadResponse: Unified typeahead response.
  - `type` 'company' | 'people_industry' | 'company_industry' | 'category' | 'location' | 'city' | 'region' | 'school' | 'title' | 'skill' | 'investor', required: Supported typeahead categories.
  - `count` integer, required: Number of results returned
  - `credits_used` number, required: Credits debited for this request
  - `results` TypeaheadResult[], required: Matching values, prefix-matches first then ranked
    - `value` string, required: The canonical value to use as a filter input
    - `popularity` string, nullable: Relative popularity bucket: '<1k', '1k-10k', '10k-100k', or '100k+'. Null for type=company.
    - `metadata` object, nullable: Extra fields (e.g., org_id and logo_url for type=company)

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/dataforb2b/apis/dataforb2b-api.md) · [All operations](https://skmtc.dev/dataforb2b/apis/dataforb2b-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dataforb2b/apis/dataforb2b-api/revisions/24ea79caa1a1?raw)