getClosestImage

hvpy.getClosestImage(date, sourceId, callback=None)

Find the image data that is closest to the requested datetime.

Return the associated metadata from the helioviewer database and the XML header of the JPEG2000 image file.

Parameters:

• date (datetime) – Datetime of the image.

• sourceId (Union[int, DataSource]) – Unique image datasource identifier.

• callback (Optional[str]) – Wrap the response object in a function call of your choosing. Default is None (no wrapping), optional.

Return type:

Union[bytes, str, Dict[str, Any]]

References

• https://api.helioviewer.org/docs/v2/api/api_groups/official_clients.html#getclosestimage

Examples

>>> from datetime import datetime
>>> from hvpy import getClosestImage
>>> getClosestImage(
...     date=datetime.today(),
...     sourceId=14,
... )
{'id': '...', 'date': '...', 'name': '...', ...}