NCEI Climate Data (Independent Publisher) (Preview)
National Centers for Environmental Information (NCEI) provides access to an extensive archive of environmental data through several platforms. We deliver the climate, coastal, oceanographic, and geophysical data you need.
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 |
| ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://www.ncei.noaa.gov/ |
| Privacy policy | https://www.ncei.noaa.gov/privacy |
| Categories | Data |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Token | securestring | The Token for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get data |
Retrieves specific data. |
| Get data categories |
Retrieve a list of data categories. |
| Get data category |
Retrieve a specific data category. |
| Get data type |
Retrieve a specific data type. |
| Get data types |
Retrieve a list of data types. |
| Get dataset |
Retrieve the specific dataset. |
| Get datasets |
Retrieve a list of available datasets. |
| Get ___location |
Retrieve a specific ___location. |
| Get ___location categories |
Retrieve a list of ___location categories. |
| Get ___location category |
Retrieve a specific ___location category. |
| Get locations |
Retrieve a list of locations. |
| Get station |
Retrieve a specific station. |
| Get station metadata (HOMR) |
Retrieve the historical metadata for a station from the Historical Observing Metadata Repository (HOMR). |
| Get stations |
Retrieves a list of stations. |
| Search datasets |
Retrieve the results of a dataset search. |
| Search station metadata (HOMR) |
Search for a station from the Historical Observing Metadata Repository (HOMR). |
Get data
Retrieves specific data.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Dataset ID
|
datasetid | True | string |
The dataset identifier. |
|
Data Type ID
|
datatypeid | string |
The data type identifier. |
|
|
Location ID
|
locationid | string |
The ___location identifier. |
|
|
Station ID
|
stationid | string |
The station identifier. |
|
|
Start Date
|
startdate | True | string |
The start date. |
|
End Date
|
enddate | True | string |
The end date. |
|
Units
|
units | string |
The units. |
|
|
Sort Field
|
sortfield | string |
The sort field. |
|
|
Sort Order
|
sortorder | string |
The sort order. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
|
|
Include Metadata
|
includemetadata | boolean |
Whether to include metadata. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Offset
|
metadata.resultset.offset | integer |
The offset. |
|
Count
|
metadata.resultset.count | integer |
The count. |
|
Limit
|
metadata.resultset.limit | integer |
The limit. |
|
Results
|
results | array of object | |
|
Date
|
results.date | string |
The date. |
|
Datatype
|
results.datatype | string |
The datatype. |
|
Station
|
results.station | string |
The station. |
|
Attributes
|
results.attributes | string |
The attributes. |
|
Value
|
results.value | integer |
The value. |
Get data categories
Retrieve a list of data categories.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Dataset ID
|
datatsetid | string |
The dataset identifier. |
|
|
Location ID
|
locationid | string |
The ___location identifier. |
|
|
Station ID
|
stationid | string |
The station identifier. |
|
|
Start Date
|
startdate | string |
The start date. |
|
|
End Date
|
enddate | string |
The end date. |
|
|
Sort Field
|
sortfield | string |
The sort field. |
|
|
Sort Order
|
sortorder | string |
The sort order. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Offset
|
metadata.resultset.offset | integer |
The offset. |
|
Count
|
metadata.resultset.count | integer |
The count. |
|
Limit
|
metadata.resultset.limit | integer |
The limit. |
|
Results
|
results | array of object | |
|
Name
|
results.name | string |
The name. |
|
ID
|
results.id | string |
The identifier. |
Get data category
Retrieve a specific data category.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
name | string |
The name. |
|
ID
|
id | string |
The identifier. |
Get data type
Retrieve a specific data type.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Min Date
|
mindate | string |
The minimum date. |
|
Max Date
|
maxdate | string |
The maximum date. |
|
Data Coverage
|
datacoverage | integer |
The data coverage. |
|
ID
|
id | string |
The identifier. |
Get data types
Retrieve a list of data types.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Dataset ID
|
datatsetid | string |
The dataset identifier. |
|
|
Location ID
|
locationid | string |
The ___location identifier. |
|
|
Station ID
|
stationid | string |
The station identifier. |
|
|
Data Category ID
|
datacategoryid | string |
The data category identifier. |
|
|
Start Date
|
startdate | string |
The start date. |
|
|
End Date
|
enddate | string |
The end date. |
|
|
Sort Field
|
sortfield | string |
The sort field. |
|
|
Sort Order
|
sortorder | string |
The sort order. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Offset
|
metadata.resultset.offset | integer |
The offset. |
|
Count
|
metadata.resultset.count | integer |
The count. |
|
Limit
|
metadata.resultset.limit | integer |
The limit. |
|
Results
|
results | array of object | |
|
Min Date
|
results.mindate | string |
The minimum date. |
|
Max Date
|
results.maxdate | string |
The maximum date. |
|
Name
|
results.name | string |
The name. |
|
Data Coverage
|
results.datacoverage | integer |
The data coverage. |
|
ID
|
results.id | string |
The identifier. |
Get dataset
Retrieve the specific dataset.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Min Date
|
mindate | string |
The minimum date. |
|
Max Date
|
maxdate | string |
The maximum date. |
|
Name
|
name | string |
The name. |
|
Data Coverage
|
datacoverage | integer |
The data coverage. |
|
ID
|
id | string |
The identifier. |
Get datasets
Retrieve a list of available datasets.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data Type ID
|
datatypeid | string |
The data type identifier. |
|
|
Location ID
|
locationid | string |
The ___location identifier. |
|
|
Station ID
|
stationid | string |
The station identifier. |
|
|
Start Date
|
startdate | string |
The start date. |
|
|
End Date
|
enddate | string |
The end date. |
|
|
Sort Field
|
sortfield | string |
The sort field. |
|
|
Sort Order
|
sortorder | string |
The sort order. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Offset
|
metadata.resultset.offset | integer |
The offset. |
|
Count
|
metadata.resultset.count | integer |
The count. |
|
Limit
|
metadata.resultset.limit | integer |
The limit. |
|
Results
|
results | array of object | |
|
UID
|
results.uid | string |
The unique identifier. |
|
Min Date
|
results.mindate | string |
The minimum date. |
|
Max Date
|
results.maxdate | string |
The maximum date. |
|
Name
|
results.name | string |
The name. |
|
Data Coverage
|
results.datacoverage | integer |
The data coverage. |
|
ID
|
results.id | string |
The identifier. |
Get ___location
Retrieve a specific ___location.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Min Date
|
mindate | string |
The minimum date. |
|
Max Date
|
maxdate | string |
The maximum date. |
|
Name
|
name | string |
The name. |
|
Data Coverage
|
datacoverage | integer |
The data coverage. |
|
ID
|
id | string |
The identifier. |
Get ___location categories
Retrieve a list of ___location categories.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Dataset ID
|
datasetid | string |
The dataset identifier. |
|
|
Start Date
|
startdate | string |
The start date. |
|
|
End Date
|
enddate | string |
The end date. |
|
|
Sort Field
|
sortfield | string |
The sort field. |
|
|
Sort Order
|
sortorder | string |
The sort order. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Offset
|
metadata.resultset.offset | integer |
The offset. |
|
Count
|
metadata.resultset.count | integer |
The count. |
|
Limit
|
metadata.resultset.limit | integer |
The limit. |
|
Results
|
results | array of object | |
|
Name
|
results.name | string |
The name. |
|
ID
|
results.id | string |
The identifier. |
Get ___location category
Retrieve a specific ___location category.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
name | string |
The name. |
|
ID
|
id | string |
The identifier. |
Get locations
Retrieve a list of locations.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Data Type ID
|
datatypeid | string |
The data type identifier. |
|
|
Location Category ID
|
locationcategoryid | string |
The ___location category identifier. |
|
|
Data Category ID
|
datacategoryid | string |
The data category identifier. |
|
|
Start Date
|
startdate | string |
The start date. |
|
|
End Date
|
enddate | string |
The end date. |
|
|
Sort Field
|
sortfield | string |
The sort field. |
|
|
Sort Order
|
sortorder | string |
The sort order. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Offset
|
metadata.resultset.offset | integer |
The offset. |
|
Count
|
metadata.resultset.count | integer |
The count. |
|
Limit
|
metadata.resultset.limit | integer |
The limit. |
|
Results
|
results | array of object | |
|
Min Date
|
results.mindate | string |
The minimum date. |
|
Max Date
|
results.maxdate | string |
The maximum date. |
|
Name
|
results.name | string |
The name. |
|
Data Coverage
|
results.datacoverage | integer |
The data coverage. |
|
ID
|
results.id | string |
The identifier. |
Get station
Retrieve a specific station.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Elevation
|
elevation | float |
The elevation. |
|
Min Date
|
mindate | string |
The minimum date. |
|
Max Date
|
maxdate | string |
The maximum date. |
|
Latitude
|
latitude | float |
The latitude. |
|
Name
|
name | string |
The name. |
|
Data Coverage
|
datacoverage | integer |
The data coverage. |
|
ID
|
id | string |
The identifier. |
|
Elevation Unit
|
elevationUnit | string |
The elevation unit. |
|
Longitude
|
longitude | float |
The longitude. |
Get station metadata (HOMR)
Retrieve the historical metadata for a station from the Historical Observing Metadata Repository (HOMR).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Station ID
|
stationid | True | string |
The station identifier. |
|
Date
|
date | string |
The date. |
|
|
Begin Date
|
begindate | string |
The begin date. |
|
|
End Date
|
enddate | string |
The end date. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Definitions
|
stationCollection.definitions | array of object | |
|
Def Type
|
stationCollection.definitions.defType | string |
The definition type. |
|
Abbreviation
|
stationCollection.definitions.abbr | string |
The abbreviation. |
|
Full Name
|
stationCollection.definitions.fullName | string |
The full name. |
|
Display Name
|
stationCollection.definitions.displayName | string |
The display name. |
|
Description
|
stationCollection.definitions.description | string |
The description. |
|
CSSA Name
|
stationCollection.definitions.cssaName | string |
The CSSA name. |
|
GHCND Name
|
stationCollection.definitions.ghcndName | string |
The GHCND name. |
|
Stations
|
stationCollection.stations | array of object | |
|
NCDC Station ID
|
stationCollection.stations.ncdcStnId | string |
The NCDC Station ID. |
|
Preferred Name
|
stationCollection.stations.header.preferredName | string |
The preferred name. |
|
Latitude Decimal
|
stationCollection.stations.header.latitude_dec | string |
The latitude decimal. |
|
Longitude Decimal
|
stationCollection.stations.header.longitude_dec | string |
The longitude decimal. |
|
Precision
|
stationCollection.stations.header.precision | string |
The precision. |
|
Begin Date
|
stationCollection.stations.header.por.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.header.por.endDate | string |
The end date. |
|
Names
|
stationCollection.stations.names | array of object | |
|
Name
|
stationCollection.stations.names.name | string |
The name. |
|
Name Type
|
stationCollection.stations.names.nameType | string |
The name type. |
|
Begin Date
|
stationCollection.stations.names.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.names.date.endDate | string |
The end date. |
|
Identifiers
|
stationCollection.stations.identifiers | array of object | |
|
ID Type
|
stationCollection.stations.identifiers.idType | string |
The identifier type. |
|
ID
|
stationCollection.stations.identifiers.id | string |
The identifier. |
|
Begin Date
|
stationCollection.stations.identifiers.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.identifiers.date.endDate | string |
The end date. |
|
NCDC Stn ID
|
stationCollection.stations.___location.ncdcstnId | string |
The NCDC station identifier. |
|
Descriptions
|
stationCollection.stations.___location.descriptions | array of object | |
|
Description
|
stationCollection.stations.___location.descriptions.description | string |
The description. |
|
Begin Date
|
stationCollection.stations.___location.descriptions.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.descriptions.date.endDate | string |
The end date. |
|
Latitudes
|
stationCollection.stations.___location.latitudes | array of object | |
|
Latitude Dec
|
stationCollection.stations.___location.latitudes.latitude_dec | string |
The latitude decimal. |
|
Precision
|
stationCollection.stations.___location.latitudes.precision | string |
The precision. |
|
Begin Date
|
stationCollection.stations.___location.latitudes.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.latitudes.date.endDate | string |
The end date. |
|
Longitudes
|
stationCollection.stations.___location.longitudes | array of object | |
|
Longitude Dec
|
stationCollection.stations.___location.longitudes.longitude_dec | string |
The longitude decimal. |
|
Precision
|
stationCollection.stations.___location.longitudes.precision | string |
The precision. |
|
Begin Date
|
stationCollection.stations.___location.longitudes.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.longitudes.date.endDate | string |
The end date. |
|
Lat Lon Pairs
|
stationCollection.stations.___location.latLonPairs | array of object | |
|
Latitude RPTD
|
stationCollection.stations.___location.latLonPairs.latitude_rptd | string |
The latitude RPTC. |
|
Longitude RPTD
|
stationCollection.stations.___location.latLonPairs.longitude_rptd | string |
The longitude RPTC. |
|
Latitude Dec
|
stationCollection.stations.___location.latLonPairs.latitude_dec | string |
The latitude decimal. |
|
Longitude Dec
|
stationCollection.stations.___location.latLonPairs.longitude_dec | string |
The longitude decimal. |
|
Latitude DMS
|
stationCollection.stations.___location.latLonPairs.latitude_dms | string |
The latitude DMS. |
|
Longitude DMS
|
stationCollection.stations.___location.latLonPairs.longitude_dms | string |
The longitude DMS. |
|
Precision
|
stationCollection.stations.___location.latLonPairs.precision | string |
The precision. |
|
Datum Horizontal
|
stationCollection.stations.___location.latLonPairs.datum_horiz | string |
The datum horizontal. |
|
Source
|
stationCollection.stations.___location.latLonPairs.source | string |
The source. |
|
Begin Date
|
stationCollection.stations.___location.latLonPairs.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.latLonPairs.date.endDate | string |
The end date. |
|
Elevations
|
stationCollection.stations.___location.elevations | array of object | |
|
Elevation Type
|
stationCollection.stations.___location.elevations.elevationType | string |
The elevation type. |
|
Elevation Feet
|
stationCollection.stations.___location.elevations.elevationFeet | string |
The elevation feet. |
|
Elevation Meters
|
stationCollection.stations.___location.elevations.elevationMeters | string |
The elevation meters. |
|
Begin Date
|
stationCollection.stations.___location.elevations.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.elevations.date.endDate | string |
The end date. |
|
Ground Elev Datum
|
stationCollection.stations.___location.elevations.groundElevDatum | string |
The ground elevation datum. |
|
Topography
|
stationCollection.stations.___location.topography | array of object | |
|
Description
|
stationCollection.stations.___location.topography.description | string |
The description. |
|
Begin Date
|
stationCollection.stations.___location.topography.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.topography.date.endDate | string |
The end date. |
|
Obstructions
|
stationCollection.stations.___location.obstructions | array of object | |
|
Description
|
stationCollection.stations.___location.obstructions.description | string |
The description. |
|
Begin Date
|
stationCollection.stations.___location.obstructions.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.obstructions.date.endDate | string |
The end date. |
|
NCDC Station ID
|
stationCollection.stations.___location.geoInfo.ncdcstnId | string |
The NCDC station identifier. |
|
Countries
|
stationCollection.stations.___location.geoInfo.countries | array of object | |
|
Country
|
stationCollection.stations.___location.geoInfo.countries.country | string |
The country. |
|
Begin Date
|
stationCollection.stations.___location.geoInfo.countries.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.geoInfo.countries.date.endDate | string |
The end date. |
|
State Provinces
|
stationCollection.stations.___location.geoInfo.stateProvinces | array of object | |
|
State/Province
|
stationCollection.stations.___location.geoInfo.stateProvinces.stateProvince | string |
The state or province. |
|
Begin Date
|
stationCollection.stations.___location.geoInfo.stateProvinces.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.geoInfo.stateProvinces.date.endDate | string |
The end date. |
|
Counties
|
stationCollection.stations.___location.geoInfo.counties | array of object | |
|
County
|
stationCollection.stations.___location.geoInfo.counties.county | string |
The county. |
|
Begin Date
|
stationCollection.stations.___location.geoInfo.counties.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.geoInfo.counties.date.endDate | string |
The end date. |
|
UTC Offsets
|
stationCollection.stations.___location.geoInfo.utcOffsets | array of object | |
|
UTC Offset
|
stationCollection.stations.___location.geoInfo.utcOffsets.utcOffset | string |
The UTC offset. |
|
Begin Date
|
stationCollection.stations.___location.geoInfo.utcOffsets.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.geoInfo.utcOffsets.date.endDate | string |
The end date. |
|
NCDC Station ID
|
stationCollection.stations.___location.nwsInfo.ncdcstnId | string |
The NCDC station identifier. |
|
Climate Divisions
|
stationCollection.stations.___location.nwsInfo.climateDivisions | array of object | |
|
State/Province
|
stationCollection.stations.___location.nwsInfo.climateDivisions.stateProvince | string |
The state or province. |
|
Climate Division
|
stationCollection.stations.___location.nwsInfo.climateDivisions.climateDivision | string |
The climate division. |
|
Display Name
|
stationCollection.stations.___location.nwsInfo.climateDivisions.displayName | string |
The display name. |
|
Begin Date
|
stationCollection.stations.___location.nwsInfo.climateDivisions.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.nwsInfo.climateDivisions.date.endDate | string |
The end date. |
|
NWS Regions
|
stationCollection.stations.___location.nwsInfo.nwsRegions | array of object | |
|
NWS Region
|
stationCollection.stations.___location.nwsInfo.nwsRegions.nwsRegion | string |
The NWS region. |
|
Begin Date
|
stationCollection.stations.___location.nwsInfo.nwsRegions.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.nwsInfo.nwsRegions.date.endDate | string |
The end date. |
|
NWS WFOs
|
stationCollection.stations.___location.nwsInfo.nwsWfos | array of object | |
|
NWS WFO
|
stationCollection.stations.___location.nwsInfo.nwsWfos.nwsWfo | string |
The NWS WFO. |
|
Begin Date
|
stationCollection.stations.___location.nwsInfo.nwsWfos.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.___location.nwsInfo.nwsWfos.date.endDate | string |
The end date. |
|
Display Name
|
stationCollection.stations.___location.nwsInfo.nwsWfos.displayName | string |
The display name. |
|
Platforms
|
stationCollection.stations.platforms | array of object | |
|
Platform
|
stationCollection.stations.platforms.platform | string |
The platform. |
|
Begin Date
|
stationCollection.stations.platforms.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.platforms.date.endDate | string |
The end date. |
|
Relocations
|
stationCollection.stations.relocations | array of object | |
|
Relocation
|
stationCollection.stations.relocations.relocation | string |
The relocation. |
|
Date
|
stationCollection.stations.relocations.date | string |
The date. |
|
Remarks
|
stationCollection.stations.remarks | array of object | |
|
Type
|
stationCollection.stations.remarks.type | string |
The type. |
|
Remark
|
stationCollection.stations.remarks.remark | string |
The remark. |
|
Begin Date
|
stationCollection.stations.remarks.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.remarks.date.endDate | string |
The end date. |
|
Updates
|
stationCollection.stations.updates | array of object | |
|
Effective Date
|
stationCollection.stations.updates.effectiveDate | string |
The effective date. |
|
Provided By
|
stationCollection.stations.updates.providedBy | string |
The provided by. |
|
Update Source
|
stationCollection.stations.updates.updateSource | string |
The update source. |
|
Version
|
stationCollection.stations.updates.version | string |
The version. |
|
Description
|
stationCollection.stations.updates.description | string |
The description. |
|
Entered By
|
stationCollection.stations.updates.enteredBy | string |
The entered by. |
|
Entered Date
|
stationCollection.stations.updates.enteredDate | string |
The entered date. |
|
Modified By
|
stationCollection.stations.updates.modifiedBy | string |
The modified by. |
|
Modified Date
|
stationCollection.stations.updates.modifiedDate | string |
The modified date. |
|
Native ID
|
stationCollection.stations.updates.nativeId | string |
The native identifier. |
|
Elements
|
stationCollection.stations.elements | array of object | |
|
Data Program
|
stationCollection.stations.elements.dataProgram | string |
The data program. |
|
Element
|
stationCollection.stations.elements.element | string |
The element. |
|
Frequency
|
stationCollection.stations.elements.frequency | string |
The frequency. |
|
Observation Time
|
stationCollection.stations.elements.observationTime | string |
The observation time. |
|
Published Flag
|
stationCollection.stations.elements.publishedFlag | string |
The published flag. |
|
Receiver
|
stationCollection.stations.elements.receiver | string |
The receiver. |
|
Reporting Method
|
stationCollection.stations.elements.reportingMethod | string |
The reporting method. |
|
Equipment
|
stationCollection.stations.elements.equipment.equipment | string |
The equipment. |
|
Equipment Mods
|
stationCollection.stations.elements.equipment.equipmentMods | string |
The equipment mods. |
|
Equipment Azimuth
|
stationCollection.stations.elements.equipment.equipmentAzimuth | string |
The equipment azimuth. |
|
Equipment Distance
|
stationCollection.stations.elements.equipment.equipmentDistance | string |
The equipment distance. |
|
Equipment Distance Units
|
stationCollection.stations.elements.equipment.equipmentDistanceUnits | string |
The equipment distance units. |
|
Begin Date
|
stationCollection.stations.elements.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.elements.date.endDate | string |
The end date. |
Get stations
Retrieves a list of stations.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Dataset ID
|
datasetid | string |
The dataset identifier. |
|
|
Location ID
|
locationid | string |
The ___location identifier. |
|
|
Data Category ID
|
datacategoryid | string |
The data category identifier. |
|
|
Data Type ID
|
datatypeid | string |
The data type identifier. |
|
|
Extent
|
extent | string |
The extent. |
|
|
Start Date
|
startdate | string |
The start date. |
|
|
End Date
|
enddate | string |
The end date. |
|
|
Sort Field
|
sortfield | string |
The sort field. |
|
|
Sort Order
|
sortorder | string |
The sort order. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Offset
|
metadata.resultset.offset | integer |
The offset. |
|
Count
|
metadata.resultset.count | integer |
The count. |
|
Limit
|
metadata.resultset.limit | integer |
The limit. |
|
Results
|
results | array of object | |
|
Elevation
|
results.elevation | float |
The elevation. |
|
Min Date
|
results.mindate | string |
The minimum date. |
|
Max Date
|
results.maxdate | string |
The maximum date. |
|
Latitude
|
results.latitude | float |
The latitude. |
|
Name
|
results.name | string |
The name. |
|
Data Coverage
|
results.datacoverage | integer |
The data coverage. |
|
ID
|
results.id | string |
The identifier. |
|
Elevation Unit
|
results.elevationUnit | string |
The elevation unit. |
|
Longitude
|
results.longitude | float |
The longitude. |
Search datasets
Retrieve the results of a dataset search.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Dataset
|
dataset | string |
The dataset. |
|
|
Start Date
|
startDate | string |
The start date. |
|
|
End Date
|
endDate | string |
The end date. |
|
|
Bounding Box
|
boundingBox | string |
The bounding box. |
|
|
Keywords
|
keywords | string |
The keywords. |
|
|
Text
|
text | string |
The text. |
|
|
Data Types
|
dataTypes | string |
The data types. |
|
|
Stations
|
stations | string |
The stations. |
|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The offset. |
|
|
Available
|
available | boolean |
Whether available. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Doc Count Error
|
dataTypes.docCountError | integer |
The document count error. |
|
Buckets
|
dataTypes.buckets | array of object | |
|
Doc Count
|
dataTypes.buckets.docCount | integer |
The document count. |
|
Key
|
dataTypes.buckets.key | string |
The key. |
|
Sum of Other Doc Counts
|
dataTypes.sumOfOtherDocCounts | integer |
The sum of other document counts. |
|
End Date
|
endDate | string |
The end date. |
|
Count
|
count | integer |
The count. |
|
Latitude
|
bounds.bottomRight.lat | integer |
The latitude. |
|
Longitude
|
bounds.bottomRight.lon | float |
The longitude. |
|
Geohash
|
bounds.bottomRight.geohash | string |
The geohash. |
|
Fragment
|
bounds.bottomRight.fragment | boolean |
Whether a fragment. |
|
Latitude
|
bounds.topLeft.lat | float |
The latitude. |
|
Longitude
|
bounds.topLeft.lon | float |
The longitude. |
|
Geohash
|
bounds.topLeft.geohash | string |
The geohash. |
|
Fragment
|
bounds.topLeft.fragment | boolean |
Whether a fragment. |
|
Total File Size
|
totalFileSize | integer |
The total file size. |
|
Doc Count Error
|
stations.docCountError | integer |
The document count error. |
|
Buckets
|
stations.buckets | array of object | |
|
Doc Count
|
stations.buckets.docCount | integer |
The document count. |
|
Key
|
stations.buckets.key | string |
The key. |
|
Sum of Other Doc Counts
|
stations.sumOfOtherDocCounts | integer |
The sum of other document counts. |
|
Total Count
|
totalCount | integer |
The total count. |
|
Results
|
results | array of object | |
|
Tar
|
results.tar | string |
The tar. |
|
End Date
|
results.endDate | string |
The end date. |
|
Bounding Points
|
results.boundingPoints | array of object | |
|
Point
|
results.boundingPoints.point | array of float |
The point. |
|
File Path
|
results.filePath | string |
The file path. |
|
Stations
|
results.stations | array of object | |
|
Data Types
|
results.stations.dataTypes | array of object | |
|
Coverage
|
results.stations.dataTypes.coverage | float |
The coverage. |
|
End Date
|
results.stations.dataTypes.endDate | string |
The end date. |
|
Start
|
results.stations.dataTypes.dateRange.start | string |
The start. |
|
End
|
results.stations.dataTypes.dateRange.end | string |
The end. |
|
Search Weight
|
results.stations.dataTypes.searchWeight | integer |
The search weight. |
|
ID
|
results.stations.dataTypes.id | string |
The identifier. |
|
Start Date
|
results.stations.dataTypes.startDate | string |
The start date. |
|
Name
|
results.stations.name | string |
The name. |
|
ID
|
results.stations.id | string |
The identifier. |
|
Data Types
|
results.dataTypes | array of object | |
|
Start
|
results.dataTypes.dateRange.start | string |
The start. |
|
End
|
results.dataTypes.dateRange.end | string |
The end. |
|
Search Weight
|
results.dataTypes.searchWeight | integer |
The search weight. |
|
Name
|
results.dataTypes.name | string |
The name. |
|
ID
|
results.dataTypes.id | string |
The identifier. |
|
File Size
|
results.fileSize | integer |
The file size. |
|
Point
|
results.centroid.point | array of float |
The point. |
|
Name
|
results.name | string |
The name. |
|
Coordinates
|
results.___location.coordinates | array of float |
The coordinates. |
|
Type
|
results.___location.type | string |
The type. |
|
ID
|
results.id | string |
The identifier. |
|
Data Types Count
|
results.dataTypesCount | integer |
The data types count. |
|
Start Date
|
results.startDate | string |
The start date. |
|
Start Date
|
startDate | string |
The start date. |
Search station metadata (HOMR)
Search for a station from the Historical Observing Metadata Repository (HOMR).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
QID
|
qid | string |
Any fully qualified ID such as COOP:046742. When used with qidMod, can contain partial station ID's. Either the network or ID number may be omitted. |
|
|
QID mod
|
qidMod | string |
Specifies how the ID portion of the qid parameter should be applied within the search. If a qid is passed but the qidMod parameter is not used, qidMod is assumed to be IS. |
|
|
State
|
state | string |
Two-letter code for US states, Canadian provinces, and other Island areas. |
|
|
County
|
county | string |
US county names, best used with a state identifier. |
|
|
Country
|
country | string |
A country name. |
|
|
Name
|
name | string |
Searches on any type of name we have for the station. |
|
|
Name Mod
|
nameMod | string |
Specifies how the name parameter should be applied within the search. If a name is passed but the name mod parameter is not used, name mod is assumed to be IS. |
|
|
Platform
|
platform | string |
Limit the search to stations of a certain platform/network type. |
|
|
Date
|
date | string |
Limits returned values to only those that occurred on a specific date. Alternatively, date=all will return all values for matched stations. If this field is omitted, the search will return only the most recent values for each field. This field affects only the returned values. Matching for other search parameters is still done across the entire station history, unless the current field is used. |
|
|
Begin Date
|
begindate | string |
The begin date. |
|
|
End Date
|
enddate | string |
The end date. |
|
|
Status
|
status | string |
Find stations that have ever been closed or inactivated. Open stations have no specific status designation. |
|
|
Current
|
current | boolean |
Find stations where the other search terms match the station's current values. Without this field, parameter matching is done over entire station histories. |
|
|
Headers Only
|
headersOnly | string |
Returns only minimal information for each station found (NCDC Station ID, Preferred Name, Station Begin Date, and Station End Date), but is much quicker than a full query. If you are performing a search that returns a large number of stations and intend to choose only one from that list to examine in detail, headersOnly may give you enough information to find the NCDC Station ID for the station that you actually want. |
|
|
PHR Data
|
phrData | boolean |
The HOMR web service now includes PHR (element-level) data when available, in an elements section. Because of how this data is structured, it can substantially increase the size of any result which includes it. If you don't need this data you can omit it by including phrData=false. If the parameter is not set, it will default to phrData=true. |
|
|
Definitions
|
definitions | boolean |
The HOMR web service includes a list of definitions with every result. These are meant to serve as a reference for some of the more cryptic variable values, and are identical for every request. You can omit these from your result by setting definitions=false. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Definitions
|
stationCollection.definitions | array of object | |
|
Def Type
|
stationCollection.definitions.defType | string |
The definition type. |
|
Abbreviation
|
stationCollection.definitions.abbr | string |
The abbreviation. |
|
Full Name
|
stationCollection.definitions.fullName | string |
The full name. |
|
Display Name
|
stationCollection.definitions.displayName | string |
The display name. |
|
Description
|
stationCollection.definitions.description | string |
The description. |
|
CSSA Name
|
stationCollection.definitions.cssaName | string |
The CSSA name. |
|
GHCND Name
|
stationCollection.definitions.ghcndName | string |
The GHCND name. |
|
Stations
|
stationCollection.stations | array of object | |
|
NCDC Station ID
|
stationCollection.stations.ncdcStnId | string |
The NCDC Station ID. |
|
Preferred Name
|
stationCollection.stations.header.preferredName | string |
The preferred name. |
|
Latitude Decimal
|
stationCollection.stations.header.latitude_dec | string |
The latitude decimal. |
|
Longitude Decimal
|
stationCollection.stations.header.longitude_dec | string |
The longitude decimal. |
|
Precision
|
stationCollection.stations.header.precision | string |
The precision. |
|
Begin Date
|
stationCollection.stations.header.por.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.header.por.endDate | string |
The end date. |
|
Names
|
stationCollection.stations.names | array of object | |
|
Name
|
stationCollection.stations.names.name | string |
The name. |
|
Name Type
|
stationCollection.stations.names.nameType | string |
The name type. |
|
Identifiers
|
stationCollection.stations.identifiers | array of object | |
|
ID Type
|
stationCollection.stations.identifiers.idType | string |
The identifier type. |
|
ID
|
stationCollection.stations.identifiers.id | string |
The identifier. |
|
NCDC Stn ID
|
stationCollection.stations.___location.ncdcstnId | string |
The NCDC station identifier. |
|
Descriptions
|
stationCollection.stations.___location.descriptions | array of object | |
|
Description
|
stationCollection.stations.___location.descriptions.description | string |
The description. |
|
Latitudes
|
stationCollection.stations.___location.latitudes | array of object | |
|
Latitude Dec
|
stationCollection.stations.___location.latitudes.latitude_dec | string |
The latitude decimal. |
|
Precision
|
stationCollection.stations.___location.latitudes.precision | string |
The precision. |
|
Longitudes
|
stationCollection.stations.___location.longitudes | array of object | |
|
Longitude Dec
|
stationCollection.stations.___location.longitudes.longitude_dec | string |
The longitude decimal. |
|
Precision
|
stationCollection.stations.___location.longitudes.precision | string |
The precision. |
|
Lat Lon Pairs
|
stationCollection.stations.___location.latLonPairs | array of object | |
|
Latitude RPTD
|
stationCollection.stations.___location.latLonPairs.latitude_rptd | string |
The latitude RPTC. |
|
Longitude RPTD
|
stationCollection.stations.___location.latLonPairs.longitude_rptd | string |
The longitude RPTC. |
|
Latitude Dec
|
stationCollection.stations.___location.latLonPairs.latitude_dec | string |
The latitude decimal. |
|
Longitude Dec
|
stationCollection.stations.___location.latLonPairs.longitude_dec | string |
The longitude decimal. |
|
Latitude DMS
|
stationCollection.stations.___location.latLonPairs.latitude_dms | string |
The latitude DMS. |
|
Longitude DMS
|
stationCollection.stations.___location.latLonPairs.longitude_dms | string |
The longitude DMS. |
|
Precision
|
stationCollection.stations.___location.latLonPairs.precision | string |
The precision. |
|
Datum Horizontal
|
stationCollection.stations.___location.latLonPairs.datum_horiz | string |
The datum horizontal. |
|
Source
|
stationCollection.stations.___location.latLonPairs.source | string |
The source. |
|
Elevations
|
stationCollection.stations.___location.elevations | array of object | |
|
Elevation Type
|
stationCollection.stations.___location.elevations.elevationType | string |
The elevation type. |
|
Elevation Feet
|
stationCollection.stations.___location.elevations.elevationFeet | string |
The elevation feet. |
|
Elevation Meters
|
stationCollection.stations.___location.elevations.elevationMeters | string |
The elevation meters. |
|
Topography
|
stationCollection.stations.___location.topography | array of object | |
|
Description
|
stationCollection.stations.___location.topography.description | string |
The description. |
|
Obstructions
|
stationCollection.stations.___location.obstructions | array of object | |
|
Description
|
stationCollection.stations.___location.obstructions.description | string |
The description. |
|
NCDC Station ID
|
stationCollection.stations.___location.geoInfo.ncdcstnId | string |
The NCDC station identifier. |
|
Countries
|
stationCollection.stations.___location.geoInfo.countries | array of object | |
|
Country
|
stationCollection.stations.___location.geoInfo.countries.country | string |
The country. |
|
State Provinces
|
stationCollection.stations.___location.geoInfo.stateProvinces | array of object | |
|
State/Province
|
stationCollection.stations.___location.geoInfo.stateProvinces.stateProvince | string |
The state or province. |
|
Counties
|
stationCollection.stations.___location.geoInfo.counties | array of object | |
|
County
|
stationCollection.stations.___location.geoInfo.counties.county | string |
The county. |
|
UTC Offsets
|
stationCollection.stations.___location.geoInfo.utcOffsets | array of object | |
|
UTC Offset
|
stationCollection.stations.___location.geoInfo.utcOffsets.utcOffset | string |
The UTC offset. |
|
NCDC Station ID
|
stationCollection.stations.___location.nwsInfo.ncdcstnId | string |
The NCDC station identifier. |
|
Climate Divisions
|
stationCollection.stations.___location.nwsInfo.climateDivisions | array of object | |
|
State/Province
|
stationCollection.stations.___location.nwsInfo.climateDivisions.stateProvince | string |
The state or province. |
|
Climate Division
|
stationCollection.stations.___location.nwsInfo.climateDivisions.climateDivision | string |
The climate division. |
|
Display Name
|
stationCollection.stations.___location.nwsInfo.climateDivisions.displayName | string |
The display name. |
|
NWS Regions
|
stationCollection.stations.___location.nwsInfo.nwsRegions | array of object | |
|
NWS Region
|
stationCollection.stations.___location.nwsInfo.nwsRegions.nwsRegion | string |
The NWS region. |
|
NWS Wfos
|
stationCollection.stations.___location.nwsInfo.nwsWfos | array of object | |
|
NWS WFO
|
stationCollection.stations.___location.nwsInfo.nwsWfos.nwsWfo | string |
The NWS WFO. |
|
Display Name
|
stationCollection.stations.___location.nwsInfo.nwsWfos.displayName | string |
The display name. |
|
Platforms
|
stationCollection.stations.platforms | array of object | |
|
Platform
|
stationCollection.stations.platforms.platform | string |
The platform. |
|
Relocations
|
stationCollection.stations.relocations | array of object | |
|
Relocation
|
stationCollection.stations.relocations.relocation | string |
The relocation. |
|
Date
|
stationCollection.stations.relocations.date | string |
The date. |
|
Remarks
|
stationCollection.stations.remarks | array of object | |
|
Type
|
stationCollection.stations.remarks.type | string |
The type. |
|
Remark
|
stationCollection.stations.remarks.remark | string |
The remark. |
|
Updates
|
stationCollection.stations.updates | array of object | |
|
Effective Date
|
stationCollection.stations.updates.effectiveDate | string |
The effective date. |
|
Provided By
|
stationCollection.stations.updates.providedBy | string |
The provided by. |
|
Update Source
|
stationCollection.stations.updates.updateSource | string |
The update source. |
|
Version
|
stationCollection.stations.updates.version | string |
The version. |
|
Description
|
stationCollection.stations.updates.description | string |
The description. |
|
Entered By
|
stationCollection.stations.updates.enteredBy | string |
The entered by. |
|
Entered Date
|
stationCollection.stations.updates.enteredDate | string |
The entered date. |
|
Modified By
|
stationCollection.stations.updates.modifiedBy | string |
The modified by. |
|
Modified Date
|
stationCollection.stations.updates.modifiedDate | string |
The modified date. |
|
Elements
|
stationCollection.stations.elements | array of object | |
|
Data Program
|
stationCollection.stations.elements.dataProgram | string |
The data program. |
|
Element
|
stationCollection.stations.elements.element | string |
The element. |
|
Frequency
|
stationCollection.stations.elements.frequency | string |
The frequency. |
|
Observation Time
|
stationCollection.stations.elements.observationTime | string |
The observation time. |
|
Published Flag
|
stationCollection.stations.elements.publishedFlag | string |
The published flag. |
|
Receiver
|
stationCollection.stations.elements.receiver | string |
The receiver. |
|
Reporting Method
|
stationCollection.stations.elements.reportingMethod | string |
The reporting method. |
|
Equipment
|
stationCollection.stations.elements.equipment.equipment | string |
The equipment. |
|
Equipment Mods
|
stationCollection.stations.elements.equipment.equipmentMods | string |
The equipment mods. |
|
Equipment Azimuth
|
stationCollection.stations.elements.equipment.equipmentAzimuth | string |
The equipment azimuth. |
|
Equipment Distance
|
stationCollection.stations.elements.equipment.equipmentDistance | string |
The equipment distance. |
|
Equipment Distance Units
|
stationCollection.stations.elements.equipment.equipmentDistanceUnits | string |
The equipment distance units. |
|
Begin Date
|
stationCollection.stations.elements.date.beginDate | string |
The begin date. |
|
End Date
|
stationCollection.stations.elements.date.endDate | string |
The end date. |