Home
Tools & Services
API-V2 OpenAPI Specifications

API-V2 OpenAPI Specifications

Endpoints in the API-V2 "measurements" namespace return information about measurements, depending on the endpoint. All reponses are returned as JSON.

Endpoint and Parameter Descriptions

The following table identifies each supported endpoint, and any parameters that the endpoint request supports. Requests are constructed by appending "/api/v2/measurements" with the endpoint and any query parameters. To see which query parameter values are accepted for a query parameter, click on the links in the Param Type column for that parameter. To see what endpoint responses look like, click on the links in the Examples column.

Endpoint

Operation

Description

Examples

GET

returns this OpenAPI specification as json.

/api/v2/measurements

archiveSets

GET

returns all the ArchiveSets known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
sensors	from the specified sensors	/api/v2/missions/sensors
platforms	from the specified platforms	/api/v2/missions/platforms
collections	from the specified collections	/api/v2/measurements/collections
instruments	from the specified instruments	/api/v2/missions/instruments
scienceDomains	from specified science domains	/api/v2/measurements/scienceDomains
keywords	from specified keywords	/api/v2/measurements/keywords
pges	from specified PGEs	/api/v2/measurements/pges
products	from the specified products	/api/v2/measurements/products

return information about all ArchiveSets
- /api/v2/measurements/archiveSets
return information about all ArchiveSets associated with product "MOD09A1"
- /api/v2/measurements/archiveSets?products=MOD09A1

archiveSets/{archiveSetId}

GET

returns the specified ArchiveSet.

Param Name	Param Description	Param Type
archiveSetId	from the specified archiveSets	integer

return information about ArchiveSet 61
- /api/v2/measurements/archiveSets/61

availability

GET

returns all the Availability of products known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]

/api/v2/measurements/availability

availability/{productId}

GET

returns the Availability of the specified product.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
productId	from the specified products	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
collections	from the specified collections	/api/v2/measurements/collections
archiveSets	from the specified archiveSets	/api/v2/measurements/archiveSets
temporalRanges	temporal ranges (date and optionally, time) are specified as follows: dates can have either of the two following formats: YYYY-MM-DD where YYYY is year, MM is month number (01..12), and DD is day of month (01..number of days in month). YYYY-DDD where YYYY is the 4 digit year and DDD is the day-of-year (1..365 or 1..366 for leap years) if a date is NOT specified, then the current date is assumed. the date is separated from the time by either a space or a "T" character. times must be specified as HH:MM, where HH is the hour (0..23) counting from midnight, and MM is the minute (0..59). all times are interpreted as Coordinated Universal Time (UTC). Currently time zone specifications are not supported. date time ranges are specified as two dates or date times separated by two period (dot) characters ".." date..date : the start time is assumed to be 00:00 and the end time is assumed to be 23:59 YYYY-MM-DD..YYYY-MM-DD YYYY-DDD..YYYY-MM-DD YYYY-MM-DD..YYYY-DDD YYYY-DDD..YYYY-DDD date time..date : the end time is assumed to be 23:59 YYYY-MM-DD HH:MM..YYYY-MM-DD YYYY-DDD HH:MM..YYYY-MM-DD YYYY-MM-DD HH:MM..YYYY-DDD YYYY-DDD HH:MM..YYYY-DDD date..date time : the start time is assumed to be 00:00 YYYY-MM-DD..YYYY-MM-DD HH:MM YYYY-DDD..YYYY-MM-DD HH:MM YYYY-MM-DD..YYYY-DDD HH:MM YYYY-DDD..YYYY-DDD HH:MM date time..date time YYYY-MM-DD HH:MM..YYYY-MM-DD HH:MM YYYY-DDD HH:MM..YYYY-MM-DD HH:MM YYYY-MM-DD HH:MM..YYYY-DDD HH:MM YYYY-DDD HH:MM..YYYY-DDD HH:MM	/api/v2/measurements/temporalRanges
availability	from the specified date:time ranges	/api/v2/measurements/availability

return the Availability of the AVHRR:NOAA-14 top-of-atmosphere reflectance product (defaults to last 7 days)
- /api/v2/measurements/availability/N14_AVH02C1
return the Availability of the MODIS Aqua calibrated radiances product for archiveSet 61, for 30 July 2019
- /api/v2/measurements/availability/MOD021KM?archiveSets=61&temporalRanges=2019-07-30..2019-07-31

availableFiles

GET

returns a count of available files for the specified date, product type, archiveset/collection, and tileSet. This is used by folks at Google (and elsewhere) to check whether production is complete for a give day. Default is for current date.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
products	from the specified products	/api/v2/measurements/products
collections	from the specified collections	/api/v2/measurements/collections
archiveSets	from the specified archiveSets	/api/v2/measurements/archiveSets
startDates	YYYY-MM-DD hh:mm	/api/v2/measurements/startDates
tileSets	tile set identifier	/api/v2/measurements/tileSets

return the Availability of all products for the current day
- /api/v2/measurements/availableFiles
return the Availability of the AVHRR:NOAA-14 top-of-atmosphere reflectance product
- /api/v2/measurements/availableFiles?products=N14_AVH02C1&startDates=1988-01-11

collections

GET

returns all the Collections known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
sensors	from the specified sensors	/api/v2/missions/sensors
platforms	from the specified platforms	/api/v2/missions/platforms
archiveSets	from the specified archiveSets	/api/v2/measurements/archiveSets
instruments	from the specified instruments	/api/v2/missions/instruments
scienceDomains	from specified science domains	/api/v2/measurements/scienceDomains
keywords	from specified keywords	/api/v2/measurements/keywords
pges	from specified PGEs	/api/v2/measurements/pges
products	from the specified products	/api/v2/measurements/products

return information about all Collections
- /api/v2/measurements/collections
return collections associated with PGE103
- /api/v2/measurements/collections?pges=PGE103
return collections associated with "surface reflectance"
- /api/v2/measurements/collections?keywords=surface reflectance

collections/{collectionId}

GET

returns the specified Collection.

Param Name	Param Description	Param Type
collectionId	from the specified collection	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/

return information about Collection "viirs-c2"
- /api/v2/measurements/collections/viirs-c2

illuminations

GET

returns all the Illuminations known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]

return the Availability of all products for the current day
- /api/v2/measurements/illuminations

keywords

GET

returns all the keywords known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
products	from the specified products	/api/v2/measurements/products

all keywords
- /api/v2/measurements/keywords
keywords from the MOD00F Terra MODIS Level 0 product
- /api/v2/measurements/keywords?products=MOD00F

keywords/{keywordId}

GET

returns the specified keyword.

Param Name	Param Description	Param Type
keywordId	from specified keyword	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/

where the "cirrus" keyword is found
- /api/v2/measurements/keywords/cirrus

pges

GET

returns all the Product Generation Executables (PGE)s known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
products	from the specified products	/api/v2/measurements/products

all pges
- /api/v2/measurements/pges
pge that creates VIIRS Aerosol product VNP04LG
- /api/v2/measurements/pges?products=VNP04LG

pges/{pgeId}

GET

returns the specified PGE.

Param Name	Param Description	Param Type
pgeId	from specified PGE	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/

information about PGE09
- /api/v2/measurements/pges/PGE09
information about PGE412
- /api/v2/measurements/pges/PGE09

products

GET

returns all the Products known to the system, or all the Products matching the specified query params.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
sensors	from the specified sensors	/api/v2/missions/sensors
platforms	from the specified platforms	/api/v2/missions/platforms
collections	from the specified collections	/api/v2/measurements/collections
archiveSets	from the specified archiveSets	/api/v2/measurements/archiveSets
instruments	from the specified instruments	/api/v2/missions/instruments
scienceDomains	from specified science domains	/api/v2/measurements/scienceDomains
keywords	from specified keywords	/api/v2/measurements/keywords
pges	from specified PGEs	/api/v2/measurements/pges

return information about all products
- /api/v2/measurements/products
return information about products produced from MODIS instrument on Terra platform
- /api/v2/measurements/products?instruments=MODIS&platforms=Terra

products/{productId}

GET

returns the specified Product.

Param Name	Param Description	Param Type
productId	from the specified products	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/

return information about the VIIRS Cloud Properties product
- /api/v2/measurements/products/CLDPROP_L2_VIIRS_SNPP

regions

GET

returns all the Regions known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]

/api/v2/measurements/regions

regions/{regionId}

GET

returns the specified region.

Param Name	Param Description	Param Type
regionId	from specified region	string matching /^[\[\]\.\|a-zA-Z0-9\s\+\-]+$/

country
- /api/v2/measurements/regions/United States
ISO Code
- /api/v2/measurements/regions/USA
protected area
- /api/v2/measurements/regions/Acid Shale-Pine Forest

scienceDomains

GET

returns all the ScienceDomains known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
products	from the specified products	/api/v2/measurements/products

all science domains
- /api/v2/measurements/scienceDomains
science domain for Aqua MODIS Cloud product MYD06_L2
- /api/v2/measurements/scienceDomains?products=MYD06_L2

scienceDomains/{scienceDomainId}

GET

returns the specified scienceDomain.

Param Name	Param Description	Param Type
scienceDomainId	from specified science domain	string matching /^[a-zA-Z0-9\.\s\#\*/_,&:+-]+$/

the Nighttime Lights science domain
- /api/v2/measurements/scienceDomains/Nighttime Lights

temporalRanges

GET

returns the TemporalRanges for all products known to the system.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]

/api/v2/measurements/temporalRanges

temporalRanges/{productId}

GET

returns all the TemporalRanges known for the specified product.

Param Name	Param Description	Param Type
fields	names of information fields desired in the output	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
formats	format for desired output	one of [json, html, csv]
productId	from the specified products	string matching /^[a-zA-Z0-9\.\,\s\?\*_:\|-]+$/
collections	from the specified collections	/api/v2/measurements/collections
archiveSets	from the specified archiveSets	/api/v2/measurements/archiveSets
temporalRanges	temporal ranges (date and optionally, time) are specified as follows: dates can have either of the two following formats: YYYY-MM-DD where YYYY is year, MM is month number (01..12), and DD is day of month (01..number of days in month). YYYY-DDD where YYYY is the 4 digit year and DDD is the day-of-year (1..365 or 1..366 for leap years) if a date is NOT specified, then the current date is assumed. the date is separated from the time by either a space or a "T" character. times must be specified as HH:MM, where HH is the hour (0..23) counting from midnight, and MM is the minute (0..59). all times are interpreted as Coordinated Universal Time (UTC). Currently time zone specifications are not supported. date time ranges are specified as two dates or date times separated by two period (dot) characters ".." date..date : the start time is assumed to be 00:00 and the end time is assumed to be 23:59 YYYY-MM-DD..YYYY-MM-DD YYYY-DDD..YYYY-MM-DD YYYY-MM-DD..YYYY-DDD YYYY-DDD..YYYY-DDD date time..date : the end time is assumed to be 23:59 YYYY-MM-DD HH:MM..YYYY-MM-DD YYYY-DDD HH:MM..YYYY-MM-DD YYYY-MM-DD HH:MM..YYYY-DDD YYYY-DDD HH:MM..YYYY-DDD date..date time : the start time is assumed to be 00:00 YYYY-MM-DD..YYYY-MM-DD HH:MM YYYY-DDD..YYYY-MM-DD HH:MM YYYY-MM-DD..YYYY-DDD HH:MM YYYY-DDD..YYYY-DDD HH:MM date time..date time YYYY-MM-DD HH:MM..YYYY-MM-DD HH:MM YYYY-DDD HH:MM..YYYY-MM-DD HH:MM YYYY-MM-DD HH:MM..YYYY-DDD HH:MM YYYY-DDD HH:MM..YYYY-DDD HH:MM	/api/v2/measurements/temporalRanges
availability	from the specified date:time ranges	/api/v2/measurements/availability

return the Availability of the AVHRR:NOAA-14 top-of-atmosphere reflectance product (defaults to last 7 days)
- /api/v2/measurements/temporalRanges/N14_AVH02C1

version

GET

returns the GitLab Tag of this installed namespace.

/api/v2/measurements/version