Skip to main content
GET
Find a listing agent by name or licence number
Early access: while the developer tier is in beta, the API serves this route to Investorlift’s team and trusted partners. Investorlift will restrict the route further before it opens to every key.
The route returns the stable agent id. Use it to open a profile.

Use it when

You build an agent typeahead. You have a name or a licence number and need the agent id.
If you already have a listing, skip the search. The listing block already carries the agent’s id as listing.agents[].agent_id.

Read the response

match says how the API found the hit, best first:
  • identity_basis and license_candidates say how sure the registry is of who this is. The registry keys the four LICENSE_ values on the state roll. NAME_ONLY with license_candidates of 2 or more means that several licensees share the name. The rows under that name can belong to more than one person. See the Listing agent object.
  • Within one match level, the agents with the most listings come first. A name reads given name first, as the MLS feed writes it.
  • page.capped is true when the API cut the page at limit. The envelope’s page block has the rule and what to do when it is true.
  • Without market=, the API searches every loaded market with an agent registry. A licence-keyed agent has the same id in every market and appears once per market.

Gotchas

  • A name of fewer than three letters after normalisation is a 400. The API matches a licence number exactly, so a partial number finds nothing.
  • No cursor: page.next_cursor is always null.
  • This host does not serve name, license_state and license_number. They are null with contact_redacted: true. You can still open the profile by id.
  • A market with no published agent registry answers 422 agents_unavailable. With no market loaded at all, the search answers 503 not_ready.
Who is this listing agent?.

Authorizations

Authorization
string
header
required

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

Query Parameters

q
string
required

The agent to look for: a name in either order ("Dana Rivera" or "Rivera Dana"), part of a name, or a state licence number. An Arizona licence number is SA or BR plus nine digits, for example "SA555000123". Case and punctuation do not matter. A name needs at least 3 letters after normalisation. The API answers 400 to a shorter name.

Required string length: 1 - 200
market
string

Market code, for example phx. The loaded markets are in meta.coverage[]. It narrows the search to that market. The API answers 400 when that market is not loaded, 422 agents_unavailable when the market has no published agent registry. Without it the API searches every loaded market with a registry and each hit carries its market.

Required string length: 1 - 16
limit
integer
default:10

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

Required range: 1 <= x <= 50

Response

Agents whose name or licence number matches the query, best match first. page.next_cursor is always null and page.capped is true when the API cut the page at limit.

Agents whose name or licence number matches the query, best match first. page.next_cursor is always null and page.capped is true when the API cut the page at limit.

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: when the API produced it, which markets it covers, and how fresh they are.