Data Grapher Current Conditions API Disclaimer
API
The buoy data API allows developers and statisticians to generate images, data sets, and other useful points of interest through website GET requests to our servers which house historical buoy data.
GET Request
To gather data a GET request will need to be made to the following URL with the desired URL parameters from below:
http://www.gvsu.edu/wri/buoy/data-generate.htm
Examples
Air Temperature compared with Water Temperature at 2m and 4m every Thursday for July 2011 with the missing data points hidden:
http://www.gvsu.edu/wri/buoy/data-generate.htm?x=date&y=atmp1,tp001,tp002&date=7/7/11,7/14/11,7/21/11,7/28/11&concentration=1&disjoined=0
html preview
Chlorophyll μg/L (2m) compared with Chlorophyll μg/L (8m) for all dates between 12:00pm and 1:00pm, displayed on a scatter plot:
http://www.gvsu.edu/wri/buoy/data-generate.htm?x=clcon001&y=clcon003&time=12:00&graph=scatter&concentration=1
html preview
URL Parameters
| Attribute | Req/Opt | Default | Description |
|---|---|---|---|
| x | Optional | date |
A single x value may be passed to the API.
Supported values are:
|
| y | Required |
At least one y value must be passed to the API. Multiple y values can be separated by a comma.
Supported values are:
|
|
| date | Optional |
Date values must be in the format MM/DD/YYYY or M/D/YY and can be either ranges separated by hyphens, individual dates separated by commas, or any combination of the two. If no value is provided then all dates are considered.
Valid examples:
|
|
| time | Optional |
Time values must be in the 24-hour format H:MM or HH:MM and can be either ranges separated by hyphens, individual times separated by commas, or any combination of the two. Times must also be divisible by 15 minutes (0:00, 0:15, 0:30, and 0:45). If no value is provided then all times are considered.
Valid examples:
|
|
| graph | Optional | line |
The type of graph to display. This attribute is only valid for format=html or format=image. If format=image and graph=column then graph=bar is instead used.
Supported values are:
|
| format | Optional | html |
The media type to be returned.
Supported values are:
|
| disjoined | Optional | 1 |
A boolean variable rather or not to show missing data points for all y variables. This attribute is only valid for format=html.
Supported values are:
|
| concentration | Optional | .05 |
A decimal number in the range .01-1.0 which represents the total amount of y plots per x variable. The closer to 1 this number is, the more points will be present in the output and the more accurate the graph. |
| calculation | Optional | avg |
The mathematical calculation performed on the range points within an x variable's concentration.
Supported values are:
|
| ymin | Optional | smallest y-value |
A decimal number which represents the y variable's minimum line of the view window of the graph for format=html with yindividual=0 or format=image. If format=image is declared the ymin cannot be less than the minimum value of y or it will default to the default value. |
| ymax | Optional | largest y-value |
A decimal number which represents the y variable's maximum line of the view window of the graph for format=html with yindividual=0 or format=image. If format=image is declared the ymax cannot be greater than the maximum value of y or it will default to the default value. |
| width | Optional | 600 |
An integer which represents the width of the graph for format=image. |
| height | Optional | 400 |
An integer which represents the height of the graph for format=image. |
| callback | Optional |
A function wrapper for JSONP support with format=json. The JSON object will be passed to the value of this attribute, interpreted as a javascript function, for cross domain support. |
|
| yindividual | Optional | 0 |
A boolean variable rather or not to show all y variables plotted on the same graph. This attribute is only valid for format=html.
Supported values are:
|
All dates and times are in Eastern Standard Time (EST), GMT-4:00