Locations

Autocomplete location search

GET
/v1/locations/suggest

Autocomplete location search. Cities and counties come from Model Match's own location dictionary and carry an id (e.g. city_mo_saint-louis) that city / county filters accept — including for places our data spells differently than a mapping provider does. Street addresses come from Mapbox. Use the mapbox_id from any suggestion with retrieveLocation to get normalized geographic details and coordinates.

Authorization

x-api-key<token>

In: header

Query Parameters

q*string

Search text

Length1 <= length
limit?integer

Max results (1-10, default 5)

Default5
Range1 <= value <= 10

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/locations/suggest?q=string"
{
  "suggestions": [
    {
      "feature_type": "string",
      "full_address": "string",
      "id": "string",
      "mapbox_id": "string",
      "name": "string",
      "place_formatted": "string",
      "source": "dictionary",
      "state": "string",
      "totalCount": 0,
      "type": "string"
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

Retrieve normalized location details GET

Retrieve normalized location details (city, state, county, zip, coordinates) for a suggestion ID from `suggestLocations`. A location dictionary id resolves from Model Match's own data and echoes back its `id`; any other id resolves through Mapbox.

Search aggregated market data with filters POST

Search aggregated loan origination market data. Filterable dimensions cover geography (state, county, zip), product (loan purpose / type / amortization), borrower demographics, and loan numerics.