Webservice

Science Center Objects

Example Requests

BOU observatory data for current UTC day in IAGA2002 format
http://geomag.usgs.gov/ws/edge/?id=BOU
BOU observatory data for current UTC day in JSON format
http://geomag.usgs.gov/ws/edge/?id=BOU&format=json
BOU electric field data for current UTC day in IAGA2002 format
http://geomag.usgs.gov/ws/edge/?id=BOU&elements=E-N,E-E

See more examples

Request Limits

To ensure availability for users, the web service restricts the amount of data that can be retrieved in one request. The amount of data requested is computed as follows, where an interval is the number of seconds between start time and end time:

samples = count(elements) * interval / sampling_period

Limits by the output format

json

  • 172800 samples = 4 elements * 12 hours * 3600 samples/hour.

iaga2002

  • 345600 samples = 4 elements * 24 hours * 3600 samples/hour.
  • NOTE: while the json format supports fewer total samples per request, users may request fewer elements to retrieve longer intervals.

Parameters

id

  • Observatory code. Required.
  • Valid values: BDT, BOU, TST, BRW, BRT, BSL, CMO, CMT, DED, DHT, FRD, FRN, GUA, HON, NEW, SHU, SIT, SJG, TUC,  USGS, BLC, BRD, CBB, EUA, FCC, IQA, MEA, OTT, RES, SNK, STJ, VIC, YKC, HAD, HER, KAK

starttime

  • Time of first requested data.
  • Default: start of current UTC day
  • Format: ISO8601 (YYYY-MM-DDTHH:MM:SSZ)
  • Example: 2018-08-06T22:10:14Z

endtime

  • Time of last requested data.
  • Default: starttime + 24 hours
  • Format: ISO8601 (YYYY-MM-DDTHH:MM:SSZ)
  • Example: 2018-08-06T22:10:14Z

elements

  • Comma separated list of requested elements.
  • Default: X,Y,Z,F
  • Valid values: D, DIST, DST, E, E-E, E-N, F, G, H, SQ, SV, UK1, UK2, UK3, UK4, X, Y, Z

sampling_period

  • Interval in seconds between values.
  • Default: 60
  • Valid values: 1, 60, 3600

type

  • Type of data.
  • Default: variation Valid values: variation, adjusted, quasi-definitive,definitive
  • NOTE: the USGS web service also supports specific EDGE location codes. For example: R0 is "internet variation",R1 is "satellite variation".

format

  • Output format.
  • Default: iaga2002
  • Valid values: iaga2002, json.