ws.ipgp.fr

fdsnws-event
Web Service Interface Documentation

 
Interface description URL builder

The fdsnws-event web service provides access to origin (source location and origin time) and magnitude estimates for seismic events in QuakeML format, as well as basic information in text format.

Events may be filtered, e.g., by hypocenter, time and magnitude parameters.

This service is an implementation of the FDSN web service specification version 1.2.

Earthquake parameters have been manually reviewed by Piton de la Fournaise Volcanic Observatory (OVPF), Mayotte volcanological and seismological monitoring network (REVOSIMA), Guadeloupe Seismic and Volcanic Observatory (OVSG) and Martinique Seismic and Volcanic Observatory (OVSM). Please refer to the VOLOBSIS portal for further information.

Events are in one common database. For the Antilles, the events north of 15.5°N come from Guadeloupe observatory while, south of this latitude, the events come from Martinique observatory.

Endpoints

Base url : https://ws.ipgp.fr/fdsnws/event/1

Endpoint Methods Description
/query GET Retrieve event information in QuakeML or text format.
/catalogs GET Not implemented.
/contributors GET Not implemented.
/version GET Return the running version of the web service.
/application.wadl GET Return the WADL of the web service.

Query usage

To retrieve event information, the request are submitted by HTTP GET method.

With this method, the request is built as a URL. Request parameters are specified after /query? and separated by the & symbol. Parameters can be provided in any order.

/query? [temporal-constraints] [geographic-constraints] [depth-constraints] [magnitude-constraints]
        [miscellaneous] [format-option] [nodata=404]

The eventid parameter is particular, since it may only be combined with the boolean parameters whose name starts with include and with the format option.

/query?eventid=<event-id> [include-parameters] [format-option] [nodata=404]

See Description of the parameters below.

A URL builder is available to help forming the request.

Examples

Description of the parameters

Note: submitting an empty query (e.g. /query?) will return ALL events in QuakeML format. This request might be very long to execute.

Temporal constraints

parameter examples description default type
start[time] 2021‑12‑19
2021‑03‑23T12:34:01		 Limit to events occurring on or after the specified start time. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss
end[time] 2021‑12‑19
2021‑03‑23T12:34:01		 Limit to events occurring on or before the specified end time. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss

Geographic constraints

Box search (incompatible with radial search)

parameter examples description default type
minlat[itude] 14.0 Southern boundary. -90° degrees
maxlat[itude] 15.5 Northern boundary. 90° degrees
minlon[gitude] 60 Western boundary. -180° degrees
maxlon[gitude] 61.5 Eastern boundary. 180° degrees

Radial search (incompatible with the box search)

parameter examples description default type
lat[itude] -21.244 Specify the central latitude point. 0.0 degrees
lon[gitude] 55.714 Specify the central longitude point. 0.0 degrees
maxradius 13 Specify maximum distance from the geographic point defined by latitude and longitude. 180.0 degrees
minradius 11.1 Specify minimum distance from the geographic point defined by latitude and longitude. 0.0 degrees

Depth constraints

parameter examples description default type
mindepth -1.0 Limit to events with depths equal to or greater than the specified depth. any float (km)
maxdepth 20.0 Limit to events with depths less than or equal to the specified depth. any float (km)

Magnitude constraints

parameter examples description default type
minmag[nitude] -1.0 Limit to events with a magnitude larger than or equal to the specified minimum. any float
maxmag[nitude] 6.3 Limit to events with a magnitude smaller than or equal to the specified maximum. any float
magnitudetype magtype ML
Ms
Mw
all		 Type of magnitude used to test minimum and maximum limits. Case-insensitive. preferred text

Miscellaneous

parameter examples description default type
contributor OVSG Limit to events from a specified contributor (mapped to the agencyID). any text
limit 25 Limit the results to the specified number of events. unlimited integer
offset 20 Return results starting at the event count specified. 0 integer
orderby time–asc Order results by time / time-asc (time ascendent) or magnitude / magnitude-asc (magnitude ascendent). time text
includeallorigins true Retrieve all origins for the event, or only the primary origin. false true/false
includeallmagnitudes true Retrieve all magnitudes for the event, or only the primary magnitude. false true/false
includearrivals true Specify if phase arrivals should be included. false true/false
eventid ovsg2021fyorfy Retrieve an event based on its unique ID generated by IPGP. The parameter eventid may only be combined with format, includeallorigins, includeallmagnitudes, includearrivals and the implementation-specific parameters described below. text
format text Specify format. Valid formats include xml, text. xml format
nodata 404 Specify which HTML Status code is returned when no data is found. 204 204
or
404

Feature notes

This webservice uses SeisComP3 as back-end software.

parameter examples description default type
[include]picks true Available only in combination with includearrivals=true. true true/false
[include]focalmechanism or fm true Include the preferred focal mechanism. false true/false
[include]allfocalmechanisms or allfms true Include all focal mechanisms. false true/false
[include]stationmts or stamts true Include station moment tensors. false true/false
[include]comments true Include comments. false boolean
format csv Three additional values are available: qml-rt, sc3ml, csv. xml format
formatted true Pretty print xml output. Works with xml output format. false true/false

The following parameters, described in the fdsnws-event specification, are not supported:

  • catalog request parameter not implemented (information not available in SeisComP)
  • contributor request parameter is mapped to the agencyID
  • updatedafter request parameter not implemented: The last modification time in SeisComP is tracked on the object level. If a child of an object is updated the update time is not propagated to all parents. In order to check if a station was updated all children must be evaluated recursively. This operation would be much to expensive.

The HTTP POST method for query requests is not implemented.

Resources