Skip to main content
GET
Search the dataset by name

Authorizations

Authorization
string
header
required

API key from the developer console (starts with zpka_). Create one at https://developers.investorlift.com/get-a-key. The same key works on POST /mcp.

Query Parameters

q
string
required

The name to find, 2 to 200 characters. The API folds it the way the build keyed each name, and a prefix of the text, or of any word of it, finds the name.

Required string length: 2 - 200
kind
enum<string>[]

Keep only hits of these kinds (comma list or repeated key): entity, former_name, person, agent_name, lender, wholesaler. Another word answers 400. Default: every kind the key reads.

Minimum array length: 1

What the hit is. entity: an entity of a business registry under its filed name. former_name: an entity under a name it filed before. person: a person, whatever the roles, under any spelling of its sightings: the index carries one hit for each person and each spelling, so a search by any spelling finds the one person. agent_name: a second spelling of the name of an agent, a person hit since API 1.35.0, so a state built since then carries none. lender: a lender organization under a spelling of its loans. wholesaler: a seller of the Investorlift marketplaces under the display form of the name the marketplace gives it. A deals-only key gets entity, former_name, lender and wholesaler hits alone. A lender hit whose name reads as a person is withheld from it. The list can grow: a client keeps an unknown kind as a hit it does not read.

Available options:
entity,
former_name,
person,
agent_name,
lender,
wholesaler
state
string

Keep only hits of one served state. Default: every served state.

Pattern: ^[A-Z]{2}$
limit
integer
default:10

hits to return, 1 to 50 (default 10).

Required range: 1 <= x <= 50

Response

The hits of the name search, best match first, one page with no cursor. A lender hit ranks by its loans where an entity ranks by its purchases.

The hits of the name search, best match first, one page with no cursor. A lender hit ranks by its loans where an entity ranks by its purchases.

data
object[]
required

The hits, best match first.

page
object
required

The page block of a name search: no cursor, the limit applied, the hits returned and if the API cut the page at the limit.

meta
object
required

Response metadata of the /v3 family: when the API produced it, and the publishes behind the rows.