obspy.neries.client.Client.getEvents

Client.getEvents(*args, **kwargs)[source]

Gets a list of events.

Parameters:
  • min_datetime (str, optional) Earliest date and time for search. ISO 8601-formatted, in UTC: yyyy-MM-dd[‘T’HH:mm:ss]. e.g.: "2002-05-17" or "2002-05-17T05:24:00"
  • max_datetime (str, optional) Latest date and time for search.
  • min_latitude (int or float, optional) Minimum latitude for search. Format: +/- 90 decimal degrees.
  • max_latitude (int or float, optional) Maximum latitude for search.
  • min_longitude (int or float, optional) Minimum (“left-side”) longitude for search. Format: +/- 180 decimal degrees.
  • max_longitude (int or float, optional) Maximum (“right-side”) longitude for search.
  • min_depth (int or float, optional) Minimum event depth. Format: in km, negative down.
  • max_depth (int or float, optional) Maximum event depth.
  • min_magnitude (int or float, optional) Minimum event magnitude.
  • max_magnitude (int or float, optional) Maximum event magnitude.
  • magnitude_type (str, optional) Magnitude scale type. Examples: "mw" or "mb".
  • author (str, optional) Origin author. Examples: "CSEM", "LDG", ...
  • max_results (int (maximum: 2500)) Maximum number of returned results.
  • sort_by (str) Field to sort by. Options: "datetime", "magnitude", "flynn_region", "depth". Only available if attribute format is set to "list".
  • sort_direction (str) Sort direction. Format: "ASC" or "DESC".
  • format ('list', 'xml' or 'catalog', optional)

    Format of returned results. Defaults to 'list'.

    Note

    The JSON-formatted queries only look at preferred origin parameters, whereas QuakeML queries search all associated origins.

Return type:

Catalog, list or str

Returns:

Method will return either an ObsPy Catalog object, a list of event dictionaries or a QuakeML string depending on the format keyword.

Example

>>> from obspy.neries import Client
>>> client = Client()
>>> events = client.getEvents(min_datetime="2004-12-01",
...                           max_datetime="2005-01-01",
...                           min_magnitude=9, format="list")
>>> len(events)
1
>>> events  
[{'author': u'CSEM', 'event_id': u'20041226_0000148',
  'origin_id': 127773, 'longitude': 95.724,
  'datetime': UTCDateTime(2004, 12, 26, 0, 58, 50), 'depth': -10.0,
  'magnitude': 9.3, 'magnitude_type': u'mw', 'latitude': 3.498,
  'flynn_region': u'OFF W COAST OF NORTHERN SUMATRA'}]

This Page