Class GeoNet

Main class for interacting with the GeoNet API and related utilities. Provides access to all GeoNet services through a unified interface.

Remarks

This class acts as a central interface for all GeoNet API services and related utilities, thus providing a simplified way to access earthquake, volcano and network data, among others, from GeoNet.

Example

import { GeoNet } from "geonet";
const geonet = new GeoNet();

// Get recent earthquakes
const quakes = await geonet.getQuakes(...);

See

https://api.geonet.org.nz GeoNet API Documentation.
IntensityService For intensity-related methods.
StrongService For strong motion-related methods.
NewsService For news-related methods.
QuakeService For quake-related methods.
VolcanoService For volcano-related methods.
NetworkService For network-related methods.
QuakeMapUtil For generating GeoNet quake map URLs.

Since

1.0.0

Index

Constructors

constructor

Methods

generateColourCode generateMapURL getIntensity getNetworkFDSNDetails getNetworkGNSSDetails getNetworkSensor getNews getQuake getQuakeHistory getQuakes getQuakeStats getStrong getVolcanoAlertLevel getVolcanoQuakes

Constructors

constructor

new GeoNet(
    intensityService?: IntensityService,
    strongService?: StrongService,
    newsService?: NewsService,
    quakeService?: QuakeService,
    volcanoService?: VolcanoService,
    networkService?: NetworkService,
    quakeMapUtil?: QuakeMapUtil,
): GeoNet
Creates a new instance of the GeoNet client.
Parameters
- intensityService: IntensityService = ...
  Service for intensity data.
- strongService: StrongService = ...
  Service for strong motion data.
- newsService: NewsService = ...
  Service for news feed data.
- quakeService: QuakeService = ...
  Service for earthquake data.
- volcanoService: VolcanoService = ...
  Service for volcanic activity data.
- networkService: NetworkService = ...
  Service for network sensor data.
- quakeMapUtil: QuakeMapUtil = ...
  Utility for generating quake map URLs and MMI colour codes.
Returns GeoNet
- Defined in src/GeoNet.ts:62

Methods

generateColourCode

generateColourCode(mmi: MMI): string
Generates a colour code for a given MMI, which corresponds to the marker colour on GeoNet maps.
Parameters
- mmi: MMI
  The New Zealand Modified Mercalli Intensity of the quake.
Returns string
- The hex code colour for the earthquake based on the MMI.
- Defined in src/GeoNet.ts:138

generateMapURL

generateMapURL(coordinates: [number, number], mmi: MMI): string
Generates a link to the GeoNet quake map URL for a given set of coordinates and MMI.
Parameters
- coordinates: [number, number]
  The coordinates of the quake. Position 0 is the longitude, and position 1 is the latitude.
- mmi: MMI
  The New Zealand Modified Mercalli Intensity of the quake.
Returns string
- The URL string for the quake map.
- Defined in src/GeoNet.ts:133

getIntensity

getIntensity(req: IntensityRequestUnion): Promise<IntensityResponse>
Fetches shaking intensity information data based on the provided request parameters.
Parameters
- req: IntensityRequestUnion
  The request parameters for fetching intensity data.
Returns Promise<IntensityResponse>
- A promise that resolves to the intensity response data.
- Defined in src/GeoNet.ts:73

getNetworkFDSNDetails

getNetworkFDSNDetails(
req: NetworkFDSNStationRequest,
): Promise<NetworkFDSNStationResponse>
Fetches network data for a specified FDSN station.
Parameters
- req: NetworkFDSNStationRequest
  The request object containing the station and network codes.
Returns Promise<NetworkFDSNStationResponse>
- A promise that resolves to the sensor details data.
- Defined in src/GeoNet.ts:128

getNetworkGNSSDetails

getNetworkGNSSDetails(code: string): Promise<NetworkGNSStationResponse>
Fetches network data for a specified GNSS mark.
Parameters
- code: string
  The mark code.
Returns Promise<NetworkGNSStationResponse>
- A promise that resolves to the sensor details data.
- Defined in src/GeoNet.ts:123

getNetworkSensor

getNetworkSensor(req: NetworkSensorRequest): Promise<NetworkSensorResponse>
Fetches network data for a given sensor type.
Parameters
- req: NetworkSensorRequest
  The request object containing the sensor type.
Returns Promise<NetworkSensorResponse>
- A promise that resolves to the sensor data.
- Defined in src/GeoNet.ts:118

getNews

getNews(page?: number): Promise<NewsFeedResponse>
Fetches a simple JSON feed of GeoNet's news.
Parameters
- Optionalpage: number
  The page number of the news feed to fetch. If empty, the first page is returned.
Returns Promise<NewsFeedResponse>
- A promise that resolves to the simple JSON news feed data.
- Defined in src/GeoNet.ts:83

getQuake

getQuake(publicID: string): Promise<QuakeResponse>
Fetches quake data for a given public ID.
Parameters
- publicID: string
  The public ID of the earthquake.
Returns Promise<QuakeResponse>
- A promise that resolves to the quake data.
- Defined in src/GeoNet.ts:88

getQuakeHistory

getQuakeHistory(publicID: string): Promise<QuakeHistoryResponse>
Fetches location history data for a given public ID. Not all quakes have a location history.
Parameters
- publicID: string
  The public ID for the earthquake.
Returns Promise<QuakeHistoryResponse>
- A promise that resolves to the quake history data. The features array may be empty!
- Defined in src/GeoNet.ts:93

getQuakes

getQuakes(mmi: MMI): Promise<QuakesResponse>
Fetches all quakes that have occurred over the past 365 days.
Parameters
- mmi: MMI
  The MMI to filter quakes by.
Returns Promise<QuakesResponse>
- A promise that resolves to the quakes data.
- Defined in src/GeoNet.ts:103

getQuakeStats

getQuakeStats(): Promise<QuakeStatsResponse>
Fetches quake stats for the past 365 days.

Returns Promise<QuakeStatsResponse>
- A promise that resolves to the quake stats data.
- Defined in src/GeoNet.ts:98

getStrong

getStrong(publicID: string): Promise<StrongResponse>
Fetches strong intensity data for a given public ID.
Parameters
- publicID: string
  The public ID for the earthquake.
Returns Promise<StrongResponse>
- A promise that resolves to the strong intensity data.
- Defined in src/GeoNet.ts:78

getVolcanoAlertLevel

getVolcanoAlertLevel(): Promise<VolcanoAlertLevelResponse>
Fetches the volcanic alert level data for every volcano.

Returns Promise<VolcanoAlertLevelResponse>
- A promise that resolves to the volcanic alert level data.
- Defined in src/GeoNet.ts:108

getVolcanoQuakes

getVolcanoQuakes(volcanoID: VolcanoID): Promise<VolcanoQuakeResponse>
Fetches quakes in the vicinity of the volcano within a region predefined by GeoNet over the past 60 days.
Parameters
- volcanoID: VolcanoID
  The ID of the volcano.
Returns Promise<VolcanoQuakeResponse>
- A promise that resolves to the volcano quake data.
- Defined in src/GeoNet.ts:113

Class GeoNet

Remarks

Example

See

Since

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GeoNet

Methods

generateColourCode

Parameters

Returns string

generateMapURL

Parameters

Returns string

getIntensity

Parameters

Returns Promise<IntensityResponse>

getNetworkFDSNDetails

Parameters

Returns Promise<NetworkFDSNStationResponse>

getNetworkGNSSDetails

Parameters

Returns Promise<NetworkGNSStationResponse>

getNetworkSensor

Parameters

Returns Promise<NetworkSensorResponse>

getNews

Parameters

Returns Promise<NewsFeedResponse>

getQuake

Parameters

Returns Promise<QuakeResponse>

getQuakeHistory

Parameters

Returns Promise<QuakeHistoryResponse>

getQuakes

Parameters

Returns Promise<QuakesResponse>

getQuakeStats

Returns Promise<QuakeStatsResponse>

getStrong

Parameters

Returns Promise<StrongResponse>

getVolcanoAlertLevel

Returns Promise<VolcanoAlertLevelResponse>

getVolcanoQuakes

Parameters

Returns Promise<VolcanoQuakeResponse>

Settings

On This Page