immich-to-cloud-exporter/generated/immich/openapi_client/docs/MapApi.md

generated.immich.openapi_client.MapApi

All URIs are relative to https://github.com/api

Method	HTTP request	Description
get_map_markers	GET /map/markers	Retrieve map markers
reverse_geocode	GET /map/reverse-geocode	Reverse geocode coordinates

get_map_markers

List[MapMarkerResponseDto] get_map_markers(file_created_after=file_created_after, file_created_before=file_created_before, is_archived=is_archived, is_favorite=is_favorite, with_partners=with_partners, with_shared_albums=with_shared_albums)

Retrieve map markers

Retrieve a list of latitude and longitude coordinates for every asset with location data.

Example

• Api Key Authentication (cookie):
• Api Key Authentication (api_key):
• Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.map_marker_response_dto import MapMarkerResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
    host = "https://github.com/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = generated.immich.openapi_client.MapApi(api_client)
    file_created_after = '2024-01-01T00:00Z' # datetime | Filter assets created after this date (optional)
    file_created_before = '2024-01-01T00:00Z' # datetime | Filter assets created before this date (optional)
    is_archived = True # bool | Filter by archived status (optional)
    is_favorite = True # bool | Filter by favorite status (optional)
    with_partners = True # bool | Include partner assets (optional)
    with_shared_albums = True # bool | Include shared album assets (optional)

    try:
        # Retrieve map markers
        api_response = api_instance.get_map_markers(file_created_after=file_created_after, file_created_before=file_created_before, is_archived=is_archived, is_favorite=is_favorite, with_partners=with_partners, with_shared_albums=with_shared_albums)
        print("The response of MapApi->get_map_markers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MapApi->get_map_markers: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_created_after	datetime	Filter assets created after this date	[optional]
file_created_before	datetime	Filter assets created before this date	[optional]
is_archived	bool	Filter by archived status	[optional]
is_favorite	bool	Filter by favorite status	[optional]
with_partners	bool	Include partner assets	[optional]
with_shared_albums	bool	Include shared album assets	[optional]

Return type

List[MapMarkerResponseDto]

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reverse_geocode

List[MapReverseGeocodeResponseDto] reverse_geocode(lat, lon)

Reverse geocode coordinates

Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

Example

• Api Key Authentication (cookie):
• Api Key Authentication (api_key):
• Bearer (JWT) Authentication (bearer):

import generated.immich.openapi_client
from generated.immich.openapi_client.models.map_reverse_geocode_response_dto import MapReverseGeocodeResponseDto
from generated.immich.openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://github.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = generated.immich.openapi_client.Configuration(
    host = "https://github.com/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: cookie
configuration.api_key['cookie'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie'] = 'Bearer'

# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Configure Bearer authorization (JWT): bearer
configuration = generated.immich.openapi_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with generated.immich.openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = generated.immich.openapi_client.MapApi(api_client)
    lat = 3.4 # float | Latitude (-90 to 90)
    lon = 3.4 # float | Longitude (-180 to 180)

    try:
        # Reverse geocode coordinates
        api_response = api_instance.reverse_geocode(lat, lon)
        print("The response of MapApi->reverse_geocode:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MapApi->reverse_geocode: %s\n" % e)

Parameters

Name	Type	Description	Notes
lat	float	Latitude (-90 to 90)
lon	float	Longitude (-180 to 180)

Return type

List[MapReverseGeocodeResponseDto]

Authorization

cookie, api_key, bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]