location

Search Location

Search for locations by query string.

Uses Nominatim (OpenStreetMap) for geocoding. Rate limited to respect Nominatim's usage policy.

post/api/v1/location/search

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Cookies

access_tokenstring nullable

Request body

querystring required

Location search query

Response

Successful Response

providerstring required

Location provider used (nominatim, etc.)

Example response

{
  "provider": "nominatim",
  "results": [
    {
      "admin_area": "California",
      "country": "United States",
      "latitude": 37.7749,
      "locality": "San Francisco",
      "longitude": -122.4194,
      "name": "San Francisco, California, USA"
    }
  ]
}

Changes

No recorded changes to this operation across all 9 revisions of this API.