obspy.clients.fdsn.client.Client.get_events

Client.get_events(starttime=None, endtime=None, minlatitude=None, maxlatitude=None, minlongitude=None, maxlongitude=None, latitude=None, longitude=None, minradius=None, maxradius=None, mindepth=None, maxdepth=None, minmagnitude=None, maxmagnitude=None, magnitudetype=None, includeallorigins=None, includeallmagnitudes=None, includearrivals=None, eventid=None, limit=None, offset=None, orderby=None, catalog=None, contributor=None, updatedafter=None, filename=None, **kwargs)[source]

Query the event service of the client.

>>> client = Client("IRIS")
>>> cat = client.get_events(eventid=609301)
>>> print(cat)
1 Event(s) in Catalog:
1997-10-14T09:53:11.070000Z | -22.145, -176.720 | 7.8 mw

The return value is a Catalog object which can contain any number of events.

>>> t1 = UTCDateTime("2001-01-07T00:00:00")
>>> t2 = UTCDateTime("2001-01-07T03:00:00")
>>> cat = client.get_events(starttime=t1, endtime=t2, minmagnitude=4,
...                         catalog="ISC")
>>> print(cat)
3 Event(s) in Catalog:
2001-01-07T02:55:59.290000Z |  +9.801,  +76.548 | 4.9 mb
2001-01-07T02:35:35.170000Z | -21.291,  -68.308 | 4.4 mb
2001-01-07T00:09:25.630000Z | +22.946, -107.011 | 4.0 mb
Parameters:
  • starttime (UTCDateTime, optional) Limit to events on or after the specified start time.
  • endtime (UTCDateTime, optional) Limit to events on or before the specified end time.
  • minlatitude (float, optional) Limit to events with a latitude larger than the specified minimum.
  • maxlatitude (float, optional) Limit to events with a latitude smaller than the specified maximum.
  • minlongitude (float, optional) Limit to events with a longitude larger than the specified minimum.
  • maxlongitude (float, optional) Limit to events with a longitude smaller than the specified maximum.
  • latitude (float, optional) Specify the latitude to be used for a radius search.
  • longitude (float, optional) Specify the longitude to the used for a radius search.
  • minradius (float, optional) Limit to events within the specified minimum number of degrees from the geographic point defined by the latitude and longitude parameters.
  • maxradius (float, optional) Limit to events within the specified maximum number of degrees from the geographic point defined by the latitude and longitude parameters.
  • mindepth (float, optional) Limit to events with depth, in kilometers, larger than the specified minimum.
  • maxdepth (float, optional) Limit to events with depth, in kilometers, smaller than the specified maximum.
  • minmagnitude (float, optional) Limit to events with a magnitude larger than the specified minimum.
  • maxmagnitude (float, optional) Limit to events with a magnitude smaller than the specified maximum.
  • magnitudetype (str, optional) Specify a magnitude type to use for testing the minimum and maximum limits.
  • includeallorigins (bool, optional) Specify if all origins for the event should be included, default is data center dependent but is suggested to be the preferred origin only.
  • includeallmagnitudes (bool, optional) Specify if all magnitudes for the event should be included, default is data center dependent but is suggested to be the preferred magnitude only.
  • includearrivals (bool, optional) Specify if phase arrivals should be included.
  • eventid (str (or int, dependent on data center), optional) Select a specific event by ID; event identifiers are data center specific.
  • limit (int, optional) Limit the results to the specified number of events.
  • offset (int, optional) Return results starting at the event count specified, starting at 1.
  • orderby (str, optional)

    Order the result by time or magnitude with the following possibilities:

    • time: order by origin descending time
    • time-asc: order by origin ascending time
    • magnitude: order by descending magnitude
    • magnitude-asc: order by ascending magnitude
  • catalog (str, optional) Limit to events from a specified catalog
  • contributor (str, optional) Limit to events contributed by a specified contributor.
  • updatedafter (UTCDateTime, optional) Limit to events updated after the specified time.
  • filename (str or file) If given, the downloaded data will be saved there instead of being parsed to an ObsPy object. Thus it will contain the raw data from the webservices.

Any additional keyword arguments will be passed to the webservice as additional arguments. If you pass one of the default parameters and the webservice does not support it, a warning will be issued. Passing any non-default parameters that the webservice does not support will raise an error.