Search place suggestions for agent service-area selection

View all Realty in US Property & Mortgage Data endpoints →

Search location information for an agent-discovery workflow using the required input text. The documented default text is cali. Optional area_types controls the location categories: neighborhood, city, county, postal_code, building, and street. Its documented default is the comma-separated string neighborhood,city,county,postal_code,building,street. limit defaults to 10 and has a documented maximum of 20. Treat results as candidates for a user-selected service area rather than automatically choosing a location or sending an agent-list request. No successful probe response is supplied for this endpoint. The unverified source example is truncated and begins with an agents array containing agent-profile information; it does not establish a reliable location-suggestion response schema. Consequently, result field names, identifier formats, coordinates, and an empty-result envelope are not verified. The agent-list contract describes marketing_area_city as a location result id from this endpoint, but that mapping must be checked against an actual response before use. Do not assume identifiers or fields match the property-location autocomplete operation.

API Features

Partial-place service-area input Use the required input text for a location-search experience. The documented starting value cali illustrates a partial place query, not an agent name.
Six selectable place categories Constrain area_types with the documented neighborhood, city, county, postal_code, building, and street values; the default string contains all six.
Bounded location-picker results Request a compact candidate set with limit, which defaults to 10 and has a documented maximum of 20. No pagination offset is exposed by this operation.
Explicit marketing-area handoff Let a user choose a returned place before preparing an agent search. Validate the returned identifier format before mapping it to marketing_area_city.
Suggestion-schema guardrails Keep the agent-location parser independent of property autocomplete. The supplied truncated agent-profile example does not verify this endpoint's suggestion fields.

Live API Demo

GET /api/project/realty-in-us/agents-v2-search-location

Request cost is temporarily unavailable. No price is assumed.

View pricing

API Response (JSON)

{}
curl -X GET 'https://api.opendata-api.com/api/project/realty-in-us/agents-v2-search-location?key=<API_KEY>&area_types=neighborhood%2Ccity%2Ccounty%2Cpostal_code%2Cbuilding%2Cstreet&input=cali&limit=10'
📢
Need Help?
If you encounter API issues or need other API requirements, please contact us.
Contact Us

Use Cases

Frequently asked questions

What should I send in input?

Send a location term or phrase. The documented default and example are cali, and California is also described as an example place term. input is required; this endpoint is for locations, not searching agents by their names.

Which area_types values are documented?

The documented categories are neighborhood, city, county, postal_code, building, and street. The default is the comma-separated string neighborhood,city,county,postal_code,building,street. Keep this parameter as a string, not a JSON array.

How many location results can I request?

limit defaults to 10 and has a documented maximum of 20. Although the source describes it as a paging input, this endpoint exposes no offset or page parameter, so a next-page mechanism is not established.

Are the location response fields verified?

No. There is no successful probe response in the supplied evidence. The source example is truncated and starts with agent-profile records rather than a verifiable location-suggestion schema. Do not rely on that example for required suggestion fields or an empty-result shape.

Can a location result be sent directly as marketing_area_city?

The agent-list documentation describes marketing_area_city as an id from this location-search endpoint. However, the returned identifier format has not been verified here. Require a selected result, confirm the actual response mapping, and do not reuse assumptions from property autocomplete. Selecting a suggestion should not itself send an agent search.

Related operations

Guides

View Subscription Plans →