Climate at a Glance | National Time Series

Overview

A RESTful application programming interface (API) is available to access Climate at a Glance data. The API can format desired data as comma-separated values (CSV), JavaScript Object Notation (JSON), and Extensible Markup Language (XML). The Data Service is only available via HTTP Strict Transport Security (HSTS) following Federal government policy.

Request Endpoint Parameters

Accepted values are defined in the table below.

Required Parameters

Required parameters are passed as path parameters.

###HTTP_PATH_ROOT###/access/monitoring/climate-at-a-glance/{scope}/time-series/{location}/{parameter}/{surface}/{timescale}/{month}/{begYear}-{endYear}/data.{format}

Optional Parameters

Optional parameters are passed using a GET request. This an optional query component which follows the path, preceded by a question-mark ?, in the form of key=value pairs, and separated by an ampersand &.

…?{basePeriod}=[true|false]&{begBaseYear}=[year]&{begBaseYear}=[year]

Request Parameter	Type	Description
scope	String	Accepted Values
location	String	Accepted surface values in parentheses Accepted Values
parameter	String	Accepted Values
surface/coordinates*	String	Accepted Values
timescale	Integer, String	Accepted Values 1-60 Number of Months ytd Year to Date
month	Integer	Accepted Values 1-12 January-December 0 All Months
startYear	Integer	4-digit year (must be less than or equal to endYear) Accepted Values
endYear	Integer	4-digit year (must be greater than or equal to startYear) Accepted Values
format	String	Accepted Values csv Comma-Separated Values json JavaScript Object Notation xml Extensible Markup Language
basePeriod	Boolean	Accepted Values true Return anomalies based on the requested base period mean false Return no anomalies
begBaseYear	Integer	4-digit year (must be less than or equal to endBaseYear) Accepted Values
endBaseYear	Integer	4-digit year (must be greater than or equal to begBaseYear) Accepted Values