ws.ipgp.fr

fdsnws-station
Web Service Interface Description

 
Interface description URL builder

The fdsnws-station web service provides access to network, station, channel and instrument response metadata in FDSN StationXML format, as well as basic information on network, station and channel metadata in text format.

In addition, the metadata may be filtered, e.g., by time or geographic region. The information granularity level (network, station, channel, response) is selectable.

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

Endpoints

Base URL: https://ws.ipgp.fr/fdsnws/station/1

Endpoint Methods Description
/query GET
POST		 Retrieve metadata in StationXML or text (limited to channel level) format.
/version GET Return the running version of the web service.
/application.wadl GET Return the WADL of the web service.

Query usage

To retrieve metadata information, the request can be submitted either by HTTP GET or HTTP POST methods.

Via 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? [channel-options] [time-constraints] [geographic-constraints] [miscellaneous] [nodata=404]

See Description of the parameters below.

A URL builder is available to help forming the request.

Examples

The same request as above, using the wget client, with the resulting StationXML file saved to guadeloupe_inventory_20210325.xml:

wget "https://ws.ipgp.fr/fdsnws/station/1/query?level=response&start=2021-03-25&end=2021-03-27&minlat=15.70&maxlat=16.65&minlon=-62.00&maxlon=-60.80" -O guadeloupe_inventory_20210325.xml

Via HTTP POST method

With this method, the request is built through a "post file" containing parameter=value couples and a list of data selectors by channel and time. This method is particularly useful for specifying a precise list of channels.

parameter1=value
parameter2=value
NETWORK STATION LOCATION CHANNEL STARTTIME ENDTIME
NETWORK STATION LOCATION CHANNEL STARTTIME ENDTIME
NETWORK STATION LOCATION CHANNEL STARTTIME ENDTIME

The request can be submitted using an HTTP client like wget or curl.

All requests submitted with GET method can be submitted with POST method, except for parameters: startbefore, endbefore, startafter, endafter.

Example

Instrument response in StationXML format for selected stations and channels from network G. Note: we use a ENDTIME far in the future (3000-01-01T00:00:00) to indicate no endtime:

Create the post file postfile.txt containing:

level=response
G  PEL   00 ?N? 2011-03-16T00:00:00 3000-01-01T00:00:00
G  HDC   *  BHN 2008-10-10T00:00:00 3000-01-01T00:00:00
G  KIP   00 *   2018-06-29T02:00:00 2021-10-08T16:45:00
G  WUS   00 BHN 2021-03-15T13:25:00 2021-06-22T04:20:49
G  WUS   00 LHN 2021-03-15T13:25:00 2021-06-22T04:20:49

And submit the request using wget:

wget "https://ws.ipgp.fr/fdsnws/station/1/query?" --post-file=postfile.txt -O retrieving_metadata_sample.xml

Description of the parameters

Note: submitting an empty query (e.g. /query?) will return ALL stations at the station level in StationXML format.

Channel options

Lists (comma-separated) and wildcards (*, ?) are accepted.

parameter examples description default type
net[work] PF
GL,MQ,WI		 Select one or more SEED network codes. any string
sta[tion] CAS
DHS,ILAM,BIM		 Select one or more SEED station codes. any string
loc[ation] 00
00,10		 Select one or more SEED location identifier. Use -- for "Blank" location IDs (ID's containing 2 spaces). any string
cha[nnel] HH?
BH?,LH?		 Select one or more SEED channel codes. any string

Time constraints

parameter examples description default type
start[time] 2001‑12‑19
2012‑03‑23T12:34:01		 Limit to metadata describing channels operating on or after the specified start time. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss
end[time] 2001‑12‑19
2012‑03‑23T12:34:01		 Limit to metadata describing channels operating on or before the specified end time. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss
startbefore 2001‑12‑19
2012‑03‑23T12:34:01		 Limit to metadata epochs starting before specified time. Applied to channel epochs. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss
startafter 2001‑12‑19
2012‑03‑23T12:34:01		 Limit to metadata epochs starting after specified time. Applied to channel epochs. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss
endbefore 2001‑12‑19
2012‑03‑23T12:34:01		 Limit to metadata epochs ending before specified time. Applied to channel epochs. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss
endafter 2001‑12‑19
2012‑03‑23T12:34:01		 Limit to metadata epochs ending after specified time. Applied to channel epochs. any YYYY‑MM‑DD
YYYY‑MM‑DDThh:mm:ss

Geographic constraints

Box search (incompatible with radial search)

parameter examples description default type
minlat[itude] 15.70 Southern boundary. -90° degrees
maxlat[itude] 16.65 Northern boundary. 90° degrees
minlon[gitude] -62.00 Western boundary. -180° degrees
maxlon[gitude] -60.80 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 degrees
lon[gitude] 55.714 Specify the central longitude point. 0 degrees
maxradius 13 Specify maximum distance from the geographic point defined by latitude and longitude. 0 degrees
minradius 11.0 Specify minimum distance from the geographic point defined by latitude and longitude. 0 degrees

Miscellaneous

parameter examples description default type
level channel Specify level of detail using network, station, channel or response. station level
format xml
text		 Specify output format. Valid formats include xml, text . xml format
nodata 404 Specify which HTTP status code is returned when no data is found. 204 204 or 404

Feature notes

This webservice uses SeisComP3 as back-end software.

The following additional parameters or parameter options, which are not part of the fdsnws-station specification, are supported:

parameter examples description default type
format sc3ml An additional value is available: sc3ml. xml format
formatted true Format xml output (not used if format=text). false Boolean

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

  • includeavailability
  • updatedafter
  • matchtimeseries

Resources