Records Web Services API Documentation

Input Parameters

parameter description type
abandoned A value of true indicates the inclusion of inactive/abandoned stations in the search. boolean
country Country of event epicenter. string
download Available when rettype is dataset. Data type to be packaged with the .zip file, options are P(processed), R(raw) or T(plot).
*There exists a download limit for record data of 200 records. You can narrow your search to meet the constraint or request for access to a lesser constrained limit by emailing a request for bulk data access to cesmd@strongmotioncenter.org.
string
elat For radius searches, latitude in degrees of the center. float
elon For radius searches, longitude in degrees of the center. float
email Supply a registered e-mail to authenticate the download request. You can register at https://strongmotioncenter.org/cgi-bin/CESMD/register.pl. string
emaxlat Maximum latitude, inclusive upper bound of search range for latitude. float
emaxlon Maximum longitude, inclusive upper bound of search range for longitude. float
eminlat Minimum latitude, inclusive lower bound of search range for latitude. float
eminlon Minimum longitude, inclusive lower bound of search range for longitude. float
enddate Latest origin time (in UTC) to include in search. Format: yyyy-mm-dd HH:mm:ss datetime
erad For radius searches, distance in kilometers from the center. float
eventid Preferred USGS event ID of earthquake (including network code). For example, an event ID of 37904927 and a network code of CI would be appended as CI37904927. Multiple event IDs can be listed as CI37904927,CI38043999. string
evname Name of event. Names typically contain a city or vicinity to the epicenter. Accepts wildcards. string
faulttype Faulting type. Options are nm(normal), rs(reverse), ss(strike-slip). string
format Available when rettype is metadata. Format of output, options are xml or json. string
groupby Specify the grouping of the metadata. Default is grouping by stations. Grouping by stations will group records under the same station into a single data structure. string
maxepidist Maximum epicentral distance in kilometers to include in results float
maxlat Maximum station latitude in degrees float
maxlon Maximum station longitude in degrees float
maxmag Maximum magnitude, inclusive upper bound of search range for magnitude (Mw, Ml, Md, Mb, or Ms). float
maxpga Maximum pga to include in results float
minepidist Minimum epicentral distance to include in results float
minlat Minimum station latitude in degrees float
minlon Minimum station longitude in degrees float
minmag Minimum magnitude, inclusive lower bound of search range for magnitude (Mw, Ml, Md, Mb, or Ms). float
minpga Minimum pga to include in results float
netid Two letter Network code of station (multiple network IDs can be listed, e.g. CE,AA). string
nodata If no data is returned by the service, return a 404 response rather than the default 204. integer
orderby Order of data output. Options are pga(pga descending), pga-asc(pga ascending), epidist(epicentral distance descending), or epidist-asc(epicentral distance ascending). string
rettype Type of record data returned, metadata or dataset. Datasets are zipped and grouped by event. string
slat For radius searches, latitude in degrees of station. float
slon For radius searches, longitude in degrees of station. float
srad For radius searches, distance in kilometers from station to include in search. float
startdate Earliest origin time (in UTC) to include in search. Format: yyyy-mm-dd HH:mm:ss datetime
state State, province, territory, or prefecture of epicenter (when available). string
stname Name of station, accepts wildcards. string
sttype Type of station - if not provided, implies Any, otherwise, options are A(Array),G(Ground),B(Building),Br(Bridge),D(Dam),T(Tunnel),W(Wharf),O(Other) string

Output Parameters

object parameter description type JSON XML
status HTTP Response Code of the request. 200 when the query is successful. integer
url URL of the request string
count Total count of records matching criteria integer
data_availability plot True if gif or pdf plot is available, false otherwise boolean
processed True if processed dataset is available, false otherwise boolean
raw True if raw dataset is available, false otherwise boolean
events cesmd_id IQRID used by CESMD string
country Country of event epicenter. string
depth Event depth in kilometers float
detail Details of event including magnitude, magnitude type, local time, and/or depth. string
faultType Faulting type (SS(strike-slip), RR(reverse), NM(normal)) string
id Preferred USGS event id string
latitude Event latitude in degrees float
longitude Event longitude in degrees float
mag Magnitude value float
magType Magnitude type (Mw, Ml, Md, Mb, or Ms) string
net Network code of solution string
place Earthquake location relative to a nearby city or ocean. string
state State, province, territory, or prefecture of epicenter (when available). string
time Date and time of event in UTC time. string
title Earthquake title string
type Type of event, such as earthquake string
record epidist Epicentral distance in kilometers float
fault_dist Distance from nearest fault segment in kilometers float
fault_dist_type fault distance type, values are Rjb, Rrup string
pga_str Peak structure acceleration (g) float
pgav1 Peak ground acceleration of horizontal channels of raw data (g) float
pgav2 Peak ground acceleration of horizontal channels of processed data (g) float
pgd Peak ground displacement (cm) float
pgv Peak ground velocity (cm/sec) float
sa03 Spectral acceleration(g) at 0.3 seconds (g) float
sa10 Spectral acceleration(g) at 1 seconds (g) float
sa30 Spectral acceleration(g) at 3 seconds (g) float
SelectedNumberRecords Number of records returned within the specified grouping (event/station) integer
stations channels Number of channels integer
code Station code (without network) string
elevation Station elevation (meters) float
latitude Station latitude in degrees float
location Station location string
longitude Station longitude in degrees float
name Station name string
network Station FDSN network string
status Station status (may be active, planned, abandoned, demolished) string
recorder_type Type of recorder string
numRecorders Number of recorders integer
siteclass Station site class string
type Station type (ground, array, building, special) string
Vs30 Vs30 value integer
-->