Locations

Retrieve normalized location details

getapi.modelmatch.com/v1/locations/retrieve/{mapboxId}

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.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

mapboxIdstringrequired

Mapbox suggestion ID

Responses

200objectNormalized location details

Show attributes

locationobject | nullrequired

Show child attributes

citystring

countystring

displayNamestringrequired

idstring

Location dictionary id, when this location is one of ours. Pass it to a city / county filter instead of the free-text name.

latnumber

lonnumber

placeTypestringrequired

statestring

zipstring

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X GET "https://api.modelmatch.com/v1/locations/retrieve/<mapboxId>" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.locations.retrieve({
  path: {
    mapboxId: "<mapboxId>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/locations/retrieve/<mapboxId>",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "location": {
    "city": "<string>",
    "county": "<string>",
    "displayName": "<string>",
    "id": "<string>",
    "lat": 123.45,
    "lon": 123.45,
    "placeType": "<string>",
    "state": "<string>",
    "zip": "<string>"
  }
}