get_currents
Retrieve currents data for a specific station by providing station ID, date range, time zone, and output format. Supports JSON, XML, and CSV formats.
Instructions
Get currents data for a station
Input Schema
Name | Required | Description | Default |
---|---|---|---|
begin_date | No | Start date (YYYYMMDD or MM/DD/YYYY) | |
bin | No | Bin number | |
date | No | Date to retrieve data for ("today", "latest", "recent", or specific date) | |
end_date | No | End date (YYYYMMDD or MM/DD/YYYY) | |
format | No | Output format (json, xml, csv) | |
range | No | Number of hours to retrieve data for | |
station | Yes | Station ID | |
time_zone | No | Time zone (gmt, lst, lst_ldt) | |
units | No | Units to use ("english" or "metric") |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"begin_date": {
"description": "Start date (YYYYMMDD or MM/DD/YYYY)",
"type": "string"
},
"bin": {
"description": "Bin number",
"type": "number"
},
"date": {
"description": "Date to retrieve data for (\"today\", \"latest\", \"recent\", or specific date)",
"type": "string"
},
"end_date": {
"description": "End date (YYYYMMDD or MM/DD/YYYY)",
"type": "string"
},
"format": {
"description": "Output format (json, xml, csv)",
"enum": [
"json",
"xml",
"csv"
],
"type": "string"
},
"range": {
"description": "Number of hours to retrieve data for",
"type": "number"
},
"station": {
"description": "Station ID",
"minLength": 1,
"type": "string"
},
"time_zone": {
"description": "Time zone (gmt, lst, lst_ldt)",
"enum": [
"gmt",
"lst",
"lst_ldt"
],
"type": "string"
},
"units": {
"description": "Units to use (\"english\" or \"metric\")",
"enum": [
"english",
"metric"
],
"type": "string"
}
},
"required": [
"station"
],
"type": "object"
}