Docs
View as Markdown

usgs.earthquake_search

stable Advanced

Search earthquakes (FDSN query): minimum magnitude, newest first.

GET /v1/usgs/earthquake_search

What you get#

A list of Usgs results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
limitstringno20Rows (1-200)max 3 chars; must match [1-9]\d?|1\d\d|200; trimmed
minmagnitudestringno4.5Minimum magnitudemax 3 chars; must match \d(?:\.\d)?; trimmed

Request#

curl "https://api.onekey.dev/v1/usgs/earthquake_search?limit=5&minmagnitude=5" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Usgs response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "us6000ty57",
        "name": "M 5.4 - north of Svalbard",
        "description": "north of Svalbard",
        "url": "https://earthquake.usgs.gov/earthquakes/eventpage/us6000ty57",
        "date": "2026-09-28T13:22:39Z",
        "category": "reviewed"
      },
      "content": {
        "createdAt": "2026-09-28T15:29:02Z"
      },
      "ext": {
        "magnitude": 5.4,
        "magnitudeType": "mww",
        "significance": 449,
        "feltReports": null,
        "tsunami": false,
        "pagerAlert": "green",
        "depthKm": 10
      },
      "place": {
        "lat": 82.6385,
        "lon": -7.1923
      }
    },
    {
      "entity": {
        "id": "us6000ty43",
        "name": "M 5.2 - 190 km WSW of Port McNeill, Canada",
        "description": "190 km WSW of Port McNeill, Canada",
        "url": "https://earthquake.usgs.gov/earthquakes/eventpage/us6000ty43",
        "date": "2026-09-28T09:13:39Z",
        "category": "reviewed"
      },
      "content": {
        "createdAt": "2026-09-28T09:30:37Z"
      },
      "ext": {
        "magnitude": 5.2,
        "magnitudeType": "mww",
        "significance": 416,
        "feltReports": null,
        "tsunami": true,
        "pagerAlert": null,
        "depthKm": 10
      },
      "place": {
        "lat": 50.171,
        "lon": -129.6785
      }
    }
  ],
  "metadata": {
    "platform": "usgs",
    "endpoint": "earthquake_search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
identity.id-
properties.titleentity.name-
properties.placeentity.description-
properties.urlentity.urlsafeUrl
properties.timeentity.datetoIsoDate
properties.updatedcontent.createdAttoIsoDate
properties.magext.magnitudetoNumber
properties.magTypeext.magnitudeType-
properties.sigext.significancetoNumber
properties.feltext.feltReportstoNumber
properties.tsunamiext.tsunamitoBoolean
properties.alertext.pagerAlert-
properties.statusentity.category-
geometry.coordinates.1place.lattoNumber
geometry.coordinates.0place.lontoNumber
geometry.coordinates.2ext.depthKmtoNumber

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).