This is page 3 of 3. Use http://codebase.md/ckanthony/openapi-mcp?lines=true&page={x} to view the full context.
# Directory Structure
```
├── .dockerignore
├── .github
│ └── workflows
│ ├── ci.yml
│ └── publish.yml
├── .gitignore
├── cmd
│ └── openapi-mcp
│ └── main.go
├── Dockerfile
├── example
│ ├── agent_demo.png
│ ├── docker-compose.yml
│ └── weather
│ ├── .env.example
│ └── weatherbitio-swagger.json
├── go.mod
├── go.sum
├── openapi-mcp.png
├── pkg
│ ├── config
│ │ ├── config_test.go
│ │ └── config.go
│ ├── mcp
│ │ └── types.go
│ ├── parser
│ │ ├── parser_test.go
│ │ └── parser.go
│ └── server
│ ├── manager_test.go
│ ├── manager.go
│ ├── server_test.go
│ └── server.go
└── README.md
```
# Files
--------------------------------------------------------------------------------
/example/weather/weatherbitio-swagger.json:
--------------------------------------------------------------------------------
```json
1 | {
2 | "swagger": "2.0",
3 | "schemes": [
4 | "https",
5 | "http"
6 | ],
7 | "host": "api.weatherbit.io",
8 | "basePath": "/v2.0",
9 | "info": {
10 | "contact": {
11 | "x-twitter": "weatherbitio"
12 | },
13 | "description": "This an interactive version of the documentation for the Weatherbit API. The base URL for the API is [http://api.weatherbit.io/v2.0/](http://api.weatherbit.io/v2.0/) or [https://api.weatherbit.io/v2.0/](http://api.weatherbit.io/v2.0/). Below is the Swagger UI documentation for the API. All API requests require the `key` parameter. An Example for a 48 hour forecast for London, UK would be `http://api.weatherbit.io/v2.0/forecast/hourly?lat=51.5072`&`lon=-0.1276`. See our [Weather API description page](https://www.weatherbit.io/api) for the full documentation.",
14 | "title": "Weatherbit - Interactive Swagger UI Documentation",
15 | "version": "2.0.0",
16 | "x-apisguru-categories": [
17 | "location"
18 | ],
19 | "x-logo": {
20 | "url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_weatherbitio_profile_image.jpeg"
21 | },
22 | "x-origin": [
23 | {
24 | "format": "swagger",
25 | "url": "https://www.weatherbit.io/static/swagger.json",
26 | "version": "2.0"
27 | }
28 | ],
29 | "x-providerName": "weatherbit.io"
30 | },
31 | "produces": [
32 | "application/json"
33 | ],
34 | "paths": {
35 | "/alerts?lat={lat}&lon={lon}": {
36 | "get": {
37 | "description": "Returns severe weather alerts issued by meteorological agencies - given a lat, and a lon.",
38 | "parameters": [
39 | {
40 | "description": "Latitude component of location.",
41 | "format": "double",
42 | "in": "path",
43 | "name": "lat",
44 | "required": true,
45 | "type": "number"
46 | },
47 | {
48 | "description": "Longitude component of location.",
49 | "format": "double",
50 | "in": "path",
51 | "name": "lon",
52 | "required": true,
53 | "type": "number"
54 | },
55 | {
56 | "description": "Wraps return in jsonp callback - Example - callback=func",
57 | "format": "string",
58 | "in": "query",
59 | "name": "callback",
60 | "required": false,
61 | "type": "string"
62 | },
63 | {
64 | "description": "Your registered API key.",
65 | "format": "string",
66 | "in": "query",
67 | "name": "key",
68 | "required": true,
69 | "type": "string"
70 | }
71 | ],
72 | "responses": {
73 | "200": {
74 | "description": "Weather Alert Object.",
75 | "schema": {
76 | "$ref": "#/definitions/WeatherAlert"
77 | }
78 | },
79 | "default": {
80 | "description": "No Data.",
81 | "schema": {
82 | "$ref": "#/definitions/Error"
83 | }
84 | }
85 | },
86 | "summary": "Returns severe weather alerts issued by meteorological agencies - Given a lat/lon.",
87 | "tags": [
88 | "Alerts"
89 | ]
90 | }
91 | },
92 | "/bulk/files/{file}": {
93 | "get": {
94 | "description": "Downloads bulk data files - OPTIONS: ( current.csv.gz, forecast_hourly.csv.gz, forecast_daily.csv.gz). Units are Metric (Celcius, m/s, etc).",
95 | "parameters": [
96 | {
97 | "description": "Filename (ie. current.csv.gz)",
98 | "format": "string",
99 | "in": "path",
100 | "name": "file",
101 | "required": true,
102 | "type": "string"
103 | },
104 | {
105 | "description": "Your registered API key.",
106 | "format": "string",
107 | "in": "query",
108 | "name": "key",
109 | "required": true,
110 | "type": "string"
111 | }
112 | ],
113 | "responses": {
114 | "default": {
115 | "description": "No Data.",
116 | "schema": {
117 | "$ref": "#/definitions/Error"
118 | }
119 | }
120 | },
121 | "summary": "Download pre-generated bulk datasets",
122 | "tags": [
123 | "Bulk Downloads"
124 | ]
125 | }
126 | },
127 | "/current/airquality?city={city}&country={country}": {
128 | "get": {
129 | "description": "Returns current air quality conditions.",
130 | "parameters": [
131 | {
132 | "description": "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
133 | "format": "string",
134 | "in": "path",
135 | "name": "city",
136 | "required": true,
137 | "type": "string"
138 | },
139 | {
140 | "description": "Full name of state.",
141 | "format": "string",
142 | "in": "query",
143 | "name": "state",
144 | "required": false,
145 | "type": "string"
146 | },
147 | {
148 | "description": "Country Code (2 letter).",
149 | "format": "string",
150 | "in": "path",
151 | "name": "country",
152 | "required": true,
153 | "type": "string"
154 | },
155 | {
156 | "description": "Wraps return in jsonp callback. Example: callback=func",
157 | "format": "string",
158 | "in": "query",
159 | "name": "callback",
160 | "required": false,
161 | "type": "string"
162 | },
163 | {
164 | "description": "Your registered API key.",
165 | "format": "string",
166 | "in": "query",
167 | "name": "key",
168 | "required": true,
169 | "type": "string"
170 | }
171 | ],
172 | "responses": {
173 | "200": {
174 | "description": "Current air quality conditions",
175 | "schema": {
176 | "$ref": "#/definitions/AQCurrentGroup"
177 | }
178 | },
179 | "default": {
180 | "description": "No Data.",
181 | "schema": {
182 | "$ref": "#/definitions/Error"
183 | }
184 | }
185 | },
186 | "summary": "Returns current air quality conditions - Given City and/or State, Country.",
187 | "tags": [
188 | "Current Air Quality"
189 | ]
190 | }
191 | },
192 | "/current/airquality?city_id={city_id}": {
193 | "get": {
194 | "description": "Returns current air quality conditions.",
195 | "parameters": [
196 | {
197 | "description": "City ID. Example: 4487042",
198 | "format": "integer",
199 | "in": "path",
200 | "name": "city_id",
201 | "required": true,
202 | "type": "integer"
203 | },
204 | {
205 | "description": "Wraps return in jsonp callback. Example - callback=func",
206 | "format": "string",
207 | "in": "query",
208 | "name": "callback",
209 | "required": false,
210 | "type": "string"
211 | },
212 | {
213 | "description": "Your registered API key.",
214 | "format": "string",
215 | "in": "query",
216 | "name": "key",
217 | "required": true,
218 | "type": "string"
219 | }
220 | ],
221 | "responses": {
222 | "200": {
223 | "description": "Current air quality conditions",
224 | "schema": {
225 | "$ref": "#/definitions/AQCurrentGroup"
226 | }
227 | },
228 | "default": {
229 | "description": "No Data.",
230 | "schema": {
231 | "$ref": "#/definitions/Error"
232 | }
233 | }
234 | },
235 | "summary": "Returns current air quality conditions - Given a City ID.",
236 | "tags": [
237 | "Current Air Quality"
238 | ]
239 | }
240 | },
241 | "/current/airquality?lat={lat}&lon={lon}": {
242 | "get": {
243 | "description": "Returns current air quality conditions.",
244 | "parameters": [
245 | {
246 | "description": "Latitude component of location.",
247 | "format": "double",
248 | "in": "path",
249 | "name": "lat",
250 | "required": true,
251 | "type": "number"
252 | },
253 | {
254 | "description": "Longitude component of location.",
255 | "format": "double",
256 | "in": "path",
257 | "name": "lon",
258 | "required": true,
259 | "type": "number"
260 | },
261 | {
262 | "description": "Wraps return in jsonp callback. Example - callback=func",
263 | "format": "string",
264 | "in": "query",
265 | "name": "callback",
266 | "required": false,
267 | "type": "string"
268 | },
269 | {
270 | "description": "Your registered API key.",
271 | "format": "string",
272 | "in": "query",
273 | "name": "key",
274 | "required": true,
275 | "type": "string"
276 | }
277 | ],
278 | "responses": {
279 | "200": {
280 | "description": "Current air quality conditions",
281 | "schema": {
282 | "$ref": "#/definitions/AQCurrentGroup"
283 | }
284 | },
285 | "default": {
286 | "description": "No Data.",
287 | "schema": {
288 | "$ref": "#/definitions/Error"
289 | }
290 | }
291 | },
292 | "summary": "Returns current air quality conditions - Given a lat/lon.",
293 | "tags": [
294 | "Current Air Quality"
295 | ]
296 | }
297 | },
298 | "/current/airquality?postal_code={postal_code}": {
299 | "get": {
300 | "description": "Returns current air quality conditions.",
301 | "parameters": [
302 | {
303 | "description": "Postal Code. Example: 28546",
304 | "format": "integer",
305 | "in": "path",
306 | "name": "postal_code",
307 | "required": true,
308 | "type": "integer"
309 | },
310 | {
311 | "description": "Country Code (2 letter).",
312 | "format": "string",
313 | "in": "query",
314 | "name": "country",
315 | "required": false,
316 | "type": "string"
317 | },
318 | {
319 | "description": "Wraps return in jsonp callback. Example - callback=func",
320 | "format": "string",
321 | "in": "query",
322 | "name": "callback",
323 | "required": false,
324 | "type": "string"
325 | },
326 | {
327 | "description": "Your registered API key.",
328 | "format": "string",
329 | "in": "query",
330 | "name": "key",
331 | "required": true,
332 | "type": "string"
333 | }
334 | ],
335 | "responses": {
336 | "200": {
337 | "description": "Current air quality conditions",
338 | "schema": {
339 | "$ref": "#/definitions/AQCurrentGroup"
340 | }
341 | },
342 | "default": {
343 | "description": "No Data.",
344 | "schema": {
345 | "$ref": "#/definitions/Error"
346 | }
347 | }
348 | },
349 | "summary": "Returns current air quality conditions - Given a Postal Code.",
350 | "tags": [
351 | "Current Air Quality"
352 | ]
353 | }
354 | },
355 | "/current?cities={cities}": {
356 | "get": {
357 | "description": "Returns a group of Current Observations - Given a list of City IDs. ",
358 | "parameters": [
359 | {
360 | "description": "Comma separated list of City ID's. Example: 4487042, 4494942, 4504871",
361 | "format": "string",
362 | "in": "path",
363 | "name": "cities",
364 | "required": true,
365 | "type": "string"
366 | },
367 | {
368 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
369 | "enum": [
370 | "S",
371 | "I"
372 | ],
373 | "format": "string",
374 | "in": "query",
375 | "name": "units",
376 | "required": false,
377 | "type": "string"
378 | },
379 | {
380 | "description": "Marine stations only (buoys, oil platforms, etc)",
381 | "enum": [
382 | "t"
383 | ],
384 | "format": "string",
385 | "in": "query",
386 | "name": "marine",
387 | "required": false,
388 | "type": "string"
389 | },
390 | {
391 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
392 | "enum": [
393 | "ar",
394 | "az",
395 | "be",
396 | "bg",
397 | "bs",
398 | "ca",
399 | "cs",
400 | "de",
401 | "fi",
402 | "fr",
403 | "el",
404 | "es",
405 | "et",
406 | "hr",
407 | "hu",
408 | "id",
409 | "it",
410 | "is",
411 | "kw",
412 | "nb",
413 | "nl",
414 | "pl",
415 | "pt",
416 | "ro",
417 | "ru",
418 | "sk",
419 | "sl",
420 | "sr",
421 | "sv",
422 | "tr",
423 | "uk",
424 | "zh",
425 | "zh-tw"
426 | ],
427 | "format": "string",
428 | "in": "query",
429 | "name": "lang",
430 | "required": false,
431 | "type": "string"
432 | },
433 | {
434 | "description": "Wraps return in jsonp callback - Example - callback=func",
435 | "format": "string",
436 | "in": "query",
437 | "name": "callback",
438 | "required": false,
439 | "type": "string"
440 | },
441 | {
442 | "description": "Your registered API key.",
443 | "format": "string",
444 | "in": "query",
445 | "name": "key",
446 | "required": true,
447 | "type": "string"
448 | }
449 | ],
450 | "responses": {
451 | "200": {
452 | "description": "An Observation Group object.",
453 | "schema": {
454 | "$ref": "#/definitions/CurrentObsGroup"
455 | }
456 | },
457 | "default": {
458 | "description": "No Data.",
459 | "schema": {
460 | "$ref": "#/definitions/Error"
461 | }
462 | }
463 | },
464 | "summary": "Returns a group of observations given a list of cities",
465 | "tags": [
466 | "Current Weather Data"
467 | ]
468 | }
469 | },
470 | "/current?city={city}&country={country}": {
471 | "get": {
472 | "description": "Returns a Current Observation - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.",
473 | "parameters": [
474 | {
475 | "description": "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
476 | "format": "string",
477 | "in": "path",
478 | "name": "city",
479 | "required": true,
480 | "type": "string"
481 | },
482 | {
483 | "description": "Include 1 hour - minutely forecast in the response",
484 | "enum": [
485 | "minutely"
486 | ],
487 | "format": "string",
488 | "in": "query",
489 | "name": "include",
490 | "required": false,
491 | "type": "string"
492 | },
493 | {
494 | "description": "Full name of state.",
495 | "format": "string",
496 | "in": "query",
497 | "name": "state",
498 | "required": false,
499 | "type": "string"
500 | },
501 | {
502 | "description": "Country Code (2 letter).",
503 | "format": "string",
504 | "in": "path",
505 | "name": "country",
506 | "required": true,
507 | "type": "string"
508 | },
509 | {
510 | "description": "Marine stations only (buoys, oil platforms, etc)",
511 | "enum": [
512 | "t"
513 | ],
514 | "format": "string",
515 | "in": "query",
516 | "name": "marine",
517 | "required": false,
518 | "type": "string"
519 | },
520 | {
521 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
522 | "enum": [
523 | "S",
524 | "I"
525 | ],
526 | "format": "string",
527 | "in": "query",
528 | "name": "units",
529 | "required": false,
530 | "type": "string"
531 | },
532 | {
533 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
534 | "enum": [
535 | "ar",
536 | "az",
537 | "be",
538 | "bg",
539 | "bs",
540 | "ca",
541 | "cs",
542 | "de",
543 | "fi",
544 | "fr",
545 | "el",
546 | "es",
547 | "et",
548 | "hr",
549 | "hu",
550 | "id",
551 | "it",
552 | "is",
553 | "kw",
554 | "nb",
555 | "nl",
556 | "pl",
557 | "pt",
558 | "ro",
559 | "ru",
560 | "sk",
561 | "sl",
562 | "sr",
563 | "sv",
564 | "tr",
565 | "uk",
566 | "zh",
567 | "zh-tw"
568 | ],
569 | "format": "string",
570 | "in": "query",
571 | "name": "lang",
572 | "required": false,
573 | "type": "string"
574 | },
575 | {
576 | "description": "Wraps return in jsonp callback - Example - callback=func",
577 | "format": "string",
578 | "in": "query",
579 | "name": "callback",
580 | "required": false,
581 | "type": "string"
582 | },
583 | {
584 | "description": "Your registered API key.",
585 | "format": "string",
586 | "in": "query",
587 | "name": "key",
588 | "required": true,
589 | "type": "string"
590 | }
591 | ],
592 | "responses": {
593 | "200": {
594 | "description": "An Observation Group object.",
595 | "schema": {
596 | "$ref": "#/definitions/CurrentObsGroup"
597 | }
598 | },
599 | "default": {
600 | "description": "No Data.",
601 | "schema": {
602 | "$ref": "#/definitions/Error"
603 | }
604 | }
605 | },
606 | "summary": "Returns a Current Observation - Given City and/or State, Country.",
607 | "tags": [
608 | "Current Weather Data"
609 | ]
610 | }
611 | },
612 | "/current?city_id={city_id}": {
613 | "get": {
614 | "description": "Returns current weather observation - Given a City ID. ",
615 | "parameters": [
616 | {
617 | "description": "City ID. Example: 4487042",
618 | "format": "string",
619 | "in": "path",
620 | "name": "city_id",
621 | "required": true,
622 | "type": "string"
623 | },
624 | {
625 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
626 | "enum": [
627 | "S",
628 | "I"
629 | ],
630 | "format": "string",
631 | "in": "query",
632 | "name": "units",
633 | "required": false,
634 | "type": "string"
635 | },
636 | {
637 | "description": "Include 1 hour - minutely forecast in the response",
638 | "enum": [
639 | "minutely"
640 | ],
641 | "format": "string",
642 | "in": "query",
643 | "name": "include",
644 | "required": false,
645 | "type": "string"
646 | },
647 | {
648 | "description": "Marine stations only (buoys, oil platforms, etc)",
649 | "enum": [
650 | "t"
651 | ],
652 | "format": "string",
653 | "in": "query",
654 | "name": "marine",
655 | "required": false,
656 | "type": "string"
657 | },
658 | {
659 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
660 | "enum": [
661 | "ar",
662 | "az",
663 | "be",
664 | "bg",
665 | "bs",
666 | "ca",
667 | "cs",
668 | "de",
669 | "fi",
670 | "fr",
671 | "el",
672 | "es",
673 | "et",
674 | "hr",
675 | "hu",
676 | "id",
677 | "it",
678 | "is",
679 | "kw",
680 | "nb",
681 | "nl",
682 | "pl",
683 | "pt",
684 | "ro",
685 | "ru",
686 | "sk",
687 | "sl",
688 | "sr",
689 | "sv",
690 | "tr",
691 | "uk",
692 | "zh",
693 | "zh-tw"
694 | ],
695 | "format": "string",
696 | "in": "query",
697 | "name": "lang",
698 | "required": false,
699 | "type": "string"
700 | },
701 | {
702 | "description": "Wraps return in jsonp callback - Example - callback=func",
703 | "format": "string",
704 | "in": "query",
705 | "name": "callback",
706 | "required": false,
707 | "type": "string"
708 | },
709 | {
710 | "description": "Your registered API key.",
711 | "format": "string",
712 | "in": "query",
713 | "name": "key",
714 | "required": true,
715 | "type": "string"
716 | }
717 | ],
718 | "responses": {
719 | "200": {
720 | "description": "An Observation Group object.",
721 | "schema": {
722 | "$ref": "#/definitions/CurrentObsGroup"
723 | }
724 | },
725 | "default": {
726 | "description": "No Data.",
727 | "schema": {
728 | "$ref": "#/definitions/Error"
729 | }
730 | }
731 | },
732 | "summary": "Returns a current observation by city id.",
733 | "tags": [
734 | "Current Weather Data"
735 | ]
736 | }
737 | },
738 | "/current?lat={lat}&lon={lon}": {
739 | "get": {
740 | "description": "Returns a Current Observation - given a lat, and a lon.",
741 | "parameters": [
742 | {
743 | "description": "Latitude component of location.",
744 | "format": "double",
745 | "in": "path",
746 | "name": "lat",
747 | "required": true,
748 | "type": "number"
749 | },
750 | {
751 | "description": "Longitude component of location.",
752 | "format": "double",
753 | "in": "path",
754 | "name": "lon",
755 | "required": true,
756 | "type": "number"
757 | },
758 | {
759 | "description": "Include 1 hour - minutely forecast in the response",
760 | "enum": [
761 | "minutely"
762 | ],
763 | "format": "string",
764 | "in": "query",
765 | "name": "include",
766 | "required": false,
767 | "type": "string"
768 | },
769 | {
770 | "description": "Marine stations only (buoys, oil platforms, etc)",
771 | "enum": [
772 | "t"
773 | ],
774 | "format": "string",
775 | "in": "query",
776 | "name": "marine",
777 | "required": false,
778 | "type": "string"
779 | },
780 | {
781 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
782 | "enum": [
783 | "S",
784 | "I"
785 | ],
786 | "format": "string",
787 | "in": "query",
788 | "name": "units",
789 | "required": false,
790 | "type": "string"
791 | },
792 | {
793 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
794 | "enum": [
795 | "ar",
796 | "az",
797 | "be",
798 | "bg",
799 | "bs",
800 | "ca",
801 | "cs",
802 | "de",
803 | "fi",
804 | "fr",
805 | "el",
806 | "es",
807 | "et",
808 | "hr",
809 | "hu",
810 | "id",
811 | "it",
812 | "is",
813 | "kw",
814 | "nb",
815 | "nl",
816 | "pl",
817 | "pt",
818 | "ro",
819 | "ru",
820 | "sk",
821 | "sl",
822 | "sr",
823 | "sv",
824 | "tr",
825 | "uk",
826 | "zh",
827 | "zh-tw"
828 | ],
829 | "format": "string",
830 | "in": "query",
831 | "name": "lang",
832 | "required": false,
833 | "type": "string"
834 | },
835 | {
836 | "description": "Wraps return in jsonp callback - Example - callback=func",
837 | "format": "string",
838 | "in": "query",
839 | "name": "callback",
840 | "required": false,
841 | "type": "string"
842 | },
843 | {
844 | "description": "Your registered API key.",
845 | "format": "string",
846 | "in": "query",
847 | "name": "key",
848 | "required": true,
849 | "type": "string"
850 | }
851 | ],
852 | "responses": {
853 | "200": {
854 | "description": "An Observation Group object.",
855 | "schema": {
856 | "$ref": "#/definitions/CurrentObsGroup"
857 | }
858 | },
859 | "default": {
860 | "description": "No Data.",
861 | "schema": {
862 | "$ref": "#/definitions/Error"
863 | }
864 | }
865 | },
866 | "summary": "Returns a Current Observation - Given a lat/lon.",
867 | "tags": [
868 | "Current Weather Data"
869 | ]
870 | }
871 | },
872 | "/current?points={points}": {
873 | "get": {
874 | "description": "Returns a group of Current Observations - Given a list of points (lat1, lon1), (lat2, lon2), (latN, lonN), ...",
875 | "parameters": [
876 | {
877 | "description": "Comma separated list of points. Example: (35.5, -75.5),(45, 65),(45.12, -130.5)",
878 | "format": "string",
879 | "in": "path",
880 | "name": "points",
881 | "required": true,
882 | "type": "string"
883 | },
884 | {
885 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
886 | "enum": [
887 | "S",
888 | "I"
889 | ],
890 | "format": "string",
891 | "in": "query",
892 | "name": "units",
893 | "required": false,
894 | "type": "string"
895 | },
896 | {
897 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
898 | "enum": [
899 | "ar",
900 | "az",
901 | "be",
902 | "bg",
903 | "bs",
904 | "ca",
905 | "cs",
906 | "de",
907 | "fi",
908 | "fr",
909 | "el",
910 | "es",
911 | "et",
912 | "hr",
913 | "hu",
914 | "id",
915 | "it",
916 | "is",
917 | "kw",
918 | "nb",
919 | "nl",
920 | "pl",
921 | "pt",
922 | "ro",
923 | "ru",
924 | "sk",
925 | "sl",
926 | "sr",
927 | "sv",
928 | "tr",
929 | "uk",
930 | "zh",
931 | "zh-tw"
932 | ],
933 | "format": "string",
934 | "in": "query",
935 | "name": "lang",
936 | "required": false,
937 | "type": "string"
938 | },
939 | {
940 | "description": "Wraps return in jsonp callback. Example: callback=func",
941 | "format": "string",
942 | "in": "query",
943 | "name": "callback",
944 | "required": false,
945 | "type": "string"
946 | },
947 | {
948 | "description": "Your registered API key.",
949 | "format": "string",
950 | "in": "query",
951 | "name": "key",
952 | "required": true,
953 | "type": "string"
954 | }
955 | ],
956 | "responses": {
957 | "200": {
958 | "description": "An Observation Group object.",
959 | "schema": {
960 | "$ref": "#/definitions/CurrentObsGroup"
961 | }
962 | },
963 | "default": {
964 | "description": "No Data.",
965 | "schema": {
966 | "$ref": "#/definitions/Error"
967 | }
968 | }
969 | },
970 | "summary": "Returns a group of observations given a list of points in the format (lat1, lon1), (lat2, lon2), (latN, lonN), ...",
971 | "tags": [
972 | "Current Weather Data"
973 | ]
974 | }
975 | },
976 | "/current?postal_code={postal_code}": {
977 | "get": {
978 | "description": "Returns current weather observation - Given a Postal Code. ",
979 | "parameters": [
980 | {
981 | "description": "Postal Code. Example: 28546",
982 | "format": "string",
983 | "in": "path",
984 | "name": "postal_code",
985 | "required": true,
986 | "type": "string"
987 | },
988 | {
989 | "description": "Country Code (2 letter).",
990 | "format": "string",
991 | "in": "query",
992 | "name": "country",
993 | "required": false,
994 | "type": "string"
995 | },
996 | {
997 | "description": "Include 1 hour - minutely forecast in the response",
998 | "enum": [
999 | "minutely"
1000 | ],
1001 | "format": "string",
1002 | "in": "query",
1003 | "name": "include",
1004 | "required": false,
1005 | "type": "string"
1006 | },
1007 | {
1008 | "description": "Marine stations only (buoys, oil platforms, etc)",
1009 | "enum": [
1010 | "t"
1011 | ],
1012 | "format": "string",
1013 | "in": "query",
1014 | "name": "marine",
1015 | "required": false,
1016 | "type": "string"
1017 | },
1018 | {
1019 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
1020 | "enum": [
1021 | "S",
1022 | "I"
1023 | ],
1024 | "format": "string",
1025 | "in": "query",
1026 | "name": "units",
1027 | "required": false,
1028 | "type": "string"
1029 | },
1030 | {
1031 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
1032 | "enum": [
1033 | "ar",
1034 | "az",
1035 | "be",
1036 | "bg",
1037 | "bs",
1038 | "ca",
1039 | "cs",
1040 | "de",
1041 | "fi",
1042 | "fr",
1043 | "el",
1044 | "es",
1045 | "et",
1046 | "hr",
1047 | "hu",
1048 | "id",
1049 | "it",
1050 | "is",
1051 | "kw",
1052 | "nb",
1053 | "nl",
1054 | "pl",
1055 | "pt",
1056 | "ro",
1057 | "ru",
1058 | "sk",
1059 | "sl",
1060 | "sr",
1061 | "sv",
1062 | "tr",
1063 | "uk",
1064 | "zh",
1065 | "zh-tw"
1066 | ],
1067 | "format": "string",
1068 | "in": "query",
1069 | "name": "lang",
1070 | "required": false,
1071 | "type": "string"
1072 | },
1073 | {
1074 | "description": "Wraps return in jsonp callback - Example - callback=func",
1075 | "format": "string",
1076 | "in": "query",
1077 | "name": "callback",
1078 | "required": false,
1079 | "type": "string"
1080 | },
1081 | {
1082 | "description": "Your registered API key.",
1083 | "format": "string",
1084 | "in": "query",
1085 | "name": "key",
1086 | "required": true,
1087 | "type": "string"
1088 | }
1089 | ],
1090 | "responses": {
1091 | "200": {
1092 | "description": "An Observation Group object.",
1093 | "schema": {
1094 | "$ref": "#/definitions/CurrentObsGroup"
1095 | }
1096 | },
1097 | "default": {
1098 | "description": "No Data.",
1099 | "schema": {
1100 | "$ref": "#/definitions/Error"
1101 | }
1102 | }
1103 | },
1104 | "summary": "Returns a current observation by postal code.",
1105 | "tags": [
1106 | "Current Weather Data"
1107 | ]
1108 | }
1109 | },
1110 | "/current?station={station}": {
1111 | "get": {
1112 | "description": "Returns a Current Observation - Given a station ID.",
1113 | "parameters": [
1114 | {
1115 | "description": "Station Call ID.",
1116 | "format": "string",
1117 | "in": "path",
1118 | "name": "station",
1119 | "required": true,
1120 | "type": "string"
1121 | },
1122 | {
1123 | "description": "Include 1 hour - minutely forecast in the response",
1124 | "enum": [
1125 | "minutely"
1126 | ],
1127 | "format": "string",
1128 | "in": "query",
1129 | "name": "include",
1130 | "required": false,
1131 | "type": "string"
1132 | },
1133 | {
1134 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
1135 | "enum": [
1136 | "S",
1137 | "I"
1138 | ],
1139 | "format": "string",
1140 | "in": "query",
1141 | "name": "units",
1142 | "required": false,
1143 | "type": "string"
1144 | },
1145 | {
1146 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
1147 | "enum": [
1148 | "ar",
1149 | "az",
1150 | "be",
1151 | "bg",
1152 | "bs",
1153 | "ca",
1154 | "cs",
1155 | "de",
1156 | "fi",
1157 | "fr",
1158 | "el",
1159 | "es",
1160 | "et",
1161 | "hr",
1162 | "hu",
1163 | "id",
1164 | "it",
1165 | "is",
1166 | "kw",
1167 | "nb",
1168 | "nl",
1169 | "pl",
1170 | "pt",
1171 | "ro",
1172 | "ru",
1173 | "sk",
1174 | "sl",
1175 | "sr",
1176 | "sv",
1177 | "tr",
1178 | "uk",
1179 | "zh",
1180 | "zh-tw"
1181 | ],
1182 | "format": "string",
1183 | "in": "query",
1184 | "name": "lang",
1185 | "required": false,
1186 | "type": "string"
1187 | },
1188 | {
1189 | "description": "Wraps return in jsonp callback. Example: callback=func",
1190 | "format": "string",
1191 | "in": "query",
1192 | "name": "callback",
1193 | "required": false,
1194 | "type": "string"
1195 | },
1196 | {
1197 | "description": "Your registered API key.",
1198 | "format": "string",
1199 | "in": "query",
1200 | "name": "key",
1201 | "required": true,
1202 | "type": "string"
1203 | }
1204 | ],
1205 | "responses": {
1206 | "200": {
1207 | "description": "An Observation Group object.",
1208 | "schema": {
1209 | "$ref": "#/definitions/CurrentObsGroup"
1210 | }
1211 | },
1212 | "default": {
1213 | "description": "No Data.",
1214 | "schema": {
1215 | "$ref": "#/definitions/Error"
1216 | }
1217 | }
1218 | },
1219 | "summary": "Returns a Current Observation. - Given a station ID.",
1220 | "tags": [
1221 | "Current Weather Data"
1222 | ]
1223 | }
1224 | },
1225 | "/current?stations={stations}": {
1226 | "get": {
1227 | "description": "Returns a group of Current Observations - Given a list of Station Call IDs. ",
1228 | "parameters": [
1229 | {
1230 | "description": "Comma separated list of Station Call ID's. Example: KRDU,KBFI,KVNY",
1231 | "format": "string",
1232 | "in": "path",
1233 | "name": "stations",
1234 | "required": true,
1235 | "type": "string"
1236 | },
1237 | {
1238 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
1239 | "enum": [
1240 | "S",
1241 | "I"
1242 | ],
1243 | "format": "string",
1244 | "in": "query",
1245 | "name": "units",
1246 | "required": false,
1247 | "type": "string"
1248 | },
1249 | {
1250 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
1251 | "enum": [
1252 | "ar",
1253 | "az",
1254 | "be",
1255 | "bg",
1256 | "bs",
1257 | "ca",
1258 | "cs",
1259 | "de",
1260 | "fi",
1261 | "fr",
1262 | "el",
1263 | "es",
1264 | "et",
1265 | "hr",
1266 | "hu",
1267 | "id",
1268 | "it",
1269 | "is",
1270 | "kw",
1271 | "nb",
1272 | "nl",
1273 | "pl",
1274 | "pt",
1275 | "ro",
1276 | "ru",
1277 | "sk",
1278 | "sl",
1279 | "sr",
1280 | "sv",
1281 | "tr",
1282 | "uk",
1283 | "zh",
1284 | "zh-tw"
1285 | ],
1286 | "format": "string",
1287 | "in": "query",
1288 | "name": "lang",
1289 | "required": false,
1290 | "type": "string"
1291 | },
1292 | {
1293 | "description": "Wraps return in jsonp callback. Example: callback=func",
1294 | "format": "string",
1295 | "in": "query",
1296 | "name": "callback",
1297 | "required": false,
1298 | "type": "string"
1299 | },
1300 | {
1301 | "description": "Your registered API key.",
1302 | "format": "string",
1303 | "in": "query",
1304 | "name": "key",
1305 | "required": true,
1306 | "type": "string"
1307 | }
1308 | ],
1309 | "responses": {
1310 | "200": {
1311 | "description": "An Observation Group object.",
1312 | "schema": {
1313 | "$ref": "#/definitions/CurrentObsGroup"
1314 | }
1315 | },
1316 | "default": {
1317 | "description": "No Data.",
1318 | "schema": {
1319 | "$ref": "#/definitions/Error"
1320 | }
1321 | }
1322 | },
1323 | "summary": "Returns a group of observations given a list of stations",
1324 | "tags": [
1325 | "Current Weather Data"
1326 | ]
1327 | }
1328 | },
1329 | "/forecast/airquality?city={city}&country={country}": {
1330 | "get": {
1331 | "description": "Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.",
1332 | "parameters": [
1333 | {
1334 | "description": "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
1335 | "format": "string",
1336 | "in": "path",
1337 | "name": "city",
1338 | "required": true,
1339 | "type": "string"
1340 | },
1341 | {
1342 | "description": "Full name of state.",
1343 | "format": "string",
1344 | "in": "query",
1345 | "name": "state",
1346 | "required": false,
1347 | "type": "string"
1348 | },
1349 | {
1350 | "description": "Country Code (2 letter).",
1351 | "format": "string",
1352 | "in": "path",
1353 | "name": "country",
1354 | "required": true,
1355 | "type": "string"
1356 | },
1357 | {
1358 | "description": "Wraps return in jsonp callback. Example: callback=func",
1359 | "format": "string",
1360 | "in": "query",
1361 | "name": "callback",
1362 | "required": false,
1363 | "type": "string"
1364 | },
1365 | {
1366 | "description": "Number of hours to return.",
1367 | "format": "integer",
1368 | "in": "query",
1369 | "name": "hours",
1370 | "required": false,
1371 | "type": "integer"
1372 | },
1373 | {
1374 | "description": "Your registered API key.",
1375 | "format": "string",
1376 | "in": "query",
1377 | "name": "key",
1378 | "required": true,
1379 | "type": "string"
1380 | }
1381 | ],
1382 | "responses": {
1383 | "200": {
1384 | "description": "A forecast object.",
1385 | "schema": {
1386 | "$ref": "#/definitions/AQHourly"
1387 | }
1388 | },
1389 | "default": {
1390 | "description": "No Data.",
1391 | "schema": {
1392 | "$ref": "#/definitions/Error"
1393 | }
1394 | }
1395 | },
1396 | "summary": "Returns 72 hour (hourly) Air Quality forecast - Given City and/or State, Country.",
1397 | "tags": [
1398 | "Air Quality Forecast"
1399 | ]
1400 | }
1401 | },
1402 | "/forecast/airquality?city_id={city_id}": {
1403 | "get": {
1404 | "description": "Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.",
1405 | "parameters": [
1406 | {
1407 | "description": "City ID. Example: 4487042",
1408 | "format": "integer",
1409 | "in": "path",
1410 | "name": "city_id",
1411 | "required": true,
1412 | "type": "integer"
1413 | },
1414 | {
1415 | "description": "Wraps return in jsonp callback. Example - callback=func",
1416 | "format": "string",
1417 | "in": "query",
1418 | "name": "callback",
1419 | "required": false,
1420 | "type": "string"
1421 | },
1422 | {
1423 | "description": "Number of hours to return.",
1424 | "format": "integer",
1425 | "in": "query",
1426 | "name": "hours",
1427 | "required": false,
1428 | "type": "integer"
1429 | },
1430 | {
1431 | "description": "Your registered API key.",
1432 | "format": "string",
1433 | "in": "query",
1434 | "name": "key",
1435 | "required": true,
1436 | "type": "string"
1437 | }
1438 | ],
1439 | "responses": {
1440 | "200": {
1441 | "description": "A forecast object.",
1442 | "schema": {
1443 | "$ref": "#/definitions/AQHourly"
1444 | }
1445 | },
1446 | "default": {
1447 | "description": "No Data.",
1448 | "schema": {
1449 | "$ref": "#/definitions/Error"
1450 | }
1451 | }
1452 | },
1453 | "summary": "Returns 72 hour (hourly) Air Quality forecast - Given a City ID.",
1454 | "tags": [
1455 | "Air Quality Forecast"
1456 | ]
1457 | }
1458 | },
1459 | "/forecast/airquality?lat={lat}&lon={lon}": {
1460 | "get": {
1461 | "description": "Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.",
1462 | "parameters": [
1463 | {
1464 | "description": "Latitude component of location.",
1465 | "format": "double",
1466 | "in": "path",
1467 | "name": "lat",
1468 | "required": true,
1469 | "type": "number"
1470 | },
1471 | {
1472 | "description": "Longitude component of location.",
1473 | "format": "double",
1474 | "in": "path",
1475 | "name": "lon",
1476 | "required": true,
1477 | "type": "number"
1478 | },
1479 | {
1480 | "description": "Wraps return in jsonp callback. Example - callback=func",
1481 | "format": "string",
1482 | "in": "query",
1483 | "name": "callback",
1484 | "required": false,
1485 | "type": "string"
1486 | },
1487 | {
1488 | "description": "Your registered API key.",
1489 | "format": "string",
1490 | "in": "query",
1491 | "name": "key",
1492 | "required": true,
1493 | "type": "string"
1494 | },
1495 | {
1496 | "description": "Number of hours to return.",
1497 | "format": "integer",
1498 | "in": "query",
1499 | "name": "hours",
1500 | "required": false,
1501 | "type": "integer"
1502 | }
1503 | ],
1504 | "responses": {
1505 | "200": {
1506 | "description": "A forecast object.",
1507 | "schema": {
1508 | "$ref": "#/definitions/AQHourly"
1509 | }
1510 | },
1511 | "default": {
1512 | "description": "No Data.",
1513 | "schema": {
1514 | "$ref": "#/definitions/Error"
1515 | }
1516 | }
1517 | },
1518 | "summary": "Returns 72 hour (hourly) Air Quality forecast - Given a lat/lon.",
1519 | "tags": [
1520 | "Air Quality Forecast"
1521 | ]
1522 | }
1523 | },
1524 | "/forecast/airquality?postal_code={postal_code}": {
1525 | "get": {
1526 | "description": "Returns 72 hour (hourly) Air Quality forecast, where each point represents a one hour period.",
1527 | "parameters": [
1528 | {
1529 | "description": "Postal Code. Example: 28546",
1530 | "format": "integer",
1531 | "in": "path",
1532 | "name": "postal_code",
1533 | "required": true,
1534 | "type": "integer"
1535 | },
1536 | {
1537 | "description": "Country Code (2 letter).",
1538 | "format": "string",
1539 | "in": "query",
1540 | "name": "country",
1541 | "required": false,
1542 | "type": "string"
1543 | },
1544 | {
1545 | "description": "Wraps return in jsonp callback. Example - callback=func",
1546 | "format": "string",
1547 | "in": "query",
1548 | "name": "callback",
1549 | "required": false,
1550 | "type": "string"
1551 | },
1552 | {
1553 | "description": "Number of hours to return.",
1554 | "format": "integer",
1555 | "in": "query",
1556 | "name": "hours",
1557 | "required": false,
1558 | "type": "integer"
1559 | },
1560 | {
1561 | "description": "Your registered API key.",
1562 | "format": "string",
1563 | "in": "query",
1564 | "name": "key",
1565 | "required": true,
1566 | "type": "string"
1567 | }
1568 | ],
1569 | "responses": {
1570 | "200": {
1571 | "description": "A forecast object.",
1572 | "schema": {
1573 | "$ref": "#/definitions/AQHourly"
1574 | }
1575 | },
1576 | "default": {
1577 | "description": "No Data.",
1578 | "schema": {
1579 | "$ref": "#/definitions/Error"
1580 | }
1581 | }
1582 | },
1583 | "summary": "Returns 72 hour (hourly) Air Quality forecast - Given a Postal Code.",
1584 | "tags": [
1585 | "Air Quality Forecast"
1586 | ]
1587 | }
1588 | },
1589 | "/forecast/daily?city={city}&country={country}": {
1590 | "get": {
1591 | "description": "Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC. Accepts a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.\n",
1592 | "parameters": [
1593 | {
1594 | "description": "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
1595 | "format": "string",
1596 | "in": "path",
1597 | "name": "city",
1598 | "required": true,
1599 | "type": "string"
1600 | },
1601 | {
1602 | "description": "Full name of state.",
1603 | "format": "string",
1604 | "in": "query",
1605 | "name": "state",
1606 | "required": false,
1607 | "type": "string"
1608 | },
1609 | {
1610 | "description": "Country Code (2 letter).",
1611 | "format": "string",
1612 | "in": "path",
1613 | "name": "country",
1614 | "required": true,
1615 | "type": "string"
1616 | },
1617 | {
1618 | "description": "Number of days to return. Default 16.",
1619 | "format": "integer",
1620 | "in": "query",
1621 | "name": "days",
1622 | "required": false,
1623 | "type": "number"
1624 | },
1625 | {
1626 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
1627 | "enum": [
1628 | "S",
1629 | "I"
1630 | ],
1631 | "format": "string",
1632 | "in": "query",
1633 | "name": "units",
1634 | "required": false,
1635 | "type": "string"
1636 | },
1637 | {
1638 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
1639 | "enum": [
1640 | "ar",
1641 | "az",
1642 | "be",
1643 | "bg",
1644 | "bs",
1645 | "ca",
1646 | "cs",
1647 | "de",
1648 | "fi",
1649 | "fr",
1650 | "el",
1651 | "es",
1652 | "et",
1653 | "hr",
1654 | "hu",
1655 | "id",
1656 | "it",
1657 | "is",
1658 | "kw",
1659 | "nb",
1660 | "nl",
1661 | "pl",
1662 | "pt",
1663 | "ro",
1664 | "ru",
1665 | "sk",
1666 | "sl",
1667 | "sr",
1668 | "sv",
1669 | "tr",
1670 | "uk",
1671 | "zh",
1672 | "zh-tw"
1673 | ],
1674 | "format": "string",
1675 | "in": "query",
1676 | "name": "lang",
1677 | "required": false,
1678 | "type": "string"
1679 | },
1680 | {
1681 | "description": "Wraps return in jsonp callback. Example - callback=func",
1682 | "format": "string",
1683 | "in": "query",
1684 | "name": "callback",
1685 | "required": false,
1686 | "type": "string"
1687 | },
1688 | {
1689 | "description": "Your registered API key.",
1690 | "format": "string",
1691 | "in": "query",
1692 | "name": "key",
1693 | "required": true,
1694 | "type": "string"
1695 | }
1696 | ],
1697 | "responses": {
1698 | "200": {
1699 | "description": "A forecast object.",
1700 | "schema": {
1701 | "$ref": "#/definitions/ForecastDay"
1702 | }
1703 | },
1704 | "default": {
1705 | "description": "No Data.",
1706 | "schema": {
1707 | "$ref": "#/definitions/Error"
1708 | }
1709 | }
1710 | },
1711 | "summary": "Returns a daily forecast - Given City and/or State, Country.",
1712 | "tags": [
1713 | "16 day / daily Forecast"
1714 | ]
1715 | }
1716 | },
1717 | "/forecast/daily?city_id={city_id}": {
1718 | "get": {
1719 | "description": "Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.\n",
1720 | "parameters": [
1721 | {
1722 | "description": "City ID. Example: 4487042",
1723 | "format": "integer",
1724 | "in": "path",
1725 | "name": "city_id",
1726 | "required": true,
1727 | "type": "integer"
1728 | },
1729 | {
1730 | "description": "Number of days to return. Default 16.",
1731 | "format": "integer",
1732 | "in": "query",
1733 | "name": "days",
1734 | "required": false,
1735 | "type": "number"
1736 | },
1737 | {
1738 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
1739 | "enum": [
1740 | "S",
1741 | "I"
1742 | ],
1743 | "format": "string",
1744 | "in": "query",
1745 | "name": "units",
1746 | "required": false,
1747 | "type": "string"
1748 | },
1749 | {
1750 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
1751 | "enum": [
1752 | "ar",
1753 | "az",
1754 | "be",
1755 | "bg",
1756 | "bs",
1757 | "ca",
1758 | "cs",
1759 | "de",
1760 | "fi",
1761 | "fr",
1762 | "el",
1763 | "es",
1764 | "et",
1765 | "hr",
1766 | "hu",
1767 | "id",
1768 | "it",
1769 | "is",
1770 | "kw",
1771 | "nb",
1772 | "nl",
1773 | "pl",
1774 | "pt",
1775 | "ro",
1776 | "ru",
1777 | "sk",
1778 | "sl",
1779 | "sr",
1780 | "sv",
1781 | "tr",
1782 | "uk",
1783 | "zh",
1784 | "zh-tw"
1785 | ],
1786 | "format": "string",
1787 | "in": "query",
1788 | "name": "lang",
1789 | "required": false,
1790 | "type": "string"
1791 | },
1792 | {
1793 | "description": "Wraps return in jsonp callback. Example: callback=func",
1794 | "format": "string",
1795 | "in": "query",
1796 | "name": "callback",
1797 | "required": false,
1798 | "type": "string"
1799 | },
1800 | {
1801 | "description": "Your registered API key.",
1802 | "format": "string",
1803 | "in": "query",
1804 | "name": "key",
1805 | "required": true,
1806 | "type": "string"
1807 | }
1808 | ],
1809 | "responses": {
1810 | "200": {
1811 | "description": "A forecast object.",
1812 | "schema": {
1813 | "$ref": "#/definitions/ForecastDay"
1814 | }
1815 | },
1816 | "default": {
1817 | "description": "No Data.",
1818 | "schema": {
1819 | "$ref": "#/definitions/Error"
1820 | }
1821 | }
1822 | },
1823 | "summary": "Returns a daily forecast - Given a City ID.",
1824 | "tags": [
1825 | "16 day / daily Forecast"
1826 | ]
1827 | }
1828 | },
1829 | "/forecast/daily?lat={lat}&lon={lon}": {
1830 | "get": {
1831 | "description": "Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC. \n",
1832 | "parameters": [
1833 | {
1834 | "description": "Latitude component of location.",
1835 | "format": "double",
1836 | "in": "path",
1837 | "name": "lat",
1838 | "required": true,
1839 | "type": "number"
1840 | },
1841 | {
1842 | "description": "Longitude component of location.",
1843 | "format": "double",
1844 | "in": "path",
1845 | "name": "lon",
1846 | "required": true,
1847 | "type": "number"
1848 | },
1849 | {
1850 | "description": "Number of days to return. Default 16.",
1851 | "format": "integer",
1852 | "in": "query",
1853 | "name": "days",
1854 | "required": false,
1855 | "type": "number"
1856 | },
1857 | {
1858 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
1859 | "enum": [
1860 | "S",
1861 | "I"
1862 | ],
1863 | "format": "string",
1864 | "in": "query",
1865 | "name": "units",
1866 | "required": false,
1867 | "type": "string"
1868 | },
1869 | {
1870 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
1871 | "enum": [
1872 | "ar",
1873 | "az",
1874 | "be",
1875 | "bg",
1876 | "bs",
1877 | "ca",
1878 | "cs",
1879 | "de",
1880 | "fi",
1881 | "fr",
1882 | "el",
1883 | "es",
1884 | "et",
1885 | "hr",
1886 | "hu",
1887 | "id",
1888 | "it",
1889 | "is",
1890 | "kw",
1891 | "nb",
1892 | "nl",
1893 | "pl",
1894 | "pt",
1895 | "ro",
1896 | "ru",
1897 | "sk",
1898 | "sl",
1899 | "sr",
1900 | "sv",
1901 | "tr",
1902 | "uk",
1903 | "zh",
1904 | "zh-tw"
1905 | ],
1906 | "format": "string",
1907 | "in": "query",
1908 | "name": "lang",
1909 | "required": false,
1910 | "type": "string"
1911 | },
1912 | {
1913 | "description": "Wraps return in jsonp callback. Example: callback=func",
1914 | "format": "string",
1915 | "in": "query",
1916 | "name": "callback",
1917 | "required": false,
1918 | "type": "string"
1919 | },
1920 | {
1921 | "description": "Your registered API key.",
1922 | "format": "string",
1923 | "in": "query",
1924 | "name": "key",
1925 | "required": true,
1926 | "type": "string"
1927 | }
1928 | ],
1929 | "responses": {
1930 | "200": {
1931 | "description": "A forecast object.",
1932 | "schema": {
1933 | "$ref": "#/definitions/ForecastDay"
1934 | }
1935 | },
1936 | "default": {
1937 | "description": "No Data.",
1938 | "schema": {
1939 | "$ref": "#/definitions/Error"
1940 | }
1941 | }
1942 | },
1943 | "summary": "Returns a daily forecast - Given Lat/Lon.",
1944 | "tags": [
1945 | "16 day / daily Forecast"
1946 | ]
1947 | }
1948 | },
1949 | "/forecast/daily?postal_code={postal_code}": {
1950 | "get": {
1951 | "description": "Returns a daily forecast, where each point represents one day (24hr) period. Every point has a datetime string in the format \"YYYY-MM-DD\". One day begins at 00:00 UTC, and ends at 23:59 UTC.\n",
1952 | "parameters": [
1953 | {
1954 | "description": "Postal Code. Example: 28546",
1955 | "format": "integer",
1956 | "in": "path",
1957 | "name": "postal_code",
1958 | "required": true,
1959 | "type": "integer"
1960 | },
1961 | {
1962 | "description": "Country Code (2 letter).",
1963 | "format": "string",
1964 | "in": "query",
1965 | "name": "country",
1966 | "required": false,
1967 | "type": "string"
1968 | },
1969 | {
1970 | "description": "Number of days to return. Default 16.",
1971 | "format": "integer",
1972 | "in": "query",
1973 | "name": "days",
1974 | "required": false,
1975 | "type": "number"
1976 | },
1977 | {
1978 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
1979 | "enum": [
1980 | "S",
1981 | "I"
1982 | ],
1983 | "format": "string",
1984 | "in": "query",
1985 | "name": "units",
1986 | "required": false,
1987 | "type": "string"
1988 | },
1989 | {
1990 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
1991 | "enum": [
1992 | "ar",
1993 | "az",
1994 | "be",
1995 | "bg",
1996 | "bs",
1997 | "ca",
1998 | "cs",
1999 | "de",
2000 | "fi",
2001 | "fr",
2002 | "el",
2003 | "es",
2004 | "et",
2005 | "hr",
2006 | "hu",
2007 | "id",
2008 | "it",
2009 | "is",
2010 | "kw",
2011 | "nb",
2012 | "nl",
2013 | "pl",
2014 | "pt",
2015 | "ro",
2016 | "ru",
2017 | "sk",
2018 | "sl",
2019 | "sr",
2020 | "sv",
2021 | "tr",
2022 | "uk",
2023 | "zh",
2024 | "zh-tw"
2025 | ],
2026 | "format": "string",
2027 | "in": "query",
2028 | "name": "lang",
2029 | "required": false,
2030 | "type": "string"
2031 | },
2032 | {
2033 | "description": "Wraps return in jsonp callback. Example: callback=func",
2034 | "format": "string",
2035 | "in": "query",
2036 | "name": "callback",
2037 | "required": false,
2038 | "type": "string"
2039 | },
2040 | {
2041 | "description": "Your registered API key.",
2042 | "format": "string",
2043 | "in": "query",
2044 | "name": "key",
2045 | "required": true,
2046 | "type": "string"
2047 | }
2048 | ],
2049 | "responses": {
2050 | "200": {
2051 | "description": "A forecast object.",
2052 | "schema": {
2053 | "$ref": "#/definitions/ForecastDay"
2054 | }
2055 | },
2056 | "default": {
2057 | "description": "No Data.",
2058 | "schema": {
2059 | "$ref": "#/definitions/Error"
2060 | }
2061 | }
2062 | },
2063 | "summary": "Returns a daily forecast - Given a Postal Code.",
2064 | "tags": [
2065 | "16 day / daily Forecast"
2066 | ]
2067 | }
2068 | },
2069 | "/forecast/energy?lat={lat}&lon={lon}": {
2070 | "get": {
2071 | "description": "Retrieve an 8 day forecast relevant to te Energy Sector (degree days, solar radiation, precipitation, wind).",
2072 | "parameters": [
2073 | {
2074 | "description": "Latitude component of location.",
2075 | "format": "double",
2076 | "in": "path",
2077 | "name": "lat",
2078 | "required": true,
2079 | "type": "number"
2080 | },
2081 | {
2082 | "description": "Longitude component of location.",
2083 | "format": "double",
2084 | "in": "path",
2085 | "name": "lon",
2086 | "required": true,
2087 | "type": "number"
2088 | },
2089 | {
2090 | "description": "Temperature threshold to use to calculate degree days (default 18 C) ",
2091 | "format": "double",
2092 | "in": "query",
2093 | "name": "threshold",
2094 | "required": false,
2095 | "type": "number"
2096 | },
2097 | {
2098 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
2099 | "enum": [
2100 | "S",
2101 | "I"
2102 | ],
2103 | "format": "string",
2104 | "in": "query",
2105 | "name": "units",
2106 | "required": false,
2107 | "type": "string"
2108 | },
2109 | {
2110 | "description": "Time period (default: daily)",
2111 | "enum": [
2112 | "hourly",
2113 | "daily"
2114 | ],
2115 | "format": "string",
2116 | "in": "query",
2117 | "name": "tp",
2118 | "required": false,
2119 | "type": "string"
2120 | },
2121 | {
2122 | "description": "Wraps return in jsonp callback. Example: callback=func",
2123 | "format": "string",
2124 | "in": "query",
2125 | "name": "callback",
2126 | "required": false,
2127 | "type": "string"
2128 | },
2129 | {
2130 | "description": "Your registered API key.",
2131 | "format": "string",
2132 | "in": "query",
2133 | "name": "key",
2134 | "required": true,
2135 | "type": "string"
2136 | }
2137 | ],
2138 | "responses": {
2139 | "200": {
2140 | "description": "An Energy Data Object.",
2141 | "schema": {
2142 | "$ref": "#/definitions/EnergyObsGroupForecast"
2143 | }
2144 | },
2145 | "default": {
2146 | "description": "No Data.",
2147 | "schema": {
2148 | "$ref": "#/definitions/Error"
2149 | }
2150 | }
2151 | },
2152 | "summary": "Returns Energy Forecast API response - Given a single lat/lon. ",
2153 | "tags": [
2154 | "Forecast Degree Day API"
2155 | ]
2156 | }
2157 | },
2158 | "/forecast/hourly?city={city}&country={country}": {
2159 | "get": {
2160 | "description": " Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. Accepts a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.\n",
2161 | "parameters": [
2162 | {
2163 | "description": "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
2164 | "format": "string",
2165 | "in": "path",
2166 | "name": "city",
2167 | "required": true,
2168 | "type": "string"
2169 | },
2170 | {
2171 | "description": "Full name of state.",
2172 | "format": "string",
2173 | "in": "query",
2174 | "name": "state",
2175 | "required": false,
2176 | "type": "string"
2177 | },
2178 | {
2179 | "description": "Country Code (2 letter).",
2180 | "format": "string",
2181 | "in": "path",
2182 | "name": "country",
2183 | "required": true,
2184 | "type": "string"
2185 | },
2186 | {
2187 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
2188 | "enum": [
2189 | "S",
2190 | "I"
2191 | ],
2192 | "format": "string",
2193 | "in": "query",
2194 | "name": "units",
2195 | "required": false,
2196 | "type": "string"
2197 | },
2198 | {
2199 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
2200 | "enum": [
2201 | "ar",
2202 | "az",
2203 | "be",
2204 | "bg",
2205 | "bs",
2206 | "ca",
2207 | "cs",
2208 | "de",
2209 | "fi",
2210 | "fr",
2211 | "el",
2212 | "es",
2213 | "et",
2214 | "hr",
2215 | "hu",
2216 | "id",
2217 | "it",
2218 | "is",
2219 | "kw",
2220 | "nb",
2221 | "nl",
2222 | "pl",
2223 | "pt",
2224 | "ro",
2225 | "ru",
2226 | "sk",
2227 | "sl",
2228 | "sr",
2229 | "sv",
2230 | "tr",
2231 | "uk",
2232 | "zh",
2233 | "zh-tw"
2234 | ],
2235 | "format": "string",
2236 | "in": "query",
2237 | "name": "lang",
2238 | "required": false,
2239 | "type": "string"
2240 | },
2241 | {
2242 | "description": "Wraps return in jsonp callback. Example: callback=func",
2243 | "format": "string",
2244 | "in": "query",
2245 | "name": "callback",
2246 | "required": false,
2247 | "type": "string"
2248 | },
2249 | {
2250 | "description": "Number of hours to return.",
2251 | "format": "integer",
2252 | "in": "query",
2253 | "name": "hours",
2254 | "required": false,
2255 | "type": "integer"
2256 | },
2257 | {
2258 | "description": "Your registered API key.",
2259 | "format": "string",
2260 | "in": "query",
2261 | "name": "key",
2262 | "required": true,
2263 | "type": "string"
2264 | }
2265 | ],
2266 | "responses": {
2267 | "200": {
2268 | "description": "A forecast object.",
2269 | "schema": {
2270 | "$ref": "#/definitions/ForecastHourly"
2271 | }
2272 | },
2273 | "default": {
2274 | "description": "No Data.",
2275 | "schema": {
2276 | "$ref": "#/definitions/Error"
2277 | }
2278 | }
2279 | },
2280 | "summary": "Returns an hourly forecast - Given City and/or State, Country.",
2281 | "tags": [
2282 | "240 hour / hourly Forecast"
2283 | ]
2284 | }
2285 | },
2286 | "/forecast/hourly?city_id={city_id}": {
2287 | "get": {
2288 | "description": " Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. \n",
2289 | "parameters": [
2290 | {
2291 | "description": "City ID. Example: 4487042",
2292 | "format": "integer",
2293 | "in": "path",
2294 | "name": "city_id",
2295 | "required": true,
2296 | "type": "integer"
2297 | },
2298 | {
2299 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
2300 | "enum": [
2301 | "S",
2302 | "I"
2303 | ],
2304 | "format": "string",
2305 | "in": "query",
2306 | "name": "units",
2307 | "required": false,
2308 | "type": "string"
2309 | },
2310 | {
2311 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
2312 | "enum": [
2313 | "ar",
2314 | "az",
2315 | "be",
2316 | "bg",
2317 | "bs",
2318 | "ca",
2319 | "cs",
2320 | "de",
2321 | "fi",
2322 | "fr",
2323 | "el",
2324 | "es",
2325 | "et",
2326 | "hr",
2327 | "hu",
2328 | "id",
2329 | "it",
2330 | "is",
2331 | "kw",
2332 | "nb",
2333 | "nl",
2334 | "pl",
2335 | "pt",
2336 | "ro",
2337 | "ru",
2338 | "sk",
2339 | "sl",
2340 | "sr",
2341 | "sv",
2342 | "tr",
2343 | "uk",
2344 | "zh",
2345 | "zh-tw"
2346 | ],
2347 | "format": "string",
2348 | "in": "query",
2349 | "name": "lang",
2350 | "required": false,
2351 | "type": "string"
2352 | },
2353 | {
2354 | "description": "Wraps return in jsonp callback. Example - callback=func",
2355 | "format": "string",
2356 | "in": "query",
2357 | "name": "callback",
2358 | "required": false,
2359 | "type": "string"
2360 | },
2361 | {
2362 | "description": "Number of hours to return.",
2363 | "format": "integer",
2364 | "in": "query",
2365 | "name": "hours",
2366 | "required": false,
2367 | "type": "integer"
2368 | },
2369 | {
2370 | "description": "Your registered API key.",
2371 | "format": "string",
2372 | "in": "query",
2373 | "name": "key",
2374 | "required": true,
2375 | "type": "string"
2376 | }
2377 | ],
2378 | "responses": {
2379 | "200": {
2380 | "description": "A forecast object.",
2381 | "schema": {
2382 | "$ref": "#/definitions/ForecastHourly"
2383 | }
2384 | },
2385 | "default": {
2386 | "description": "No Data.",
2387 | "schema": {
2388 | "$ref": "#/definitions/Error"
2389 | }
2390 | }
2391 | },
2392 | "summary": "Returns an hourly forecast - Given a City ID.",
2393 | "tags": [
2394 | "240 hour / hourly Forecast"
2395 | ]
2396 | }
2397 | },
2398 | "/forecast/hourly?lat={lat}&lon={lon}": {
2399 | "get": {
2400 | "description": "Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. \n",
2401 | "parameters": [
2402 | {
2403 | "description": "Latitude component of location.",
2404 | "format": "double",
2405 | "in": "path",
2406 | "name": "lat",
2407 | "required": true,
2408 | "type": "number"
2409 | },
2410 | {
2411 | "description": "Longitude component of location.",
2412 | "format": "double",
2413 | "in": "path",
2414 | "name": "lon",
2415 | "required": true,
2416 | "type": "number"
2417 | },
2418 | {
2419 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
2420 | "enum": [
2421 | "S",
2422 | "I"
2423 | ],
2424 | "format": "string",
2425 | "in": "query",
2426 | "name": "units",
2427 | "required": false,
2428 | "type": "string"
2429 | },
2430 | {
2431 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
2432 | "enum": [
2433 | "ar",
2434 | "az",
2435 | "be",
2436 | "bg",
2437 | "bs",
2438 | "ca",
2439 | "cs",
2440 | "de",
2441 | "fi",
2442 | "fr",
2443 | "el",
2444 | "es",
2445 | "et",
2446 | "hr",
2447 | "hu",
2448 | "id",
2449 | "it",
2450 | "is",
2451 | "kw",
2452 | "nb",
2453 | "nl",
2454 | "pl",
2455 | "pt",
2456 | "ro",
2457 | "ru",
2458 | "sk",
2459 | "sl",
2460 | "sr",
2461 | "sv",
2462 | "tr",
2463 | "uk",
2464 | "zh",
2465 | "zh-tw"
2466 | ],
2467 | "format": "string",
2468 | "in": "query",
2469 | "name": "lang",
2470 | "required": false,
2471 | "type": "string"
2472 | },
2473 | {
2474 | "description": "Wraps return in jsonp callback. Example - callback=func",
2475 | "format": "string",
2476 | "in": "query",
2477 | "name": "callback",
2478 | "required": false,
2479 | "type": "string"
2480 | },
2481 | {
2482 | "description": "Your registered API key.",
2483 | "format": "string",
2484 | "in": "query",
2485 | "name": "key",
2486 | "required": true,
2487 | "type": "string"
2488 | },
2489 | {
2490 | "description": "Number of hours to return.",
2491 | "format": "integer",
2492 | "in": "query",
2493 | "name": "hours",
2494 | "required": false,
2495 | "type": "integer"
2496 | }
2497 | ],
2498 | "responses": {
2499 | "200": {
2500 | "description": "A forecast object.",
2501 | "schema": {
2502 | "$ref": "#/definitions/ForecastHourly"
2503 | }
2504 | },
2505 | "default": {
2506 | "description": "No Data.",
2507 | "schema": {
2508 | "$ref": "#/definitions/Error"
2509 | }
2510 | }
2511 | },
2512 | "summary": "Returns an hourly forecast - Given a lat/lon.",
2513 | "tags": [
2514 | "240 hour / hourly Forecast"
2515 | ]
2516 | }
2517 | },
2518 | "/forecast/hourly?postal_code={postal_code}": {
2519 | "get": {
2520 | "description": " Returns an hourly forecast, where each point represents a one hour period. Every point has a datetime string in the format \"YYYY-MM-DD:HH\". Time is UTC. \n",
2521 | "parameters": [
2522 | {
2523 | "description": "Postal Code. Example: 28546",
2524 | "format": "integer",
2525 | "in": "path",
2526 | "name": "postal_code",
2527 | "required": true,
2528 | "type": "integer"
2529 | },
2530 | {
2531 | "description": "Country Code (2 letter).",
2532 | "format": "string",
2533 | "in": "query",
2534 | "name": "country",
2535 | "required": false,
2536 | "type": "string"
2537 | },
2538 | {
2539 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
2540 | "enum": [
2541 | "S",
2542 | "I"
2543 | ],
2544 | "format": "string",
2545 | "in": "query",
2546 | "name": "units",
2547 | "required": false,
2548 | "type": "string"
2549 | },
2550 | {
2551 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
2552 | "enum": [
2553 | "ar",
2554 | "az",
2555 | "be",
2556 | "bg",
2557 | "bs",
2558 | "ca",
2559 | "cs",
2560 | "de",
2561 | "fi",
2562 | "fr",
2563 | "el",
2564 | "es",
2565 | "et",
2566 | "hr",
2567 | "hu",
2568 | "id",
2569 | "it",
2570 | "is",
2571 | "kw",
2572 | "nb",
2573 | "nl",
2574 | "pl",
2575 | "pt",
2576 | "ro",
2577 | "ru",
2578 | "sk",
2579 | "sl",
2580 | "sr",
2581 | "sv",
2582 | "tr",
2583 | "uk",
2584 | "zh",
2585 | "zh-tw"
2586 | ],
2587 | "format": "string",
2588 | "in": "query",
2589 | "name": "lang",
2590 | "required": false,
2591 | "type": "string"
2592 | },
2593 | {
2594 | "description": "Wraps return in jsonp callback. Example - callback=func",
2595 | "format": "string",
2596 | "in": "query",
2597 | "name": "callback",
2598 | "required": false,
2599 | "type": "string"
2600 | },
2601 | {
2602 | "description": "Number of hours to return.",
2603 | "format": "integer",
2604 | "in": "query",
2605 | "name": "hours",
2606 | "required": false,
2607 | "type": "integer"
2608 | },
2609 | {
2610 | "description": "Your registered API key.",
2611 | "format": "string",
2612 | "in": "query",
2613 | "name": "key",
2614 | "required": true,
2615 | "type": "string"
2616 | }
2617 | ],
2618 | "responses": {
2619 | "200": {
2620 | "description": "A forecast object.",
2621 | "schema": {
2622 | "$ref": "#/definitions/ForecastHourly"
2623 | }
2624 | },
2625 | "default": {
2626 | "description": "No Data.",
2627 | "schema": {
2628 | "$ref": "#/definitions/Error"
2629 | }
2630 | }
2631 | },
2632 | "summary": "Returns an hourly forecast - Given a Postal Code.",
2633 | "tags": [
2634 | "240 hour / hourly Forecast"
2635 | ]
2636 | }
2637 | },
2638 | "/history/airquality?city={city}&country={country}": {
2639 | "get": {
2640 | "description": "Returns historical air quality conditions.",
2641 | "parameters": [
2642 | {
2643 | "description": "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
2644 | "format": "string",
2645 | "in": "path",
2646 | "name": "city",
2647 | "required": true,
2648 | "type": "string"
2649 | },
2650 | {
2651 | "description": "Full name of state.",
2652 | "format": "string",
2653 | "in": "query",
2654 | "name": "state",
2655 | "required": false,
2656 | "type": "string"
2657 | },
2658 | {
2659 | "description": "Country Code (2 letter).",
2660 | "format": "string",
2661 | "in": "path",
2662 | "name": "country",
2663 | "required": true,
2664 | "type": "string"
2665 | },
2666 | {
2667 | "description": "Wraps return in jsonp callback. Example: callback=func",
2668 | "format": "string",
2669 | "in": "query",
2670 | "name": "callback",
2671 | "required": false,
2672 | "type": "string"
2673 | },
2674 | {
2675 | "description": "Your registered API key.",
2676 | "format": "string",
2677 | "in": "query",
2678 | "name": "key",
2679 | "required": true,
2680 | "type": "string"
2681 | }
2682 | ],
2683 | "responses": {
2684 | "200": {
2685 | "description": "Historical air quality conditions",
2686 | "schema": {
2687 | "$ref": "#/definitions/AQCurrentGroup"
2688 | }
2689 | },
2690 | "default": {
2691 | "description": "No Data.",
2692 | "schema": {
2693 | "$ref": "#/definitions/Error"
2694 | }
2695 | }
2696 | },
2697 | "summary": "Returns 72 hours of historical quality conditions - Given City and/or State, Country.",
2698 | "tags": [
2699 | "Historical Air Quality"
2700 | ]
2701 | }
2702 | },
2703 | "/history/airquality?city_id={city_id}": {
2704 | "get": {
2705 | "description": "Returns historical air quality conditions.",
2706 | "parameters": [
2707 | {
2708 | "description": "City ID.",
2709 | "format": "double",
2710 | "in": "path",
2711 | "name": "city_id",
2712 | "required": true,
2713 | "type": "number"
2714 | },
2715 | {
2716 | "description": "Wraps return in jsonp callback. Example - callback=func",
2717 | "format": "string",
2718 | "in": "query",
2719 | "name": "callback",
2720 | "required": false,
2721 | "type": "string"
2722 | },
2723 | {
2724 | "description": "Your registered API key.",
2725 | "format": "string",
2726 | "in": "query",
2727 | "name": "key",
2728 | "required": true,
2729 | "type": "string"
2730 | }
2731 | ],
2732 | "responses": {
2733 | "200": {
2734 | "description": "Historical air quality conditions",
2735 | "schema": {
2736 | "$ref": "#/definitions/AQCurrentGroup"
2737 | }
2738 | },
2739 | "default": {
2740 | "description": "No Data.",
2741 | "schema": {
2742 | "$ref": "#/definitions/Error"
2743 | }
2744 | }
2745 | },
2746 | "summary": "Returns 72 hours of historical air quality conditions - Given a City ID.",
2747 | "tags": [
2748 | "Historical Air Quality"
2749 | ]
2750 | }
2751 | },
2752 | "/history/airquality?lat={lat}&lon={lon}": {
2753 | "get": {
2754 | "description": "Returns historical air quality conditions.",
2755 | "parameters": [
2756 | {
2757 | "description": "Latitude component of location.",
2758 | "format": "double",
2759 | "in": "path",
2760 | "name": "lat",
2761 | "required": true,
2762 | "type": "number"
2763 | },
2764 | {
2765 | "description": "Longitude component of location.",
2766 | "format": "double",
2767 | "in": "path",
2768 | "name": "lon",
2769 | "required": true,
2770 | "type": "number"
2771 | },
2772 | {
2773 | "description": "Wraps return in jsonp callback. Example - callback=func",
2774 | "format": "string",
2775 | "in": "query",
2776 | "name": "callback",
2777 | "required": false,
2778 | "type": "string"
2779 | },
2780 | {
2781 | "description": "Your registered API key.",
2782 | "format": "string",
2783 | "in": "query",
2784 | "name": "key",
2785 | "required": true,
2786 | "type": "string"
2787 | }
2788 | ],
2789 | "responses": {
2790 | "200": {
2791 | "description": "Historical air quality conditions",
2792 | "schema": {
2793 | "$ref": "#/definitions/AQCurrentGroup"
2794 | }
2795 | },
2796 | "default": {
2797 | "description": "No Data.",
2798 | "schema": {
2799 | "$ref": "#/definitions/Error"
2800 | }
2801 | }
2802 | },
2803 | "summary": "Returns 72 hours of historical air quality conditions - Given a lat/lon.",
2804 | "tags": [
2805 | "Historical Air Quality"
2806 | ]
2807 | }
2808 | },
2809 | "/history/airquality?postal_code={postal_code}": {
2810 | "get": {
2811 | "description": "Returns historical air quality conditions.",
2812 | "parameters": [
2813 | {
2814 | "description": "Postal Code. Example: 28546",
2815 | "format": "integer",
2816 | "in": "path",
2817 | "name": "postal_code",
2818 | "required": true,
2819 | "type": "integer"
2820 | },
2821 | {
2822 | "description": "Country Code (2 letter).",
2823 | "format": "string",
2824 | "in": "query",
2825 | "name": "country",
2826 | "required": false,
2827 | "type": "string"
2828 | },
2829 | {
2830 | "description": "Wraps return in jsonp callback. Example - callback=func",
2831 | "format": "string",
2832 | "in": "query",
2833 | "name": "callback",
2834 | "required": false,
2835 | "type": "string"
2836 | },
2837 | {
2838 | "description": "Your registered API key.",
2839 | "format": "string",
2840 | "in": "query",
2841 | "name": "key",
2842 | "required": true,
2843 | "type": "string"
2844 | }
2845 | ],
2846 | "responses": {
2847 | "200": {
2848 | "description": "Historical air quality conditions",
2849 | "schema": {
2850 | "$ref": "#/definitions/AQCurrentGroup"
2851 | }
2852 | },
2853 | "default": {
2854 | "description": "No Data.",
2855 | "schema": {
2856 | "$ref": "#/definitions/Error"
2857 | }
2858 | }
2859 | },
2860 | "summary": "Returns 72 hours of historical air quality conditions - Given a Postal Code.",
2861 | "tags": [
2862 | "Historical Air Quality"
2863 | ]
2864 | }
2865 | },
2866 | "/history/daily?city={city}&country={country}": {
2867 | "get": {
2868 | "description": "Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate. **(LIMIT 1 year per request)**",
2869 | "parameters": [
2870 | {
2871 | "description": "City search.. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
2872 | "format": "string",
2873 | "in": "path",
2874 | "name": "city",
2875 | "required": true,
2876 | "type": "string"
2877 | },
2878 | {
2879 | "description": "Full name of state.",
2880 | "format": "string",
2881 | "in": "query",
2882 | "name": "state",
2883 | "required": false,
2884 | "type": "string"
2885 | },
2886 | {
2887 | "description": "Country Code (2 letter).",
2888 | "format": "string",
2889 | "in": "path",
2890 | "name": "country",
2891 | "required": true,
2892 | "type": "string"
2893 | },
2894 | {
2895 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
2896 | "format": "string",
2897 | "in": "query",
2898 | "name": "start_date",
2899 | "required": true,
2900 | "type": "string"
2901 | },
2902 | {
2903 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
2904 | "format": "string",
2905 | "in": "query",
2906 | "name": "end_date",
2907 | "required": true,
2908 | "type": "string"
2909 | },
2910 | {
2911 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
2912 | "enum": [
2913 | "S",
2914 | "I"
2915 | ],
2916 | "format": "string",
2917 | "in": "query",
2918 | "name": "units",
2919 | "required": false,
2920 | "type": "string"
2921 | },
2922 | {
2923 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
2924 | "enum": [
2925 | "ar",
2926 | "az",
2927 | "be",
2928 | "bg",
2929 | "bs",
2930 | "ca",
2931 | "cs",
2932 | "de",
2933 | "fi",
2934 | "fr",
2935 | "el",
2936 | "es",
2937 | "et",
2938 | "hr",
2939 | "hu",
2940 | "id",
2941 | "it",
2942 | "is",
2943 | "kw",
2944 | "nb",
2945 | "nl",
2946 | "pl",
2947 | "pt",
2948 | "ro",
2949 | "ru",
2950 | "sk",
2951 | "sl",
2952 | "sr",
2953 | "sv",
2954 | "tr",
2955 | "uk",
2956 | "zh",
2957 | "zh-tw"
2958 | ],
2959 | "format": "string",
2960 | "in": "query",
2961 | "name": "lang",
2962 | "required": false,
2963 | "type": "string"
2964 | },
2965 | {
2966 | "description": "Wraps return in jsonp callback. Example: callback=func",
2967 | "format": "string",
2968 | "in": "query",
2969 | "name": "callback",
2970 | "required": false,
2971 | "type": "string"
2972 | },
2973 | {
2974 | "description": "Your registered API key.",
2975 | "format": "string",
2976 | "in": "query",
2977 | "name": "key",
2978 | "required": true,
2979 | "type": "string"
2980 | }
2981 | ],
2982 | "responses": {
2983 | "200": {
2984 | "description": "An Historical Day Data Object.",
2985 | "schema": {
2986 | "$ref": "#/definitions/HistoryDay"
2987 | }
2988 | },
2989 | "default": {
2990 | "description": "No Data.",
2991 | "schema": {
2992 | "$ref": "#/definitions/Error"
2993 | }
2994 | }
2995 | },
2996 | "summary": "Returns Historical Observations - Given City and/or State, Country.",
2997 | "tags": [
2998 | "Daily Historical Weather Data"
2999 | ]
3000 | }
3001 | },
3002 | "/history/daily?city_id={city_id}": {
3003 | "get": {
3004 | "description": "Returns Historical Observations - Given a City ID. **(LIMIT 1 year per request)**",
3005 | "parameters": [
3006 | {
3007 | "description": "City ID. Example: 4487042",
3008 | "format": "string",
3009 | "in": "path",
3010 | "name": "city_id",
3011 | "required": true,
3012 | "type": "string"
3013 | },
3014 | {
3015 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
3016 | "format": "string",
3017 | "in": "query",
3018 | "name": "start_date",
3019 | "required": true,
3020 | "type": "string"
3021 | },
3022 | {
3023 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
3024 | "format": "string",
3025 | "in": "query",
3026 | "name": "end_date",
3027 | "required": true,
3028 | "type": "string"
3029 | },
3030 | {
3031 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3032 | "enum": [
3033 | "S",
3034 | "I"
3035 | ],
3036 | "format": "string",
3037 | "in": "query",
3038 | "name": "units",
3039 | "required": false,
3040 | "type": "string"
3041 | },
3042 | {
3043 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
3044 | "enum": [
3045 | "ar",
3046 | "az",
3047 | "be",
3048 | "bg",
3049 | "bs",
3050 | "ca",
3051 | "cs",
3052 | "de",
3053 | "fi",
3054 | "fr",
3055 | "el",
3056 | "es",
3057 | "et",
3058 | "hr",
3059 | "hu",
3060 | "id",
3061 | "it",
3062 | "is",
3063 | "kw",
3064 | "nb",
3065 | "nl",
3066 | "pl",
3067 | "pt",
3068 | "ro",
3069 | "ru",
3070 | "sk",
3071 | "sl",
3072 | "sr",
3073 | "sv",
3074 | "tr",
3075 | "uk",
3076 | "zh",
3077 | "zh-tw"
3078 | ],
3079 | "format": "string",
3080 | "in": "query",
3081 | "name": "lang",
3082 | "required": false,
3083 | "type": "string"
3084 | },
3085 | {
3086 | "description": "Wraps return in jsonp callback. Example: callback=func",
3087 | "format": "string",
3088 | "in": "query",
3089 | "name": "callback",
3090 | "required": false,
3091 | "type": "string"
3092 | },
3093 | {
3094 | "description": "Your registered API key.",
3095 | "format": "string",
3096 | "in": "query",
3097 | "name": "key",
3098 | "required": true,
3099 | "type": "string"
3100 | }
3101 | ],
3102 | "responses": {
3103 | "200": {
3104 | "description": "An Historical Day Data Object.",
3105 | "schema": {
3106 | "$ref": "#/definitions/HistoryDay"
3107 | }
3108 | },
3109 | "default": {
3110 | "description": "No Data.",
3111 | "schema": {
3112 | "$ref": "#/definitions/Error"
3113 | }
3114 | }
3115 | },
3116 | "summary": "Returns Historical Observations - Given a City ID",
3117 | "tags": [
3118 | "Daily Historical Weather Data"
3119 | ]
3120 | }
3121 | },
3122 | "/history/daily?lat={lat}&lon={lon}": {
3123 | "get": {
3124 | "description": "Returns Historical Observations - Given a lat, and lon. **(LIMIT 1 year per request)**",
3125 | "parameters": [
3126 | {
3127 | "description": "Latitude component of location.",
3128 | "format": "double",
3129 | "in": "path",
3130 | "name": "lat",
3131 | "required": true,
3132 | "type": "number"
3133 | },
3134 | {
3135 | "description": "Longitude component of location.",
3136 | "format": "double",
3137 | "in": "path",
3138 | "name": "lon",
3139 | "required": true,
3140 | "type": "number"
3141 | },
3142 | {
3143 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3144 | "format": "string",
3145 | "in": "query",
3146 | "name": "start_date",
3147 | "required": true,
3148 | "type": "string"
3149 | },
3150 | {
3151 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3152 | "format": "string",
3153 | "in": "query",
3154 | "name": "end_date",
3155 | "required": true,
3156 | "type": "string"
3157 | },
3158 | {
3159 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3160 | "enum": [
3161 | "S",
3162 | "I"
3163 | ],
3164 | "format": "string",
3165 | "in": "query",
3166 | "name": "units",
3167 | "required": false,
3168 | "type": "string"
3169 | },
3170 | {
3171 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
3172 | "enum": [
3173 | "ar",
3174 | "az",
3175 | "be",
3176 | "bg",
3177 | "bs",
3178 | "ca",
3179 | "cs",
3180 | "de",
3181 | "fi",
3182 | "fr",
3183 | "el",
3184 | "es",
3185 | "et",
3186 | "hr",
3187 | "hu",
3188 | "id",
3189 | "it",
3190 | "is",
3191 | "kw",
3192 | "nb",
3193 | "nl",
3194 | "pl",
3195 | "pt",
3196 | "ro",
3197 | "ru",
3198 | "sk",
3199 | "sl",
3200 | "sr",
3201 | "sv",
3202 | "tr",
3203 | "uk",
3204 | "zh",
3205 | "zh-tw"
3206 | ],
3207 | "format": "string",
3208 | "in": "query",
3209 | "name": "lang",
3210 | "required": false,
3211 | "type": "string"
3212 | },
3213 | {
3214 | "description": "Wraps return in jsonp callback. Example: callback=func",
3215 | "format": "string",
3216 | "in": "query",
3217 | "name": "callback",
3218 | "required": false,
3219 | "type": "string"
3220 | },
3221 | {
3222 | "description": "Your registered API key.",
3223 | "format": "string",
3224 | "in": "query",
3225 | "name": "key",
3226 | "required": true,
3227 | "type": "string"
3228 | }
3229 | ],
3230 | "responses": {
3231 | "200": {
3232 | "description": "An Historical Day Data Object.",
3233 | "schema": {
3234 | "$ref": "#/definitions/HistoryDay"
3235 | }
3236 | },
3237 | "default": {
3238 | "description": "No Data.",
3239 | "schema": {
3240 | "$ref": "#/definitions/Error"
3241 | }
3242 | }
3243 | },
3244 | "summary": "Returns Historical Observations - Given a lat/lon.",
3245 | "tags": [
3246 | "Daily Historical Weather Data"
3247 | ]
3248 | }
3249 | },
3250 | "/history/daily?postal_code={postal_code}": {
3251 | "get": {
3252 | "description": "Returns Historical Observations - Given a Postal Code. **(LIMIT 1 year per request)**",
3253 | "parameters": [
3254 | {
3255 | "description": "Postal Code. Example: 28546",
3256 | "format": "string",
3257 | "in": "path",
3258 | "name": "postal_code",
3259 | "required": true,
3260 | "type": "string"
3261 | },
3262 | {
3263 | "description": "Country Code (2 letter).",
3264 | "format": "string",
3265 | "in": "query",
3266 | "name": "country",
3267 | "required": false,
3268 | "type": "string"
3269 | },
3270 | {
3271 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
3272 | "format": "string",
3273 | "in": "query",
3274 | "name": "start_date",
3275 | "required": true,
3276 | "type": "string"
3277 | },
3278 | {
3279 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
3280 | "format": "string",
3281 | "in": "query",
3282 | "name": "end_date",
3283 | "required": true,
3284 | "type": "string"
3285 | },
3286 | {
3287 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3288 | "enum": [
3289 | "S",
3290 | "I"
3291 | ],
3292 | "format": "string",
3293 | "in": "query",
3294 | "name": "units",
3295 | "required": false,
3296 | "type": "string"
3297 | },
3298 | {
3299 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
3300 | "enum": [
3301 | "ar",
3302 | "az",
3303 | "be",
3304 | "bg",
3305 | "bs",
3306 | "ca",
3307 | "cs",
3308 | "de",
3309 | "fi",
3310 | "fr",
3311 | "el",
3312 | "es",
3313 | "et",
3314 | "hr",
3315 | "hu",
3316 | "id",
3317 | "it",
3318 | "is",
3319 | "kw",
3320 | "nb",
3321 | "nl",
3322 | "pl",
3323 | "pt",
3324 | "ro",
3325 | "ru",
3326 | "sk",
3327 | "sl",
3328 | "sr",
3329 | "sv",
3330 | "tr",
3331 | "uk",
3332 | "zh",
3333 | "zh-tw"
3334 | ],
3335 | "format": "string",
3336 | "in": "query",
3337 | "name": "lang",
3338 | "required": false,
3339 | "type": "string"
3340 | },
3341 | {
3342 | "description": "Wraps return in jsonp callback. Example: callback=func",
3343 | "format": "string",
3344 | "in": "query",
3345 | "name": "callback",
3346 | "required": false,
3347 | "type": "string"
3348 | },
3349 | {
3350 | "description": "Your registered API key.",
3351 | "format": "string",
3352 | "in": "query",
3353 | "name": "key",
3354 | "required": true,
3355 | "type": "string"
3356 | }
3357 | ],
3358 | "responses": {
3359 | "200": {
3360 | "description": "An Historical Day Data Object.",
3361 | "schema": {
3362 | "$ref": "#/definitions/HistoryDay"
3363 | }
3364 | },
3365 | "default": {
3366 | "description": "No Data.",
3367 | "schema": {
3368 | "$ref": "#/definitions/Error"
3369 | }
3370 | }
3371 | },
3372 | "summary": "Returns Historical Observations - Given a Postal Code",
3373 | "tags": [
3374 | "Daily Historical Weather Data"
3375 | ]
3376 | }
3377 | },
3378 | "/history/daily?station={station}": {
3379 | "get": {
3380 | "description": "Returns Historical Observations - Given a station ID. **(LIMIT 1 year per request)**",
3381 | "parameters": [
3382 | {
3383 | "description": "Station ID.",
3384 | "format": "string",
3385 | "in": "path",
3386 | "name": "station",
3387 | "required": true,
3388 | "type": "string"
3389 | },
3390 | {
3391 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3392 | "format": "string",
3393 | "in": "query",
3394 | "name": "start_date",
3395 | "required": true,
3396 | "type": "string"
3397 | },
3398 | {
3399 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3400 | "format": "string",
3401 | "in": "query",
3402 | "name": "end_date",
3403 | "required": true,
3404 | "type": "string"
3405 | },
3406 | {
3407 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3408 | "enum": [
3409 | "S",
3410 | "I"
3411 | ],
3412 | "format": "string",
3413 | "in": "query",
3414 | "name": "units",
3415 | "required": false,
3416 | "type": "string"
3417 | },
3418 | {
3419 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
3420 | "enum": [
3421 | "ar",
3422 | "az",
3423 | "be",
3424 | "bg",
3425 | "bs",
3426 | "ca",
3427 | "cs",
3428 | "de",
3429 | "fi",
3430 | "fr",
3431 | "el",
3432 | "es",
3433 | "et",
3434 | "hr",
3435 | "hu",
3436 | "id",
3437 | "it",
3438 | "is",
3439 | "kw",
3440 | "nb",
3441 | "nl",
3442 | "pl",
3443 | "pt",
3444 | "ro",
3445 | "ru",
3446 | "sk",
3447 | "sl",
3448 | "sr",
3449 | "sv",
3450 | "tr",
3451 | "uk",
3452 | "zh",
3453 | "zh-tw"
3454 | ],
3455 | "format": "string",
3456 | "in": "query",
3457 | "name": "lang",
3458 | "required": false,
3459 | "type": "string"
3460 | },
3461 | {
3462 | "description": "Wraps return in jsonp callback. Example: callback=func",
3463 | "format": "string",
3464 | "in": "query",
3465 | "name": "callback",
3466 | "required": false,
3467 | "type": "string"
3468 | },
3469 | {
3470 | "description": "Your registered API key.",
3471 | "format": "string",
3472 | "in": "query",
3473 | "name": "key",
3474 | "required": true,
3475 | "type": "string"
3476 | }
3477 | ],
3478 | "responses": {
3479 | "200": {
3480 | "description": "An Historical Day Data Object.",
3481 | "schema": {
3482 | "$ref": "#/definitions/HistoryDay"
3483 | }
3484 | },
3485 | "default": {
3486 | "description": "No Data.",
3487 | "schema": {
3488 | "$ref": "#/definitions/Error"
3489 | }
3490 | }
3491 | },
3492 | "summary": "Returns Historical Observations - Given a station ID.",
3493 | "tags": [
3494 | "Daily Historical Weather Data"
3495 | ]
3496 | }
3497 | },
3498 | "/history/energy?lat={lat}&lon={lon}": {
3499 | "get": {
3500 | "description": "Returns aggregate energy specific historical weather fields, over a specified time period.",
3501 | "parameters": [
3502 | {
3503 | "description": "Latitude component of location.",
3504 | "format": "double",
3505 | "in": "path",
3506 | "name": "lat",
3507 | "required": true,
3508 | "type": "number"
3509 | },
3510 | {
3511 | "description": "Longitude component of location.",
3512 | "format": "double",
3513 | "in": "path",
3514 | "name": "lon",
3515 | "required": true,
3516 | "type": "number"
3517 | },
3518 | {
3519 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3520 | "format": "string",
3521 | "in": "query",
3522 | "name": "start_date",
3523 | "required": true,
3524 | "type": "string"
3525 | },
3526 | {
3527 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3528 | "format": "string",
3529 | "in": "query",
3530 | "name": "end_date",
3531 | "required": true,
3532 | "type": "string"
3533 | },
3534 | {
3535 | "description": "Time period to aggregate by (daily, monthly)",
3536 | "enum": [
3537 | "hourly",
3538 | "daily",
3539 | "monthly"
3540 | ],
3541 | "format": "string",
3542 | "in": "query",
3543 | "name": "tp",
3544 | "required": false,
3545 | "type": "string"
3546 | },
3547 | {
3548 | "description": "Temperature threshold to use to calculate degree days (default 18 C) ",
3549 | "format": "double",
3550 | "in": "query",
3551 | "name": "threshold",
3552 | "required": false,
3553 | "type": "number"
3554 | },
3555 | {
3556 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3557 | "enum": [
3558 | "S",
3559 | "I"
3560 | ],
3561 | "format": "string",
3562 | "in": "query",
3563 | "name": "units",
3564 | "required": false,
3565 | "type": "string"
3566 | },
3567 | {
3568 | "description": "Wraps return in jsonp callback. Example: callback=func",
3569 | "format": "string",
3570 | "in": "query",
3571 | "name": "callback",
3572 | "required": false,
3573 | "type": "string"
3574 | },
3575 | {
3576 | "description": "Your registered API key.",
3577 | "format": "string",
3578 | "in": "query",
3579 | "name": "key",
3580 | "required": true,
3581 | "type": "string"
3582 | }
3583 | ],
3584 | "responses": {
3585 | "200": {
3586 | "description": "An Energy Data Object.",
3587 | "schema": {
3588 | "$ref": "#/definitions/EnergyObsGroup"
3589 | }
3590 | },
3591 | "default": {
3592 | "description": "No Data.",
3593 | "schema": {
3594 | "$ref": "#/definitions/Error"
3595 | }
3596 | }
3597 | },
3598 | "summary": "Returns Energy API response - Given a single lat/lon. ",
3599 | "tags": [
3600 | "Historical Degree Day API"
3601 | ]
3602 | }
3603 | },
3604 | "/history/hourly?city={city}&country={country}": {
3605 | "get": {
3606 | "description": "Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate. **(LIMIT 31 days per request)**",
3607 | "parameters": [
3608 | {
3609 | "description": "City search. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
3610 | "format": "string",
3611 | "in": "path",
3612 | "name": "city",
3613 | "required": true,
3614 | "type": "string"
3615 | },
3616 | {
3617 | "description": "Full name of state.",
3618 | "format": "string",
3619 | "in": "query",
3620 | "name": "state",
3621 | "required": false,
3622 | "type": "string"
3623 | },
3624 | {
3625 | "description": "Country Code (2 letter).",
3626 | "format": "string",
3627 | "in": "path",
3628 | "name": "country",
3629 | "required": true,
3630 | "type": "string"
3631 | },
3632 | {
3633 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3634 | "format": "string",
3635 | "in": "query",
3636 | "name": "start_date",
3637 | "required": true,
3638 | "type": "string"
3639 | },
3640 | {
3641 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3642 | "format": "string",
3643 | "in": "query",
3644 | "name": "end_date",
3645 | "required": true,
3646 | "type": "string"
3647 | },
3648 | {
3649 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3650 | "enum": [
3651 | "S",
3652 | "I"
3653 | ],
3654 | "format": "string",
3655 | "in": "query",
3656 | "name": "units",
3657 | "required": false,
3658 | "type": "string"
3659 | },
3660 | {
3661 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
3662 | "enum": [
3663 | "ar",
3664 | "az",
3665 | "be",
3666 | "bg",
3667 | "bs",
3668 | "ca",
3669 | "cs",
3670 | "de",
3671 | "fi",
3672 | "fr",
3673 | "el",
3674 | "es",
3675 | "et",
3676 | "hr",
3677 | "hu",
3678 | "id",
3679 | "it",
3680 | "is",
3681 | "kw",
3682 | "nb",
3683 | "nl",
3684 | "pl",
3685 | "pt",
3686 | "ro",
3687 | "ru",
3688 | "sk",
3689 | "sl",
3690 | "sr",
3691 | "sv",
3692 | "tr",
3693 | "uk",
3694 | "zh",
3695 | "zh-tw"
3696 | ],
3697 | "format": "string",
3698 | "in": "query",
3699 | "name": "lang",
3700 | "required": false,
3701 | "type": "string"
3702 | },
3703 | {
3704 | "description": "Assume utc (default) or local time for start_date, end_date",
3705 | "enum": [
3706 | "local",
3707 | "utc"
3708 | ],
3709 | "format": "string",
3710 | "in": "query",
3711 | "name": "tz",
3712 | "required": false,
3713 | "type": "string"
3714 | },
3715 | {
3716 | "description": "Wraps return in jsonp callback. Example: callback=func",
3717 | "format": "string",
3718 | "in": "query",
3719 | "name": "callback",
3720 | "required": false,
3721 | "type": "string"
3722 | },
3723 | {
3724 | "description": "Your registered API key.",
3725 | "format": "string",
3726 | "in": "query",
3727 | "name": "key",
3728 | "required": true,
3729 | "type": "string"
3730 | }
3731 | ],
3732 | "responses": {
3733 | "200": {
3734 | "description": "An Historical Data Object.",
3735 | "schema": {
3736 | "$ref": "#/definitions/History"
3737 | }
3738 | },
3739 | "default": {
3740 | "description": "No Data.",
3741 | "schema": {
3742 | "$ref": "#/definitions/Error"
3743 | }
3744 | }
3745 | },
3746 | "summary": "Returns Historical Observations - Given City and/or State, Country.",
3747 | "tags": [
3748 | "Hourly Historical Weather Data"
3749 | ]
3750 | }
3751 | },
3752 | "/history/hourly?city_id={city_id}": {
3753 | "get": {
3754 | "description": "Returns Historical Observations - Given a City ID. **(LIMIT 31 days per request)**",
3755 | "parameters": [
3756 | {
3757 | "description": "City ID. Example: 4487042",
3758 | "format": "string",
3759 | "in": "path",
3760 | "name": "city_id",
3761 | "required": true,
3762 | "type": "string"
3763 | },
3764 | {
3765 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
3766 | "format": "string",
3767 | "in": "query",
3768 | "name": "start_date",
3769 | "required": true,
3770 | "type": "string"
3771 | },
3772 | {
3773 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
3774 | "format": "string",
3775 | "in": "query",
3776 | "name": "end_date",
3777 | "required": true,
3778 | "type": "string"
3779 | },
3780 | {
3781 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3782 | "enum": [
3783 | "S",
3784 | "I"
3785 | ],
3786 | "format": "string",
3787 | "in": "query",
3788 | "name": "units",
3789 | "required": false,
3790 | "type": "string"
3791 | },
3792 | {
3793 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
3794 | "enum": [
3795 | "ar",
3796 | "az",
3797 | "be",
3798 | "bg",
3799 | "bs",
3800 | "ca",
3801 | "cs",
3802 | "de",
3803 | "fi",
3804 | "fr",
3805 | "el",
3806 | "es",
3807 | "et",
3808 | "hr",
3809 | "hu",
3810 | "id",
3811 | "it",
3812 | "is",
3813 | "kw",
3814 | "nb",
3815 | "nl",
3816 | "pl",
3817 | "pt",
3818 | "ro",
3819 | "ru",
3820 | "sk",
3821 | "sl",
3822 | "sr",
3823 | "sv",
3824 | "tr",
3825 | "uk",
3826 | "zh",
3827 | "zh-tw"
3828 | ],
3829 | "format": "string",
3830 | "in": "query",
3831 | "name": "lang",
3832 | "required": false,
3833 | "type": "string"
3834 | },
3835 | {
3836 | "description": "Assume utc (default) or local time for start_date, end_date",
3837 | "enum": [
3838 | "local",
3839 | "utc"
3840 | ],
3841 | "format": "string",
3842 | "in": "query",
3843 | "name": "tz",
3844 | "required": false,
3845 | "type": "string"
3846 | },
3847 | {
3848 | "description": "Wraps return in jsonp callback. Example: callback=func",
3849 | "format": "string",
3850 | "in": "query",
3851 | "name": "callback",
3852 | "required": false,
3853 | "type": "string"
3854 | },
3855 | {
3856 | "description": "Your registered API key.",
3857 | "format": "string",
3858 | "in": "query",
3859 | "name": "key",
3860 | "required": true,
3861 | "type": "string"
3862 | }
3863 | ],
3864 | "responses": {
3865 | "200": {
3866 | "description": "An Historical Data Object.",
3867 | "schema": {
3868 | "$ref": "#/definitions/History"
3869 | }
3870 | },
3871 | "default": {
3872 | "description": "No Data.",
3873 | "schema": {
3874 | "$ref": "#/definitions/Error"
3875 | }
3876 | }
3877 | },
3878 | "summary": "Returns Historical Observations - Given a City ID",
3879 | "tags": [
3880 | "Hourly Historical Weather Data"
3881 | ]
3882 | }
3883 | },
3884 | "/history/hourly?lat={lat}&lon={lon}": {
3885 | "get": {
3886 | "description": "Returns Historical Observations - Given a lat, and lon. **(LIMIT 31 days per request)**",
3887 | "parameters": [
3888 | {
3889 | "description": "Latitude component of location.",
3890 | "format": "double",
3891 | "in": "path",
3892 | "name": "lat",
3893 | "required": true,
3894 | "type": "number"
3895 | },
3896 | {
3897 | "description": "Longitude component of location.",
3898 | "format": "double",
3899 | "in": "path",
3900 | "name": "lon",
3901 | "required": true,
3902 | "type": "number"
3903 | },
3904 | {
3905 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3906 | "format": "string",
3907 | "in": "query",
3908 | "name": "start_date",
3909 | "required": true,
3910 | "type": "string"
3911 | },
3912 | {
3913 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
3914 | "format": "string",
3915 | "in": "query",
3916 | "name": "end_date",
3917 | "required": true,
3918 | "type": "string"
3919 | },
3920 | {
3921 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
3922 | "enum": [
3923 | "S",
3924 | "I"
3925 | ],
3926 | "format": "string",
3927 | "in": "query",
3928 | "name": "units",
3929 | "required": false,
3930 | "type": "string"
3931 | },
3932 | {
3933 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
3934 | "enum": [
3935 | "ar",
3936 | "az",
3937 | "be",
3938 | "bg",
3939 | "bs",
3940 | "ca",
3941 | "cs",
3942 | "de",
3943 | "fi",
3944 | "fr",
3945 | "el",
3946 | "es",
3947 | "et",
3948 | "hr",
3949 | "hu",
3950 | "id",
3951 | "it",
3952 | "is",
3953 | "kw",
3954 | "nb",
3955 | "nl",
3956 | "pl",
3957 | "pt",
3958 | "ro",
3959 | "ru",
3960 | "sk",
3961 | "sl",
3962 | "sr",
3963 | "sv",
3964 | "tr",
3965 | "uk",
3966 | "zh",
3967 | "zh-tw"
3968 | ],
3969 | "format": "string",
3970 | "in": "query",
3971 | "name": "lang",
3972 | "required": false,
3973 | "type": "string"
3974 | },
3975 | {
3976 | "description": "Assume utc (default) or local time for start_date, end_date",
3977 | "enum": [
3978 | "local",
3979 | "utc"
3980 | ],
3981 | "format": "string",
3982 | "in": "query",
3983 | "name": "tz",
3984 | "required": false,
3985 | "type": "string"
3986 | },
3987 | {
3988 | "description": "Wraps return in jsonp callback. Example: callback=func",
3989 | "format": "string",
3990 | "in": "query",
3991 | "name": "callback",
3992 | "required": false,
3993 | "type": "string"
3994 | },
3995 | {
3996 | "description": "Your registered API key.",
3997 | "format": "string",
3998 | "in": "query",
3999 | "name": "key",
4000 | "required": true,
4001 | "type": "string"
4002 | }
4003 | ],
4004 | "responses": {
4005 | "200": {
4006 | "description": "An Historical Data Object.",
4007 | "schema": {
4008 | "$ref": "#/definitions/History"
4009 | }
4010 | },
4011 | "default": {
4012 | "description": "No Data.",
4013 | "schema": {
4014 | "$ref": "#/definitions/Error"
4015 | }
4016 | }
4017 | },
4018 | "summary": "Returns Historical Observations - Given a lat/lon.",
4019 | "tags": [
4020 | "Hourly Historical Weather Data"
4021 | ]
4022 | }
4023 | },
4024 | "/history/hourly?postal_code={postal_code}": {
4025 | "get": {
4026 | "description": "Returns Historical Observations - Given a Postal Code. **(LIMIT 31 days per request)**",
4027 | "parameters": [
4028 | {
4029 | "description": "Postal Code. Example: 28546",
4030 | "format": "string",
4031 | "in": "path",
4032 | "name": "postal_code",
4033 | "required": true,
4034 | "type": "string"
4035 | },
4036 | {
4037 | "description": "Country Code (2 letter).",
4038 | "format": "string",
4039 | "in": "query",
4040 | "name": "country",
4041 | "required": false,
4042 | "type": "string"
4043 | },
4044 | {
4045 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
4046 | "format": "string",
4047 | "in": "query",
4048 | "name": "start_date",
4049 | "required": true,
4050 | "type": "string"
4051 | },
4052 | {
4053 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
4054 | "format": "string",
4055 | "in": "query",
4056 | "name": "end_date",
4057 | "required": true,
4058 | "type": "string"
4059 | },
4060 | {
4061 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
4062 | "enum": [
4063 | "S",
4064 | "I"
4065 | ],
4066 | "format": "string",
4067 | "in": "query",
4068 | "name": "units",
4069 | "required": false,
4070 | "type": "string"
4071 | },
4072 | {
4073 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
4074 | "enum": [
4075 | "ar",
4076 | "az",
4077 | "be",
4078 | "bg",
4079 | "bs",
4080 | "ca",
4081 | "cs",
4082 | "de",
4083 | "fi",
4084 | "fr",
4085 | "el",
4086 | "es",
4087 | "et",
4088 | "hr",
4089 | "hu",
4090 | "id",
4091 | "it",
4092 | "is",
4093 | "kw",
4094 | "nb",
4095 | "nl",
4096 | "pl",
4097 | "pt",
4098 | "ro",
4099 | "ru",
4100 | "sk",
4101 | "sl",
4102 | "sr",
4103 | "sv",
4104 | "tr",
4105 | "uk",
4106 | "zh",
4107 | "zh-tw"
4108 | ],
4109 | "format": "string",
4110 | "in": "query",
4111 | "name": "lang",
4112 | "required": false,
4113 | "type": "string"
4114 | },
4115 | {
4116 | "description": "Assume utc (default) or local time for start_date, end_date",
4117 | "enum": [
4118 | "local",
4119 | "utc"
4120 | ],
4121 | "format": "string",
4122 | "in": "query",
4123 | "name": "tz",
4124 | "required": false,
4125 | "type": "string"
4126 | },
4127 | {
4128 | "description": "Wraps return in jsonp callback. Example: callback=func",
4129 | "format": "string",
4130 | "in": "query",
4131 | "name": "callback",
4132 | "required": false,
4133 | "type": "string"
4134 | },
4135 | {
4136 | "description": "Your registered API key.",
4137 | "format": "string",
4138 | "in": "query",
4139 | "name": "key",
4140 | "required": true,
4141 | "type": "string"
4142 | }
4143 | ],
4144 | "responses": {
4145 | "200": {
4146 | "description": "An Historical Data Object.",
4147 | "schema": {
4148 | "$ref": "#/definitions/History"
4149 | }
4150 | },
4151 | "default": {
4152 | "description": "No Data.",
4153 | "schema": {
4154 | "$ref": "#/definitions/Error"
4155 | }
4156 | }
4157 | },
4158 | "summary": "Returns Historical Observations - Given a Postal Code",
4159 | "tags": [
4160 | "Hourly Historical Weather Data"
4161 | ]
4162 | }
4163 | },
4164 | "/history/hourly?station={station}": {
4165 | "get": {
4166 | "description": "Returns Historical Observations - Given a station ID. **(LIMIT 31 days per request)**",
4167 | "parameters": [
4168 | {
4169 | "description": "Station ID.",
4170 | "format": "string",
4171 | "in": "path",
4172 | "name": "station",
4173 | "required": true,
4174 | "type": "string"
4175 | },
4176 | {
4177 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4178 | "format": "string",
4179 | "in": "query",
4180 | "name": "start_date",
4181 | "required": true,
4182 | "type": "string"
4183 | },
4184 | {
4185 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4186 | "format": "string",
4187 | "in": "query",
4188 | "name": "end_date",
4189 | "required": true,
4190 | "type": "string"
4191 | },
4192 | {
4193 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
4194 | "enum": [
4195 | "S",
4196 | "I"
4197 | ],
4198 | "format": "string",
4199 | "in": "query",
4200 | "name": "units",
4201 | "required": false,
4202 | "type": "string"
4203 | },
4204 | {
4205 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
4206 | "enum": [
4207 | "ar",
4208 | "az",
4209 | "be",
4210 | "bg",
4211 | "bs",
4212 | "ca",
4213 | "cs",
4214 | "de",
4215 | "fi",
4216 | "fr",
4217 | "el",
4218 | "es",
4219 | "et",
4220 | "hr",
4221 | "hu",
4222 | "id",
4223 | "it",
4224 | "is",
4225 | "kw",
4226 | "nb",
4227 | "nl",
4228 | "pl",
4229 | "pt",
4230 | "ro",
4231 | "ru",
4232 | "sk",
4233 | "sl",
4234 | "sr",
4235 | "sv",
4236 | "tr",
4237 | "uk",
4238 | "zh",
4239 | "zh-tw"
4240 | ],
4241 | "format": "string",
4242 | "in": "query",
4243 | "name": "lang",
4244 | "required": false,
4245 | "type": "string"
4246 | },
4247 | {
4248 | "description": "Assume utc (default) or local time for start_date, end_date",
4249 | "enum": [
4250 | "local",
4251 | "utc"
4252 | ],
4253 | "format": "string",
4254 | "in": "query",
4255 | "name": "tz",
4256 | "required": false,
4257 | "type": "string"
4258 | },
4259 | {
4260 | "description": "Wraps return in jsonp callback. Example: callback=func",
4261 | "format": "string",
4262 | "in": "query",
4263 | "name": "callback",
4264 | "required": false,
4265 | "type": "string"
4266 | },
4267 | {
4268 | "description": "Your registered API key.",
4269 | "format": "string",
4270 | "in": "query",
4271 | "name": "key",
4272 | "required": true,
4273 | "type": "string"
4274 | }
4275 | ],
4276 | "responses": {
4277 | "200": {
4278 | "description": "An Historical Data Object.",
4279 | "schema": {
4280 | "$ref": "#/definitions/History"
4281 | }
4282 | },
4283 | "default": {
4284 | "description": "No Data.",
4285 | "schema": {
4286 | "$ref": "#/definitions/Error"
4287 | }
4288 | }
4289 | },
4290 | "summary": "Returns Historical Observations - Given a station ID.",
4291 | "tags": [
4292 | "Hourly Historical Weather Data"
4293 | ]
4294 | }
4295 | },
4296 | "/history/subhourly?city={city}&country={country}": {
4297 | "get": {
4298 | "description": "Returns Historical Observations - Given a city in the format of City,ST or City. The state, and country parameters can be provided to make the search more accurate.",
4299 | "parameters": [
4300 | {
4301 | "description": "City search. Example - &city=Raleigh,NC or &city=Berlin,DE or city=Paris&country=FR",
4302 | "format": "string",
4303 | "in": "path",
4304 | "name": "city",
4305 | "required": true,
4306 | "type": "string"
4307 | },
4308 | {
4309 | "description": "Full name of state.",
4310 | "format": "string",
4311 | "in": "query",
4312 | "name": "state",
4313 | "required": false,
4314 | "type": "string"
4315 | },
4316 | {
4317 | "description": "Country Code (2 letter).",
4318 | "format": "string",
4319 | "in": "path",
4320 | "name": "country",
4321 | "required": true,
4322 | "type": "string"
4323 | },
4324 | {
4325 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4326 | "format": "string",
4327 | "in": "query",
4328 | "name": "start_date",
4329 | "required": true,
4330 | "type": "string"
4331 | },
4332 | {
4333 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4334 | "format": "string",
4335 | "in": "query",
4336 | "name": "end_date",
4337 | "required": true,
4338 | "type": "string"
4339 | },
4340 | {
4341 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
4342 | "enum": [
4343 | "S",
4344 | "I"
4345 | ],
4346 | "format": "string",
4347 | "in": "query",
4348 | "name": "units",
4349 | "required": false,
4350 | "type": "string"
4351 | },
4352 | {
4353 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
4354 | "enum": [
4355 | "ar",
4356 | "az",
4357 | "be",
4358 | "bg",
4359 | "bs",
4360 | "ca",
4361 | "cs",
4362 | "de",
4363 | "fi",
4364 | "fr",
4365 | "el",
4366 | "es",
4367 | "et",
4368 | "hr",
4369 | "hu",
4370 | "id",
4371 | "it",
4372 | "is",
4373 | "kw",
4374 | "nb",
4375 | "nl",
4376 | "pl",
4377 | "pt",
4378 | "ro",
4379 | "ru",
4380 | "sk",
4381 | "sl",
4382 | "sr",
4383 | "sv",
4384 | "tr",
4385 | "uk",
4386 | "zh",
4387 | "zh-tw"
4388 | ],
4389 | "format": "string",
4390 | "in": "query",
4391 | "name": "lang",
4392 | "required": false,
4393 | "type": "string"
4394 | },
4395 | {
4396 | "description": "Assume utc (default) or local time for start_date, end_date",
4397 | "enum": [
4398 | "local",
4399 | "utc"
4400 | ],
4401 | "format": "string",
4402 | "in": "query",
4403 | "name": "tz",
4404 | "required": false,
4405 | "type": "string"
4406 | },
4407 | {
4408 | "description": "Wraps return in jsonp callback. Example: callback=func",
4409 | "format": "string",
4410 | "in": "query",
4411 | "name": "callback",
4412 | "required": false,
4413 | "type": "string"
4414 | },
4415 | {
4416 | "description": "Your registered API key.",
4417 | "format": "string",
4418 | "in": "query",
4419 | "name": "key",
4420 | "required": true,
4421 | "type": "string"
4422 | }
4423 | ],
4424 | "responses": {
4425 | "200": {
4426 | "description": "An Historical Data Object.",
4427 | "schema": {
4428 | "$ref": "#/definitions/History"
4429 | }
4430 | },
4431 | "default": {
4432 | "description": "No Data.",
4433 | "schema": {
4434 | "$ref": "#/definitions/Error"
4435 | }
4436 | }
4437 | },
4438 | "summary": "Returns Historical Observations - Given City and/or State, Country.",
4439 | "tags": [
4440 | "Sub-Hourly Historical Weather Data"
4441 | ]
4442 | }
4443 | },
4444 | "/history/subhourly?city_id={city_id}": {
4445 | "get": {
4446 | "description": "Returns Historical Observations - Given a City ID.",
4447 | "parameters": [
4448 | {
4449 | "description": "City ID. Example: 4487042",
4450 | "format": "string",
4451 | "in": "path",
4452 | "name": "city_id",
4453 | "required": true,
4454 | "type": "string"
4455 | },
4456 | {
4457 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
4458 | "format": "string",
4459 | "in": "query",
4460 | "name": "start_date",
4461 | "required": true,
4462 | "type": "string"
4463 | },
4464 | {
4465 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
4466 | "format": "string",
4467 | "in": "query",
4468 | "name": "end_date",
4469 | "required": true,
4470 | "type": "string"
4471 | },
4472 | {
4473 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
4474 | "enum": [
4475 | "S",
4476 | "I"
4477 | ],
4478 | "format": "string",
4479 | "in": "query",
4480 | "name": "units",
4481 | "required": false,
4482 | "type": "string"
4483 | },
4484 | {
4485 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
4486 | "enum": [
4487 | "ar",
4488 | "az",
4489 | "be",
4490 | "bg",
4491 | "bs",
4492 | "ca",
4493 | "cs",
4494 | "de",
4495 | "fi",
4496 | "fr",
4497 | "el",
4498 | "es",
4499 | "et",
4500 | "hr",
4501 | "hu",
4502 | "id",
4503 | "it",
4504 | "is",
4505 | "kw",
4506 | "nb",
4507 | "nl",
4508 | "pl",
4509 | "pt",
4510 | "ro",
4511 | "ru",
4512 | "sk",
4513 | "sl",
4514 | "sr",
4515 | "sv",
4516 | "tr",
4517 | "uk",
4518 | "zh",
4519 | "zh-tw"
4520 | ],
4521 | "format": "string",
4522 | "in": "query",
4523 | "name": "lang",
4524 | "required": false,
4525 | "type": "string"
4526 | },
4527 | {
4528 | "description": "Assume utc (default) or local time for start_date, end_date",
4529 | "enum": [
4530 | "local",
4531 | "utc"
4532 | ],
4533 | "format": "string",
4534 | "in": "query",
4535 | "name": "tz",
4536 | "required": false,
4537 | "type": "string"
4538 | },
4539 | {
4540 | "description": "Wraps return in jsonp callback. Example: callback=func",
4541 | "format": "string",
4542 | "in": "query",
4543 | "name": "callback",
4544 | "required": false,
4545 | "type": "string"
4546 | },
4547 | {
4548 | "description": "Your registered API key.",
4549 | "format": "string",
4550 | "in": "query",
4551 | "name": "key",
4552 | "required": true,
4553 | "type": "string"
4554 | }
4555 | ],
4556 | "responses": {
4557 | "200": {
4558 | "description": "An Historical Data Object.",
4559 | "schema": {
4560 | "$ref": "#/definitions/HistorySubhourly"
4561 | }
4562 | },
4563 | "default": {
4564 | "description": "No Data.",
4565 | "schema": {
4566 | "$ref": "#/definitions/Error"
4567 | }
4568 | }
4569 | },
4570 | "summary": "Returns Historical Observations - Given a City ID",
4571 | "tags": [
4572 | "Sub-Hourly Historical Weather Data"
4573 | ]
4574 | }
4575 | },
4576 | "/history/subhourly?lat={lat}&lon={lon}": {
4577 | "get": {
4578 | "description": "Returns Historical Observations - Given a lat, and lon.",
4579 | "parameters": [
4580 | {
4581 | "description": "Latitude component of location.",
4582 | "format": "double",
4583 | "in": "path",
4584 | "name": "lat",
4585 | "required": true,
4586 | "type": "number"
4587 | },
4588 | {
4589 | "description": "Longitude component of location.",
4590 | "format": "double",
4591 | "in": "path",
4592 | "name": "lon",
4593 | "required": true,
4594 | "type": "number"
4595 | },
4596 | {
4597 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4598 | "format": "string",
4599 | "in": "query",
4600 | "name": "start_date",
4601 | "required": true,
4602 | "type": "string"
4603 | },
4604 | {
4605 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4606 | "format": "string",
4607 | "in": "query",
4608 | "name": "end_date",
4609 | "required": true,
4610 | "type": "string"
4611 | },
4612 | {
4613 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
4614 | "enum": [
4615 | "S",
4616 | "I"
4617 | ],
4618 | "format": "string",
4619 | "in": "query",
4620 | "name": "units",
4621 | "required": false,
4622 | "type": "string"
4623 | },
4624 | {
4625 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
4626 | "enum": [
4627 | "ar",
4628 | "az",
4629 | "be",
4630 | "bg",
4631 | "bs",
4632 | "ca",
4633 | "cs",
4634 | "de",
4635 | "fi",
4636 | "fr",
4637 | "el",
4638 | "es",
4639 | "et",
4640 | "hr",
4641 | "hu",
4642 | "id",
4643 | "it",
4644 | "is",
4645 | "kw",
4646 | "nb",
4647 | "nl",
4648 | "pl",
4649 | "pt",
4650 | "ro",
4651 | "ru",
4652 | "sk",
4653 | "sl",
4654 | "sr",
4655 | "sv",
4656 | "tr",
4657 | "uk",
4658 | "zh",
4659 | "zh-tw"
4660 | ],
4661 | "format": "string",
4662 | "in": "query",
4663 | "name": "lang",
4664 | "required": false,
4665 | "type": "string"
4666 | },
4667 | {
4668 | "description": "Assume utc (default) or local time for start_date, end_date",
4669 | "enum": [
4670 | "local",
4671 | "utc"
4672 | ],
4673 | "format": "string",
4674 | "in": "query",
4675 | "name": "tz",
4676 | "required": false,
4677 | "type": "string"
4678 | },
4679 | {
4680 | "description": "Wraps return in jsonp callback. Example: callback=func",
4681 | "format": "string",
4682 | "in": "query",
4683 | "name": "callback",
4684 | "required": false,
4685 | "type": "string"
4686 | },
4687 | {
4688 | "description": "Your registered API key.",
4689 | "format": "string",
4690 | "in": "query",
4691 | "name": "key",
4692 | "required": true,
4693 | "type": "string"
4694 | }
4695 | ],
4696 | "responses": {
4697 | "200": {
4698 | "description": "An Historical Data Object.",
4699 | "schema": {
4700 | "$ref": "#/definitions/HistorySubhourly"
4701 | }
4702 | },
4703 | "default": {
4704 | "description": "No Data.",
4705 | "schema": {
4706 | "$ref": "#/definitions/Error"
4707 | }
4708 | }
4709 | },
4710 | "summary": "Returns Historical Observations - Given a lat/lon.",
4711 | "tags": [
4712 | "Sub-Hourly Historical Weather Data"
4713 | ]
4714 | }
4715 | },
4716 | "/history/subhourly?postal_code={postal_code}": {
4717 | "get": {
4718 | "description": "Returns Historical Observations - Given a Postal Code.",
4719 | "parameters": [
4720 | {
4721 | "description": "Postal Code. Example: 28546",
4722 | "format": "string",
4723 | "in": "path",
4724 | "name": "postal_code",
4725 | "required": true,
4726 | "type": "string"
4727 | },
4728 | {
4729 | "description": "Country Code (2 letter).",
4730 | "format": "string",
4731 | "in": "query",
4732 | "name": "country",
4733 | "required": false,
4734 | "type": "string"
4735 | },
4736 | {
4737 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
4738 | "format": "string",
4739 | "in": "query",
4740 | "name": "start_date",
4741 | "required": true,
4742 | "type": "string"
4743 | },
4744 | {
4745 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH)",
4746 | "format": "string",
4747 | "in": "query",
4748 | "name": "end_date",
4749 | "required": true,
4750 | "type": "string"
4751 | },
4752 | {
4753 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
4754 | "enum": [
4755 | "S",
4756 | "I"
4757 | ],
4758 | "format": "string",
4759 | "in": "query",
4760 | "name": "units",
4761 | "required": false,
4762 | "type": "string"
4763 | },
4764 | {
4765 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
4766 | "enum": [
4767 | "ar",
4768 | "az",
4769 | "be",
4770 | "bg",
4771 | "bs",
4772 | "ca",
4773 | "cs",
4774 | "de",
4775 | "fi",
4776 | "fr",
4777 | "el",
4778 | "es",
4779 | "et",
4780 | "hr",
4781 | "hu",
4782 | "id",
4783 | "it",
4784 | "is",
4785 | "kw",
4786 | "nb",
4787 | "nl",
4788 | "pl",
4789 | "pt",
4790 | "ro",
4791 | "ru",
4792 | "sk",
4793 | "sl",
4794 | "sr",
4795 | "sv",
4796 | "tr",
4797 | "uk",
4798 | "zh",
4799 | "zh-tw"
4800 | ],
4801 | "format": "string",
4802 | "in": "query",
4803 | "name": "lang",
4804 | "required": false,
4805 | "type": "string"
4806 | },
4807 | {
4808 | "description": "Assume utc (default) or local time for start_date, end_date",
4809 | "enum": [
4810 | "local",
4811 | "utc"
4812 | ],
4813 | "format": "string",
4814 | "in": "query",
4815 | "name": "tz",
4816 | "required": false,
4817 | "type": "string"
4818 | },
4819 | {
4820 | "description": "Wraps return in jsonp callback. Example: callback=func",
4821 | "format": "string",
4822 | "in": "query",
4823 | "name": "callback",
4824 | "required": false,
4825 | "type": "string"
4826 | },
4827 | {
4828 | "description": "Your registered API key.",
4829 | "format": "string",
4830 | "in": "query",
4831 | "name": "key",
4832 | "required": true,
4833 | "type": "string"
4834 | }
4835 | ],
4836 | "responses": {
4837 | "200": {
4838 | "description": "An Historical Data Object.",
4839 | "schema": {
4840 | "$ref": "#/definitions/HistorySubhourly"
4841 | }
4842 | },
4843 | "default": {
4844 | "description": "No Data.",
4845 | "schema": {
4846 | "$ref": "#/definitions/Error"
4847 | }
4848 | }
4849 | },
4850 | "summary": "Returns Historical Observations - Given a Postal Code",
4851 | "tags": [
4852 | "Sub-Hourly Historical Weather Data"
4853 | ]
4854 | }
4855 | },
4856 | "/history/subhourly?station={station}": {
4857 | "get": {
4858 | "description": "Returns Historical Observations - Given a station ID.",
4859 | "parameters": [
4860 | {
4861 | "description": "Station ID.",
4862 | "format": "string",
4863 | "in": "path",
4864 | "name": "station",
4865 | "required": true,
4866 | "type": "string"
4867 | },
4868 | {
4869 | "description": "Start Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4870 | "format": "string",
4871 | "in": "query",
4872 | "name": "start_date",
4873 | "required": true,
4874 | "type": "string"
4875 | },
4876 | {
4877 | "description": "End Date (YYYY-MM-DD or YYYY-MM-DD:HH).",
4878 | "format": "string",
4879 | "in": "query",
4880 | "name": "end_date",
4881 | "required": true,
4882 | "type": "string"
4883 | },
4884 | {
4885 | "description": "Convert to units. Default Metric See <a target='blank' href='/api/requests'>units field description</a>",
4886 | "enum": [
4887 | "S",
4888 | "I"
4889 | ],
4890 | "format": "string",
4891 | "in": "query",
4892 | "name": "units",
4893 | "required": false,
4894 | "type": "string"
4895 | },
4896 | {
4897 | "description": "Language (Default: English) See <a target='blank' href='/api/requests'>language field description</a>",
4898 | "enum": [
4899 | "ar",
4900 | "az",
4901 | "be",
4902 | "bg",
4903 | "bs",
4904 | "ca",
4905 | "cs",
4906 | "de",
4907 | "fi",
4908 | "fr",
4909 | "el",
4910 | "es",
4911 | "et",
4912 | "hr",
4913 | "hu",
4914 | "id",
4915 | "it",
4916 | "is",
4917 | "kw",
4918 | "nb",
4919 | "nl",
4920 | "pl",
4921 | "pt",
4922 | "ro",
4923 | "ru",
4924 | "sk",
4925 | "sl",
4926 | "sr",
4927 | "sv",
4928 | "tr",
4929 | "uk",
4930 | "zh",
4931 | "zh-tw"
4932 | ],
4933 | "format": "string",
4934 | "in": "query",
4935 | "name": "lang",
4936 | "required": false,
4937 | "type": "string"
4938 | },
4939 | {
4940 | "description": "Assume utc (default) or local time for start_date, end_date",
4941 | "enum": [
4942 | "local",
4943 | "utc"
4944 | ],
4945 | "format": "string",
4946 | "in": "query",
4947 | "name": "tz",
4948 | "required": false,
4949 | "type": "string"
4950 | },
4951 | {
4952 | "description": "Wraps return in jsonp callback. Example: callback=func",
4953 | "format": "string",
4954 | "in": "query",
4955 | "name": "callback",
4956 | "required": false,
4957 | "type": "string"
4958 | },
4959 | {
4960 | "description": "Your registered API key.",
4961 | "format": "string",
4962 | "in": "query",
4963 | "name": "key",
4964 | "required": true,
4965 | "type": "string"
4966 | }
4967 | ],
4968 | "responses": {
4969 | "200": {
4970 | "description": "An Historical Data Object.",
4971 | "schema": {
4972 | "$ref": "#/definitions/HistorySubhourly"
4973 | }
4974 | },
4975 | "default": {
4976 | "description": "No Data.",
4977 | "schema": {
4978 | "$ref": "#/definitions/Error"
4979 | }
4980 | }
4981 | },
4982 | "summary": "Returns Historical Observations - Given a station ID.",
4983 | "tags": [
4984 | "Sub-Hourly Historical Weather Data"
4985 | ]
4986 | }
4987 | }
4988 | },
4989 | "definitions": {
4990 | "AQCurrent": {
4991 | "properties": {
4992 | "aqi": {
4993 | "description": "Cloud cover as a percentage (%)",
4994 | "example": 100,
4995 | "type": "integer"
4996 | },
4997 | "no2": {
4998 | "description": "Concentration of NO2 (µg/m³)",
4999 | "example": 25,
5000 | "type": "number"
5001 | },
5002 | "o3": {
5003 | "description": "Concentration of O3 (µg/m³)",
5004 | "example": 2,
5005 | "type": "number"
5006 | },
5007 | "pm10": {
5008 | "description": "Concentration of PM 10 (µg/m³)",
5009 | "example": 150,
5010 | "type": "number"
5011 | },
5012 | "pm25": {
5013 | "description": "Concentration of PM 2.5 (µg/m³)",
5014 | "example": 230,
5015 | "type": "number"
5016 | },
5017 | "so2": {
5018 | "description": "Concentration of SO2 (µg/m³)",
5019 | "example": 50,
5020 | "type": "number"
5021 | }
5022 | },
5023 | "type": "object"
5024 | },
5025 | "AQCurrentGroup": {
5026 | "properties": {
5027 | "city_name": {
5028 | "description": "City Name",
5029 | "example": "Raleigh",
5030 | "type": "string"
5031 | },
5032 | "country_code": {
5033 | "description": "Country Abbreviation",
5034 | "example": "US",
5035 | "type": "string"
5036 | },
5037 | "data": {
5038 | "items": {
5039 | "$ref": "#/definitions/AQCurrent"
5040 | },
5041 | "type": "array"
5042 | },
5043 | "lat": {
5044 | "description": "Latitude",
5045 | "example": "38.25",
5046 | "type": "string"
5047 | },
5048 | "lon": {
5049 | "description": "Longitude",
5050 | "example": "-78.00",
5051 | "type": "string"
5052 | },
5053 | "state_code": {
5054 | "description": "State Abbreviation",
5055 | "example": "NC",
5056 | "type": "string"
5057 | },
5058 | "timezone": {
5059 | "description": "Local IANA time zone",
5060 | "example": "America/New_York",
5061 | "type": "string"
5062 | }
5063 | },
5064 | "type": "object"
5065 | },
5066 | "AQHour": {
5067 | "properties": {
5068 | "aqi": {
5069 | "description": "Cloud cover as a percentage (%)",
5070 | "example": 100,
5071 | "type": "integer"
5072 | },
5073 | "no2": {
5074 | "description": "Concentration of NO2 (µg/m³)",
5075 | "example": 25,
5076 | "type": "number"
5077 | },
5078 | "o3": {
5079 | "description": "Concentration of O3 (µg/m³)",
5080 | "example": 2,
5081 | "type": "number"
5082 | },
5083 | "pm10": {
5084 | "description": "Concentration of PM 10 (µg/m³)",
5085 | "example": 150,
5086 | "type": "number"
5087 | },
5088 | "pm25": {
5089 | "description": "Concentration of PM 2.5 (µg/m³)",
5090 | "example": 230,
5091 | "type": "number"
5092 | },
5093 | "so2": {
5094 | "description": "Concentration of SO2 (µg/m³)",
5095 | "example": 50,
5096 | "type": "number"
5097 | },
5098 | "timestamp_local": {
5099 | "description": "Timestamp in local time",
5100 | "example": "2019-03-04T12:00:00",
5101 | "type": "string"
5102 | },
5103 | "timestamp_utc": {
5104 | "description": "Timestamp UTC",
5105 | "example": "2019-03-04T17:00:00",
5106 | "type": "string"
5107 | },
5108 | "ts": {
5109 | "description": "Unix Timestamp",
5110 | "example": "1551718800",
5111 | "type": "number"
5112 | }
5113 | },
5114 | "type": "object"
5115 | },
5116 | "AQHourly": {
5117 | "properties": {
5118 | "city_name": {
5119 | "description": "City Name",
5120 | "example": "Raleigh",
5121 | "type": "string"
5122 | },
5123 | "country_code": {
5124 | "description": "Country Abbreviation",
5125 | "example": "US",
5126 | "type": "string"
5127 | },
5128 | "data": {
5129 | "items": {
5130 | "$ref": "#/definitions/AQHour"
5131 | },
5132 | "type": "array"
5133 | },
5134 | "lat": {
5135 | "description": "Latitude",
5136 | "example": "38.25",
5137 | "type": "string"
5138 | },
5139 | "lon": {
5140 | "description": "Longitude",
5141 | "example": "-78.00",
5142 | "type": "string"
5143 | },
5144 | "state_code": {
5145 | "description": "State Abbreviation",
5146 | "example": "NC",
5147 | "type": "string"
5148 | },
5149 | "timezone": {
5150 | "description": "Local IANA time zone",
5151 | "example": "America/New_York",
5152 | "type": "string"
5153 | }
5154 | },
5155 | "type": "object"
5156 | },
5157 | "AlertRegionGroup": {
5158 | "description": "List of impacted regions",
5159 | "example": "St Louis, MO",
5160 | "type": "string"
5161 | },
5162 | "CurrentObs": {
5163 | "properties": {
5164 | "app_temp": {
5165 | "description": "Apparent temperature - Default (C)",
5166 | "example": 14.85,
5167 | "type": "number"
5168 | },
5169 | "aqi": {
5170 | "description": "Air quality index (US EPA standard 0 to +500)",
5171 | "example": 50,
5172 | "type": "number"
5173 | },
5174 | "city_name": {
5175 | "description": "City name (closest)",
5176 | "example": "Raleigh",
5177 | "type": "string"
5178 | },
5179 | "clouds": {
5180 | "description": "Cloud cover (%)",
5181 | "example": 42,
5182 | "type": "integer"
5183 | },
5184 | "country_code": {
5185 | "description": "Country abbreviation",
5186 | "example": "US",
5187 | "type": "string"
5188 | },
5189 | "datetime": {
5190 | "description": "Cycle Hour (UTC) of observation",
5191 | "example": "2017-03-15:13",
5192 | "type": "string"
5193 | },
5194 | "dewpt": {
5195 | "description": "Dew point temperature - default (C)",
5196 | "example": 12,
5197 | "type": "number"
5198 | },
5199 | "dhi": {
5200 | "description": "Diffuse horizontal irradiance (W/m^2)",
5201 | "example": 450.4,
5202 | "type": "number"
5203 | },
5204 | "dni": {
5205 | "description": "Direct normal irradiance (W/m^2)",
5206 | "example": 450.4,
5207 | "type": "number"
5208 | },
5209 | "elev_angle": {
5210 | "description": "Current solar elevation angle (Degrees)",
5211 | "example": 37,
5212 | "type": "number"
5213 | },
5214 | "ghi": {
5215 | "description": "Global horizontal irradiance (W/m^2)",
5216 | "example": 450.4,
5217 | "type": "number"
5218 | },
5219 | "gust": {
5220 | "description": "Wind gust speed - Default (m/s)",
5221 | "example": 9,
5222 | "type": "number"
5223 | },
5224 | "hour_angle": {
5225 | "description": "Current solar hour angle (Degrees)",
5226 | "example": 45,
5227 | "type": "number"
5228 | },
5229 | "lat": {
5230 | "description": "Latitude",
5231 | "example": 38,
5232 | "type": "number"
5233 | },
5234 | "lon": {
5235 | "description": "Longitude",
5236 | "example": -78.25,
5237 | "type": "number"
5238 | },
5239 | "ob_time": {
5240 | "description": "Full time (UTC) of observation (YYYY-MM-DD HH:MM)",
5241 | "example": "2017-03-15 13:11",
5242 | "type": "string"
5243 | },
5244 | "pod": {
5245 | "description": "Part of the day (d = day, n = night)",
5246 | "type": "string"
5247 | },
5248 | "precip": {
5249 | "description": "Precipitation in last hour - Default (mm)",
5250 | "example": 2,
5251 | "type": "number"
5252 | },
5253 | "pres": {
5254 | "description": "Pressure (mb)",
5255 | "example": 1010,
5256 | "type": "number"
5257 | },
5258 | "rh": {
5259 | "description": "Relative humidity (%)",
5260 | "example": 75,
5261 | "type": "integer"
5262 | },
5263 | "slp": {
5264 | "description": "Mean sea level pressure in millibars (mb)",
5265 | "example": 1013.12,
5266 | "type": "number"
5267 | },
5268 | "snow": {
5269 | "description": "Snowfall in last hour - Default (mm)",
5270 | "example": 10,
5271 | "type": "number"
5272 | },
5273 | "solar_rad": {
5274 | "description": "Estimated solar radiation (W/m^2)",
5275 | "example": 300.4,
5276 | "type": "number"
5277 | },
5278 | "sources": {
5279 | "description": "List of data sources used in response",
5280 | "items": {
5281 | "example": "rtma",
5282 | "type": "string"
5283 | },
5284 | "type": "array"
5285 | },
5286 | "state_code": {
5287 | "description": "State abbreviation",
5288 | "example": "NC",
5289 | "type": "string"
5290 | },
5291 | "station": {
5292 | "description": "Source Station ID",
5293 | "example": "KRDU",
5294 | "type": "string"
5295 | },
5296 | "sunrise": {
5297 | "description": "Time (UTC) of Sunrise (HH:MM)",
5298 | "example": "06:22",
5299 | "type": "string"
5300 | },
5301 | "sunset": {
5302 | "description": "Time (UTC) of Sunset (HH:MM)",
5303 | "example": "19:34",
5304 | "type": "string"
5305 | },
5306 | "temp": {
5307 | "description": "Temperature - Default (C)",
5308 | "example": 13.85,
5309 | "type": "number"
5310 | },
5311 | "timezone": {
5312 | "description": "Local IANA time zone",
5313 | "example": "America/New_York",
5314 | "type": "string"
5315 | },
5316 | "ts": {
5317 | "description": "Unix Timestamp",
5318 | "example": 1490990400,
5319 | "type": "number"
5320 | },
5321 | "uv": {
5322 | "description": "UV Index",
5323 | "example": 6.5,
5324 | "type": "number"
5325 | },
5326 | "vis": {
5327 | "description": "Visibility - default (M)",
5328 | "example": 10000,
5329 | "type": "integer"
5330 | },
5331 | "weather": {
5332 | "properties": {
5333 | "code": {
5334 | "description": "Weather Condition code",
5335 | "example": "802",
5336 | "type": "string"
5337 | },
5338 | "description": {
5339 | "description": "Weather Condition description",
5340 | "example": "Broken clouds",
5341 | "type": "string"
5342 | },
5343 | "icon": {
5344 | "description": "Icon code for forecast image display",
5345 | "example": "c02",
5346 | "type": "string"
5347 | }
5348 | },
5349 | "type": "object"
5350 | },
5351 | "wind_cdir": {
5352 | "description": "Cardinal wind direction",
5353 | "example": "ENE",
5354 | "type": "string"
5355 | },
5356 | "wind_cdir_full": {
5357 | "description": "Cardinal wind direction (text)",
5358 | "example": "East-North-East",
5359 | "type": "string"
5360 | },
5361 | "wind_dir": {
5362 | "description": "Wind direction (degrees)",
5363 | "example": 125,
5364 | "type": "integer"
5365 | },
5366 | "wind_speed": {
5367 | "description": "Wind speed - Default (m/s)",
5368 | "example": 5.85,
5369 | "type": "number"
5370 | }
5371 | },
5372 | "type": "object"
5373 | },
5374 | "CurrentObsGroup": {
5375 | "properties": {
5376 | "count": {
5377 | "description": "Count of found observations",
5378 | "example": "1",
5379 | "type": "integer"
5380 | },
5381 | "data": {
5382 | "items": {
5383 | "$ref": "#/definitions/CurrentObs"
5384 | },
5385 | "type": "array"
5386 | }
5387 | },
5388 | "type": "object"
5389 | },
5390 | "EnergyObs": {
5391 | "properties": {
5392 | "cdd": {
5393 | "description": "Cooling degree days",
5394 | "example": 10,
5395 | "type": "number"
5396 | },
5397 | "city_name": {
5398 | "description": "City name (closest)",
5399 | "example": "Raleigh",
5400 | "type": "string"
5401 | },
5402 | "clouds": {
5403 | "description": "Average cloud cover (%)",
5404 | "example": 42,
5405 | "type": "integer"
5406 | },
5407 | "country_code": {
5408 | "description": "Country abbreviation",
5409 | "example": "US",
5410 | "type": "string"
5411 | },
5412 | "dewpt": {
5413 | "description": "Average dew point temperature - Default (C)",
5414 | "example": 12,
5415 | "type": "number"
5416 | },
5417 | "hdd": {
5418 | "description": "Heating degree days",
5419 | "example": 120,
5420 | "type": "number"
5421 | },
5422 | "lat": {
5423 | "description": "Latitude",
5424 | "example": "38.00",
5425 | "type": "string"
5426 | },
5427 | "lon": {
5428 | "description": "Longitude",
5429 | "example": "-78.25",
5430 | "type": "string"
5431 | },
5432 | "precip": {
5433 | "description": "Total precipitation in period - Default (mm)",
5434 | "example": 2,
5435 | "type": "number"
5436 | },
5437 | "rh": {
5438 | "description": "Average Relative humidity (%)",
5439 | "example": 75,
5440 | "type": "integer"
5441 | },
5442 | "snow": {
5443 | "description": "Total snowfall in period - Default (mm)",
5444 | "example": 10,
5445 | "type": "number"
5446 | },
5447 | "sources": {
5448 | "description": "List of data sources used in response",
5449 | "items": {
5450 | "example": "12345-89083",
5451 | "type": "string"
5452 | },
5453 | "type": "array"
5454 | },
5455 | "state_code": {
5456 | "description": "State abbreviation",
5457 | "example": "NC",
5458 | "type": "string"
5459 | },
5460 | "station_id": {
5461 | "description": "Nearest Station ID [DEPRECATED]",
5462 | "example": "12345-999999",
5463 | "type": "string"
5464 | },
5465 | "sun_hours": {
5466 | "description": "Average number of daily sun hours - # hours where Solar GHI > 1000 W/m^2",
5467 | "example": 4.5,
5468 | "type": "number"
5469 | },
5470 | "t_dhi": {
5471 | "description": "Total diffuse horizontal solar irradiance (W/m^2)",
5472 | "example": 450,
5473 | "type": "number"
5474 | },
5475 | "t_dni": {
5476 | "description": "Total direct normal solar irradiance (W/m^2)",
5477 | "example": 1200,
5478 | "type": "number"
5479 | },
5480 | "t_ghi": {
5481 | "description": "Total global horizontal solar irradiance (W/m^2)",
5482 | "example": 3000,
5483 | "type": "number"
5484 | },
5485 | "temp": {
5486 | "description": "Average temperature - Default (C)",
5487 | "example": 13.85,
5488 | "type": "number"
5489 | },
5490 | "timezone": {
5491 | "description": "Local IANA time zone",
5492 | "example": "America/New_York",
5493 | "type": "string"
5494 | },
5495 | "wind_dir": {
5496 | "description": "Average wind direction (Degrees)",
5497 | "example": 125,
5498 | "type": "integer"
5499 | },
5500 | "wind_spd": {
5501 | "description": "Average wind speed - Default (m/s)",
5502 | "example": 5.85,
5503 | "type": "number"
5504 | }
5505 | },
5506 | "type": "object"
5507 | },
5508 | "EnergyObsGroup": {
5509 | "properties": {
5510 | "count": {
5511 | "description": "Count of found observations",
5512 | "example": "1",
5513 | "type": "integer"
5514 | },
5515 | "data": {
5516 | "items": {
5517 | "$ref": "#/definitions/EnergyObs"
5518 | },
5519 | "type": "array"
5520 | },
5521 | "end_date": {
5522 | "description": "End Date",
5523 | "example": "2017-01-30",
5524 | "type": "integer"
5525 | },
5526 | "start_date": {
5527 | "description": "Start Date",
5528 | "example": "2017-01-01",
5529 | "type": "integer"
5530 | }
5531 | },
5532 | "type": "object"
5533 | },
5534 | "EnergyObsGroupForecast": {
5535 | "properties": {
5536 | "city_name": {
5537 | "description": "City name (closest)",
5538 | "example": "Raleigh",
5539 | "type": "string"
5540 | },
5541 | "country_code": {
5542 | "description": "Country abbreviation",
5543 | "example": "US",
5544 | "type": "string"
5545 | },
5546 | "data": {
5547 | "items": {
5548 | "$ref": "#/definitions/EnergyObsSeries"
5549 | },
5550 | "type": "array"
5551 | },
5552 | "lat": {
5553 | "description": "Latitude",
5554 | "example": "38.00",
5555 | "type": "string"
5556 | },
5557 | "lon": {
5558 | "description": "Longitude",
5559 | "example": "-78.25",
5560 | "type": "string"
5561 | },
5562 | "state_code": {
5563 | "description": "State abbreviation",
5564 | "example": "NC",
5565 | "type": "string"
5566 | },
5567 | "threshold_units": {
5568 | "description": "Degree day threshold units",
5569 | "example": "C",
5570 | "type": "string"
5571 | },
5572 | "threshold_value": {
5573 | "description": "Degree day threshold",
5574 | "example": "18",
5575 | "type": "string"
5576 | },
5577 | "timezone": {
5578 | "description": "Local IANA time zone",
5579 | "example": "America/New_York",
5580 | "type": "string"
5581 | }
5582 | },
5583 | "type": "object"
5584 | },
5585 | "EnergyObsSeries": {
5586 | "properties": {
5587 | "cdd": {
5588 | "description": "Cooling degree days",
5589 | "example": 10,
5590 | "type": "number"
5591 | },
5592 | "clouds": {
5593 | "description": "Average cloud cover (%)",
5594 | "example": 42,
5595 | "type": "integer"
5596 | },
5597 | "date": {
5598 | "description": "Date",
5599 | "example": "2018-06-01",
5600 | "type": "string"
5601 | },
5602 | "dewpt": {
5603 | "description": "Average dew point temperature - Default (C)",
5604 | "example": 12,
5605 | "type": "number"
5606 | },
5607 | "hdd": {
5608 | "description": "Heating degree days",
5609 | "example": 120,
5610 | "type": "number"
5611 | },
5612 | "precip": {
5613 | "description": "Total precipitation in period - Default (mm)",
5614 | "example": 2,
5615 | "type": "number"
5616 | },
5617 | "rh": {
5618 | "description": "Average Relative humidity (%)",
5619 | "example": 75,
5620 | "type": "integer"
5621 | },
5622 | "snow": {
5623 | "description": "Total snowfall in period - Default (mm)",
5624 | "example": 10,
5625 | "type": "number"
5626 | },
5627 | "sun_hours": {
5628 | "description": "Average number of daily sun hours - # hours where Solar GHI > 1000 W/m^2",
5629 | "example": 4.5,
5630 | "type": "number"
5631 | },
5632 | "t_dhi": {
5633 | "description": "Total diffuse horizontal solar irradiance (W/m^2)",
5634 | "example": 450,
5635 | "type": "number"
5636 | },
5637 | "t_dni": {
5638 | "description": "Total direct normal solar irradiance (W/m^2)",
5639 | "example": 1200,
5640 | "type": "number"
5641 | },
5642 | "t_ghi": {
5643 | "description": "Total global horizontal solar irradiance (W/m^2)",
5644 | "example": 3000,
5645 | "type": "number"
5646 | },
5647 | "temp": {
5648 | "description": "Average temperature - Default (C)",
5649 | "example": 13.85,
5650 | "type": "number"
5651 | },
5652 | "wind_dir": {
5653 | "description": "Average wind direction (Degrees)",
5654 | "example": 125,
5655 | "type": "integer"
5656 | },
5657 | "wind_spd": {
5658 | "description": "Average wind speed - Default (m/s)",
5659 | "example": 5.85,
5660 | "type": "number"
5661 | }
5662 | },
5663 | "type": "object"
5664 | },
5665 | "Error": {
5666 | "properties": {
5667 | "code": {
5668 | "format": "int32",
5669 | "type": "integer"
5670 | },
5671 | "message": {
5672 | "type": "string"
5673 | }
5674 | },
5675 | "type": "object"
5676 | },
5677 | "Forecast": {
5678 | "properties": {
5679 | "app_max_temp": {
5680 | "description": "Apparent Maximum daily Temperature - default (C)",
5681 | "example": 4,
5682 | "type": "number"
5683 | },
5684 | "app_min_temp": {
5685 | "description": "Apparent Minimum daily Temperature - default (C)",
5686 | "example": -2,
5687 | "type": "number"
5688 | },
5689 | "clouds": {
5690 | "description": "Cloud cover as a percentage (%)",
5691 | "example": 100,
5692 | "type": "integer"
5693 | },
5694 | "datetime": {
5695 | "description": "Date in format \"YYYY-MM-DD:HH\". All datetime is in (UTC)",
5696 | "example": "2019-03-04:17",
5697 | "type": "string"
5698 | },
5699 | "dewpt": {
5700 | "description": "Dewpoint (Average) - default (C)",
5701 | "example": 1,
5702 | "type": "number"
5703 | },
5704 | "max_dhi": {
5705 | "description": "[Deprecated] Max direct component of solar insolation (W/m^2)",
5706 | "example": "655",
5707 | "type": "number"
5708 | },
5709 | "max_temp": {
5710 | "description": "Maximum daily Temperature - default (C)",
5711 | "example": 1.5,
5712 | "type": "number"
5713 | },
5714 | "min_temp": {
5715 | "description": "Minimum daily Temperature - default (C)",
5716 | "example": -1.23,
5717 | "type": "number"
5718 | },
5719 | "moon_phase": {
5720 | "description": "Moon phase",
5721 | "example": 0.87,
5722 | "type": "number"
5723 | },
5724 | "moonrise_ts": {
5725 | "description": "Moonrise unix timestamp",
5726 | "example": 1530331260,
5727 | "type": "integer"
5728 | },
5729 | "moonset_ts": {
5730 | "description": "Moonset unix timestamp",
5731 | "example": 1530331260,
5732 | "type": "integer"
5733 | },
5734 | "pod": {
5735 | "description": "Part of the day (d = day, n = night)",
5736 | "example": "n",
5737 | "type": "string"
5738 | },
5739 | "pop": {
5740 | "description": "Chance of Precipitation as a percentage (%)",
5741 | "example": 75,
5742 | "type": "number"
5743 | },
5744 | "precip": {
5745 | "description": "Accumulated precipitation since last forecast point - default (mm)",
5746 | "example": 1.1,
5747 | "type": "number"
5748 | },
5749 | "pres": {
5750 | "description": "Pressure (mb)",
5751 | "example": 1005,
5752 | "type": "number"
5753 | },
5754 | "rh": {
5755 | "description": "Relative Humidity as a percentage (%)",
5756 | "example": 95,
5757 | "type": "integer"
5758 | },
5759 | "slp": {
5760 | "description": "Mean Sea level pressure (mb)",
5761 | "example": 1012.89,
5762 | "type": "number"
5763 | },
5764 | "snow": {
5765 | "description": "Accumulated snowfall since last forecast point - default (mm)",
5766 | "example": 10.45,
5767 | "type": "number"
5768 | },
5769 | "snow_depth": {
5770 | "description": "Snow Depth - default (mm)",
5771 | "example": 45,
5772 | "type": "number"
5773 | },
5774 | "sunrise_ts": {
5775 | "description": "Sunrise unix timestamp",
5776 | "example": 1530331260,
5777 | "type": "integer"
5778 | },
5779 | "sunset_ts": {
5780 | "description": "Sunset unix timestamp",
5781 | "example": 1530331260,
5782 | "type": "integer"
5783 | },
5784 | "temp": {
5785 | "description": "Temperature (Average) - default (C)",
5786 | "example": 1,
5787 | "type": "number"
5788 | },
5789 | "timestamp_local": {
5790 | "description": "Timestamp in local time",
5791 | "example": "2019-03-04T12:00:00",
5792 | "type": "string"
5793 | },
5794 | "timestamp_utc": {
5795 | "description": "Timestamp UTC",
5796 | "example": "2019-03-04T17:00:00",
5797 | "type": "string"
5798 | },
5799 | "ts": {
5800 | "description": "Unix Timestamp",
5801 | "example": "1551718800",
5802 | "type": "number"
5803 | },
5804 | "uv": {
5805 | "description": "UV Index",
5806 | "example": 6.5,
5807 | "type": "number"
5808 | },
5809 | "vis": {
5810 | "description": "Average Visibility default (KM)",
5811 | "example": 3,
5812 | "type": "number"
5813 | },
5814 | "weather": {
5815 | "properties": {
5816 | "code": {
5817 | "description": "Weather Condition code",
5818 | "example": "601",
5819 | "type": "string"
5820 | },
5821 | "description": {
5822 | "description": "Weather Condition description",
5823 | "example": "Snow",
5824 | "type": "string"
5825 | },
5826 | "icon": {
5827 | "description": "Icon code for forecast image display",
5828 | "example": "s02n",
5829 | "type": "string"
5830 | }
5831 | },
5832 | "type": "object"
5833 | },
5834 | "wind_cdir": {
5835 | "description": "Cardinal wind direction",
5836 | "example": "ENE",
5837 | "type": "string"
5838 | },
5839 | "wind_cdir_full": {
5840 | "description": "Cardinal wind direction (text)",
5841 | "example": "East-North-East",
5842 | "type": "string"
5843 | },
5844 | "wind_dir": {
5845 | "description": "Wind direction",
5846 | "example": 105,
5847 | "type": "integer"
5848 | },
5849 | "wind_spd": {
5850 | "description": "Wind Speed (default m/s)",
5851 | "example": 13.85,
5852 | "type": "number"
5853 | }
5854 | },
5855 | "type": "object"
5856 | },
5857 | "ForecastDay": {
5858 | "properties": {
5859 | "city_name": {
5860 | "description": "City Name",
5861 | "example": "Raleigh",
5862 | "type": "string"
5863 | },
5864 | "country_code": {
5865 | "description": "Country Abbreviation",
5866 | "example": "US",
5867 | "type": "string"
5868 | },
5869 | "data": {
5870 | "items": {
5871 | "$ref": "#/definitions/Forecast"
5872 | },
5873 | "type": "array"
5874 | },
5875 | "lat": {
5876 | "description": "Latitude",
5877 | "example": "38.25",
5878 | "type": "string"
5879 | },
5880 | "lon": {
5881 | "description": "Longitude",
5882 | "example": "-78.00",
5883 | "type": "string"
5884 | },
5885 | "state_code": {
5886 | "description": "State Abbreviation",
5887 | "example": "NC",
5888 | "type": "string"
5889 | },
5890 | "timezone": {
5891 | "description": "Local IANA time zone",
5892 | "example": "America/New_York",
5893 | "type": "string"
5894 | }
5895 | },
5896 | "type": "object"
5897 | },
5898 | "ForecastHour": {
5899 | "properties": {
5900 | "app_temp": {
5901 | "description": "Apparent Temperature - Default (C)",
5902 | "example": 4.5,
5903 | "type": "number"
5904 | },
5905 | "clouds": {
5906 | "description": "Cloud cover as a percentage (%)",
5907 | "example": 100,
5908 | "type": "integer"
5909 | },
5910 | "datetime": {
5911 | "description": "Date in format \"YYYY-MM-DD:HH\". All datetime is in (UTC)",
5912 | "example": "2019-03-04:17",
5913 | "type": "string"
5914 | },
5915 | "dewpt": {
5916 | "description": "Dewpoint - Default (C)",
5917 | "example": -4,
5918 | "type": "number"
5919 | },
5920 | "dhi": {
5921 | "description": "Diffuse normal solar irradiance (W/m^2)",
5922 | "example": 200,
5923 | "type": "number"
5924 | },
5925 | "dni": {
5926 | "description": "Direct normal solar irradiance (W/m^2)",
5927 | "example": 400,
5928 | "type": "number"
5929 | },
5930 | "ghi": {
5931 | "description": "Global horizontal solar irradiance (W/m^2)",
5932 | "example": 1000,
5933 | "type": "number"
5934 | },
5935 | "pod": {
5936 | "description": "Part of day (d = day, n = night)",
5937 | "example": "d",
5938 | "type": "string"
5939 | },
5940 | "pop": {
5941 | "description": "Chance of Precipitation as a percentage (%)",
5942 | "example": 75,
5943 | "type": "number"
5944 | },
5945 | "precip": {
5946 | "description": "Accumulated precipitation since last forecast point. Default (mm)",
5947 | "example": 1.1,
5948 | "type": "number"
5949 | },
5950 | "pres": {
5951 | "description": "Pressure (mb)",
5952 | "example": 1005,
5953 | "type": "number"
5954 | },
5955 | "rh": {
5956 | "description": "Relative Humidity as a percentage (%)",
5957 | "example": 95,
5958 | "type": "integer"
5959 | },
5960 | "slp": {
5961 | "description": "Mean Sea level pressure (mb)",
5962 | "example": 1012.89,
5963 | "type": "number"
5964 | },
5965 | "snow": {
5966 | "description": "Accumulated snowfall since last forecast point - Default (mm)",
5967 | "example": 10.45,
5968 | "type": "number"
5969 | },
5970 | "snow_depth": {
5971 | "description": "Snow depth - Default (mm)",
5972 | "example": 45,
5973 | "type": "number"
5974 | },
5975 | "solar_rad": {
5976 | "description": "Estimated solar radiation (W/m^2)",
5977 | "example": 300,
5978 | "type": "number"
5979 | },
5980 | "temp": {
5981 | "description": "Temperature - Default (C)",
5982 | "example": -1.5,
5983 | "type": "number"
5984 | },
5985 | "timestamp_local": {
5986 | "description": "Timestamp in local time",
5987 | "example": "2019-03-04T12:00:00",
5988 | "type": "string"
5989 | },
5990 | "timestamp_utc": {
5991 | "description": "Timestamp UTC",
5992 | "example": "2019-03-04T17:00:00",
5993 | "type": "string"
5994 | },
5995 | "ts": {
5996 | "description": "Unix Timestamp",
5997 | "example": "1551718800",
5998 | "type": "number"
5999 | },
6000 | "uv": {
6001 | "description": "UV Index",
6002 | "example": 6.5,
6003 | "type": "number"
6004 | },
6005 | "vis": {
6006 | "description": "Visibility - Default (KM)",
6007 | "example": 1,
6008 | "type": "number"
6009 | },
6010 | "weather": {
6011 | "properties": {
6012 | "code": {
6013 | "description": "Weather Condition code",
6014 | "example": "601",
6015 | "type": "string"
6016 | },
6017 | "description": {
6018 | "description": "Weather Condition description",
6019 | "example": "Snow",
6020 | "type": "string"
6021 | },
6022 | "icon": {
6023 | "description": "Icon code for forecast image display",
6024 | "example": "s02d",
6025 | "type": "string"
6026 | }
6027 | },
6028 | "type": "object"
6029 | },
6030 | "wind_cdir": {
6031 | "description": "Cardinal wind direction",
6032 | "example": "ENE",
6033 | "type": "string"
6034 | },
6035 | "wind_cdir_full": {
6036 | "description": "Cardinal wind direction (text)",
6037 | "example": "East-North-East",
6038 | "type": "string"
6039 | },
6040 | "wind_dir": {
6041 | "description": "Wind direction",
6042 | "example": 105,
6043 | "type": "integer"
6044 | },
6045 | "wind_gust_spd": {
6046 | "description": "Wind Gust Speed - Default (m/s)",
6047 | "example": 16.85,
6048 | "type": "number"
6049 | },
6050 | "wind_spd": {
6051 | "description": "Wind Speed - Default (m/s)",
6052 | "example": 13.85,
6053 | "type": "number"
6054 | }
6055 | },
6056 | "type": "object"
6057 | },
6058 | "ForecastHourly": {
6059 | "properties": {
6060 | "city_name": {
6061 | "description": "City Name",
6062 | "example": "Raleigh",
6063 | "type": "string"
6064 | },
6065 | "country_code": {
6066 | "description": "Country Abbreviation",
6067 | "example": "US",
6068 | "type": "string"
6069 | },
6070 | "data": {
6071 | "items": {
6072 | "$ref": "#/definitions/ForecastHour"
6073 | },
6074 | "type": "array"
6075 | },
6076 | "lat": {
6077 | "description": "Latitude",
6078 | "example": "38.25",
6079 | "type": "string"
6080 | },
6081 | "lon": {
6082 | "description": "Longitude",
6083 | "example": "-78.00",
6084 | "type": "string"
6085 | },
6086 | "state_code": {
6087 | "description": "State Abbreviation",
6088 | "example": "NC",
6089 | "type": "string"
6090 | },
6091 | "timezone": {
6092 | "description": "Local IANA time zone",
6093 | "example": "America/New_York",
6094 | "type": "string"
6095 | }
6096 | },
6097 | "type": "object"
6098 | },
6099 | "GeoIPObj": {
6100 | "properties": {
6101 | "area_code": {
6102 | "description": "Area Code",
6103 | "example": "919",
6104 | "type": "string"
6105 | },
6106 | "charset": {
6107 | "description": "Character encoding",
6108 | "example": "1",
6109 | "type": "string"
6110 | },
6111 | "city": {
6112 | "description": "City Name",
6113 | "example": "Raleigh",
6114 | "type": "string"
6115 | },
6116 | "continent_code": {
6117 | "description": "Country Abbreviation",
6118 | "example": "US",
6119 | "type": "string"
6120 | },
6121 | "country_code": {
6122 | "description": "Country Code (Short)",
6123 | "example": "US",
6124 | "type": "string"
6125 | },
6126 | "country_code3": {
6127 | "description": "Country Code (Long)",
6128 | "example": "USA",
6129 | "type": "string"
6130 | },
6131 | "dma_code": {
6132 | "description": "Longitude",
6133 | "example": "560",
6134 | "type": "string"
6135 | },
6136 | "ip": {
6137 | "description": "IP Address",
6138 | "example": "192.168.1.102",
6139 | "type": "string"
6140 | },
6141 | "latitude": {
6142 | "description": "State Abbreviation",
6143 | "example": "35.811",
6144 | "type": "string"
6145 | },
6146 | "longitude": {
6147 | "description": "City Name",
6148 | "example": "-78.64",
6149 | "type": "string"
6150 | },
6151 | "metro_code": {
6152 | "description": "Longitude",
6153 | "example": "560",
6154 | "type": "string"
6155 | },
6156 | "offset": {
6157 | "description": "UTC Offset (deprecated)",
6158 | "example": "-4",
6159 | "type": "string"
6160 | },
6161 | "organization": {
6162 | "description": "Organization Name",
6163 | "example": "AS11426 Time Warner Cable Internet LLC",
6164 | "type": "string"
6165 | },
6166 | "postal_code": {
6167 | "description": "Postal Code",
6168 | "example": "27601",
6169 | "type": "string"
6170 | },
6171 | "region": {
6172 | "description": "Latitude",
6173 | "example": "NC",
6174 | "type": "string"
6175 | },
6176 | "timezone": {
6177 | "description": "Local IANA time zone",
6178 | "example": "America/New_York",
6179 | "type": "string"
6180 | }
6181 | },
6182 | "type": "object"
6183 | },
6184 | "History": {
6185 | "properties": {
6186 | "city_name": {
6187 | "description": "City name (Closest)",
6188 | "example": "Seattle",
6189 | "type": "string"
6190 | },
6191 | "country_code": {
6192 | "description": "Country abbreviation",
6193 | "example": "US",
6194 | "type": "string"
6195 | },
6196 | "data": {
6197 | "items": {
6198 | "$ref": "#/definitions/HistoryObj"
6199 | },
6200 | "type": "array"
6201 | },
6202 | "lat": {
6203 | "description": "Latitude",
6204 | "example": "47.61",
6205 | "type": "string"
6206 | },
6207 | "lon": {
6208 | "description": "Longitude",
6209 | "example": "-122.33",
6210 | "type": "string"
6211 | },
6212 | "sources": {
6213 | "description": "List of data sources used in response",
6214 | "items": {
6215 | "example": "12345-89083",
6216 | "type": "string"
6217 | },
6218 | "type": "array"
6219 | },
6220 | "state_code": {
6221 | "description": "State abbreviation",
6222 | "example": "WA",
6223 | "type": "string"
6224 | },
6225 | "timezone": {
6226 | "description": "Local IANA time zone",
6227 | "example": "America/New_York",
6228 | "type": "string"
6229 | }
6230 | },
6231 | "type": "object"
6232 | },
6233 | "HistoryDay": {
6234 | "properties": {
6235 | "city_name": {
6236 | "description": "City name (Closest)",
6237 | "example": "Seattle",
6238 | "type": "string"
6239 | },
6240 | "country_code": {
6241 | "description": "Country abbreviation",
6242 | "example": "US",
6243 | "type": "string"
6244 | },
6245 | "data": {
6246 | "items": {
6247 | "$ref": "#/definitions/HistoryDayObj"
6248 | },
6249 | "type": "array"
6250 | },
6251 | "lat": {
6252 | "description": "Latitude",
6253 | "example": "47.61",
6254 | "type": "string"
6255 | },
6256 | "lon": {
6257 | "description": "Longitude",
6258 | "example": "-122.33",
6259 | "type": "string"
6260 | },
6261 | "sources": {
6262 | "description": "List of data sources used in response",
6263 | "items": {
6264 | "example": "12345-89083",
6265 | "type": "string"
6266 | },
6267 | "type": "array"
6268 | },
6269 | "state_code": {
6270 | "description": "State abbreviation",
6271 | "example": "WA",
6272 | "type": "string"
6273 | },
6274 | "timezone": {
6275 | "description": "Local IANA time zone",
6276 | "example": "America/New_York",
6277 | "type": "string"
6278 | }
6279 | },
6280 | "type": "object"
6281 | },
6282 | "HistoryDayObj": {
6283 | "properties": {
6284 | "datetime": {
6285 | "description": "Date in format \"YYYY-MM-DD\". All datetime is in (UTC)",
6286 | "example": "2015-01-03",
6287 | "type": "string"
6288 | },
6289 | "dewpt": {
6290 | "description": "Average dewpoint - Default (C)",
6291 | "example": -1.5,
6292 | "type": "number"
6293 | },
6294 | "dhi": {
6295 | "description": "Average hourly diffuse horizontal solar irradiance (W/m^2)",
6296 | "example": 125,
6297 | "type": "integer"
6298 | },
6299 | "dni": {
6300 | "description": "Average direct normal solar irradiance (W/m^2)",
6301 | "example": 125,
6302 | "type": "integer"
6303 | },
6304 | "ghi": {
6305 | "description": "Average hourly global horizontal solar irradiance (W/m^2)",
6306 | "example": 125,
6307 | "type": "integer"
6308 | },
6309 | "max_temp": {
6310 | "description": "Max temperature - Default (C)",
6311 | "example": 1.5,
6312 | "type": "number"
6313 | },
6314 | "max_temp_ts": {
6315 | "description": "Time of max memperature - Unix Timestamp",
6316 | "example": 1501970816,
6317 | "type": "number"
6318 | },
6319 | "max_uv": {
6320 | "description": "Max UV Index (1-11+)",
6321 | "example": 6,
6322 | "type": "number"
6323 | },
6324 | "max_wind_dir": {
6325 | "description": "Direction of wind at time of max 2min wind (degrees)",
6326 | "example": 325,
6327 | "type": "integer"
6328 | },
6329 | "max_wind_spd": {
6330 | "description": "Max 2min Wind Speed - default (m/s)",
6331 | "example": 19.98,
6332 | "type": "number"
6333 | },
6334 | "max_wind_spd_ts": {
6335 | "description": "Time of max 2min wind - unix timestamp",
6336 | "example": 1501970516,
6337 | "type": "number"
6338 | },
6339 | "min_temp": {
6340 | "description": "Min temperature - Default (C)",
6341 | "example": 11.7,
6342 | "type": "number"
6343 | },
6344 | "min_temp_ts": {
6345 | "description": "Time of max temperature - unix timestamp",
6346 | "example": 1501970516,
6347 | "type": "number"
6348 | },
6349 | "precip": {
6350 | "description": "Liquid equivalent precipitation - default (mm)",
6351 | "example": 3,
6352 | "type": "number"
6353 | },
6354 | "precip_gpm": {
6355 | "description": "Satellite estimated liquid equivalent precipitation - default (mm)",
6356 | "example": 3,
6357 | "type": "number"
6358 | },
6359 | "pres": {
6360 | "description": "Average pressure (mb)",
6361 | "example": 885.1,
6362 | "type": "number"
6363 | },
6364 | "revision_status": {
6365 | "description": "Data revision status (interim or final)",
6366 | "example": "final",
6367 | "type": "string"
6368 | },
6369 | "rh": {
6370 | "description": "Average relative humidity as a percentage (%)",
6371 | "example": 85,
6372 | "type": "integer"
6373 | },
6374 | "slp": {
6375 | "description": "Average sea level pressure (mb)",
6376 | "example": 1020.1,
6377 | "type": "number"
6378 | },
6379 | "snow": {
6380 | "description": "Snowfall - default (mm)",
6381 | "example": 30,
6382 | "type": "number"
6383 | },
6384 | "snow_depth": {
6385 | "description": "Snow Depth - default (mm)",
6386 | "example": 60,
6387 | "type": "number"
6388 | },
6389 | "t_dhi": {
6390 | "description": "Total diffuse horizontal solar irradiance (W/m^2)",
6391 | "example": 4500,
6392 | "type": "integer"
6393 | },
6394 | "t_dni": {
6395 | "description": "Total direct normal solar irradiance (W/m^2)",
6396 | "example": 4500,
6397 | "type": "integer"
6398 | },
6399 | "t_ghi": {
6400 | "description": "Total global horizontal solar irradiance (W/m^2)",
6401 | "example": 4500,
6402 | "type": "integer"
6403 | },
6404 | "temp": {
6405 | "description": "Average temperature - Default (C)",
6406 | "example": 1,
6407 | "type": "number"
6408 | },
6409 | "ts": {
6410 | "description": "Unix timestamp of datetime (Midnight UTC)",
6411 | "example": 1501970516,
6412 | "type": "integer"
6413 | },
6414 | "wind_dir": {
6415 | "description": "Average wind direction (degrees)",
6416 | "example": 325,
6417 | "type": "integer"
6418 | },
6419 | "wind_gust_spd": {
6420 | "description": "Wind gust speed - default (m/s)",
6421 | "example": 40.98,
6422 | "type": "number"
6423 | },
6424 | "wind_spd": {
6425 | "description": "Average wind speed - default (m/s)",
6426 | "example": 14.98,
6427 | "type": "number"
6428 | }
6429 | },
6430 | "type": "object"
6431 | },
6432 | "HistoryObj": {
6433 | "properties": {
6434 | "app_temp": {
6435 | "description": "Apparent Temperature or Wind Chill/Heat Index (Default Celcius)",
6436 | "example": -1.5,
6437 | "type": "number"
6438 | },
6439 | "azimuth": {
6440 | "description": "Azimuth angle (Degrees)",
6441 | "example": 50.5,
6442 | "type": "number"
6443 | },
6444 | "clouds": {
6445 | "description": "Cloud Cover 0-100 (%)",
6446 | "example": 50,
6447 | "type": "integer"
6448 | },
6449 | "datetime": {
6450 | "description": "Date in format \"YYYY-MM-DD:HH\". All datetime is in (UTC)",
6451 | "example": "2019-03-04:17",
6452 | "type": "string"
6453 | },
6454 | "dewpt": {
6455 | "description": "Dew point (Default Celcius)",
6456 | "example": -1.5,
6457 | "type": "integer"
6458 | },
6459 | "dhi": {
6460 | "description": "Diffuse normal solar irradiance (W/m^2)",
6461 | "example": 200,
6462 | "type": "number"
6463 | },
6464 | "dni": {
6465 | "description": "Direct normal solar irradiance (W/m^2)",
6466 | "example": 400,
6467 | "type": "number"
6468 | },
6469 | "elev_angle": {
6470 | "description": "Solar elevation angle (Degrees)",
6471 | "example": 27.5,
6472 | "type": "number"
6473 | },
6474 | "ghi": {
6475 | "description": "Global horizontal solar irradiance (W/m^2)",
6476 | "example": 1500,
6477 | "type": "number"
6478 | },
6479 | "h_angle": {
6480 | "description": "Solar hour angle (Degrees)",
6481 | "example": 15,
6482 | "type": "number"
6483 | },
6484 | "pod": {
6485 | "description": "Part of the day (d = day, n = night)",
6486 | "example": "n",
6487 | "type": "string"
6488 | },
6489 | "precip": {
6490 | "description": "Liquid equivalent precipitation - Default (mm)",
6491 | "example": 3,
6492 | "type": "number"
6493 | },
6494 | "pres": {
6495 | "description": "Pressure (mb)",
6496 | "example": 845,
6497 | "type": "number"
6498 | },
6499 | "revision_status": {
6500 | "description": "Data revision status (interim or final)",
6501 | "example": "final",
6502 | "type": "string"
6503 | },
6504 | "rh": {
6505 | "description": "Relative Humidity as a percentage (%)",
6506 | "example": 85,
6507 | "type": "integer"
6508 | },
6509 | "slp": {
6510 | "description": "Sea level pressure (mb)",
6511 | "example": 1020.1,
6512 | "type": "number"
6513 | },
6514 | "snow": {
6515 | "description": "Snowfall - Default (mm)",
6516 | "example": 30,
6517 | "type": "number"
6518 | },
6519 | "solar_rad": {
6520 | "description": "Estimated solar radiation (W/m^2)",
6521 | "example": 300,
6522 | "type": "number"
6523 | },
6524 | "temp": {
6525 | "description": "Temperature (Default Celcius)",
6526 | "example": -1.2,
6527 | "type": "number"
6528 | },
6529 | "timestamp_local": {
6530 | "description": "Timestamp in local time",
6531 | "example": "2019-03-04T12:00:00",
6532 | "type": "string"
6533 | },
6534 | "timestamp_utc": {
6535 | "description": "Timestamp UTC",
6536 | "example": "2019-03-04T17:00:00",
6537 | "type": "string"
6538 | },
6539 | "ts": {
6540 | "description": "Unix Timestamp",
6541 | "example": "1551718800",
6542 | "type": "number"
6543 | },
6544 | "uv": {
6545 | "description": "UV Index (1-11+)",
6546 | "example": 4,
6547 | "type": "number"
6548 | },
6549 | "vis": {
6550 | "description": "Visibility (KM)",
6551 | "example": 10,
6552 | "type": "number"
6553 | },
6554 | "weather": {
6555 | "properties": {
6556 | "code": {
6557 | "description": "Weather Condition code",
6558 | "example": "601",
6559 | "type": "string"
6560 | },
6561 | "description": {
6562 | "description": "Weather Condition description",
6563 | "example": "Light Snow",
6564 | "type": "string"
6565 | },
6566 | "icon": {
6567 | "description": "Icon code for forecast image display",
6568 | "example": "s01n",
6569 | "type": "string"
6570 | }
6571 | },
6572 | "type": "object"
6573 | },
6574 | "wind_dir": {
6575 | "description": "Wind direction (Degrees)",
6576 | "example": 325,
6577 | "type": "integer"
6578 | },
6579 | "wind_gust_spd": {
6580 | "description": "Wind Gust Speed - Default (m/s)",
6581 | "example": 16.85,
6582 | "type": "number"
6583 | },
6584 | "wind_spd": {
6585 | "description": "Wind Speed (Default m/s)",
6586 | "example": 14.7,
6587 | "type": "number"
6588 | }
6589 | },
6590 | "type": "object"
6591 | },
6592 | "HistorySubhourly": {
6593 | "properties": {
6594 | "city_name": {
6595 | "description": "City name (Closest)",
6596 | "example": "Seattle",
6597 | "type": "string"
6598 | },
6599 | "country_code": {
6600 | "description": "Country abbreviation",
6601 | "example": "US",
6602 | "type": "string"
6603 | },
6604 | "data": {
6605 | "items": {
6606 | "$ref": "#/definitions/HistoryObj"
6607 | },
6608 | "type": "array"
6609 | },
6610 | "lat": {
6611 | "description": "Latitude",
6612 | "example": "47.61",
6613 | "type": "string"
6614 | },
6615 | "lon": {
6616 | "description": "Longitude",
6617 | "example": "-122.33",
6618 | "type": "string"
6619 | },
6620 | "sources": {
6621 | "description": "List of data sources used in response",
6622 | "items": {
6623 | "example": "12345-89083",
6624 | "type": "string"
6625 | },
6626 | "type": "array"
6627 | },
6628 | "state_code": {
6629 | "description": "State abbreviation",
6630 | "example": "WA",
6631 | "type": "string"
6632 | },
6633 | "timezone": {
6634 | "description": "Local IANA time zone",
6635 | "example": "America/New_York",
6636 | "type": "string"
6637 | }
6638 | },
6639 | "type": "object"
6640 | },
6641 | "HistorySubhourlyObj": {
6642 | "properties": {
6643 | "app_temp": {
6644 | "description": "Apparent Temperature or Wind Chill/Heat Index (Default Celcius)",
6645 | "example": -1.5,
6646 | "type": "number"
6647 | },
6648 | "azimuth": {
6649 | "description": "Solar azimuth angle (Degrees)",
6650 | "example": 40.5,
6651 | "type": "number"
6652 | },
6653 | "clouds": {
6654 | "description": "Cloud Cover 0-100 (%)",
6655 | "example": 50,
6656 | "type": "integer"
6657 | },
6658 | "dewpt": {
6659 | "description": "Dew point (Default Celcius)",
6660 | "example": -1.5,
6661 | "type": "integer"
6662 | },
6663 | "dhi": {
6664 | "description": "Diffuse normal solar irradiance (W/m^2)",
6665 | "example": 200,
6666 | "type": "number"
6667 | },
6668 | "dni": {
6669 | "description": "Direct normal solar irradiance (W/m^2)",
6670 | "example": 400,
6671 | "type": "number"
6672 | },
6673 | "elev_angle": {
6674 | "description": "Solar elevation angle (Degrees)",
6675 | "example": 27.5,
6676 | "type": "number"
6677 | },
6678 | "ghi": {
6679 | "description": "Global horizontal solar irradiance (W/m^2)",
6680 | "example": 1500,
6681 | "type": "number"
6682 | },
6683 | "pod": {
6684 | "description": "Part of the day (d = day, n = night)",
6685 | "example": "n",
6686 | "type": "string"
6687 | },
6688 | "precip_rate": {
6689 | "description": "Liquid equivalent precipitation rate - Default (mm/hr)",
6690 | "example": 3,
6691 | "type": "number"
6692 | },
6693 | "pres": {
6694 | "description": "Pressure (mb)",
6695 | "example": 845,
6696 | "type": "number"
6697 | },
6698 | "revision_status": {
6699 | "description": "Data revision status (interim or final)",
6700 | "example": "final",
6701 | "type": "string"
6702 | },
6703 | "rh": {
6704 | "description": "Relative Humidity as a percentage (%)",
6705 | "example": 85,
6706 | "type": "integer"
6707 | },
6708 | "slp": {
6709 | "description": "Sea level pressure (mb)",
6710 | "example": 1020.1,
6711 | "type": "number"
6712 | },
6713 | "snow_rate": {
6714 | "description": "Snowfall Rate - Default (mm/hr)",
6715 | "example": 30,
6716 | "type": "number"
6717 | },
6718 | "solar_rad": {
6719 | "description": "Estimated solar radiation (W/m^2)",
6720 | "example": 300,
6721 | "type": "number"
6722 | },
6723 | "temp": {
6724 | "description": "Temperature (Default Celcius)",
6725 | "example": -1.2,
6726 | "type": "number"
6727 | },
6728 | "timestamp_local": {
6729 | "description": "Timestamp in local time",
6730 | "example": "2019-03-04T12:15:00",
6731 | "type": "string"
6732 | },
6733 | "timestamp_utc": {
6734 | "description": "Timestamp UTC",
6735 | "example": "2019-03-04T17:15:00",
6736 | "type": "string"
6737 | },
6738 | "ts": {
6739 | "description": "Unix Timestamp",
6740 | "example": "1551718800",
6741 | "type": "number"
6742 | },
6743 | "uv": {
6744 | "description": "UV Index (1-11+)",
6745 | "example": 4,
6746 | "type": "number"
6747 | },
6748 | "vis": {
6749 | "description": "Visibility (KM)",
6750 | "example": 10,
6751 | "type": "number"
6752 | },
6753 | "weather": {
6754 | "properties": {
6755 | "code": {
6756 | "description": "Weather Condition code",
6757 | "example": "601",
6758 | "type": "string"
6759 | },
6760 | "description": {
6761 | "description": "Weather Condition description",
6762 | "example": "Light Snow",
6763 | "type": "string"
6764 | },
6765 | "icon": {
6766 | "description": "Icon code for forecast image display",
6767 | "example": "s01n",
6768 | "type": "string"
6769 | }
6770 | },
6771 | "type": "object"
6772 | },
6773 | "wind_dir": {
6774 | "description": "Wind direction (Degrees)",
6775 | "example": 325,
6776 | "type": "integer"
6777 | },
6778 | "wind_gust_spd": {
6779 | "description": "Wind Gust Speed - Default (m/s)",
6780 | "example": 16.85,
6781 | "type": "number"
6782 | },
6783 | "wind_spd": {
6784 | "description": "Wind Speed (Default m/s)",
6785 | "example": 14.7,
6786 | "type": "number"
6787 | }
6788 | },
6789 | "type": "object"
6790 | },
6791 | "WeatherAlert": {
6792 | "properties": {
6793 | "alerts": {
6794 | "items": {
6795 | "$ref": "#/definitions/WeatherAlertGroup"
6796 | },
6797 | "type": "array"
6798 | },
6799 | "lat": {
6800 | "description": "Latitude",
6801 | "example": 38,
6802 | "type": "number"
6803 | },
6804 | "lon": {
6805 | "description": "Longitude",
6806 | "example": -78.25,
6807 | "type": "number"
6808 | }
6809 | },
6810 | "type": "object"
6811 | },
6812 | "WeatherAlertGroup": {
6813 | "properties": {
6814 | "alerts": {
6815 | "items": {
6816 | "$ref": "#/definitions/AlertRegionGroup"
6817 | },
6818 | "type": "array"
6819 | },
6820 | "description": {
6821 | "description": "Full description of weather alert",
6822 | "example": "Mississippi River at Chester\n\n.This Flood Warning is a result of 1-2 inches of rainfall across\nthe basin earlier this week...\nThe Flood Warning continues for\nthe Mississippi River at Chester\n* until Tuesday morning.\n* At 8:30 PM Friday the stage was 26.8 feet.\n* Flood stage is 27.0 feet.\n* Minor flooding is forecast.\n* The river is forecast to rise above flood stage by tonight and to\ncrest near 29.0 feet by Saturday evening. The river is forecast to\nfall below flood stage by Monday morning.\n* Impact: At 28.0 feet...Unleveed islands near Chester and the prison\nfarm floods.\n* Impact: At 27.0 feet...Flood Stage. Unprotected farmland on right\nbank begins to flood.",
6823 | "type": "string"
6824 | },
6825 | "effective_local": {
6826 | "description": "Issued time local",
6827 | "example": "2019-02-08T21:51:00",
6828 | "type": "string"
6829 | },
6830 | "effective_utc": {
6831 | "description": "Issued time UTC",
6832 | "example": "2019-02-09T02:51:00",
6833 | "type": "string"
6834 | },
6835 | "expires_local": {
6836 | "description": "Expiration time local",
6837 | "example": "2019-02-09T21:51:00",
6838 | "type": "string"
6839 | },
6840 | "expires_utc": {
6841 | "description": "Expiration time UTC",
6842 | "example": "2019-02-10T02:51:00",
6843 | "type": "string"
6844 | },
6845 | "severity": {
6846 | "description": "Severity of weather. (Advisory | Watch | Warning)",
6847 | "example": "Warning",
6848 | "type": "string"
6849 | },
6850 | "title": {
6851 | "description": "Brief description of weather alert",
6852 | "example": "Flood Warning issued February 8 at 8:51PM CST expiring February 12 at 8:24AM CST by NWS St Louis MO",
6853 | "type": "string"
6854 | },
6855 | "uri": {
6856 | "description": "URI to weather alert",
6857 | "example": "https://api.weather.gov/alerts/NWS-IDP-PROD-3361975-2942026",
6858 | "type": "string"
6859 | }
6860 | },
6861 | "type": "object"
6862 | }
6863 | }
6864 | }
```