/ncei-api-guide

A guide to the NCEIs suite of climate data APIs

Primary LanguageJupyter NotebookCreative Commons Zero v1.0 UniversalCC0-1.0

NCEI API Guide

This guide is an attempt to demystify the suite of APIs provided by the National Oceanic and Atmospheric Administration's (NOAA's) National Centers for Environmental Information (NCEI), which are rather sparsely documented.

As of 2019-11-08, there are at least 5 APIs offered by the NCEI, four within the 'NCEI Suite' and one inherited from the NCDC when they were gobbled up by the NCEI.

API Name Listed on https://www.ncdc.noaa.gov/cdo-web/webservices Listed on https://www.ncdc.noaa.gov/data-access
Data Service API Yes Yes
Search Service API Yes Yes
Order Service API No Yes
Support Service API No Yes
Climate Data Online (API v2) Yes No

Use this API to get weather data.

Endpoint

GET https://www.ncei.noaa.gov/access/services/data/v1?{paramKey1}={val1}&{paramKey2}={val2}

Parameters

Parameter Key Possible Values Our Description NCEI Description
dataset daily-summaries, global-marine, global-summary-of-the-year The dataset parameter selects the dataset to query for data. Please note that all the datasets are NOT available through the NCEI Access Data Service API, however new datasets are added quarterly.
stations USC00457180, USC00390043, AUCE, ASN00084027 The stations parameter adds a comma separated list of station identifiers for selection and subsetting.
startDate 1776-07-04, 1941-12-07, 2001-11-02T12:45:00Z, 2001-11-02T12:45:00z, 2001-11-02T08:45:00+04:00 This is the date to select from the dataset for a given start date. This parameter is an ISO 8601 date (YYYY-MM-DD) -or- ISO 8601 combined date and time format (YYYY-MM-DDTHH:mm:ss). If using an ISO 8601 combined date and time format the T that separates the time is NOT optional. The ISO 8601 combined date and time also supports optional time zone representations. Use Z or z for UTC and +HH:mm or -HH:mm for the offset from UTC. The plus symbol (+) must be URL encoded at “%2B” or it will not validate. The start and end dates are not required. The startDate must come before the endDate parameter. Some datasets are averages over time and may ignore parts of a date.
endDate 1776-07-04, 1941-12-07, 2001-11-02T12:45:00Z, 2001-11-02T12:45:00z, 2001-11-02T08:45:00+04:00 This is the date to select datasets whose period of record (PoR) starts on or after the given endDate. This parameter is an ISO 8601 date (YYYY-MM-DD) -or- ISO 8601 combined date and time format (YYYY-MM-DDTHH:mm:ss). If using an ISO 8601 combined date and time format, the T that separates the time is NOT optional. The ISO 8601 combined date and time also supports optional time zone representations. Use Z or z for UTC and +HH:mm or -HH:mm for the offset from UTC. The plus symbol (+) must be URL encoded as “%2B” or it will not validate. If the start date is required for the dataset then you must include the startDate parameter.
dataTypes ACCESS_STATUS_IND_ERR, ACCESS_STATUS_IND_IVAD, ADAPTIVE_QC_FLAGS, AF-TRIM_FLAG, AH-HI_CLD_AMT_ECR, AIR_TEMP, AM-MID_CLD_AMT_ECR, AMT_PRECIP, AMT_PRES_TEND, ANC-NCDC_QC_FLAGS, AQA-ADAPTIVE_QC_FLAGS, AQZ-ADAPTIVE_QC_FLAGS, ATTI-ATTM_IND5, ATTI-ATTM_IND6, ATTL-ATTM_LEN5, ATTL-ATTM_LEN6, ATTM_CT, ATTM_ENC, ATTM_ID, ATTM_ID2, ATTM_ID3, ATTM_IND10, ATTM_IND4, ATTM_IND7, ATTM_IND8, ATTM_IND9, ATTM_LEN, ATTM_LEN10, ATTM_LEN2, ATTM_LEN3, ATTM_LEN4, ATTM_LEN7, ATTM_LEN8, ATTM_LEN9, AUTH_REF_CODE_ERR, AUTH_REF_CODE_IVAD, AWSI-AWS_IND, BD, BFL, BH, BM, BMP, BNC-NCDC_QC_FLAGS, BOX_SY_IND, BSAT, BSRH, BSST, BSWU, BSWV, BUID, BY1, C1M-RECRUIT_COUNTRY, CCCC, CCE-CHANGE_CODE, CHAR_PPP, CHE-HI_CLD_TYPE_ECR, CLD_HGT, CLE-LOW_CLD_TYPE_ECR, CME-MID_CLD_TYPE_ECR, CNC-NCDC_QC_FLAGS, CONCEN_OF_SEA_ICE, COR-COUNTRY_OF_REGISTER, CORR_ERROR_FLAG, CORR_ERROR_VALUE, COUNTRY_CODE, COURSE_OVER_GROUND, CO_CODE_II, CREATE_DAY_NUM_ERR, CREATE_DAY_NUM_IVAD, DECK, DEP_LOAD_IN, DEW_PT_TEMP, DIR_OF_SWELL2, DNC-NCDC_QC_FLAGS, DOS-SST_DEPTH, DPT_IND, DQA-ADAPTIVE_QC_FLAGS, DQZ-ADAPTIVE_QC_FLAGS, DUP_CHK, DUP_STATUS, DUR_OF_PER, ENC-NCDC_QC_FLAGS, EOH-HYGRO_EXPOSURE, EOT-THERM_EXPOSURE, EXTERNAL, FBSRC, FIELD_NUM, FIELD_NUM_ERR, FM_CODE_VER, FNC-NCDC_QC_FLAGS, GNC-NCDC_QC_FLAGS, HE-LOW_CLD_HGT_ECR, HGT_IND, HGT_OF_SWELL2, HI_CLD_TYPE, HOA-HGT_ANEMOMETER, HOB-HGT_BAR, HOP-HGT_VISUAL_OBS_PLATFORM, HOT-HGT_AT_SENSOR, ICE_ACCR_ON_SHIP, ICE_OF_LAND_ORIGIN, ICE_SIT_TREND, ID_IND, IMMA_VER, IMMT_VER, IMONO-IMO_NUM, IND_FOR_PRECIP, IND_FOR_TEMP, IND_FOR_WAVE_MEAS, IND_FOR_WBT, INPUT_COMP_NUM, INPUT_COMP_NUM_ERR, INTERMEDIATE_REJECT_FLAG, KOV-KIND_OF_VESSEL, LANDLOCKED_FLAG, LL_IND, LOT-SCREEN_LOCATION, LOV-VESSEL_LENGTH, LOW_CLD_AMT, LOW_CLD_TYPE, MAX_HT_SUM_LOAD, META_SRC, MID_CLD_TYPE, MQCS_VER, MSH, MST, NATIONAL_USE, NAT_SOURCE_IND, NCDC_QC_FLAGS, NE-TTL_CLD_AMT_ECR, NHE-LOW_CLD_AMT_ECR, NIGHT_DAY_FLAG, NOL_HIGH_AMT_ECR, NOL_MID_AMT_ECR, OAV-ALKALINITY, OAZ-ALKALINITY_DEPTH, OB_PLATFORM, OB_SOURCE, OCV-TTL_CHLORO, OCZ-TTL_CHLORO_DEPTH, ODV-DIS_ORG_CARBON, ODZ-DIS_ORG_CARBON_DEPTH, ONE_BOX_NUM, ONV-NITRATE, ONZ-NITRATE_DEPTH, OOV-DIS_OXYGEN, OOZ-DIS_OXYGEN_DEPTH, OPCV-PP_CO2, OPCZ-PP_CO2_DEPTH, OPHV-PH, OPHZ-PH_DEPTH, OPM-SHIP_TYPE, OPV-PHOSPHATE, OPZ-PHOSPHATE_DEPTH, OSIV-SILICATE, OSIZ-SILICATE_DEPTH, OSV-SALINITY, OSZ-SALINITY_DEPTH, OTV-SST2, OTZ-SST_DEPTH2, PAST_WX, PAST_WX2, PER_OF_SWELL2, PF-TRIM_FLAG, PLATFORM_ID, PNC-NCDC_QC_FLAGS, PQA-ADAPTIVE_QC_FLAGS, PQZ-ADAPTIVE_QC_FLAGS, PRESS_BIAS, PRES_WX, PUID-PROVIDER_UID, QC_IND, QC_IND_FOR_FIELDS, QI1-QC_IND_FOR_FIELDS, QI10-QC_IND_FOR_FIELDS, QI11-QC_IND_FOR_FIELDS, QI12-QC_IND_FOR_FIELDS, QI13-QC_IND_FOR_FIELDS, QI14-QC_IND_FOR_FIELDS, QI15-QC_IND_FOR_FIELDS, QI16-QC_IND_FOR_FIELDS, QI17-QC_IND_FOR_FIELDS, QI18-QC_IND_FOR_FIELDS, QI19-QC_IND_FOR_FIELDS, QI2-QC_IND_FOR_FIELDS, QI20-QC_IND_FOR_FIELDS, QI22-IMMT_QC_SHIP_HEADING, QI23-IMMT_QC_COURSE_OVER_GROUND, QI24-IMMT_QC_SHIP_SPEED_OVER_GROUND, QI25-IMMT_QC_MAX_HT_SUM_LOAD, QI27-IMMT_QC_DEP_SUM_LOAD, QI28-IMMT_QC_REL_WIND_DIR, QI29-IMMT_QC_REL_WIND_SPEED, QI3-QC_IND_FOR_FIELDS, QI4-QC_IND_FOR_FIELDS, QI5-QC_IND_FOR_FIELDS, QI6-QC_IND_FOR_FIELDS, QI7-QC_IND_FOR_FIELDS, QI8-QC_IND_FOR_FIELDS, QI9-QC_IND_FOR_FIELDS, RATE_OF_I, RELEASE_NUM_PRIMARY, RELEASE_NUM_SECONDARY, RELEASE_NUM_TERTIARY, RELEASE_STATUS_IND, REL_LUNAR_ILLUM, REL_WIND_DIR, REL_WIND_SPD, RF-TRIM_FLAG, RH, RH_IND, SEA_LVL_PRES, SEA_SURF_TEMP, SF-TRIM_FLAG, SHIP_COURSE, SHIP_HEADING, SHIP_ID, SHIP_SPD, SIG_CLOUD_AMT, SIG_CLOUD_HGT, SIG_CLOUD_TYPE, SIM-SST_METHOD, SKY_BRIGHT_IND, SME-SRC_META_ELEMENT, SMF-SRC_META_FILE, SMV-SRC_FORMAT_VER, SNC-NCDC_QC_FLAGS, SOLAR_ALT, SOURCE_EXCLUSION_FLAG, SOURCE_ID, SPD_OVER_GROUND, SQA-ADAPTIVE_QC_FLAGS, SQZ-ADAPTIVE_QC_FLAGS, SRH, SST_MM, STAGE_OF_DEVELP, STA_WX_IND, SUPPLEMENTAL_DATA, SWELL_DIR, SWELL_HGT, SWELL_PERIOD, SWELL_PERIOD_IND, SWU, SWV, TEN_BOX_NUM, THICKNESS_OF_I, TIME_IND, TNC-NCDC_QC_FLAGS, TOB-BAR_TYPE, TOH-HYGRO_TYPE, TOT-THERM_TYPE, TOT_CLD_AMT, TRACK_CHK, TRIM_FLAG, TRUE_BEARING_ICE_EDGE, TYPE_IND_VAU1, TYPE_IND_VAU2, TYPE_IND_VAU3, UF-TRIM_FLAG, UNCERT_TYPE_IVAU1, UNCERT_TYPE_IVAU2, UNCERT_TYPE_IVAU3, UNIQUE_ID, UQA-ADAPTIVE_QC_FLAGS, UQZ-ADAPTIVE_QC_FLAGS, VAD_QC, VAD_SCALE_FACTOR, VALUE_ADDED, VAU1_SCALE_FACTOR, VAU2_SCALE_FACTOR, VAU3_SCALE_FACTOR, VF-TRIM_FLAG, VISIBILITY, VQA-ADAPTIVE_QC_FLAGS, VQZ-ADAPTIVE_QC_FLAGS, VV_IND, WAVE_DIR, WAVE_HGT, WAVE_PERIOD, WAVE_PERIOD_IND, WET_BULB_TEMP, WIND_DIR, WIND_DIR_IND, WIND_SPD, WIND_SPD_IND, WIND_SPEED, WNC-NCDC_QC_FLAGS, WWE-PRES_WX_ECR, XNC-NCDC_QC_FLAGS, YNC-NCDC_QC_FLAGS, ZNC-NCDC_QC_FLAGS, alt, lat, lon, station_info, station_name, time Data Types allows the selection of one or many dataTypes. Datasets have different names for the data types (e.g., variables, observations). The dataTypes parameter is used with a comma-separated list. This parameter is case-sensitive and will respond with an HTTPS Status Code: 400 Bad Request and JSON with more information.
boundingBox 49.795,-2.073,49.183,-0.992 The bounding box is used to select data from a geographic location contained within the coordinates, given as four comma separated numbers. North and South range from -90 to 90 and East and West range from -180 to 180. If these are not set the geographic extent defaults to the entire globe (90,-180,-90,180).
format csv, ssv, json, pdf, netcdf (probably exhaustive) The format parameter allows the user to select how the data should be formatted. Note that some data formats ignore certain data types. For example, PDF data may only display data types for a report, and not for the requested dataTypes.
options includeAttributes:true,includeStationName:1 The API supports an options parameter that turns features on and off. Options are separated by commas and the respective values are separated by a colon (:); boolean values are represented by true or false,or zero (0) and one (1). Options can either pass as a comma-separated list: …&options=includeAttributes:true,includeStationName:1 or individually as URL parameters: ...&includeAttributes=0&includeStationName=true
includeAttributes true, false Includes the attribute for a selected datatype. These are typically comma separated (e.g., “T,,0,0700”), and added to the results if the includeAttributes parameter is set to true. This value can be the word true or a numeric representation of the boolean value, 1. The default value is false or 0 and will not display datatype(s) attributes.
includeStationName true, false Includes the station’s name, if available, for the selected dataset and data type. This value can be the word true or a numeric representation of the boolean value, 1. The default value is false or 0 and will not display datatype(s) attributes.
includeStationLocation 1, 0, true, false Includes the station’s location, if available, for the selected dataset and data type. This value can be the word true or a numeric representation of the boolean value, 1. The default value is false or 0 and will not display datatype(s) attributes.
units metric, standard The units parameter converts the output data for datasets and datatypes that support conversion to either “metric” or “standard” units.

Detailed Value Descriptions

dataTypes

Value NCEI Description
ACCESS_STATUS_IND_ERR Access Status Indicator - Error
ACCESS_STATUS_IND_IVAD Access Status Indicator
ADAPTIVE_QC_FLAGS ADAPTIVE_QC_FLAGS
AF-TRIM_FLAG Trimming Flag - Air Temperature
AH-HI_CLD_AMT_ECR Extended Cloud Reconstructions High Cloud Amount
AIR_TEMP Air Temperature
AM-MID_CLD_AMT_ECR Extended Cloud Reconstructions Middle Cloud Amount
AMT_PRECIP Precipitation Amount
AMT_PRES_TEND Pressure Tendency
ANC-NCDC_QC_FLAGS NCDC QC Flags - Air Temp
AQA-ADAPTIVE_QC_FLAGS Adaptive QC Flag - Air Temperature
AQZ-ADAPTIVE_QC_FLAGS Adaptive QC Flag - Air Temperature
ATTI-ATTM_IND5 Attachment Indicator 5
ATTI-ATTM_IND6 Attachment Indicator 6
ATTL-ATTM_LEN5 Attachment Length 5
ATTL-ATTM_LEN6 Attachment Length 6
ATTM_CT Attachment Count
ATTM_ENC Attachment Encoding
ATTM_ID Attachment Indicator
ATTM_ID2 Attachment Indicator 2
ATTM_ID3 Attachment Indicator 3
ATTM_IND10 Attachment Indicator 10
ATTM_IND4 Attachment Indicator 4
ATTM_IND7 Attachment Indicator 7
ATTM_IND8 Attachment Indicator 8
ATTM_IND9 Attachment Indicator 9
ATTM_LEN Attachment Length
ATTM_LEN10 Attachment Length 10
ATTM_LEN2 Attachment Length 2
ATTM_LEN3 Attachment Length 3
ATTM_LEN4 Attachment Length 4
ATTM_LEN7 Attachment Length 7
ATTM_LEN8 Attachment Length 8
ATTM_LEN9 Attachment Length 9
AUTH_REF_CODE_ERR Author Reference Code - Error
AUTH_REF_CODE_IVAD Author Reference Code
AWSI-AWS_IND Automatic Weather Station Indicator
BD Background Day
BFL Time Period Displacement
BH Background Hour
BM Background Month
BMP Background Sea Level Pressure
BNC-NCDC_QC_FLAGS NCDC QC Flags - Visibility
BOX_SY_IND Box System Indicator
BSAT Background Air Temperature
BSRH Background Relative Humidity
BSST Background SST
BSWU Background Wind U Component
BSWV Background Wind V Component
BUID Bulletin ID
BY1 Background Year
C1M-RECRUIT_COUNTRY Recruiting Country
CCCC Collecting Center
CCE-CHANGE_CODE Change Code
CHAR_PPP Characteristics of Pressure Tendency
CHE-HI_CLD_TYPE_ECR Extended Cloud Reconstructions High Cloud Type
CLD_HGT Cloud Height
CLE-LOW_CLD_TYPE_ECR Extended Cloud Reconstructions Low Cloud Type
CME-MID_CLD_TYPE_ECR Extended Cloud Reconstructions Middle Cloud Type
CNC-NCDC_QC_FLAGS NCDC QC Flags - Clouds
CONCEN_OF_SEA_ICE Concentration of Sea Ice
COR-COUNTRY_OF_REGISTER Country of Register
CORR_ERROR_FLAG Corrected/Erroneous Field Flag
CORR_ERROR_VALUE Corrected/Erroneous Field Value
COUNTRY_CODE Country Code
COURSE_OVER_GROUND Ship's Course Over Ground
CO_CODE_II Country Code 2
CREATE_DAY_NUM_ERR Creation Day Number - Error
CREATE_DAY_NUM_IVAD Creation Day Number
DECK Deck
DEP_LOAD_IN Departure from Maximum Height of Cargo Above Max Summer Load Line
DEW_PT_TEMP Dew Point Temperature
DIR_OF_SWELL2 Swell Direction 2
DNC-NCDC_QC_FLAGS NCDC QC Flags - Dew Point
DOS-SST_DEPTH SST Depth
DPT_IND Dew Point Temperature Indicator
DQA-ADAPTIVE_QC_FLAGS Adaptive QC Flag - Dew Point Temperature
DQZ-ADAPTIVE_QC_FLAGS Adaptive QC Flag - Dew Point Temperature
DUP_CHK Duplicate Check
DUP_STATUS Duplicate Status
DUR_OF_PER Duration of Precipitation
ENC-NCDC_QC_FLAGS NCDC QC Flags - Wind Waves
EOH-HYGRO_EXPOSURE Hygrometer Exposure
EOT-THERM_EXPOSURE Thermometer Exposure
EXTERNAL Externally Provided QC Flags
FBSRC Feedback Source
FIELD_NUM Field Number
FIELD_NUM_ERR Field Number - Error
FM_CODE_VER FM SHIP Code Version
FNC-NCDC_QC_FLAGS NCDC QC Flags - Swells
GNC-NCDC_QC_FLAGS NCDC QC Flags - Wet Bulb
HE-LOW_CLD_HGT_ECR Extended Cloud Reconstructions Low Cloud Height
HGT_IND Cloud Height Indicator
HGT_OF_SWELL2 Swell Height 2
HI_CLD_TYPE High Cloud Type
HOA-HGT_ANEMOMETER Height of Anemometer
HOB-HGT_BAR Height of Barometer
HOP-HGT_VISUAL_OBS_PLATFORM Height of Visual Observation Platform
HOT-HGT_AT_SENSOR Height of Air Temperature Sensor
ICE_ACCR_ON_SHIP Ice Accretion On Ship
ICE_OF_LAND_ORIGIN Ice of Land Origin
ICE_SIT_TREND Ice trend
ID_IND Identification Indicator
IMMA_VER IMMA Version
IMMT_VER IMMT Version
IMONO-IMO_NUM IMO Number
IND_FOR_PRECIP Precipitation Indicator
IND_FOR_TEMP Temperature Indicator
IND_FOR_WAVE_MEAS Wave Measurement Indicator
IND_FOR_WBT Wet Bulb Temperature Indicator
INPUT_COMP_NUM Input Component Number
INPUT_COMP_NUM_ERR Input Component Number - Error
INTERMEDIATE_REJECT_FLAG Intermediate Reject Flag
KOV-KIND_OF_VESSEL Kind of Vessel
LANDLOCKED_FLAG Landlocked Flag
LL_IND Latitude Longitude Indicator
LOT-SCREEN_LOCATION Screen Location
LOV-VESSEL_LENGTH Vessel Length
LOW_CLD_AMT Low Cloud Amount
LOW_CLD_TYPE Low Cloud Type
MAX_HT_SUM_LOAD Maximum Height of Cargo Above Max Summer Load Line
META_SRC Metadata Source
MID_CLD_TYPE Middle Cloud Type
MQCS_VER Version of Minimum QC Standards (MQCS)
MSH Model Surface Height
MST Model Surface Type
NATIONAL_USE National Use
NAT_SOURCE_IND National Source Indicator
NCDC_QC_FLAGS NCDC_QC_FLAGS
NE-TTL_CLD_AMT_ECR Extended Cloud Reconstructions Total Cloud Amount
NHE-LOW_CLD_AMT_ECR Extended Cloud Reconstructions Low Cloud Amount
NIGHT_DAY_FLAG Night/Day Flag
NOL_HIGH_AMT_ECR Extended Cloud Reconstructions NOL High Cloud Amount
NOL_MID_AMT_ECR Extended Cloud Reconstructions NOL Middle Cloud Amount
OAV-ALKALINITY Alkalinity
OAZ-ALKALINITY_DEPTH Alkalinity Depth
OB_PLATFORM Observation Platform
OB_SOURCE Observation Source
OCV-TTL_CHLORO Total Chlorophyll
OCZ-TTL_CHLORO_DEPTH Total Chlorophyll Depth
ODV-DIS_ORG_CARBON Dissolved Organic Carbon
ODZ-DIS_ORG_CARBON_DEPTH Dissolved Organic Carbon Depth
ONE_BOX_NUM One Degree Box Number
ONV-NITRATE Nitrate
ONZ-NITRATE_DEPTH Nitrate Depth
OOV-DIS_OXYGEN Dissolved Oxygen
OOZ-DIS_OXYGEN_DEPTH Dissolved Oxygen Depth
OPCV-PP_CO2 Partial Pressure of Carbon Dioxide
OPCZ-PP_CO2_DEPTH Partial Pressure of Carbon Dioxide Depth
OPHV-PH PH
OPHZ-PH_DEPTH PH Depth
OPM-SHIP_TYPE Ship Type
OPV-PHOSPHATE Phosphate
OPZ-PHOSPHATE_DEPTH Phosphate Depth
OSIV-SILICATE Silicate
OSIZ-SILICATE_DEPTH Silicated Depth
OSV-SALINITY Salinity
OSZ-SALINITY_DEPTH Salinity Depth
OTV-SST2 SST 2
OTZ-SST_DEPTH2 SST Depth 2
PAST_WX Past Weather
PAST_WX2 Past Weather 2
PER_OF_SWELL2 Swell Period 2
PF-TRIM_FLAG Trimming Flag - Sea Level Pressure
PLATFORM_ID Platform Type Indicator
PNC-NCDC_QC_FLAGS NCDC QC Flags - SLP
PQA-ADAPTIVE_QC_FLAGS Adaptive QC Flag - Sea Leve Pressure
PQZ-ADAPTIVE_QC_FLAGS Adaptive QC Flag - Sea Leve Pressure
PRESS_BIAS Pressure Bias
PRES_WX Present Weather
PUID-PROVIDER_UID Provider's Unique Record Identification
QC_IND QC Indicator
QC_IND_FOR_FIELDS QC_IND_FOR_FIELDS
QI1-QC_IND_FOR_FIELDS QC Flag - height of clouds
QI10-QC_IND_FOR_FIELDS QC Flag - sea surface temperature
QI11-QC_IND_FOR_FIELDS QC Flag - period of wind waves
QI12-QC_IND_FOR_FIELDS QC Flag - height of wind waves
QI13-QC_IND_FOR_FIELDS QC Flag - swell
QI14-QC_IND_FOR_FIELDS QC Flag - precipitation
QI15-QC_IND_FOR_FIELDS QC Flag - characteristic of pressure tendency
QI16-QC_IND_FOR_FIELDS QC Flag - amount of pressure tendency
QI17-QC_IND_FOR_FIELDS QC Flag - true direction of ship
QI18-QC_IND_FOR_FIELDS QC Flag - ship's average speed
QI19-QC_IND_FOR_FIELDS QC Flag - wet bulb temperature
QI2-QC_IND_FOR_FIELDS QC Flag - visibility
QI20-QC_IND_FOR_FIELDS QC Flag - ship's position
QI22-IMMT_QC_SHIP_HEADING QC Flag - ship's heading
QI23-IMMT_QC_COURSE_OVER_GROUND QC Flag - ship's course over ground
QI24-IMMT_QC_SHIP_SPEED_OVER_GROUND QC Flag - ship's speed over ground
QI25-IMMT_QC_MAX_HT_SUM_LOAD QC Flag - summer load line
QI27-IMMT_QC_DEP_SUM_LOAD QC Flag - departure from summer load line
QI28-IMMT_QC_REL_WIND_DIR QC Flag - relative wind direction
QI29-IMMT_QC_REL_WIND_SPEED QC Flag - relative wind speed
QI3-QC_IND_FOR_FIELDS QC Flag - clouds
QI4-QC_IND_FOR_FIELDS QC Flag - wind direction
QI5-QC_IND_FOR_FIELDS QC Flag - wind speed
QI6-QC_IND_FOR_FIELDS QC Flag - air temperature
QI7-QC_IND_FOR_FIELDS QC Flag - dew point temperature
QI8-QC_IND_FOR_FIELDS QC Flag - air pressure
QI9-QC_IND_FOR_FIELDS QC Flag - weather
RATE_OF_I Rate of Ice Accretion on Ship
RELEASE_NUM_PRIMARY Release Number Primary
RELEASE_NUM_SECONDARY Release Number Secondary
RELEASE_NUM_TERTIARY Release Number Tertiary
RELEASE_STATUS_IND Release Status Indicator
REL_LUNAR_ILLUM Relative Lunar Illuminance
REL_WIND_DIR Relative Wind Direction
REL_WIND_SPD Relative Wind Speed
RF-TRIM_FLAG Trimming Flag - Relative Humidity
RH Relative Humidity
RH_IND Relative Humidity Indicator
SEA_LVL_PRES Sea Level Pressure
SEA_SURF_TEMP Sea Surface Temperature
SF-TRIM_FLAG Trimming Flag - SST
SHIP_COURSE Ship's Course
SHIP_HEADING Ship's Heading
SHIP_ID Identification
SHIP_SPD Ship's Speed
SIG_CLOUD_AMT Significant Cloud Amount
SIG_CLOUD_HGT Significant Cloud Height
SIG_CLOUD_TYPE Significant Cloud Type
SIM-SST_METHOD SST Method
SKY_BRIGHT_IND Sky Brightness Indicator
SME-SRC_META_ELEMENT Source Metadata Element
SMF-SRC_META_FILE Source Metadata File
SMV-SRC_FORMAT_VER Source Metadata Format Version
SNC-NCDC_QC_FLAGS NCDC QC Flags - SST
SOLAR_ALT Solar Altitude
SOURCE_EXCLUSION_FLAG Source Exclusion Flag
SOURCE_ID Source
SPD_OVER_GROUND Ship's Speed Over Ground
SQA-ADAPTIVE_QC_FLAGS Adaptive QC Flag - SST
SQZ-ADAPTIVE_QC_FLAGS Adaptive QC Flag - SST
SRH Derived Relative Humidity
SST_MM Sea Surface Temperature Method Indicator
STAGE_OF_DEVELP Stage of Development of Sea Ice
STA_WX_IND Weather Indicator
SUPPLEMENTAL_DATA Supplemental Data
SWELL_DIR Swell Direction
SWELL_HGT Swell Height
SWELL_PERIOD Swell Period
SWELL_PERIOD_IND Swell Period Indicator
SWU Derived Wind U Component
SWV Derived Wind V Component
TEN_BOX_NUM Ten Degree Box Number
THICKNESS_OF_I Thickness of Ice Accretion On Ship
TIME_IND Time Indicator
TNC-NCDC_QC_FLAGS NCDC QC Flags - Character of Pressure Tendency
TOB-BAR_TYPE Barometer Type
TOH-HYGRO_TYPE Hygrometer Type
TOT-THERM_TYPE Thermometer Type
TOT_CLD_AMT Total Cloud Amount
TRACK_CHK Track Check
TRIM_FLAG TRIM_FLAG
TRUE_BEARING_ICE_EDGE Ice Edge Bearing
TYPE_IND_VAU1 Type Indicator for VAU1
TYPE_IND_VAU2 Type Indicator for VAU2
TYPE_IND_VAU3 Type Indicator for VAU3
UF-TRIM_FLAG Trimming Flag - U Wind Component
UNCERT_TYPE_IVAU1 Uncertainty Type for VAU1
UNCERT_TYPE_IVAU2 Uncertainty Type for VAU2
UNCERT_TYPE_IVAU3 Uncertainty Type for VAU3
UNIQUE_ID Unique Report ID
UQA-ADAPTIVE_QC_FLAGS Adaptive QC Flag - U Wind Component
UQZ-ADAPTIVE_QC_FLAGS Adaptive QC Flag - U Wind Component
VAD_QC Value-Added Data QC Flag
VAD_SCALE_FACTOR Value-Added Data Scale Factor
VALUE_ADDED Value-Added Data
VAU1_SCALE_FACTOR Scaling Factor for VAU1
VAU2_SCALE_FACTOR Scaling Factor for VAU2
VAU3_SCALE_FACTOR Scaling Factor for VAU3
VF-TRIM_FLAG Trimming Flag - V Wind Component
VISIBILITY Visibility
VQA-ADAPTIVE_QC_FLAGS Adaptive QC Flag - V Wind Component
VQZ-ADAPTIVE_QC_FLAGS Adaptive QC Flag - V Wind Component
VV_IND Visibility Indicator
WAVE_DIR Wave Direction
WAVE_HGT Wave Height
WAVE_PERIOD Wave Period
WAVE_PERIOD_IND Wave Period Indicator
WET_BULB_TEMP Wet Bulb Temperature
WIND_DIR Wind Direction
WIND_DIR_IND Wind Direction Indicator
WIND_SPD Wind Speed
WIND_SPD_IND Wind Speed Indicator
WIND_SPEED Wind Speed
WNC-NCDC_QC_FLAGS NCDC QC Flags - Wind
WWE-PRES_WX_ECR Extended Cloud Reconstructions Present Weather
XNC-NCDC_QC_FLAGS NCDC QC Flags - Present Wx
YNC-NCDC_QC_FLAGS NCDC QC Flags - Past Wx
ZNC-NCDC_QC_FLAGS NCDC QC Flags - Full Report
alt the elevation of a geophysical point of observation relative to Mean Sea Level
lat GEOPHYSICAL-POINT-OBSERVATION latitude coordinate
lon GEOPHYSICAL-POINT-OBSERVATION longitude coordinate
station_info name of the station
station_name station identification code
time time of observation

Examples

documentation to come...

Response

key value

Search Service API (NCEI Common Access Search Service) - https://www.ncei.noaa.gov/support/access-search-service-api-user-documentation

Use this API to "discover datasets and data.

Endpoint

GET https://www.ncei.noaa.gov/access/services/search/v1/data?{paramKey1}={val1}&{paramKey2}={val2}

Parameters

Parameter Key Possible Values Our Description NCEI Description
dataset daily-summaries
startDate 2010-01-01T00:00:00 This is the date to select datasets whose period of record (PoR) starts on or after the given startDate. This parameter is an ISO 8601 date (YYYY-MM-DD) -or- ISO 8601 combined date and time format (YYYY-MM-DDTHH:mm:ss). If using an ISO 8601 combined date and time format, the T that separates the time is NOT optional. The ISO 8601 combined date and time also supports optional time zone representations. Use Z or z for UTC and +HH:mm or -HH:mm for the offset from UTC. The start and end dates are not required. The startDate must come before the endDate parameter. Some datasets are averages over time and may ignore parts of a date.
endDate 2016-12-31T23:09:59 This is the date to select datasets whose period of record (PoR) starts on or after the given startDate. This parameter is an ISO 8601 date (YYYY-MM-DD) -or- ISO 8601 combined date and time format (YYYY-MM-DDTHH:mm:ss). If using an ISO 8601 combined date and time format, the T that separates the time is NOT optional. The ISO 8601 combined date and time also supports optional time zone representations. Use Z or z for UTC and +HH:mm or -HH:mm for the offset from UTC. The start and end dates are not required. The startDate must come before the endDate parameter. Some datasets are averages over time and may ignore parts of a date.
boundingBox OR bbox 35.462327,-82.563951,35.412327,-82.513951 The bounding box is used to select data from a geographic location contained within the coordinates, given as four comma separated numbers. North and South range from -90 to 90 and East and West range from -180 to 180. If these are not set the geographic extent defaults to the entire globe (90,-180,-90,180).
keywords precipitation The text parameter used to locate datasets by matching the terms of the dataset name and description.
text rain The text parameter used to locate datasets by matching the terms of the dataset name and description.
available true, false A boolean (true or false) used to locate datasets based on whether they are available in the Data Search Endpoint.
dataTypes PRCP
stations USW00003812
limit 10
offset 0

Examples

documentation to come...

Response

key value

Order Service API (NCEI Common Access Order Service) - https://www.ncei.noaa.gov/support/access-order-service

Endpoint

GET https://www.ncei.noaa.gov/access/services/orders/v1?{paramKey1}={val1}&{paramKey2}={val2}

Parameters

Parameter Key Possible Values Our Description NCEI Description
email john.smith@noaa.gov The email parameter is required, while the limit and offset are not.
limit 10 Limit and offset parameters can be used for paginated resultsets. The limit parameter sets the number of orders per page.
offset 0 Limit and offset parameters can be used for paginated resultsets. The offset parameter delegates the starting point of the orders resultset.

Examples

https://www.ncei.noaa.gov/access/services/orders/v1?email=charles.burris@noaa.gov&limit=5&offset=0

Response

key value

Support Service API (NCEI Common Access Support Service) - https://www.ncei.noaa.gov/support/access-support-service

Use this API to get information about what attributes are available for a given dataset.

Endpoint

GET https://www.ncei.noaa.gov/access/services/support/v3/datasets/{datasetId}.json

Parameters

Parameter Key Possible Values Our Description NCEI Description
datasetId daily-summaries, global-marine, global-summary-of-the-year The National Centers for Environmental Information (NCEI) Common Access Support Service provides a RESTful application programming interface (API) to discover metadata and attributes about datasets based on a set of parameters to the /v3/datasets URL.

Examples

https://www.ncei.noaa.gov/access/services/support/v3/datasets/daily-summaries.json

Response

key value

Access to Climate Data Online (CDO) Advanced Programming Interface (API) is changing. The CDO API version 2 is at end-of-life and will be shutdown after 7/15/2019.

First, request a token at this URL: https://www.ncdc.noaa.gov/cdo-web/token Don't be alarmed by the NCDC URL. The National Climactic Data Center (NCDC) is the former name of the NCEI.