hvpy.getJPX(startTime, endTime, sourceId, linked=True, verbose=False, jpip=False, cadence=None)[source]#

Generate and (optionally) download a custom JPX movie of the specified datasource from the API.

  • startTime (List[datetime]) – Datetime for the beginning of the JPX movie data.

  • endTime (List[datetime]) – Datetime for the end of the JPX movie data.

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

  • linked (bool) – Generate a linked JPX file containing image pointers instead of data for each individual frame in the series. Default is True, optional.

  • verbose (bool) – if set to True, the JSON response will include timestamps for each frame in the resulting movie and any warning messages associated with the request. In addition to the JPX movie file URI. Default is False, optional.

  • jpip (bool) – Return a JPIP URI string instead of the binary data of the movie itself, or instead of an HTTP URI in the JSON response (if verbose is set to True). Default is False, optional.

  • cadence (Optional[int]) – The desired amount of time (in seconds) between each frame in the movie. Default is None (maximum cadence), optional.

Return type:

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



>>> from hvpy import getJPX
>>> from datetime import datetime, timedelta
>>> getJPX( - timedelta(days=15, minutes=5),
... - timedelta(days=15),
...        sourceId=14,
...        linked=False,
...        jpip=True,
...        verbose=False,
...        cadence=60)