API Explorer — Registered User Endpoints
Endpoints that require authentication. Use your API key to access on-demand ground motion estimates and manage your custom monitoring sites.
Sign in to access authenticated endpoints
A free account gives you an API key for on-demand ground motion queries and custom site management. You can browse this page and see endpoint documentation without signing in.
Your API Key
After signing in, your API key will appear here. Pass it in the Authorization header as a Bearer token, or as the api_key query parameter.
POST
/api/v1/auth/login
External API consumers use this endpoint to obtain a JWT access token and API key programmatically, without going through the website. The response contains an access_token (short-lived JWT for Bearer authentication) and an api_key (static token that can also be used for authentication). Use the access token or API key in subsequent requests to authenticated endpoints.
POST /api/v1/ground-motion/ automatically. Any registered user can call it.
The password is redacted in the curl command above. Only run this on a trusted device.
POST
/api/v1/ground-motion/
Compute ground shaking intensity (MMI) at any custom location within the supported region (lat 28–50°N, lon 125–113°W). Supply the USGS event ID, the estimation method, and your coordinates. For gazetteer sites, results are served from cache instantly. For other locations, GMPE methods compute in real time. The response includes from_cache, in_shakemap_coverage, and vs30_used fields. Requires authentication (Bearer token or API key).
GET/POST/DELETE
/api/v1/users/sites
Register and manage your own monitoring sites. When an earthquake is published, ground shaking estimates are automatically computed for all your registered sites and included in email notifications. Free accounts support 1 site; paid accounts support up to 50. All site coordinates must be within the supported region (lat 28–50°N, lon 125–113°W). Site-specific Vs30 is looked up automatically at registration time. To manage sites interactively, visit your account page.
List your sites
Add a site
Returns 201 Created with the new site record, including the system-assigned site ID and Vs30.
Delete a site
Returns 204 No Content on success. Replace site_id with the integer ID from the list response.