SAGE Facility FDSNWS dataselect Web Service Documentation

Service interface URL builder Help Revisions

Description

URL Builder

The fdsnws-dataselect service provides access to time series data for specified channels and time ranges.

Data are selected using SEED time series identifiers (network, station, location & channel) in addition to time ranges. Data are returned in miniSEED , SAC zip , and GeoCSV format.

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

NOTE: polling for real-time continuous data is not allowed. For continuous, near real-time data please use our streaming service.

Below is a full list of service parameters and their usage.

Query Usage

/query? (date-range-options) [channel-options] [quality-options] [misc-options] [format-options] [nodata=404]

where

date-range-options	:: 	(start=<time>) (end=<time>)
channel-options		:: 	[net=<network>] [sta=<station>] [loc=<location>] [cha=<channel>]
quality-options		:: 	[quality=<D|R|Q|M|B>]
misc-options		::	[repository=<repository_name>] [szsrecs=<true|false>] [scale=AUTO] [minimumlength=<seconds>]* [longestonly=<true|false>]*
format-options          ::      [format=<miniseed|sac.zip|geocsv>]

(..) required
[..] optional
* deprecated

Query parameters are joined by ampersands ”&”, without blank space (see the sample queries).

POST Usage

Alternately, instead of providing parameter-value pairs in the URL, a file containing a selection list can be POSTed to this service. This is the same method used with the fdsnws-station webservice. For additional details, including an example selection file, visit this page’s help section.

quality=<D|R|Q|M|B>
format=<miniseed|sac.zip|geocsv>
<Network> <Station> <Location> <Channel> <StartTime> <EndTime>
...

Quality and format are optional. Minimumlength and longestonly are options being deprecated. Wildcards are acceptable for Network, Station, Location, and Channel. Click here for time format details.

Sample Queries

Detailed Descriptions of each Query Parameter

parameters examples discussion default type
FDSN options
start[time] 2010-02-27T06:30:00 Specifies the desired start-time for miniSEED data day/time
end[time] 2010-02-27T10:30:00 Specify the end-time for the miniSEED data day/time
net[work] IU Select one or more network codes. Accepts wildcards and lists. Can be SEED codes or data center defined codes. any string
sta[tion] ANMO Select one or more SEED station codes. Accepts wildcards and lists. any string
loc[ation] 00 Select one or more SEED location identifier. Accepts wildcards and lists. Use -- for “Blank” location IDs (ID’s containing 2 spaces). any string
cha[nnel] BH1 Select one or more SEED channel codes. Accepts wildcards and lists. any string
quality B Select data based on miniSEED data quality indicator. D, R, Q, M, B. M and B (default) are treated the same and indicate best available. If M or B are selected, the output data records will be stamped with an M. B quality
minimumlength 0.0 [DEPRECATED] Limit results to continuous data segments of a minimum length specified in seconds. 0.0 float
longestonly false [DEPRECATED] Limit results to the longest continuous segment per channel. false boolean
repo[sitory] realtime Limit results to specified repositories. Acceptable values are primary (for the primary SEED archive) and realtime (for the realtime collection buffers). primary string
szsrecs false Skip data records with zero samples, such as event detection data. true boolean
scale auto Scale the timeseries values by the instrument sensitivity. The scaling is only applied to GeoCSV formatted output and the only valid input for this parameter is scale=AUTO. auto string
nodata 404 Specify which HTML Status code is returned when no data is found.1 204 204 or 404
format sac.zip Specify the format of the data returned:
miniseed — miniSEED data format
sac.zip — SAC data format in .zip bundle
geocsv — GeoCSV format in time-sample pair, 2 column format
geocsv.<modifiers> — GeoCSV with the following additional modifiers:
    * .inline — return as text/plain with disposition inline, else returned as text/csv with disposition attachment
    * .zip — return as a ZIP archive, each segment as a file in the archive, without this .inline is assumed
    * .tspair — return in time-sample pair, 2 column format. The default.
    * .slist — return as sample list, 1 column format, without this .tspair is assumed. 		miniseed

1 By default, the service returns a HTTP response code 204, which means the request was successful, but no data (no content) was retrieved. However, because there was no “error”, no error message is generated and it may appear that the browser did nothing. To force an empty query response to display an error message, add nodata=404 to the URL.

WADL

Retrieve the WADL associated with this service:

application.wadl

Date and Time Formats

Year, Month, Day in Month — Time:

YYYY-MM-DDThh:mm:ss[.ssssss] ex. 1997-01-31T12:04:32.123

YYYY-MM-DD ex. 1997-01-31 a time of 00:00:00 is assumed

Where:

YYYY	:: four-digit year
MM	:: two-digit month (01=January, etc.)
DD	:: two-digit day of month (01 through 31)
T	:: date-time separator
hh	:: two digits of hour (00 through 23) (AM/PM NOT allowed)
mm	:: two digits of minute (00 through 59)
ss	:: two digits of second (00 through 59)
ssssss	:: one to six digits representing decimal fractions of a second, down to microseconds

Wildcards and Lists

Wildcards
The question mark ? represents any single character (exactly one), while the asterisk * represents zero or more characters.

Lists
Multiple items may also be retrieved using a comma separated list. Wildcards may be included in the list. For example, with channel codes: channel=EH?,BHZ,BHE

Restricted Data Access

For access to restricted data, requests should be sent to: service/fdsnws/dataselect/1/queryauth

Requests sent to this URL are authenticated via digest access authentication in order to establish the caller's credentials. For anonymous access, the user nobody@iris.edu and password anonymous may be used. This credential has identical data access permission as the regular submit path's: service/fdsnws/dataselect/1/query

Problems with this service?

Please send an email report of which service you were using, your URL query, and any error feedback to:
data-help@earthscope.org
We will address your issue as soon as possible.

FDSNWS dataselect web service