getplt v4

The getplt API retrieves GIMMS/GLAM NDVI time-series plot images.

This is the latest version, released on 2023-01-27.

ENDPOINTS

 GET https://glam1.gsfc.nasa.gov/api/getplt/v4
 POST https://glam1.gsfc.nasa.gov/api/getplt/v4

PARAMETERS

Name Type Description
version string The database version in the format: v<number>.
Default is the latest version: v16. See list of DB versions.		 optional
sat string The satellite name. Can be MOD, MYD or VNP. required
layer string The layer name. Default is NDVI. optional
mask string The land or crop mask ID name. See list of mask names by DB version.
Default is the land mask: MOD44W_2009_land.
Example: NASS_2011-2016_corn		 optional
shape string The vector shape name. Can be either ADM or LIS. required
ids number or string The ADM or LIS shape ID. For example, ADM ID: 1234, LIS ID: 0122_494.
Can be specified more than once to form a list of ADM or LIS IDs. For example, ids=1234&ids=2345. See list of ADM shape IDs.		 required
years number The year in 4 digit format. For example, 2020.
Can be specified more than once to form a list of years. For example, years=2020&years2021.
Default is all years.		 optional
start_month number The start month. Valid values are 1-12. Default is: 1. optional
num_months number The number of months. Valid values are 1-12. Default is: 12. optional
mcv number Minimum cumulative value - the minimum NDVI value to accumulate. Valid range is 0.0-1.0. required if ts_type=
cumulative
ts_type string The time series type. Can be one of seasonal, cumulative, or complete. required
stats string Statistics to plot. Possible values are mean, min, and max. Default is none.
Can be specified more than once. For example, stats=mean&stats=min&stats=max		 optional
height number The image height in pixels. Default is 400. optional
width number The image width in pixels. Default is 600. optional
labels number Indicate 1 to add labels, or 0 to omit. Default is 0. optional
attachment number Indicate 1 to prompt the browser "Save As" dialogue box, or 0 to return inline. Default is 0. optional
format string The image format. Possible values are png or svg. Default is png. optional

RETURNS

PNG or SVG image file.

STATUS CODES

Code Reason
200 OK
400 Bad Request
500 Internal error

EXAMPLES

URL GET

https://glam1.gsfc.nasa.gov/api/getplt/v4?version=v16&sat=MOD&mask=NASS_2011-2016_corn&shape=ADM&ids=110955&years=2019&years=2020&start_month=4&num_months=8&ts_type=seasonal&stats=mean&stats=min&stats=max&format=png

curl GET

curl -o output.png "https://glam1.gsfc.nasa.gov/api/getplt/v4?version=v16&sat=MOD&mask=NASS_2011-2016_corn&shape=ADM&ids=110955&years=2019&years=2020&start_month=4&num_months=8&ts_type=seasonal&stats=mean&stats=min&stats=max&format=png"

curl POST

curl https://glam1.gsfc.nasa.gov/api/getplt/v4 \
 -d "version=v16" \
 -d "sat=MOD" \
 -d "layer=NDVI" \
 -d "mask=NASS_2011-2016_corn" \
 -d "shape=ADM" \
 -d "ids=110955" \
 -d "years=2019" \
 -d "years=2020" \
 -d "start_month=4" \
 -d "num_months=8" \
 -d "ts_type=seasonal" \
 -d "stats=mean" \
 -d "stats=min" \
 -d "stats=max" \
 -d "format=png" \
 -o output.png

Alternatively,

curl -o output.png -d "version=v16&sat=MOD&mask=NASS_2011-2016_corn&shape=ADM&ids=110955&years=2019&years=2020&start_month=4&num_months=8&ts_type=seasonal&stats=mean&stats=min&stats=max&format=png" https://glam1.gsfc.nasa.gov/api/getplt/v4

wget GET

wget -O output.png "https://glam1.gsfc.nasa.gov/api/getplt/v4?version=v16&sat=MOD&mask=NASS_2011-2016_corn&shape=ADM&ids=110955&years=2019&years=2020&start_month=4&num_months=8&ts_type=seasonal&stats=mean&stats=min&stats=max&format=png"

wget POST

wget -O output.png --post-data "version=v16&sat=MOD&mask=NASS_2011-2016_corn&shape=ADM&ids=110955&years=2019&years=2020&start_month=4&num_months=8&ts_type=seasonal&stats=mean&stats=min&stats=max&format=png" https://glam1.gsfc.nasa.gov/api/getplt/v4