Geosatellite: API Reference#

class yr_weather.Geosatellite(headers: dict | None = {}, use_cache: bool | None = True)#

Bases: BaseClient

A client for interacting with the Yr Geosatellite API.

get_image(area: Literal['africa', 'atlantic_ocean', 'europe', 'global', 'mediterranean'] | None = 'europe', img_type: Literal['infrared', 'visible'] | None = 'infrared', time: str | None = None, size: Literal['normal, small'] | None = 'normal') → Response#

Get a geosatellite image.

Parameters:

  • area (Optional[SatArea]) – The area for the image. Must be a valid SatArea.

  • img_type (Optional[Literal["infrared", "visible"]]) – The image type. Either “infrared” or “visible”.

  • time (Optional[str]) – The time formatted as described in MET.no’s documentation.

  • size (Optional[Literal["normal, small"]]) – Image resolution. Either “normal” or “small” for thumbnails.

Returns:

A Response class enabling saving or futher management of the data received.

Return type:

requests.Response