National Weather Service (Independent Publisher) (Preview)

The National Weather Service (NWS) web service allows developers access to critical forecasts, alerts, and observations, along with other weather data. The web service was designed with a cache-friendly approach that expires content based upon the information life cycle.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Troy Taylor |
URL | https://www.hitachisolutions.com |
[email protected] |
Connector Metadata | |
---|---|
Publisher | Troy Taylor |
Website | https://www.weather.gov/ |
Privacy policy | https://www.weather.gov/privacy |
Categories | Data |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Get a radar server |
Retrieve metadata about a given radar server. |
Get a single alert |
Retrieve a single alert. |
Get active alert counts |
Retrieve a count of active alerts. |
Get active alerts |
Retrieve a list of active alerts. |
Get active alerts for a marine region |
Retrieve a list of active alerts for a marine region. |
Get active alerts for a zone |
Retrieve a list of active alerts for a zone. |
Get active alerts for an area |
Retrieve a list of active alerts for an area. |
Get alert types |
Retrieve a list of alert types. |
Get all alerts |
Retrieve a list of alerts. |
Get an office headline |
Retrieve a specific news headline for a given NWS office. |
Get CWA by sequence |
Retrieve a specific Center Weather Advisory from a CWSU. |
Get CWA list |
Retrieve a list of Center Weather Advisories from a CWSU. |
Get CWSU metadata |
Retrieve metadata about a Center Weather Service Unit. |
Get glossary |
Retrieve a list of glossary terms. |
Get gridpoint forecast |
Retrieve a raw numerical forecast data for a 2.5km grid area. |
Get gridpoint stations |
Retrieve a list of observation stations for a 2.5km grid area. |
Get hourly gridpoint forecast |
Retrieve an hourly forecast for a 2.5km grid area. |
Get latest station observation |
Retrieve the latest observation for a station. |
Get observation by time |
Returns a single station observation. |
Get observation station |
Retrieve metadata about a given observation station. |
Get observation stations |
Retrieve a list of observation stations. |
Get office |
Retrieve metadata about a NWS forecast office. |
Get office headlines |
Retrieve a list of news headlines for a given NWS office. |
Get point |
Retrieve metadata about a given latitude/longitude point. |
Get profiler metadata |
Retrieve metadata about a profiler station. |
Get radar queue |
Retrieve a list of radar queue records. |
Get radar servers |
Retrieve a list of radar servers. |
Get radar station |
Retrieve metadata about a given radar station. |
Get radar station alarms |
Retrieve a list of alarms for a radar station. |
Get radar stations |
Retrieve a list of radar stations. |
Get SIGMET by ATSU, date, and time |
Retrieve a specific SIGMET/AIRMET. |
Get SIGMETs |
Retrieve a list of SIGMET/AIRMETs. |
Get SIGMETs by ATSU |
Retrieve a list of SIGMET/AIRMETs for a specific ATSU. |
Get SIGMETs by ATSU and date |
Retrieve a list of SIGMET/AIRMETs for a specific ATSU and date. |
Get station observations |
Retrieve a list of observations for a station. |
Get TAF by time |
Retrieve a single Terminal Aerodrome Forecast. |
Get TAFs |
Retrieve Terminal Aerodrome Forecasts for the specified airport station. |
Get text product |
Retrieve a specific text product. |
Get text product locations |
Retrieve a list of valid text product issuance locations. |
Get text product locations by type |
Retrieve a list of valid text product issuance locations for a given type. |
Get text product types |
Retrieve a list of valid text product types. |
Get text product types by location |
Retrieve a list of valid text product types for a given location. |
Get text products |
Retrieve a list of text products. |
Get text products by type |
Retrieve a list of text products by type. |
Get text products by type and location |
Retrieve a list of text products for a given type and location. |
Get textual gridpoint forecast |
Retrieve a textual forecast for a 2.5km grid area. |
Get zone |
Retrieve metadata about a given zone. |
Get zone forecast |
Retrieve a zone forecast. |
Get zone observations |
Retrieve a list of observations for a zone. |
Get zone stations |
Retrieve a list of observation stations for a zone. |
Get zones |
Retrieve a list of zones. |
Get zones by type |
Retrieve a list of zones by type. |
Get a radar server
Retrieve metadata about a given radar server.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Radar Server ID
|
id | True | string |
Server identifier. |
Reporting Host
|
reportingHost | string |
Show records from specific reporting host. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Version
|
@context.@version | string |
The version of the context. |
Context ID
|
@id | string |
The identifier for the context. |
Context Type
|
@type | string |
The type of the context. |
Radar Server ID
|
id | string |
The identifier for the radar server. |
Type
|
type | string |
The type of the radar server. |
Collection Time
|
collectionTime | string |
The collection time for the radar server. |
Reporting Host
|
reportingHost | string |
The reporting host for the radar server. |
University of Oklahoma
|
ping.targets.client.universityOfOklahoma | boolean |
Whether the University of Oklahoma target is up. |
Education Research Consortium
|
ping.targets.client.eductionResearchConsortium | boolean |
Whether the Education Research Consortium target is up. |
Unidata
|
ping.targets.client.unidata | boolean |
Whether the Unidata target is up. |
NCEP
|
ping.targets.client.ncep | boolean |
Whether the NCEP target is up. |
Radar Operations Center
|
ping.targets.client.radarOperationsCenter | boolean |
Whether the Radar Operations Center target is up. |
Central Region Headquarters
|
ping.targets.client.centralRegionHeadquarters | boolean |
Whether the Central Region Headquarters target is up. |
Eastern Region Headquarters
|
ping.targets.client.easternRegionHeadquarters | boolean |
Whether the Eastern Region Headquarters target is up. |
LDM4
|
ping.targets.ldm.ldm4 | boolean |
Whether the LDM4 target is up. |
LDM3
|
ping.targets.ldm.ldm3 | boolean |
Whether the LDM3 target is up. |
Radar
|
ping.targets.radar | array of |
The radar target. |
LDM3
|
ping.targets.server.ldm3 | boolean |
Whether the LDM3 target is up. |
LDM4
|
ping.targets.server.ldm4 | boolean |
Whether the LDM4 target is up. |
ROC Router
|
ping.targets.misc.rocRouter | boolean |
Whether the ROC router is up. |
Eth1
|
ping.targets.misc.eth1 | boolean |
Whether the eth1 target is up. |
Eth0
|
ping.targets.misc.eth0 | boolean |
Whether the eth0 target is up. |
Timestamp
|
ping.timestamp | string |
The timestamp for the ping. |
Timestamp
|
hardware.timestamp | string |
The timestamp for the hardware. |
CPU Idle
|
hardware.cpuIdle | float |
The CPU idle percentage. |
IO Utilization
|
hardware.ioUtilization | float |
The IO utilization percentage. |
Disk
|
hardware.disk | integer |
The disk usage in bytes. |
Load 1
|
hardware.load1 | float |
The 1 minute load average. |
Load 5
|
hardware.load5 | float |
The 5 minute load average. |
Load 15
|
hardware.load15 | float |
The 15 minute load average. |
Memory
|
hardware.memory | float |
The memory usage percentage. |
Uptime
|
hardware.uptime | string |
The uptime. |
Timestamp
|
ldm.timestamp | string |
The timestamp for the LDM. |
Latest Product
|
ldm.latestProduct | string |
The latest product. |
Oldest Product
|
ldm.oldestProduct | string |
The oldest product. |
Storage Size
|
ldm.storageSize | integer |
The storage size in bytes. |
Count
|
ldm.count | integer |
The count. |
Active
|
ldm.active | boolean |
Whether the LDM is active. |
Timestamp
|
network.timestamp | string |
The timestamp for the network. |
Interface
|
network.eth1.interface | string |
The interface. |
Active
|
network.eth1.active | boolean |
Whether the interface is active. |
Transmissions No Error
|
network.eth1.transNoError | integer |
The number of transmitted packets with no errors. |
Transmissions Error
|
network.eth1.transError | integer |
The number of transmitted packets with errors. |
Transmissions Dropped
|
network.eth1.transDropped | integer |
The number of transmitted packets dropped. |
Transmissions Overrun
|
network.eth1.transOverrun | integer |
The number of transmitted packets overrun. |
Receives No Error
|
network.eth1.recvNoError | integer |
The number of received packets with no errors. |
Receives Error
|
network.eth1.recvError | integer |
The number of received packets with errors. |
Receives Dropped
|
network.eth1.recvDropped | integer |
The number of received packets dropped. |
Receives Overrun
|
network.eth1.recvOverrun | integer |
The number of received packets overrun. |
Interface
|
network.eth0.interface | string |
The interface. |
Active
|
network.eth0.active | boolean |
Whether the interface is active. |
Transmissions No Error
|
network.eth0.transNoError | integer |
The number of transmitted packets with no errors. |
Transmissions Error
|
network.eth0.transError | integer |
The number of transmitted packets with errors. |
Transmissions Dropped
|
network.eth0.transDropped | integer |
The number of transmitted packets dropped. |
Transmissions Overrun
|
network.eth0.transOverrun | integer |
The number of transmitted packets overrun. |
Receives No Error
|
network.eth0.recvNoError | integer |
The number of received packets with no errors. |
Receives Error
|
network.eth0.recvError | integer |
The number of received packets with errors. |
Receives Dropped
|
network.eth0.recvDropped | integer |
The number of received packets dropped. |
Receives Overrun
|
network.eth0.recvOverrun | integer |
The number of received packets overrun. |
Get a single alert
Retrieve a single alert.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Alert ID
|
id | True | string |
Alert identifier. |
Returns
- Body
- AlertGeoJson
Get active alert counts
Retrieve a count of active alerts.
Returns
Name | Path | Type | Description |
---|---|---|---|
Total
|
total | integer |
The total number of active alerts. |
Land
|
land | integer |
The total number of active alerts affecting land zones. |
Marine
|
marine | integer |
The total number of active alerts affecting marine zones. |
Regions
|
regions | object |
Active alerts by marine region. |
Areas
|
areas | object |
Active alerts by area (state/territory). |
Zones
|
zones | object |
Active alerts by NWS public zone or county code. |
Get active alerts
Retrieve a list of active alerts.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Alert Status
|
status | array |
Status (actual, exercise, system, test, draft). |
|
Alert Message Type
|
message_type | array |
Message type (alert, update, cancel). |
|
Alert Event Name
|
event | array |
Event name. |
|
Alert Code
|
code | array |
Event code. |
|
Alert Area
|
area | array |
State/territory code or marine area code. This parameter is incompatible with the following parameters: point, region, region_type, zone |
|
Alert Point
|
point | string |
Point (latitude,longitude). This parameter is incompatible with the following parameters: area, region, region_type, zone |
|
Alert Region
|
region | array |
Marine region code. This parameter is incompatible with the following parameters: area, point, region_type, zone. |
|
Alert Region Type
|
region_type | string |
Region type (land or marine). This parameter is incompatible with the following parameters: area, point, region, zone |
|
Alert Zone
|
zone | array |
Zone ID (forecast or county). This parameter is incompatible with the following parameters: area, point, region, region_type |
|
Alert Urgency
|
urgency | array |
Urgency (immediate, expected, future, past, unknown). |
|
Alert Severity
|
severity | array |
Severity (extreme, severe, moderate, minor, unknown). |
|
Alert Certainty
|
certainty | array |
Certainty (observed, likely, possible, unlikely, unknown). |
|
Limit
|
limit | integer |
Limit. |
Get active alerts for a marine region
Retrieve a list of active alerts for a marine region.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Region ID
|
region | True | string |
Marine region identifier. |
Get active alerts for a zone
Retrieve a list of active alerts for a zone.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Zone ID
|
zoneId | True | string |
NWS public zone/county identifier. |
Get active alerts for an area
Retrieve a list of active alerts for an area.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Area ID
|
area | True | string |
State/area identifier. |
Get alert types
Retrieve a list of alert types.
Returns
Name | Path | Type | Description |
---|---|---|---|
Event Types
|
eventTypes | array of string |
A list of recognized event types. |
Get all alerts
Retrieve a list of alerts.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Query Start Time
|
start | date-time |
Start time. |
|
Query End Time
|
end | date-time |
End time. |
|
Alert Status
|
status | array |
Status (actual, exercise, system, test, draft). |
|
Alert Message Type
|
message_type | array |
Message type (alert, update, cancel). |
|
Alert Event Name
|
event | array |
Event name. |
|
Alert Code
|
code | array |
Event code. |
|
Alert Area
|
area | array |
State/territory code or marine area code. This parameter is incompatible with the following parameters: point, region, region_type, zone |
|
Alert Point
|
point | string |
Point (latitude,longitude). This parameter is incompatible with the following parameters: area, region, region_type, zone |
|
Alert Region
|
region | array |
Marine region code. This parameter is incompatible with the following parameters: area, point, region_type, zone. |
|
Alert Region Type
|
region_type | string |
Region type (land or marine). This parameter is incompatible with the following parameters: area, point, region, zone |
|
Alert Zone
|
zone | array |
Zone ID (forecast or county). This parameter is incompatible with the following parameters: area, point, region, region_type |
|
Alert Urgency
|
urgency | array |
Urgency (immediate, expected, future, past, unknown). |
|
Alert Severity
|
severity | array |
Severity (extreme, severe, moderate, minor, unknown). |
|
Alert Certainty
|
certainty | array |
Certainty (observed, likely, possible, unlikely, unknown). |
|
Limit
|
limit | integer |
Limit. |
|
Pagination Cursor
|
cursor | string |
Pagination cursor. |
Get an office headline
Retrieve a specific news headline for a given NWS office.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Office ID
|
officeId | True | string |
NWS office identifier. |
Headline ID
|
headlineId | True | string |
Headline record identifier. |
Returns
An object representing a headline from a NWS office.
- Office Headline
- OfficeHeadline
Get CWA by sequence
Retrieve a specific Center Weather Advisory from a CWSU.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Center Weather Service Unit ID
|
cwsuId | True | string |
NWS CWSU identifier. |
Date
|
date | True | date |
Date (YYYY-MM-DD format). |
Sequence
|
sequence | True | integer |
Sequence number. |
Returns
Get CWA list
Retrieve a list of Center Weather Advisories from a CWSU.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Center Weather Service Unit ID
|
cwsuId | True | string |
NWS CWSU identifier. |
Returns
A collection of Center Weather Advisories in GeoJSON format.
- Center Weather Advisory Collection (GeoJSON)
- CenterWeatherAdvisoryCollectionGeoJson
Get CWSU metadata
Retrieve metadata about a Center Weather Service Unit.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Center Weather Service Unit ID
|
cwsuId | True | string |
NWS CWSU identifier. |
Returns
An object representing a NWS office.
- Office
- Office
Get glossary
Retrieve a list of glossary terms.
Returns
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Glossary
|
glossary | array of object | |
Term
|
glossary.term | string |
The glossary term being defined. |
Definition
|
glossary.definition | string |
A definition for the term. |
Get gridpoint forecast
Retrieve a raw numerical forecast data for a 2.5km grid area.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Gridpoint WFO
|
wfo | True | string |
Forecast office identifier. |
Gridpoint X
|
x | True | integer |
Forecast grid X coordinate. |
Gridpoint Y
|
y | True | integer |
Forecast grid Y coordinate. |
Returns
A GeoJSON object representing a gridpoint.
- Gridpoint (GeoJSON)
- GridpointGeoJson
Get gridpoint stations
Retrieve a list of observation stations for a 2.5km grid area.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Gridpoint WFO
|
wfo | True | string |
Forecast office identifier. |
Gridpoint X
|
x | True | integer |
Forecast grid X coordinate. |
Gridpoint Y
|
y | True | integer |
Forecast grid Y coordinate. |
Limit
|
limit | integer |
Limit. |
|
Pagination Cursor
|
cursor | string |
Pagination cursor. |
Get hourly gridpoint forecast
Retrieve an hourly forecast for a 2.5km grid area.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Gridpoint Forecast Feature Flags
|
Feature-Flags | array |
Enable future and experimental features (see documentation for more info):* forecast_temperature_qv: Represent temperature as QuantitativeValue* forecast_wind_speed_qv: Represent wind speed as QuantitativeValue. |
|
Gridpoint Forecast Units
|
units | string |
Use US customary or SI (metric) units in textual output. |
|
Gridpoint WFO
|
wfo | True | string |
Forecast office identifier. |
Gridpoint X
|
x | True | integer |
Forecast grid X coordinate. |
Gridpoint Y
|
y | True | integer |
Forecast grid Y coordinate. |
Get latest station observation
Retrieve the latest observation for a station.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Observation Station ID
|
stationId | True | string |
Observation station identifier. |
Require QC
|
require_qc | boolean |
Require QC. |
Get observation by time
Returns a single station observation.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Observation Station ID
|
stationId | True | string |
Observation station identifier. |
Time
|
time | True | date-time |
Timestamp of requested observation. |
Get observation station
Retrieve metadata about a given observation station.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Observation Station ID
|
stationId | True | string |
Observation station identifier. |
Returns
Get observation stations
Retrieve a list of observation stations.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Station ID
|
id | array |
Filter by observation station identifier. |
|
State
|
state | array |
Filter by state/marine area code. |
|
Limit
|
limit | integer |
Limit. |
|
Pagination Cursor
|
cursor | string |
Pagination cursor. |
Get office
Retrieve metadata about a NWS forecast office.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Office ID
|
officeId | True | string |
NWS office identifier. |
Returns
An object representing a NWS office.
- Office
- Office
Get office headlines
Retrieve a list of news headlines for a given NWS office.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Office ID
|
officeId | True | string |
NWS office identifier. |
Returns
A collection of headlines from NWS offices.
- Office Headline Collection
- OfficeHeadlineCollection
Get point
Retrieve metadata about a given latitude/longitude point.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Path Point
|
point | True | string |
Point (latitude, longitude). |
Returns
A GeoJSON object representing a point.
- Point (GeoJSON)
- PointGeoJson
Get profiler metadata
Retrieve metadata about a profiler station.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Station ID
|
stationId | True | string |
Profiler station identifier. |
Time
|
time | string |
Time interval. |
|
Interval
|
interval | string |
Averaging interval. |
Returns
Get radar queue
Retrieve a list of radar queue records.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Host
|
host | True | string |
LDM host. |
Limit
|
limit | integer |
Record limit. |
|
Arrived
|
arrived | string |
Range for arrival time. |
|
Created
|
created | string |
Range for creation time. |
|
Published
|
published | string |
Range for publish time. |
|
Station ID
|
station | string |
Station identifier. |
|
Type
|
type | string |
Record type. |
|
Feed
|
feed | string |
Originating product feed. |
|
Resolution
|
resolution | integer |
Resolution version. |
Returns
Get radar servers
Retrieve a list of radar servers.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Reporting Host
|
reportingHost | string |
Show records from specific reporting host. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Version
|
@context.@version | string |
The version of the context. |
Context
|
@graph | array of object | |
Context ID
|
@graph.@id | string |
The identifier for the context record. |
Context Type
|
@graph.@type | string |
The type of the context record. |
ID
|
@graph.id | string |
The identifier for the radar server. |
Type
|
@graph.type | string |
The type of the radar server. |
Active
|
@graph.active | boolean |
Whether the radar server is active. |
Primary
|
@graph.primary | boolean |
Whether the radar server is primary. |
Aggregate
|
@graph.aggregate | boolean |
Whether the radar server is an aggregate. |
Locked
|
@graph.locked | boolean |
Whether the radar server is locked. |
Radar Network Up
|
@graph.radarNetworkUp | boolean |
Whether the radar network is up. |
Collection Time
|
@graph.collectionTime | string |
The collection time for the radar server. |
Reporting Host
|
@graph.reportingHost | string |
The reporting host for the radar server. |
Client
|
@graph.ping.targets.client | array of |
The client target. |
LDM4
|
@graph.ping.targets.ldm.ldm4 | boolean |
Whether the LDM4 target is up. |
TDS
|
@graph.ping.targets.ldm.tds | boolean |
Whether the TDS target is up. |
LDM2
|
@graph.ping.targets.ldm.ldm2 | boolean |
Whether the LDM2 target is up. |
LDM3
|
@graph.ping.targets.ldm.ldm3 | boolean |
Whether the LDM3 target is up. |
LDM1
|
@graph.ping.targets.ldm.ldm1 | boolean |
Whether the LDM1 target is up. |
RDS
|
@graph.ping.targets.ldm.rds | boolean |
Whether the RDS target is up. |
Radar
|
@graph.ping.targets.radar | array of |
The radar target. |
LDM4
|
@graph.ping.targets.server.ldm4 | boolean |
Whether the LDM4 target is up. |
LDM3
|
@graph.ping.targets.server.ldm3 | boolean |
Whether the LDM3 target is up. |
TDS
|
@graph.ping.targets.server.tds | boolean |
Whether the TDS target is up. |
LDM2
|
@graph.ping.targets.server.ldm2 | boolean |
Whether the LDM2 target is up. |
LDM1
|
@graph.ping.targets.server.ldm1 | boolean |
Whether the LDM1 target is up. |
RDS
|
@graph.ping.targets.server.rds | boolean |
Whether the RDS target is up. |
TOC Router
|
@graph.ping.targets.misc.tocRouter | boolean |
Whether the TOC router is up. |
ROC Router
|
@graph.ping.targets.misc.rocRouter | boolean |
Whether the ROC router is up. |
Eth0
|
@graph.ping.targets.misc.eth0 | boolean |
Whether the eth0 target is up. |
Eth1
|
@graph.ping.targets.misc.eth1 | boolean |
Whether the eth1 target is up. |
BackupIP
|
@graph.ping.targets.misc.backupIp | boolean |
Whether the backup IP target is up. |
Timestamp
|
@graph.ping.timestamp | string |
The timestamp for the ping. |
Last Executed
|
@graph.command.lastExecuted | string |
The last executed command. |
Last Executed Time
|
@graph.command.lastExecutedTime | string |
The timestamp for the last executed command. |
Last NEXRAD Data Time
|
@graph.command.lastNexradDataTime | string |
The timestamp for the last NEXRAD data. |
Last Received
|
@graph.command.lastReceived | string |
The last received command. |
Last Received Time
|
@graph.command.lastReceivedTime | string |
The timestamp for the last received command. |
Timestamp
|
@graph.command.timestamp | string |
The timestamp for the command. |
Timestamp
|
@graph.hardware.timestamp | string |
The timestamp for the hardware. |
CPU Idle
|
@graph.hardware.cpuIdle | float |
The CPU idle percentage. |
IO Utilization
|
@graph.hardware.ioUtilization | float |
The IO utilization percentage. |
Disk
|
@graph.hardware.disk | integer |
The disk usage in bytes. |
Load 1
|
@graph.hardware.load1 | float |
The 1 minute load average. |
Load 5
|
@graph.hardware.load5 | float |
The 5 minute load average. |
Load 15
|
@graph.hardware.load15 | float |
The 15 minute load average. |
Memory
|
@graph.hardware.memory | float |
The memory usage percentage. |
Uptime
|
@graph.hardware.uptime | string |
The uptime. |
Timestamp
|
@graph.ldm.timestamp | string |
The timestamp for the LDM. |
Latest Product
|
@graph.ldm.latestProduct | string |
The latest product. |
Oldest Product
|
@graph.ldm.oldestProduct | string |
The oldest product. |
Storage Size
|
@graph.ldm.storageSize | integer |
The storage size in bytes. |
Count
|
@graph.ldm.count | integer |
The count. |
Active
|
@graph.ldm.active | boolean |
Whether the LDM is active. |
Timestamp
|
@graph.network.timestamp | string |
The timestamp for the network. |
Interface
|
@graph.network.eth0.interface | string |
The interface. |
Active
|
@graph.network.eth0.active | boolean |
Whether the interface is active. |
Transmissions No Error
|
@graph.network.eth0.transNoError | integer |
The number of transmitted packets with no errors. |
Transmissions Error
|
@graph.network.eth0.transError | integer |
The number of transmitted packets with errors. |
Transmissions Dropped
|
@graph.network.eth0.transDropped | integer |
The number of transmitted packets dropped. |
Transmissions Overrun
|
@graph.network.eth0.transOverrun | integer |
The number of transmitted packets overrun. |
Receives No Error
|
@graph.network.eth0.recvNoError | integer |
The number of received packets with no errors. |
Receives Error
|
@graph.network.eth0.recvError | integer |
The number of received packets with errors. |
Receives Dropped
|
@graph.network.eth0.recvDropped | integer |
The number of received packets dropped. |
Receives Overrun
|
@graph.network.eth0.recvOverrun | integer |
The number of received packets overrun. |
Interface
|
@graph.network.eth1.interface | string |
The interface. |
Active
|
@graph.network.eth1.active | boolean |
Whether the interface is active. |
Transmissions No Error
|
@graph.network.eth1.transNoError | integer |
The number of transmitted packets with no errors. |
Transmissions Error
|
@graph.network.eth1.transError | integer |
The number of transmitted packets with errors. |
Transmissions Dropped
|
@graph.network.eth1.transDropped | integer |
The number of transmitted packets dropped. |
Transmissions Overrun
|
@graph.network.eth1.transOverrun | integer |
The number of transmitted packets overrun. |
Receives No Error
|
@graph.network.eth1.recvNoError | integer |
The number of received packets with no errors. |
Receives Error
|
@graph.network.eth1.recvError | integer |
The number of received packets with errors. |
Receives Dropped
|
@graph.network.eth1.recvDropped | integer |
The number of received packets dropped. |
Receives Overrun
|
@graph.network.eth1.recvOverrun | integer |
The number of received packets overrun. |
Get radar station
Retrieve metadata about a given radar station.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Radar Station ID
|
stationId | True | string |
Radar station identifier. |
Reporting Host
|
reportingHost | string |
Show RDA and latency info from specific reporting host. |
|
Host
|
host | string |
Show latency info from specific LDM host. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The identifier for the radar station. |
Type
|
type | string |
The type of the radar station. |
Type
|
geometry.type | string |
The type of the geometry. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates of the geometry. |
Context ID
|
properties.@id | string |
The identifier for the context. |
Context Type
|
properties.@type | string |
The type of the context. |
Radar Station ID
|
properties.id | string |
The identifier for the radar station. |
Name
|
properties.name | string |
The name of the radar station. |
Station Type
|
properties.stationType | string |
The type of the radar station. |
Unit Code
|
properties.elevation.unitCode | string |
The unit code for the elevation. |
Value
|
properties.elevation.value | float |
The value of the elevation. |
Time Zone
|
properties.timeZone | string |
The time zone for the radar station. |
Unit Code
|
properties.latency.current.unitCode | string |
The unit code for the current latency. |
Value
|
properties.latency.current.value | float |
The value of the current latency. |
Unit Code
|
properties.latency.average.unitCode | string |
The unit code for the average latency. |
Value
|
properties.latency.average.value | float |
The value of the average latency. |
Unit Code
|
properties.latency.max.unitCode | string |
The unit code for the maximum latency. |
Value
|
properties.latency.max.value | integer |
The value of the maximum latency. |
Level Two Last Received Time
|
properties.latency.levelTwoLastReceivedTime | string |
The timestamp for the last received level two data. |
Max Latency Time
|
properties.latency.maxLatencyTime | string |
The timestamp for the maximum latency. |
Reporting Host
|
properties.latency.reportingHost | string |
The reporting host for the latency. |
Host
|
properties.latency.host | string |
The host for the latency. |
Timestamp
|
properties.rda.timestamp | string |
The timestamp for the RDA. |
Reporting Host
|
properties.rda.reportingHost | string |
The reporting host for the RDA. |
Resolution Version
|
properties.rda.properties.resolutionVersion | string |
The resolution version. |
NL2 Path
|
properties.rda.properties.nl2Path | string |
The NL2 path. |
Volume Coverage Pattern
|
properties.rda.properties.volumeCoveragePattern | string |
The volume coverage pattern. |
Control Status
|
properties.rda.properties.controlStatus | string |
The control status. |
Build Number
|
properties.rda.properties.buildNumber | float |
The build number. |
Alarm Summary
|
properties.rda.properties.alarmSummary | string |
The alarm summary. |
Mode
|
properties.rda.properties.mode | string |
The mode. |
Generator State
|
properties.rda.properties.generatorState | string |
The generator state. |
Super Resolution Status
|
properties.rda.properties.superResolutionStatus | string |
The super resolution status. |
Operability Status
|
properties.rda.properties.operabilityStatus | string |
The operability status. |
Status
|
properties.rda.properties.status | string |
The status. |
Unit Code
|
properties.rda.properties.averageTransmitterPower.unitCode | string |
The unit code for the average transmitter power. |
Value
|
properties.rda.properties.averageTransmitterPower.value | integer |
The value of the average transmitter power. |
Unit Code
|
properties.rda.properties.reflectivityCalibrationCorrection.unitCode | string |
The unit code for the reflectivity calibration correction. |
Value
|
properties.rda.properties.reflectivityCalibrationCorrection.value | float |
The value of the reflectivity calibration correction. |
Timestamp
|
properties.performance.timestamp | string |
The timestamp for the performance. |
Reporting Host
|
properties.performance.reportingHost | string |
The reporting host for the performance. |
NTP Status
|
properties.performance.properties.ntp_status | integer |
The NTP status. |
Command Channel
|
properties.performance.properties.commandChannel | string |
The command channel. |
Unit Code
|
properties.performance.properties.radomeAirTemperature.unitCode | string |
The unit code for the radome air temperature. |
Value
|
properties.performance.properties.radomeAirTemperature.value | float |
The value of the radome air temperature. |
Transitional Power Source
|
properties.performance.properties.transitionalPowerSource | string |
The transitional power source. |
Unit Code
|
properties.performance.properties.horizontalShortPulseNoise.unitCode | string |
The unit code for the horizontal short pulse noise. |
Value
|
properties.performance.properties.horizontalShortPulseNoise.value | float |
The value of the horizontal short pulse noise. |
Elevation Encoder Light
|
properties.performance.properties.elevationEncoderLight | string |
The elevation encoder light. |
Unit Code
|
properties.performance.properties.horizontalLongPulseNoise.unitCode | string |
The unit code for the horizontal long pulse noise. |
Value
|
properties.performance.properties.horizontalLongPulseNoise.value | float |
The value of the horizontal long pulse noise. |
Azimuth Encoder Light
|
properties.performance.properties.azimuthEncoderLight | string |
The azimuth encoder light. |
Unit Code
|
properties.performance.properties.horizontalNoiseTemperature.unitCode | string |
The unit code for the horizontal noise temperature. |
Value
|
properties.performance.properties.horizontalNoiseTemperature.value | float |
The value of the horizontal noise temperature. |
Linearity
|
properties.performance.properties.linearity | float |
The linearity. |
Unit Code
|
properties.performance.properties.transmitterPeakPower.unitCode | string |
The unit code for the transmitter peak power. |
Value
|
properties.performance.properties.transmitterPeakPower.value | float |
The value of the transmitter peak power. |
Unit Code
|
properties.performance.properties.horizontalDeltadBZ0.unitCode | string |
The unit code for the horizontal delta dBZ0. |
Value
|
properties.performance.properties.horizontalDeltadBZ0.value | float |
The value of the horizontal delta dBZ0. |
Transmitter Recycle Count
|
properties.performance.properties.transmitterRecycleCount | integer |
The transmitter recycle count. |
Unit Code
|
properties.performance.properties.verticalDeltadBZ0.unitCode | string |
The unit code for the vertical delta dBZ0. |
Value
|
properties.performance.properties.verticalDeltadBZ0.value | float |
The value of the vertical delta dBZ0. |
Unit Code
|
properties.performance.properties.receiverBias.unitCode | string |
The unit code for the receiver bias. |
Value
|
properties.performance.properties.receiverBias.value | float |
The value of the receiver bias. |
Unit Code
|
properties.performance.properties.shortPulseHorizontaldBZ0.unitCode | string |
The unit code for the short pulse horizontal dBZ0. |
Value
|
properties.performance.properties.shortPulseHorizontaldBZ0.value | float |
The value of the short pulse horizontal dBZ0. |
Unit Code
|
properties.performance.properties.transmitterImbalance.unitCode | string |
The unit code for the transmitter imbalance. |
Value
|
properties.performance.properties.transmitterImbalance.value | float |
The value of the transmitter imbalance. |
Unit Code
|
properties.performance.properties.longPulseHorizontaldBZ0.unitCode | string |
The unit code for the long pulse horizontal dBZ0. |
Value
|
properties.performance.properties.longPulseHorizontaldBZ0.value | float |
The value of the long pulse horizontal dBZ0. |
Performance Check Time
|
properties.performance.properties.performanceCheckTime | string |
The timestamp for the performance check. |
Unit Code
|
properties.performance.properties.transmitterLeavingAirTemperature.unitCode | string |
The unit code for the transmitter leaving air temperature. |
Value
|
properties.performance.properties.transmitterLeavingAirTemperature.value | float |
The value of the transmitter leaving air temperature. |
Unit Code
|
properties.performance.properties.shelterTemperature.unitCode | string |
The unit code for the shelter temperature. |
Value
|
properties.performance.properties.shelterTemperature.value | float |
The value of the shelter temperature. |
Power Source
|
properties.performance.properties.powerSource | string |
The power source. |
Unit Code
|
properties.performance.properties.dynamicRange.unitCode | string |
The unit code for the dynamic range. |
Value
|
properties.performance.properties.dynamicRange.value | integer |
The value of the dynamic range. |
Unit Code
|
properties.performance.properties.fuelLevel.unitCode | string |
The unit code for the fuel level. |
Value
|
properties.performance.properties.fuelLevel.value | integer |
The value of the fuel level. |
Timestamp
|
properties.adaptation.timestamp | string |
The timestamp for the adaptation. |
Reporting Host
|
properties.adaptation.reportingHost | string |
The reporting host for the adaptation. |
Unit Code
|
properties.adaptation.properties.transmitterFrequency.unitCode | string |
The unit code for the transmitter frequency. |
Value
|
properties.adaptation.properties.transmitterFrequency.value | integer |
The value of the transmitter frequency. |
Unit Code
|
properties.adaptation.properties.pathLossWG04Circulator.unitCode | string |
The unit code for the path loss WG04 circulator. |
Value
|
properties.adaptation.properties.pathLossWG04Circulator.value | float |
The value of the path loss WG04 circulator. |
Unit Code
|
properties.adaptation.properties.antennaGainIncludingRadome.unitCode | string |
The unit code for the antenna gain including radome. |
Value
|
properties.adaptation.properties.antennaGainIncludingRadome.value | float |
The value of the antenna gain including radome. |
Unit Code
|
properties.adaptation.properties.pathLossA6ArcDetector.unitCode | string |
The unit code for the path loss A6 arc detector. |
Value
|
properties.adaptation.properties.pathLossA6ArcDetector.value | float |
The value of the path loss A6 arc detector. |
Unit Code
|
properties.adaptation.properties.cohoPowerAtA1J4.unitCode | string |
The unit code for the coho power at A1J4. |
Value
|
properties.adaptation.properties.cohoPowerAtA1J4.value | float |
The value of the coho power at A1J4. |
Unit Code
|
properties.adaptation.properties.ameHorzizontalTestSignalPower.unitCode | string |
The unit code for the ame horzizontal test signal power. |
Value
|
properties.adaptation.properties.ameHorzizontalTestSignalPower.value | float |
The value of the ame horzizontal test signal power. |
Unit Code
|
properties.adaptation.properties.pathLossTransmitterCouplerCoupling.unitCode | string |
The unit code for the path loss transmitter coupler coupling. |
Value
|
properties.adaptation.properties.pathLossTransmitterCouplerCoupling.value | float |
The value of the path loss transmitter coupler coupling. |
Unit Code
|
properties.adaptation.properties.staloPowerAtA1J2.unitCode | string |
The unit code for the stalo power at A1J2. |
Value
|
properties.adaptation.properties.staloPowerAtA1J2.value | float |
The value of the stalo power at A1J2. |
Unit Code
|
properties.adaptation.properties.ameNoiseSourceHorizontalExcessNoiseRatio.unitCode | string |
The unit code for the ame noise source horizontal excess noise ratio. |
Value
|
properties.adaptation.properties.ameNoiseSourceHorizontalExcessNoiseRatio.value | float |
The value of the ame noise source horizontal excess noise ratio. |
Unit Code
|
properties.adaptation.properties.pathLossVerticalIFHeliaxTo4AT16.unitCode | string |
The unit code for the path loss vertical IF heliax to 4AT16. |
Value
|
properties.adaptation.properties.pathLossVerticalIFHeliaxTo4AT16.value | float |
The value of the path loss vertical IF heliax to 4AT16. |
Unit Code
|
properties.adaptation.properties.pathLossAT4Attenuator.unitCode | string |
The unit code for the path loss AT4 attenuator. |
Value
|
properties.adaptation.properties.pathLossAT4Attenuator.value | float |
The value of the path loss AT4 attenuator. |
Unit Code
|
properties.adaptation.properties.pathLossHorzontalIFHeliaxTo4AT17.unitCode | string |
The unit code for the path loss horzontal IF heliax to 4AT17. |
Value
|
properties.adaptation.properties.pathLossHorzontalIFHeliaxTo4AT17.value | integer |
The value of the path loss horzontal IF heliax to 4AT17. |
Unit Code
|
properties.adaptation.properties.pathLossIFDRIFAntiAliasFilter.unitCode | string |
The unit code for the path loss IFDRIF anti alias filter. |
Value
|
properties.adaptation.properties.pathLossIFDRIFAntiAliasFilter.value | float |
The value of the path loss IFDRIF anti alias filter. |
Unit Code
|
properties.adaptation.properties.pathLossIFDBurstAntiAliasFilter.unitCode | string |
The unit code for the path loss IFDBurst anti alias filter. |
Value
|
properties.adaptation.properties.pathLossIFDBurstAntiAliasFilter.value | float |
The value of the path loss IFDBurst anti alias filter. |
Unit Code
|
properties.adaptation.properties.pathLossWG02HarmonicFilter.unitCode | string |
The unit code for the path loss WG02 harmonic filter. |
Value
|
properties.adaptation.properties.pathLossWG02HarmonicFilter.value | float |
The value of the path loss WG02 harmonic filter. |
Unit Code
|
properties.adaptation.properties.transmitterPowerDataWattsFactor.unitCode | string |
The unit code for the transmitter power data watts factor. |
Value
|
properties.adaptation.properties.transmitterPowerDataWattsFactor.value | float |
The value of the transmitter power data watts factor. |
Unit Code
|
properties.adaptation.properties.pathLossWaveguideKlystronToSwitch.unitCode | string |
The unit code for the path loss waveguide klystron to switch. |
Value
|
properties.adaptation.properties.pathLossWaveguideKlystronToSwitch.value | float |
The value of the path loss waveguide klystron to switch. |
Unit Code
|
properties.adaptation.properties.pulseWidthTransmitterOutputShortPulse.unitCode | string |
The unit code for the pulse width transmitter output short pulse. |
Value
|
properties.adaptation.properties.pulseWidthTransmitterOutputShortPulse.value | integer |
The value of the pulse width transmitter output short pulse. |
Unit Code
|
properties.adaptation.properties.pulseWidthTransmitterOutputLongPulse.unitCode | string |
The unit code for the pulse width transmitter output long pulse. |
Value
|
properties.adaptation.properties.pulseWidthTransmitterOutputLongPulse.value | integer |
The value of the pulse width transmitter output long pulse. |
Unit Code
|
properties.adaptation.properties.pathLossWG06SpectrumFilter.unitCode | string |
The unit code for the path loss WG06 spectrum filter. |
Value
|
properties.adaptation.properties.pathLossWG06SpectrumFilter.value | float |
The value of the path loss WG06 spectrum filter. |
Unit Code
|
properties.adaptation.properties.horizontalReceiverNoiseShortPulse.unitCode | string |
The unit code for the horizontal receiver noise short pulse. |
Value
|
properties.adaptation.properties.horizontalReceiverNoiseShortPulse.value | float |
The value of the horizontal receiver noise short pulse. |
Unit Code
|
properties.adaptation.properties.horizontalReceiverNoiseLongPulse.unitCode | string |
The unit code for the horizontal receiver noise long pulse. |
Value
|
properties.adaptation.properties.horizontalReceiverNoiseLongPulse.value | float |
The value of the horizontal receiver noise long pulse. |
Transmitter Spectrum Filter Installed
|
properties.adaptation.properties.transmitterSpectrumFilterInstalled | string |
The transmitter spectrum filter installed. |
Get radar station alarms
Retrieve a list of alarms for a radar station.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Staton ID
|
stationId | True | string |
Radar station identifier. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Version
|
@context.@version | string |
The context version. |
ID
|
@id | string |
The context identifier. |
Graph
|
@graph | array of object | |
Type
|
@graph.@type | string |
The type of the alarm. |
Station ID
|
@graph.stationId | string |
The station identifier. |
Status
|
@graph.status | string |
The status of the alarm. |
Active Channel
|
@graph.activeChannel | integer |
The active channel. |
Message
|
@graph.message | string |
The message. |
Timestamp
|
@graph.timestamp | string |
The timestamp for the alarm. |
Get radar stations
Retrieve a list of radar stations.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Station Type
|
stationType | array |
Limit results to a specific station type or types. |
|
Reporting Host
|
reportingHost | string |
Show RDA and latency info from specific reporting host. |
|
Host
|
host | string |
Show latency info from specific LDM host. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type of the radar station. |
Features
|
features | array of object | |
ID
|
features.id | string |
The identifier for the radar station. |
Type
|
features.type | string |
The type of the radar station. |
Type
|
features.geometry.type | string |
The type of the geometry. |
Coordinates
|
features.geometry.coordinates | array of float |
The coordinates of the geometry. |
Context ID
|
features.properties.@id | string |
The identifier for the context. |
Context Type
|
features.properties.@type | string |
The type of the context. |
Radar Station ID
|
features.properties.id | string |
The identifier for the radar station. |
Name
|
features.properties.name | string |
The name of the radar station. |
Station Type
|
features.properties.stationType | string |
The type of the radar station. |
Unit Code
|
features.properties.elevation.unitCode | string |
The unit code for the elevation. |
Value
|
features.properties.elevation.value | float |
The value of the elevation. |
Time Zone
|
features.properties.timeZone | string |
The time zone for the radar station. |
Unit Code
|
features.properties.latency.current.unitCode | string |
The unit code for the current latency. |
Value
|
features.properties.latency.current.value | float |
The value of the current latency. |
Unit Code
|
features.properties.latency.average.unitCode | string |
The unit code for the average latency. |
Value
|
features.properties.latency.average.value | integer |
The value of the average latency. |
Unit Code
|
features.properties.latency.max.unitCode | string |
The unit code for the maximum latency. |
Value
|
features.properties.latency.max.value | integer |
The value of the maximum latency. |
Level Two Last Received Time
|
features.properties.latency.levelTwoLastReceivedTime | string |
The timestamp for the last received level two data. |
Max Latency Time
|
features.properties.latency.maxLatencyTime | string |
The timestamp for the maximum latency. |
Reporting Host
|
features.properties.latency.reportingHost | string |
The reporting host for the latency. |
Host
|
features.properties.latency.host | string |
The host for the latency. |
Timestamp
|
features.properties.rda.timestamp | string |
The timestamp for the RDA. |
Reporting Host
|
features.properties.rda.reportingHost | string |
The reporting host for the RDA. |
Resolution Version
|
features.properties.rda.properties.resolutionVersion | string |
The resolution version. |
NL2 Path
|
features.properties.rda.properties.nl2Path | string |
The NL2 path. |
Volume Coverage Pattern
|
features.properties.rda.properties.volumeCoveragePattern | string |
The volume coverage pattern. |
Control Status
|
features.properties.rda.properties.controlStatus | string |
The control status. |
Build Number
|
features.properties.rda.properties.buildNumber | integer |
The build number. |
Alarm Summary
|
features.properties.rda.properties.alarmSummary | string |
The alarm summary. |
Mode
|
features.properties.rda.properties.mode | string |
The mode. |
Generator State
|
features.properties.rda.properties.generatorState | string |
The generator state. |
Super Resolution Status
|
features.properties.rda.properties.superResolutionStatus | string |
The super resolution status. |
Operability Status
|
features.properties.rda.properties.operabilityStatus | string |
The operability status. |
Status
|
features.properties.rda.properties.status | string |
The status. |
Unit Code
|
features.properties.rda.properties.averageTransmitterPower.unitCode | string |
The unit code for the average transmitter power. |
Value
|
features.properties.rda.properties.averageTransmitterPower.value | integer |
The value of the average transmitter power. |
Unit Code
|
features.properties.rda.properties.reflectivityCalibrationCorrection.unitCode | string |
The unit code for the reflectivity calibration correction. |
Value
|
features.properties.rda.properties.reflectivityCalibrationCorrection.value | float |
The value of the reflectivity calibration correction. |
Get SIGMET by ATSU, date, and time
Retrieve a specific SIGMET/AIRMET.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ATSU ID
|
atsu | True | string |
ATSU identifier. |
Date
|
date | True | date |
Date (YYYY-MM-DD format). |
Time
|
time | True | string |
Time (HHMM format). This time is always specified in UTC (Zulu) time. |
Returns
A GeoJSON object representing a SIGMET report.
- SIGMET (GeoJSON)
- SigmetGeoJson
Get SIGMETs
Retrieve a list of SIGMET/AIRMETs.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Query Start Time
|
start | date-time |
Start time. |
|
Query End Time
|
end | date-time |
End time. |
|
Query Date
|
date | date |
Date (YYYY-MM-DD format). |
|
ATSU
|
atsu | string |
ATSU identifier. |
|
Sequence
|
sequence | string |
SIGMET sequence number. |
Returns
A GeoJSON object representing a collection of SIGMET reports.
- SIGMET Collection (GeoJSON)
- SigmetCollectionGeoJson
Get SIGMETs by ATSU
Retrieve a list of SIGMET/AIRMETs for a specific ATSU.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ATSU ID
|
atsu | True | string |
ATSU identifier. |
Returns
A GeoJSON object representing a collection of SIGMET reports.
- SIGMET Collection (GeoJSON)
- SigmetCollectionGeoJson
Get SIGMETs by ATSU and date
Retrieve a list of SIGMET/AIRMETs for a specific ATSU and date.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ATSU ID
|
atsu | True | string |
ATSU identifier. |
Date
|
date | True | date |
Date (YYYY-MM-DD format). |
Returns
A GeoJSON object representing a collection of SIGMET reports.
- SIGMET Collection (GeoJSON)
- SigmetCollectionGeoJson
Get station observations
Retrieve a list of observations for a station.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Query Start Time
|
start | date-time |
Start time. |
|
Query End Time
|
end | date-time |
End time. |
|
Observation Station ID
|
stationId | True | string |
Observation station identifier. |
Limit
|
limit | integer |
Limit. |
Get TAF by time
Retrieve a single Terminal Aerodrome Forecast.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Observation Station ID
|
stationId | True | string |
Observation station identifier. |
Date
|
date | True | date |
Date (YYYY-MM-DD format). |
Time
|
time | True | string |
Time (HHMM format). This time is always specified in UTC (Zulu) time. |
Returns
Get TAFs
Retrieve Terminal Aerodrome Forecasts for the specified airport station.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Observation Station ID
|
stationId | True | string |
Observation station identifier. |
Returns
Get text product
Retrieve a specific text product.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Product ID
|
productId | True | string |
Product identifier. |
Returns
An object representing a text product.
- Text Product
- TextProduct
Get text product locations
Retrieve a list of valid text product issuance locations.
Returns
A collection of text product locations.
- Text Product Location Collection
- TextProductLocationCollection
Get text product locations by type
Retrieve a list of valid text product issuance locations for a given type.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Type ID
|
typeId | True | string |
Product type identifier. |
Returns
A collection of text product locations.
- Text Product Location Collection
- TextProductLocationCollection
Get text product types
Retrieve a list of valid text product types.
Returns
A collection of text product types.
- Text Product Type Collection
- TextProductTypeCollection
Get text product types by location
Retrieve a list of valid text product types for a given location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location ID
|
locationId | True | string |
Product location identifier. |
Returns
A collection of text product types.
- Text Product Type Collection
- TextProductTypeCollection
Get text products
Retrieve a list of text products.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Location
|
location | array |
Location identifier. |
|
Start
|
start | date-time |
Start time. |
|
End
|
end | date-time |
End time. |
|
Office
|
office | array |
Issuing office. |
|
WMO ID
|
wmoid | array |
WMO identifier code. |
|
Type
|
type | array |
Product code. |
|
Limit
|
limit | integer |
Limit. |
Returns
A collection of text products.
- Text Product Collection
- TextProductCollection
Get text products by type
Retrieve a list of text products by type.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Type ID
|
typeId | True | string |
Product type identifier. |
Returns
A collection of text products.
- Text Product Collection
- TextProductCollection
Get text products by type and location
Retrieve a list of text products for a given type and location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Type ID
|
typeId | True | string |
Product type identifier. |
Location ID
|
locationId | True | string |
Product location identifier. |
Returns
A collection of text products.
- Text Product Collection
- TextProductCollection
Get textual gridpoint forecast
Retrieve a textual forecast for a 2.5km grid area.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Gridpoint Forecast Feature Flags
|
Feature-Flags | array |
Enable future and experimental features (see documentation for more info):* forecast_temperature_qv: Represent temperature as QuantitativeValue* forecast_wind_speed_qv: Represent wind speed as QuantitativeValue. |
|
Gridpoint Forecast Units
|
units | string |
Use US customary or SI (metric) units in textual output. |
|
Gridpoint WFO
|
wfo | True | string |
Forecast office identifier. |
Gridpoint X
|
x | True | integer |
Forecast grid X coordinate. |
Gridpoint Y
|
y | True | integer |
Forecast grid Y coordinate. |
Get zone
Retrieve metadata about a given zone.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Type
|
type | True | string |
Zone type. |
NWS Zone ID
|
zoneId | True | string |
NWS public zone/county identifier. |
Effective
|
effective | date-time |
Effective date/time. |
Returns
A GeoJSON object representing a forecast zone.
- Zone (GeoJSON)
- ZoneGeoJson
Get zone forecast
Retrieve a zone forecast.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Type
|
type | True | string |
Zone type. |
NWS Zone ID
|
zoneId | True | string |
NWS public zone/county identifier. |
Returns
A GeoJSON object representing a zone area forecast.
- Zone Forecast (GeoJSON)
- ZoneForecastGeoJson
Get zone observations
Retrieve a list of observations for a zone.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Zone ID
|
zoneId | True | string |
NWS public zone/county identifier. |
Start
|
start | date-time |
Start date/time. |
|
End
|
end | date-time |
End date/time. |
|
Limit
|
limit | integer |
Limit. |
Returns
A GeoJSON object representing a collection of weather observations.
- Observation Collection (GeoJSON)
- ObservationCollectionGeoJson
Get zone stations
Retrieve a list of observation stations for a zone.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
NWS Zone ID
|
zoneId | True | string |
NWS public zone/county identifier. |
Limit
|
limit | integer |
Limit. |
|
Pagination Cursor
|
cursor | string |
Pagination cursor. |
Get zones
Retrieve a list of zones.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
ID
|
id | array |
Zone ID (forecast or county). |
|
Area
|
area | array |
State/marine area code. |
|
Region
|
region | array |
Region code. |
|
Type
|
type | array |
Zone type. |
|
Point
|
point | string |
Point (latitude,longitude). |
|
Include geometry
|
include_geometry | boolean |
Include geometry in results (true/false). |
|
Limit
|
limit | integer |
Limit. |
|
Effective
|
effective | date-time |
Effective date/time. |
Returns
A GeoJSON object representing a collection of forecast zones.
- Zone Collection (GeoJSON)
- ZoneCollectionGeoJson
Get zones by type
Retrieve a list of zones by type.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Type
|
type | True | string |
Zone type. |
ID
|
id | array |
Zone ID (forecast or county). |
|
Area
|
area | array |
State/marine area code. |
|
Region
|
region | array |
Region code. |
|
Point
|
point | string |
Point (latitude,longitude). |
|
Include Geometry
|
include_geometry | boolean |
Include geometry in results (true/false). |
|
Limit
|
limit | integer |
Limit. |
|
Effective
|
effective | date-time |
Effective date/time. |
Returns
A GeoJSON object representing a collection of forecast zones.
- Zone Collection (GeoJSON)
- ZoneCollectionGeoJson
Definitions
Alert
An object representing a public alert message. Unless otherwise noted, the fields in this object correspond to the National Weather Service CAP v1.2 specification, which extends the OASIS Common Alerting Protocol (CAP) v1.2 specification and USA Integrated Public Alert and Warning System (IPAWS) Profile v1.0. Refer to this documentation for more complete information. http://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2-os.html http://docs.oasis-open.org/emergency/cap/v1.2/ipaws-profile/v1.0/cs01/cap-v1.2-ipaws-profile-cs01.html https://alerts.weather.gov/#technical-notes-v12
Name | Path | Type | Description |
---|---|---|---|
Alert ID
|
id | AlertId |
The identifier of the alert message. |
Area Description
|
areaDesc | string |
A textual description of the area affected by the alert. |
Zone IDs
|
geocode.UGC | array of NWSZoneID |
A list of NWS public zone or county identifiers. |
SAME Codes
|
geocode.SAME | array of string |
A list of SAME (Specific Area Message Encoding) codes for affected counties. |
Affected Zones
|
affectedZones | array of string |
An array of API links for zones affected by the alert. This is an API-specific extension field and is not part of the CAP specification. |
References
|
references | array of object |
A list of prior alerts that this alert updates or replaces. |
API Link
|
references.@id | uri |
An API link to the prior alert. |
Alert ID
|
references.identifier | AlertId |
The identifier of the alert message. |
Sender
|
references.sender | string |
The sender of the prior alert. |
Sent
|
references.sent | date-time |
The time the prior alert was sent. |
Sent
|
sent | date-time |
The time of the origination of the alert message. |
Effective
|
effective | date-time |
The effective time of the information of the alert message. |
Onset
|
onset | date-time |
The expected time of the beginning of the subject event of the alert message. |
Expires
|
expires | date-time |
The expiry time of the information of the alert message. |
Ends
|
ends | date-time |
The expected end time of the subject event of the alert message. |
Status
|
status | AlertStatus |
The code denoting the appropriate handling of the alert message. |
Message Type
|
messageType | AlertMessageType |
The code denoting the nature of the alert message. |
Category
|
category | string |
The code denoting the category of the subject event of the alert message. |
Severity
|
severity | AlertSeverity |
The code denoting the severity of the subject event of the alert message. |
Certainty
|
certainty | AlertCertainty |
The code denoting the certainty of the subject event of the alert message. |
Urgency
|
urgency | AlertUrgency |
The code denoting the urgency of the subject event of the alert message. |
Event
|
event | string |
The text denoting the type of the subject event of the alert message. |
Sender
|
sender | string |
Email address of the NWS webmaster. |
Sender Name
|
senderName | string |
The text naming the originator of the alert message. |
Headline
|
headline | string |
The text headline of the alert message. |
Description
|
description | string |
The text describing the subject event of the alert message. |
Instruction
|
instruction | string |
The text describing the recommended action to be taken by recipients of the alert message. |
Response
|
response | string |
The code denoting the type of action recommended for the target audience. This corresponds to responseType in the CAP specification. |
Parameters
|
parameters | object |
System-specific additional parameters associated with the alert message. The keys in this object correspond to parameter definitions in the NWS CAP specification. |
AlertGeoJson
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
properties
|
properties | Alert |
An object representing a public alert message. Unless otherwise noted, the fields in this object correspond to the National Weather Service CAP v1.2 specification, which extends the OASIS Common Alerting Protocol (CAP) v1.2 specification and USA Integrated Public Alert and Warning System (IPAWS) Profile v1.0. Refer to this documentation for more complete information. http://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2-os.html http://docs.oasis-open.org/emergency/cap/v1.2/ipaws-profile/v1.0/cs01/cap-v1.2-ipaws-profile-cs01.html https://alerts.weather.gov/#technical-notes-v12 |
AlertId
AlertCertainty
The code denoting the certainty of the subject event of the alert message.
The code denoting the certainty of the subject event of the alert message.
- Certainty
- string
AlertMessageType
The code denoting the nature of the alert message.
The code denoting the nature of the alert message.
- Message Type
- string
AlertSeverity
The code denoting the severity of the subject event of the alert message.
The code denoting the severity of the subject event of the alert message.
- Severity
- string
AlertStatus
The code denoting the appropriate handling of the alert message.
The code denoting the appropriate handling of the alert message.
- Status
- string
AlertUrgency
The code denoting the urgency of the subject event of the alert message.
The code denoting the urgency of the subject event of the alert message.
- Urgency
- string
ATSUIdentifier
CenterWeatherAdvisoryCollectionGeoJson
A collection of Center Weather Advisories in GeoJSON format.
Name | Path | Type | Description |
---|---|---|---|
Features
|
features | array of object |
The features. |
properties
|
features.properties | CenterWeatherAdvisory | |
Type
|
geoJsonFeatureCollection.type | string |
The type. |
features
|
geoJsonFeatureCollection.features | array of object | |
Type
|
geoJsonFeatureCollection.features.type | string |
The type. |
Type
|
geoJsonFeatureCollection.features.geometry.type | string |
The type. |
Coordinates
|
geoJsonFeatureCollection.features.geometry.coordinates | array of number |
The coordinates. |
properties
|
geoJsonFeatureCollection.features.properties | CenterWeatherAdvisory | |
Format
|
format | date-time |
The format. |
Observed Property
|
observedProperty | string |
The observed property. |
Text
|
text | string |
The text. |
CenterWeatherAdvisoryGeoJson
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
properties
|
properties | CenterWeatherAdvisory |
CenterWeatherAdvisory
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The identifier of the Center Weather Advisory. |
Issue Time
|
issueTime | date-time |
The time the Center Weather Advisory was issued. |
NWS Center Weather Service Unit ID
|
cwsu | NWSCenterWeatherServiceUnitId |
Three-letter identifier for a Center Weather Service Unit (CWSU). |
Sequence
|
sequence | integer |
The sequence number of the Center Weather Advisory. |
Start
|
start | date-time |
The start time of the Center Weather Advisory. |
End
|
end | date-time |
The end time of the Center Weather Advisory. |
Observed Property
|
observedProperty | string |
The observed property. |
Text
|
text | string |
The text. |
GeometryString
A geometry represented in Well-Known Text (WKT) format.
A geometry represented in Well-Known Text (WKT) format.
- Geometry
- string
Gridpoint
Raw forecast data for a 2.5km grid square. This is a list of all potential data layers that may appear. Some layers may not be present in all areas. * temperature. * dewpoint. * maxTemperature. * minTemperature. * relativeHumidity. * apparentTemperature. * heatIndex. * windChill. * wetBulbGlobeTemperature. * skyCover. * windDirection. * windSpeed. * windGust. * weather. * hazards: Watch and advisory products in effect. * probabilityOfPrecipitation. * quantitativePrecipitation. * iceAccumulation. * snowfallAmount. * snowLevel. * ceilingHeight. * visibility. * transportWindSpeed. * transportWindDirection. * mixingHeight. * hainesIndex. * lightningActivityLevel. * twentyFootWindSpeed. * twentyFootWindDirection. * waveHeight. * wavePeriod. * waveDirection. * primarySwellHeight. * primarySwellDirection. * secondarySwellHeight. * secondarySwellDirection. * wavePeriod2. * windWaveHeight. * dispersionIndex. * pressure: Barometric pressure. * probabilityOfTropicalStormWinds. * probabilityOfHurricaneWinds. * potentialOf15mphWinds. * potentialOf25mphWinds. * potentialOf35mphWinds. * potentialOf45mphWinds. * potentialOf20mphWindGusts. * potentialOf30mphWindGusts. * potentialOf40mphWindGusts. * potentialOf50mphWindGusts. * potentialOf60mphWindGusts. * grasslandFireDangerIndex. * probabilityOfThunder. * davisStabilityIndex. * atmosphericDispersionIndex. * lowVisibilityOccurrenceRiskIndex. * stability. * redFlagThreatIndex
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Geometry
|
geometry | GeometryString |
A geometry represented in Well-Known Text (WKT) format. |
Context ID
|
@id | string |
The identifier of the context gridpoint. |
Context ype
|
@type | string |
The type of context gridpoint. |
Update Time
|
updateTime | date-time |
The time the gridpoint was last updated. |
ISO 8601 Interval
|
validTimes | ISO8601Interval |
A time interval in ISO 8601 format. This can be one of: 1. Start and end time 2. Start time and duration 3. Duration and end time The string "NOW" can also be used in place of a start/end time. |
Quantitative Value
|
elevation | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Forecast Office
|
forecastOffice | string |
The forecast office. |
Grid ID
|
gridId | string |
The grid identifier. |
Grid X
|
gridX | integer |
The grid X coordinate. |
Grid Y
|
gridY | integer |
The grid Y coordinate. |
Values
|
weather.values | array of object |
The values. |
ISO 8601 Interval
|
weather.values.validTime | ISO8601Interval |
A time interval in ISO 8601 format. This can be one of: 1. Start and end time 2. Start time and duration 3. Duration and end time The string "NOW" can also be used in place of a start/end time. |
Value
|
weather.values.value | array of object |
The weather value. |
Coverage
|
weather.values.value.coverage | string |
The coverage. |
Weather
|
weather.values.value.weather | string |
The weather. |
Intensity
|
weather.values.value.intensity | string |
The intensity. |
Quantitative Value
|
weather.values.value.visibility | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Attributes
|
weather.values.value.attributes | array of string |
The attributes. |
Values
|
hazards.values | array of object |
The values. |
ISO 8601 Interval
|
hazards.values.validTime | ISO8601Interval |
A time interval in ISO 8601 format. This can be one of: 1. Start and end time 2. Start time and duration 3. Duration and end time The string "NOW" can also be used in place of a start/end time. |
value
|
hazards.values.value | array of object | |
Phenomenon
|
hazards.values.value.phenomenon | string |
Hazard code. This value will correspond to a P-VTEC phenomenon code as defined in NWS Directive 10-1703. |
Significance
|
hazards.values.value.significance | string |
Significance code. This value will correspond to a P-VTEC significance code as defined in NWS Directive 10-1703. This will most frequently be "A" for a watch or "Y" for an advisory. |
Event Number
|
hazards.values.value.event_number | integer |
Event number. If this hazard refers to a national or regional center product (such as a Storm Prediction Center convective watch), this value will be the sequence number of that product. |
GridpointGeoJson
A GeoJSON object representing a gridpoint.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
Gridpoint
|
properties | Gridpoint |
Raw forecast data for a 2.5km grid square. This is a list of all potential data layers that may appear. Some layers may not be present in all areas. * temperature. * dewpoint. * maxTemperature. * minTemperature. * relativeHumidity. * apparentTemperature. * heatIndex. * windChill. * wetBulbGlobeTemperature. * skyCover. * windDirection. * windSpeed. * windGust. * weather. * hazards: Watch and advisory products in effect. * probabilityOfPrecipitation. * quantitativePrecipitation. * iceAccumulation. * snowfallAmount. * snowLevel. * ceilingHeight. * visibility. * transportWindSpeed. * transportWindDirection. * mixingHeight. * hainesIndex. * lightningActivityLevel. * twentyFootWindSpeed. * twentyFootWindDirection. * waveHeight. * wavePeriod. * waveDirection. * primarySwellHeight. * primarySwellDirection. * secondarySwellHeight. * secondarySwellDirection. * wavePeriod2. * windWaveHeight. * dispersionIndex. * pressure: Barometric pressure. * probabilityOfTropicalStormWinds. * probabilityOfHurricaneWinds. * potentialOf15mphWinds. * potentialOf25mphWinds. * potentialOf35mphWinds. * potentialOf45mphWinds. * potentialOf20mphWindGusts. * potentialOf30mphWindGusts. * potentialOf40mphWindGusts. * potentialOf50mphWindGusts. * potentialOf60mphWindGusts. * grasslandFireDangerIndex. * probabilityOfThunder. * davisStabilityIndex. * atmosphericDispersionIndex. * lowVisibilityOccurrenceRiskIndex. * stability. * redFlagThreatIndex |
ID
|
id | string |
The identifier of the gridpoint. |
ISO8601Interval
A time interval in ISO 8601 format. This can be one of: 1. Start and end time 2. Start time and duration 3. Duration and end time The string "NOW" can also be used in place of a start/end time.
A time interval in ISO 8601 format. This can be one of: 1. Start and end time 2. Start time and duration 3. Duration and end time The string "NOW" can also be used in place of a start/end time.
- ISO 8601 Interval
- string
JsonLdContext
A JSON-LD context definition.
Name | Path | Type | Description |
---|---|---|---|
Items
|
MetarPhenomenon
An object representing a decoded METAR phenomenon string.
Name | Path | Type | Description |
---|---|---|---|
Intensity
|
intensity | string |
The intensity. |
Modifier
|
modifier | string |
The modifier. |
Weather
|
weather | string |
The weather. |
Raw String
|
rawString | string |
The raw METAR string. |
In Vicinity
|
inVicinity | boolean |
Indicates whether the phenomenon is in the vicinity. |
MetarSkyCoverage
An object representing a decoded METAR sky coverage string.
An object representing a decoded METAR sky coverage string.
- METAR Sky Coverage
- string
NWSCenterWeatherServiceUnitId
Three-letter identifier for a Center Weather Service Unit (CWSU).
Three-letter identifier for a Center Weather Service Unit (CWSU).
- NWS Center Weather Service Unit ID
- string
NWSForecastOfficeId
Three-letter identifier for a NWS office.
Three-letter identifier for a NWS office.
- NWS Forecast Office ID
- string
NWSZoneID
UGC identifier for a NWS forecast zone or county. The first two letters will correspond to either a state code or marine area code (see #/components/schemas/StateTerritoryCode and #/components/schemas/MarineAreaCode for lists of valid letter combinations). The third letter will be Z for public/fire zone or C for county.
UGC identifier for a NWS forecast zone or county. The first two letters will correspond to either a state code or marine area code (see #/components/schemas/StateTerritoryCode and #/components/schemas/MarineAreaCode for lists of valid letter combinations). The third letter will be Z for public/fire zone or C for county.
- NWS Zone ID
- string
NWSZoneType
Observation
An object representing a weather observation.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Geometry
|
geometry | GeometryString |
A geometry represented in Well-Known Text (WKT) format. |
ID
|
@id | string |
The identifier of the observation. |
Type
|
@type | string |
The type. |
Quantitative Value
|
elevation | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Station
|
station | string |
The station. |
Timestamp
|
timestamp | date-time |
The timestamp. |
Raw Message
|
rawMessage | string |
The raw message. |
Text Description
|
textDescription | string |
The text description. |
Icon
|
icon | string |
The icon. |
Present Weather
|
presentWeather | array of MetarPhenomenon |
The present weather. |
Quantitative Value
|
temperature | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
dewpoint | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
windDirection | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
windSpeed | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
windGust | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
barometricPressure | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
seaLevelPressure | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
visibility | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
maxTemperatureLast24Hours | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
minTemperatureLast24Hours | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
precipitationLastHour | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
precipitationLast3Hours | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
precipitationLast6Hours | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
relativeHumidity | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
windChill | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
heatIndex | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Cloud Layers
|
cloudLayers | array of object |
The cloud layers. |
Quantitative Value
|
cloudLayers.base | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
METAR Sky Coverage
|
cloudLayers.amount | MetarSkyCoverage |
An object representing a decoded METAR sky coverage string. |
ObservationCollectionGeoJson
A GeoJSON object representing a collection of weather observations.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Features
|
features | array of object |
The features. |
Type
|
features.type | string |
The type. |
Type
|
features.geometry.type | string |
The type. |
Coordinates
|
features.geometry.coordinates | array of float |
The coordinates. |
Observation
|
features.properties | Observation |
An object representing a weather observation. |
Type
|
crs.type | string |
The type. |
Name
|
crs.name | string |
The name. |
Bounding Box
|
bbox | array of float |
The bounding box. |
ObservationStation
An object representing a weather observation station.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Geometry
|
geometry | GeometryString |
A geometry represented in Well-Known Text (WKT) format. |
ID
|
@id | string |
The identifier of the observation station. |
Type
|
@type | string |
The type. |
Quantitative Value
|
elevation | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Station Identifier
|
stationIdentifier | string |
The station identifier. |
Name
|
name | string |
The name of the station. |
Time Zone
|
timeZone | string |
The time zone. |
Forecast
|
forecast | string |
A link to the NWS public forecast zone containing this station. |
County
|
county | string |
A link to the NWS county zone containing this station. |
Fire Weather Zone
|
fireWeatherZone | string |
A link to the NWS fire weather forecast zone containing this station. |
ObservationStationGeoJson
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
Observation Station
|
properties | ObservationStation |
An object representing a weather observation station. |
ID
|
id | string |
The identifier of the observation station. |
Office
An object representing a NWS office.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Type
|
@type | string |
The type. |
Context ID
|
@id | string |
The identifier of the context. |
ID
|
id | string |
The identifier of the office. |
Name
|
name | string |
The name of the office. |
Type
|
address.@type | string |
The type. |
Street Address
|
address.streetAddress | string |
The street address. |
Locality
|
address.addressLocality | string |
The locality. |
Region
|
address.addressRegion | string |
The region. |
Postal Code
|
address.postalCode | string |
The postal code. |
Telephone
|
telephone | string |
The telephone number. |
Fax Number
|
faxNumber | string |
The fax number. |
Email
|
string |
The email address. |
|
Same As
|
sameAs | string |
The same as. |
NWS Region
|
nwsRegion | string |
The NWS region. |
Parent Organization
|
parentOrganization | string |
The parent organization. |
Responsible Counties
|
responsibleCounties | array of string |
The responsible counties. |
Responsible Forecast Zones
|
responsibleForecastZones | array of string |
The responsible forecast zones. |
Responsible Fire Zones
|
responsibleFireZones | array of string |
The responsible fire zones. |
Approved Observation Stations
|
approvedObservationStations | array of string |
The approved observation stations. |
OfficeHeadline
An object representing a headline from a NWS office.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Context ID
|
@id | string |
The identifier of the context |
ID
|
id | string |
The identifier of the headline. |
Office
|
office | string |
The office. |
Important
|
important | boolean |
Indicates whether the headline is important. |
Issuance Time
|
issuanceTime | date-time |
The issuance time. |
Link
|
link | string |
The link. |
Name
|
name | string |
The name of the headline. |
Title
|
title | string |
The title of the headline. |
Summary
|
summary | string |
The summary of the headline. |
Content
|
content | string |
The content of the headline. |
OfficeHeadlineCollection
A collection of headlines from NWS offices.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Graph
|
@graph | array of OfficeHeadline |
The graph. |
Point
An object representing a point.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Geometry
|
geometry | GeometryString |
A geometry represented in Well-Known Text (WKT) format. |
Context ID
|
@id | string |
The identifier of the context. |
Context Type
|
@type | string |
The context type. |
NWS Forecast Office ID
|
cwa | NWSForecastOfficeId |
Three-letter identifier for a NWS office. |
Forecast Office
|
forecastOffice | string |
The forecast office. |
NWS Forecast Office ID
|
gridId | NWSForecastOfficeId |
Three-letter identifier for a NWS office. |
Grid X
|
gridX | integer |
The grid X. |
Grid Y
|
gridY | integer |
The grid Y. |
Forecast
|
forecast | string |
The forecast. |
Hourly Forecast
|
forecastHourly | string |
The hourly forecast. |
Forecast Grid Data
|
forecastGridData | string |
The forecast grid data. |
Observation Stations
|
observationStations | string |
The observation stations. |
Type
|
relativeLocation.type | string |
The type. |
Type
|
relativeLocation.geometry.type | string |
The type. |
Coordinates
|
relativeLocation.geometry.coordinates | array of float |
The coordinates. |
Relative Location
|
relativeLocation.properties | RelativeLocation |
An object representing a relative location. |
ID
|
relativeLocation.id | string |
The identifier of the relative location. |
Forecast Zone
|
forecastZone | string |
The forecast zone. |
County
|
county | string |
The county. |
Fire Weather Zone
|
fireWeatherZone | string |
The fire weather zone. |
Time Zone
|
timeZone | string |
The time zone. |
Radar Station
|
radarStation | string |
The radar station. |
PointGeoJson
A GeoJSON object representing a point.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
Point
|
properties | Point |
An object representing a point. |
ID
|
id | string |
The identifier of the point. |
QuantitativeValue
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue
Name | Path | Type | Description |
---|---|---|---|
Value
|
value | float |
A measured value. |
Max Value
|
maxValue | float |
The maximum value of a range of measured values. |
Min Value
|
minValue | float |
The minimum value of a range of measured values. |
Unit of Measure
|
unitCode | UnitOfMeasure |
A string denoting a unit of measure. Units with the namespace "wmo" or "wmoUnit" are defined in the World Meteorological Organization Codes Registry at http://codes.wmo.int/common/unit and should be canonically resolvable to http://codes.wmo.int/common/unit/{unit}. Units with the namespace "nwsUnit" are currently custom and do not align to any standard. Units with no namespace or the namespace "uc" are compliant with the Unified Code for Units of Measure syntax defined at https://unitsofmeasure.org/. This also aligns with recent versions of the Geographic Markup Language (GML) standard, the IWXXM standard, and OGC Observations and Measurements v2.0 (ISO/DIS 19156). Namespaced units are considered deprecated. We will be aligning API to use the same standards as GML/IWXXM in the future. |
Quality Control
|
qualityControl | string |
For values in observation records, the quality control flag from the MADIS system. The definitions of these flags can be found at https://madis.ncep.noaa.gov/madis_sfc_qc_notes.shtml |
RelativeLocation
An object representing a relative location.
Name | Path | Type | Description |
---|---|---|---|
City
|
city | string |
The city. |
State
|
state | string |
The state. |
Quantitative Value
|
distance | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Quantitative Value
|
bearing | QuantitativeValue |
A structured value representing a measurement and its unit of measure. This object is a slighly modified version of the schema.org definition at https://schema.org/QuantitativeValue |
Sigmet
An object representing a significant meteorological information (SIGMET) report.
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The identifier of the SIGMET. |
Issue Time
|
issueTime | date-time |
The time the SIGMET was issued. |
FIR
|
fir | string |
The flight information region (FIR) in which the SIGMET is valid. |
ATSU Identifier
|
atsu | ATSUIdentifier |
ATSU Identifier. |
Sequence
|
sequence | string |
The sequence number of the SIGMET. |
Phenomenon
|
phenomenon | string |
The phenomenon described by the SIGMET. |
Start
|
start | date-time |
The time the SIGMET is valid from. |
End
|
end | date-time |
The time the SIGMET is valid until. |
SigmetCollectionGeoJson
A GeoJSON object representing a collection of SIGMET reports.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Features
|
features | array of object |
The features. |
Type
|
features.type | string |
The type. |
Type
|
features.geometry.type | string |
The type. |
Coordinates
|
features.geometry.coordinates | array of float |
The coordinates. |
SIGMET (GeoJSON)
|
features.properties | SigmetGeoJson |
A GeoJSON object representing a SIGMET report. |
Type
|
crs.type | string |
The type. |
Name
|
crs.name | string |
The name. |
Bounding Box
|
bbox | array of float |
The bounding box. |
SigmetGeoJson
A GeoJSON object representing a SIGMET report.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
SIGMET
|
properties | Sigmet |
An object representing a significant meteorological information (SIGMET) report. |
ID
|
id | string |
The identifier of the SIGMET. |
StateTerritoryCode
A code representing a state or territory.
A code representing a state or territory.
- State/Territory Code
- string
TextProduct
An object representing a text product.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Context ID
|
@id | string |
The identifier of the context. |
ID
|
id | string |
The identifier of the text product. |
WMO Collective ID
|
wmoCollectiveId | string |
The WMO collective ID. |
Issuing Office
|
issuingOffice | string |
The issuing office. |
Issuance Time
|
issuanceTime | date-time |
The time the text product was issued. |
Product Code
|
productCode | string |
The product code. |
Product Name
|
productName | string |
The name of the product. |
Product Text
|
productText | string |
The text of the product. |
TextProductCollection
A collection of text products.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Graph
|
@graph | array of TextProduct |
The graph. |
TextProductTypeCollection
A collection of text product types.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Graph
|
@graph | array of object |
The graph. |
Product Code
|
@graph.productCode | string |
The product code. |
Product Name
|
@graph.productName | string |
The name of the product. |
TextProductLocationCollection
A collection of text product locations.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Locations
|
locations | object |
The locations. |
UnitOfMeasure
A string denoting a unit of measure. Units with the namespace "wmo" or "wmoUnit" are defined in the World Meteorological Organization Codes Registry at http://codes.wmo.int/common/unit and should be canonically resolvable to http://codes.wmo.int/common/unit/{unit}. Units with the namespace "nwsUnit" are currently custom and do not align to any standard. Units with no namespace or the namespace "uc" are compliant with the Unified Code for Units of Measure syntax defined at https://unitsofmeasure.org/. This also aligns with recent versions of the Geographic Markup Language (GML) standard, the IWXXM standard, and OGC Observations and Measurements v2.0 (ISO/DIS 19156). Namespaced units are considered deprecated. We will be aligning API to use the same standards as GML/IWXXM in the future.
A string denoting a unit of measure. Units with the namespace "wmo" or "wmoUnit" are defined in the World Meteorological Organization Codes Registry at http://codes.wmo.int/common/unit and should be canonically resolvable to http://codes.wmo.int/common/unit/{unit}. Units with the namespace "nwsUnit" are currently custom and do not align to any standard. Units with no namespace or the namespace "uc" are compliant with the Unified Code for Units of Measure syntax defined at https://unitsofmeasure.org/. This also aligns with recent versions of the Geographic Markup Language (GML) standard, the IWXXM standard, and OGC Observations and Measurements v2.0 (ISO/DIS 19156). Namespaced units are considered deprecated. We will be aligning API to use the same standards as GML/IWXXM in the future.
- Unit of Measure
- string
Zone
An object representing a forecast zone.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Geometry
|
geometry | GeometryString |
A geometry represented in Well-Known Text (WKT) format. |
Context ID
|
@id | string |
The identifier of the context. |
Context Type
|
@type | string |
The context type. |
NWS Zone ID
|
id | NWSZoneID |
UGC identifier for a NWS forecast zone or county. The first two letters will correspond to either a state code or marine area code (see #/components/schemas/StateTerritoryCode and #/components/schemas/MarineAreaCode for lists of valid letter combinations). The third letter will be Z for public/fire zone or C for county. |
NWS Zone Type
|
type | NWSZoneType |
The type of NWS zone. |
Name
|
name | string |
The name of the zone. |
Effective Date
|
effectiveDate | date-time |
The effective date of the zone. |
Expiration Date
|
expirationDate | date-time |
The expiration date of the zone. |
State/Territory Code
|
state.id | StateTerritoryCode |
A code representing a state or territory. |
Name
|
state.name | string |
The name of the state. |
Description
|
state.description | string |
A description of the state. |
Type
|
state.geometry.type | string |
The type. |
Coordinates
|
state.geometry.coordinates | array of float |
The coordinates. |
Forecast Office
|
forecastOffice | string |
The forecast office. |
Grid Identifier
|
gridIdentifier | string |
The grid identifier. |
AWIPS Location Identifier
|
awipsLocationIdentifier | string |
The AWIPS location identifier. |
CWA
|
cwa | array of NWSForecastOfficeId |
The county warning area. |
Forecast Offices
|
forecastOffices | array of string |
The forecast offices. |
Time Zone
|
timeZone | array of string |
The time zone. |
Observation Stations
|
observationStations | array of string |
The observation stations. |
Radar Station
|
radarStation | string |
The radar station. |
ZoneGeoJson
A GeoJSON object representing a forecast zone.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
Zone
|
properties | Zone |
An object representing a forecast zone. |
ID
|
id | string |
The identifier of the zone. |
ZoneCollectionGeoJson
A GeoJSON object representing a collection of forecast zones.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Features
|
features | array of object |
The features. |
Type
|
features.type | string |
The type. |
Type
|
features.geometry.type | string |
The type. |
Coordinates
|
features.geometry.coordinates | array of float |
The coordinates. |
Zone
|
features.properties | Zone |
An object representing a forecast zone. |
Type
|
crs.type | string |
The type. |
Name
|
crs.name | string |
The name. |
Bounding Box
|
bbox | array of float |
The bounding box. |
ZoneForecast
An object representing a zone area forecast.
Name | Path | Type | Description |
---|---|---|---|
JSON-LD Context
|
@context | JsonLdContext |
A JSON-LD context definition. |
Geometry
|
geometry | GeometryString |
A geometry represented in Well-Known Text (WKT) format. |
Zone
|
zone | string |
An API link to the zone this forecast is for. |
Updated
|
updated | date-time |
The time this zone forecast product was published. |
Periods
|
periods | array of object |
An array of forecast periods. |
Number
|
periods.number | integer |
A sequential identifier number. |
Detailed Forecast
|
periods.detailedForecast | string |
A detailed textual forecast for the period. |
ZoneForecastGeoJson
A GeoJSON object representing a zone area forecast.
Name | Path | Type | Description |
---|---|---|---|
Type
|
type | string |
The type. |
Type
|
geometry.type | string |
The type. |
Coordinates
|
geometry.coordinates | array of float |
The coordinates. |
Zone Forecast
|
properties | ZoneForecast |
An object representing a zone area forecast. |
ID
|
id | string |
The identifier of the zone forecast. |