Search

Search places

Search for places by name.

get/search/places

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/search/places
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Query parameters

namestring required

Place name to search for

Response

admin1namestring

Administrative level 1 name (state/province)

admin2namestring

Administrative level 2 name (county/district)

latitudenumber required

Latitude coordinate

longitudenumber required

Longitude coordinate

namestring required

Place name

Changes

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