# usgs.earthquakes

**stable** **Advanced**

Recent earthquakes from a USGS summary feed (e.g. 2.5_day, significant_week).

`GET /v1/usgs/earthquakes`

## 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

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `feed` | string | no | `2.5_day` | Feed name, e.g. 2.5_day | max 20 chars; must match `(?:significant\|4\.5\|2\.5\|1\.0\|all)_(?:hour\|day\|week\|month)`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/usgs/earthquakes?feed=2.5_day" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/usgs/earthquakes",
    params={"feed": "2.5_day"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ feed: "2.5_day" });
const res = await fetch(`https://api.onekey.dev/v1/usgs/earthquakes?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": [
    {
      "content": {
        "id": "us6000ty7u",
        "title": "M 4.9 - 2 km SW of Sakai, Japan",
        "createdAt": "2026-09-28T19:45:07Z",
        "url": "https://earthquake.usgs.gov/earthquakes/eventpage/us6000ty7u"
      },
      "ext": {
        "place": "2 km SW of Sakai, Japan",
        "magnitude": 4.9,
        "depthKm": 70.972
      },
      "place": {
        "lat": 36.0809,
        "lon": 139.7782
      }
    },
    {
      "content": {
        "id": "pr71535013",
        "title": "M 2.9 - 45 km N of Charlotte Amalie, U.S. Virgin Islands",
        "createdAt": "2026-09-28T19:19:54Z",
        "url": "https://earthquake.usgs.gov/earthquakes/eventpage/pr71535013"
      },
      "ext": {
        "place": "45 km N of Charlotte Amalie, U.S. Virgin Islands",
        "magnitude": 2.91,
        "depthKm": 23.6
      },
      "place": {
        "lat": 18.7485,
        "lon": -64.9403333333333
      }
    }
  ],
  "metadata": {
    "platform": "usgs",
    "endpoint": "earthquakes",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `content.id` | - |
| `properties.title` | `content.title` | - |
| `properties.place` | `ext.place` | - |
| `properties.mag` | `ext.magnitude` | `toNumber` |
| `properties.time` | `content.createdAt` | `toIsoDate` |
| `properties.url` | `content.url` | `safeUrl` |
| `geometry.coordinates.1` | `place.lat` | `toNumber` |
| `geometry.coordinates.0` | `place.lon` | `toNumber` |
| `geometry.coordinates.2` | `ext.depthKm` | `toNumber` |

## Caching and freshness

- Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
- Between 30 seconds and 5 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 10 minutes 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

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).