@apifreaks/openapi-specs 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +156 -0
  3. package/dist/index.cjs +44663 -0
  4. package/dist/index.d.cts +30 -0
  5. package/dist/index.d.ts +30 -0
  6. package/dist/index.js +44631 -0
  7. package/package.json +81 -0
  8. package/specs/commodity/commodity-fluctuation.json +301 -0
  9. package/specs/commodity/commodity-prices.json +317 -0
  10. package/specs/commodity/commodity-symbols.json +215 -0
  11. package/specs/commodity/commodity-time-series.json +329 -0
  12. package/specs/commodity/historical-commodity-prices.json +273 -0
  13. package/specs/currency/currency-converter.json +261 -0
  14. package/specs/currency/currency-fluctuation.json +282 -0
  15. package/specs/currency/currency-historical-data-limit.json +158 -0
  16. package/specs/currency/currency-rate.json +229 -0
  17. package/specs/currency/currency-supported.json +234 -0
  18. package/specs/currency/currency-symbols.json +161 -0
  19. package/specs/currency/currency-time-series.json +325 -0
  20. package/specs/currency/geolocalized-currency-conversion.json +287 -0
  21. package/specs/currency/historical-currency-converter.json +269 -0
  22. package/specs/currency/historical-currency-rate.json +246 -0
  23. package/specs/dns/bulk-dns-lookup.json +624 -0
  24. package/specs/dns/dns-history-lookup.json +579 -0
  25. package/specs/dns/dns-lookup.json +466 -0
  26. package/specs/dns/reverse-dns-lookup.json +414 -0
  27. package/specs/domain/bulk-domain-checker.json +284 -0
  28. package/specs/domain/domain-search-with-suggestions.json +280 -0
  29. package/specs/domain/domain-search.json +206 -0
  30. package/specs/domain/subdomain-lookup.json +343 -0
  31. package/specs/email-validation/bulk-email-validation.json +534 -0
  32. package/specs/email-validation/email-checker.json +586 -0
  33. package/specs/financial/bulk-vat-rates-country.json +341 -0
  34. package/specs/financial/financial-apis-supported-countries.json +204 -0
  35. package/specs/financial/iban-validation.json +328 -0
  36. package/specs/financial/swift-code-finder.json +192 -0
  37. package/specs/financial/swift-code-lookup.json +220 -0
  38. package/specs/financial/vat-number-validation.json +283 -0
  39. package/specs/financial/vat-rates-by-ip.json +275 -0
  40. package/specs/financial/vat-rates-country.json +288 -0
  41. package/specs/general/usage-credits.json +218 -0
  42. package/specs/geocoding/forward-geocoding.json +402 -0
  43. package/specs/geocoding/reverse-geocoding.json +326 -0
  44. package/specs/geodb/administrative-units-details.json +250 -0
  45. package/specs/geodb/administrative-units-levels.json +198 -0
  46. package/specs/geodb/administrative-units.json +237 -0
  47. package/specs/geodb/cities.json +288 -0
  48. package/specs/geodb/countries-details.json +274 -0
  49. package/specs/geodb/countries.json +276 -0
  50. package/specs/geodb/flags-supported.json +166 -0
  51. package/specs/geodb/flags.json +227 -0
  52. package/specs/geodb/regions.json +109 -0
  53. package/specs/geodb/subregions.json +217 -0
  54. package/specs/ip-intelligence/bulk-ip-lookup.json +1162 -0
  55. package/specs/ip-intelligence/bulk-ip-threat-intelligence.json +417 -0
  56. package/specs/ip-intelligence/ip-locator.json +941 -0
  57. package/specs/ip-intelligence/ip-threat-intelligence.json +316 -0
  58. package/specs/other/astronomy-data.json +803 -0
  59. package/specs/pdf/delete-pdf-page.json +286 -0
  60. package/specs/pdf/linearize-pdf.json +277 -0
  61. package/specs/pdf/merge-pdf.json +285 -0
  62. package/specs/pdf/pdf-compress.json +304 -0
  63. package/specs/pdf/pdf-decrypt.json +297 -0
  64. package/specs/pdf/pdf-encrypt.json +314 -0
  65. package/specs/pdf/pdf-extract-pages.json +295 -0
  66. package/specs/pdf/pdf-file-status.json +208 -0
  67. package/specs/pdf/pdf-file.json +190 -0
  68. package/specs/pdf/pdf-files.json +126 -0
  69. package/specs/pdf/pdf-resource-download.json +168 -0
  70. package/specs/pdf/pdf-resource-upload-binary.json +218 -0
  71. package/specs/pdf/pdf-resource-upload.json +248 -0
  72. package/specs/pdf/pdf-restrict.json +343 -0
  73. package/specs/pdf/pdf-split-pages.json +281 -0
  74. package/specs/pdf/pdf-task-status.json +252 -0
  75. package/specs/pdf/pdf-to-image.json +1219 -0
  76. package/specs/pdf/pdf-unrestrict.json +324 -0
  77. package/specs/pdf/rotate-pdf-pages.json +305 -0
  78. package/specs/phone-validation/bulk-phone-number-validation.json +518 -0
  79. package/specs/phone-validation/phone-number-validation.json +456 -0
  80. package/specs/scraper/web-scraper.json +674 -0
  81. package/specs/screenshot/bulk-screenshot.json +949 -0
  82. package/specs/screenshot/website-screenshot.json +1147 -0
  83. package/specs/ssl/ssl-certificate-chain-lookup.json +756 -0
  84. package/specs/ssl/ssl-certificate-lookup.json +634 -0
  85. package/specs/timezone/timezone-converter.json +362 -0
  86. package/specs/timezone/timezone-lookup.json +910 -0
  87. package/specs/user-agent/bulk-user-agent-parser.json +441 -0
  88. package/specs/user-agent/user-agent-parser.json +346 -0
  89. package/specs/weather/air-quality.json +779 -0
  90. package/specs/weather/bulk-live-weather.json +834 -0
  91. package/specs/weather/flood-forecast.json +693 -0
  92. package/specs/weather/historical-weather.json +1019 -0
  93. package/specs/weather/live-weather.json +789 -0
  94. package/specs/weather/marine-weather.json +940 -0
  95. package/specs/weather/time-series-weather.json +1056 -0
  96. package/specs/weather/weather-forecast.json +1202 -0
  97. package/specs/whois/asn-lookup.json +729 -0
  98. package/specs/whois/bulk-whois-lookup.json +698 -0
  99. package/specs/whois/domain-whois-history-lookup.json +500 -0
  100. package/specs/whois/reverse-whois.json +625 -0
  101. package/specs/whois/whois-domain-lookup.json +533 -0
  102. package/specs/whois/whois-ip-lookup.json +1110 -0
  103. package/specs/zip-code/bulk-zip-code-lookup.json +318 -0
  104. package/specs/zip-code/zip-code-api.json +299 -0
  105. package/specs/zip-code/zip-code-distance-match.json +311 -0
  106. package/specs/zip-code/zip-code-distance.json +307 -0
  107. package/specs/zip-code/zip-codes-by-city.json +279 -0
  108. package/specs/zip-code/zip-codes-by-region.json +278 -0
  109. package/specs/zip-code/zip-codes-radius-search.json +349 -0
@@ -0,0 +1,1056 @@
1
+ {
2
+ "openapi": "3.1.1",
3
+ "info": {
4
+ "title": "Time Series Weather API Reference",
5
+ "version": "1.0.0",
6
+ "description": "Pull historical weather data across a date range for a single location. Requires startDate and endDate with a range up to 90 days for daily precision or 7 days for hourly precision. Accepts location by city name, GPS coordinates, or IP address. Returns daily or hourly data keyed by date in an object, with each date containing temperature max/min/mean, precipitation, wind speed and gusts, cloud cover, relative humidity, pressure, dew point, shortwave radiation, and evapotranspiration data plus astronomy information (sunrise/sunset, moon phase). All dates must be in the past (1940 onwards).",
7
+ "contact": {
8
+ "name": "APIFreaks Support",
9
+ "url": "https://apifreaks.com/contact",
10
+ "email": "support@apifreaks.com"
11
+ }
12
+ },
13
+ "servers": [
14
+ {
15
+ "url": "https://api.apifreaks.com/v1.0/weather",
16
+ "description": "Time Series Weather API Server"
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/time-series": {
21
+ "get": {
22
+ "tags": ["Weather APIs"],
23
+ "summary": "Get historical weather data across a date range",
24
+ "description": "Pull historical weather information for date ranges up to 90 days (daily data) or 7 days (hourly data). Get consistent formatting across your specified date range with reliable historical weather patterns.",
25
+ "operationId": "getTimeSeriesData",
26
+ "parameters": [
27
+ {
28
+ "name": "format",
29
+ "in": "query",
30
+ "required": false,
31
+ "description": "Format of the response. Possible values: json.",
32
+ "schema": {
33
+ "type": "string",
34
+ "enum": ["json"],
35
+ "default": "json"
36
+ }
37
+ },
38
+ {
39
+ "name": "startDate",
40
+ "in": "query",
41
+ "required": true,
42
+ "schema": {
43
+ "type": "string",
44
+ "format": "date"
45
+ },
46
+ "description": "Starting date for the data in YYYY-MM-DD format. Historical dates must be past dates only. Current or future dates are not allowed for historical data. Data available from 1940 onwards. For precision=daily, the difference between endDate and startDate must not exceed 90 days. For precision=hourly, the difference must not exceed 7 days."
47
+ },
48
+ {
49
+ "name": "endDate",
50
+ "in": "query",
51
+ "required": true,
52
+ "schema": {
53
+ "type": "string",
54
+ "format": "date"
55
+ },
56
+ "description": "End date for the data in YYYY-MM-DD format. Historical dates must be past dates only. Current or future dates are not allowed for historical data. Data available from 1940 onwards. For precision=daily, the difference between endDate and startDate must not exceed 90 days. For precision=hourly, the difference must not exceed 7 days."
57
+ },
58
+ {
59
+ "name": "location",
60
+ "in": "query",
61
+ "schema": {
62
+ "type": "string"
63
+ },
64
+ "description": "City name, place name, or full address.",
65
+ "required": false
66
+ },
67
+ {
68
+ "name": "lat",
69
+ "in": "query",
70
+ "schema": {
71
+ "type": "number"
72
+ },
73
+ "description": "Latitude of the location, used together with long. A value of exactly 0 is treated as missing by the live API and returns a 400, so use a small non-zero value (e.g. 0.0001) for equator queries.",
74
+ "required": false
75
+ },
76
+ {
77
+ "name": "long",
78
+ "in": "query",
79
+ "schema": {
80
+ "type": "number"
81
+ },
82
+ "description": "Longitude of the location, used together with lat. A value of exactly 0 is treated as missing by the live API and returns a 400, so use a small non-zero value (e.g. 0.0001) for prime-meridian queries.",
83
+ "required": false
84
+ },
85
+ {
86
+ "name": "ip",
87
+ "in": "query",
88
+ "schema": {
89
+ "type": "string"
90
+ },
91
+ "description": "IP(v4 or v6) address for location inference.",
92
+ "required": false
93
+ },
94
+ {
95
+ "name": "precision",
96
+ "in": "query",
97
+ "schema": {
98
+ "enum": ["daily", "hourly"],
99
+ "type": "string",
100
+ "default": "daily"
101
+ },
102
+ "description": "Precision of the data. daily returns a daily aggregate per date; hourly returns 24 hourly readings per date instead and requires the date range to be 7 days or less.",
103
+ "required": false
104
+ },
105
+ {
106
+ "name": "timezone",
107
+ "in": "query",
108
+ "schema": {
109
+ "type": "string"
110
+ },
111
+ "description": "Timezone for the results.",
112
+ "required": false
113
+ }
114
+ ],
115
+ "responses": {
116
+ "200": {
117
+ "description": "Successful response",
118
+ "content": {
119
+ "application/json": {
120
+ "schema": {
121
+ "$ref": "#/components/schemas/TimeSeriesResponse"
122
+ },
123
+ "examples": {
124
+ "typicalSuccess": {
125
+ "summary": "Typical successful response (daily precision, address lookup)",
126
+ "value": {
127
+ "location": {
128
+ "location_string": "Lahore",
129
+ "country_name": "Pakistan",
130
+ "state_prov": "Punjab",
131
+ "city": "Lahore",
132
+ "locality": "",
133
+ "latitude": "31.56568",
134
+ "longitude": "74.31418",
135
+ "elevation": "",
136
+ "timezone": "Asia/Karachi",
137
+ "timezone_abbreviation": "GMT+5"
138
+ },
139
+ "historical": {
140
+ "2025-08-01": {
141
+ "daily": {
142
+ "timestamp": "2025-08-01",
143
+ "weather_code": 63,
144
+ "temperature_2m_mean": 27.7,
145
+ "temperature_2m_max": 30.3,
146
+ "temperature_2m_min": 26,
147
+ "apparent_temperature_mean": 34,
148
+ "apparent_temperature_max": 36.8,
149
+ "apparent_temperature_min": 31.8,
150
+ "precipitation_sum": 11.9,
151
+ "rain_sum": 11.9,
152
+ "snowfall_sum": 0,
153
+ "wind_speed_10m_max": 10.9,
154
+ "wind_gusts_10m_max": 27.7,
155
+ "wind_speed_10m_mean": 7.4,
156
+ "wind_speed_10m_min": 3.1,
157
+ "wind_gusts_10m_min": 6.8,
158
+ "wind_gusts_10m_mean": 17.8,
159
+ "wind_direction_10m_dominant": 82,
160
+ "shortwave_radiation_sum": 8.98,
161
+ "et0_fao_evapotranspiration_sum": 2.01,
162
+ "cloud_cover_mean": 99,
163
+ "dew_point_2m_mean": 25.9,
164
+ "dew_point_2m_max": 26.5,
165
+ "dew_point_2m_min": 24.9,
166
+ "relative_humidity_2m_mean": 90,
167
+ "relative_humidity_2m_max": 97,
168
+ "relative_humidity_2m_min": 79,
169
+ "pressure_msl_mean": 999.2,
170
+ "surface_pressure_mean": 975.3
171
+ },
172
+ "astronomy": {
173
+ "date": "2025-08-01",
174
+ "mid_night": "00:09",
175
+ "night_end": "03:47",
176
+ "sunrise": "05:17",
177
+ "sunset": "19:00",
178
+ "night_begin": "20:30",
179
+ "sun_status": "-",
180
+ "solar_noon": "12:09",
181
+ "day_length": "13:43",
182
+ "moon_phase": "FIRST_QUARTER",
183
+ "moonrise": "12:18",
184
+ "moonset": "23:04",
185
+ "moon_status": "-"
186
+ }
187
+ }
188
+ }
189
+ }
190
+ },
191
+ "hourlyPrecision": {
192
+ "summary": "Hourly precision response (no daily key)",
193
+ "value": {
194
+ "location": {
195
+ "location_string": "Lahore",
196
+ "country_name": "Pakistan",
197
+ "state_prov": "Punjab",
198
+ "city": "Lahore",
199
+ "locality": "",
200
+ "latitude": "31.56568",
201
+ "longitude": "74.31418",
202
+ "elevation": "",
203
+ "timezone": "Asia/Karachi",
204
+ "timezone_abbreviation": "GMT+5"
205
+ },
206
+ "historical": {
207
+ "2025-08-01": {
208
+ "hourly": [
209
+ {
210
+ "timestamp": "2025-08-01T00:00",
211
+ "temperature_2m": 27,
212
+ "relative_humidity_2m": 92,
213
+ "dew_point_2m": 25.5,
214
+ "apparent_temperature": 32.9,
215
+ "precipitation": 0,
216
+ "rain": 0,
217
+ "snowfall": 0,
218
+ "weather_code": 3,
219
+ "pressure_msl": 999.5,
220
+ "surface_pressure": 975.5,
221
+ "cloud_cover": 100,
222
+ "et0_fao_evapotranspiration": 0,
223
+ "wind_speed_10m": 8.2,
224
+ "wind_direction_10m": 100,
225
+ "wind_gusts_10m": 16.2,
226
+ "albedo": null,
227
+ "shortwave_radiation": 0,
228
+ "direct_radiation": 0,
229
+ "diffuse_radiation": 0,
230
+ "direct_normal_irradiance": 0,
231
+ "global_tilted_irradiance": 0
232
+ }
233
+ ],
234
+ "astronomy": {
235
+ "date": "2025-08-01",
236
+ "mid_night": "00:09",
237
+ "night_end": "03:47",
238
+ "sunrise": "05:17",
239
+ "sunset": "19:00",
240
+ "night_begin": "20:30",
241
+ "sun_status": "-",
242
+ "solar_noon": "12:09",
243
+ "day_length": "13:43",
244
+ "moon_phase": "FIRST_QUARTER",
245
+ "moonrise": "12:18",
246
+ "moonset": "23:04",
247
+ "moon_status": "-"
248
+ }
249
+ }
250
+ }
251
+ }
252
+ }
253
+ }
254
+ }
255
+ }
256
+ },
257
+ "400": {
258
+ "description": "Bad Request — Missing/invalid parameters, invalid date range, or location could not be resolved",
259
+ "content": {
260
+ "application/json": {
261
+ "schema": {
262
+ "$ref": "#/components/schemas/ErrorResponse"
263
+ },
264
+ "examples": {
265
+ "MissingParams": {
266
+ "summary": "Missing startDate/endDate",
267
+ "value": {
268
+ "timestamp": "2026-07-24T11:35:05.667Z",
269
+ "status": 400,
270
+ "message": "please pass correct parameters",
271
+ "error": "Invalid Param Exception",
272
+ "path": "/v1.0/weather/time-series"
273
+ }
274
+ },
275
+ "InvalidDateFormat": {
276
+ "summary": "startDate/endDate not in YYYY-MM-DD format",
277
+ "value": {
278
+ "timestamp": "2026-07-24T11:35:26.589Z",
279
+ "status": 400,
280
+ "message": "startDate must be in yyyy-mm-dd format",
281
+ "error": "invalid-params",
282
+ "path": "/v1.0/weather/time-series"
283
+ }
284
+ },
285
+ "DateRangeTooWideDaily": {
286
+ "summary": "Range over 90 days at daily precision",
287
+ "value": {
288
+ "timestamp": "2026-07-24T11:35:06.179Z",
289
+ "status": 400,
290
+ "message": "Date range cannot exceed 90 days.",
291
+ "error": "error",
292
+ "path": "/v1.0/weather/time-series"
293
+ }
294
+ },
295
+ "DateRangeTooWideHourly": {
296
+ "summary": "Range over 7 days at hourly precision",
297
+ "value": {
298
+ "timestamp": "2026-07-24T11:35:06.654Z",
299
+ "status": 400,
300
+ "message": "Time-series hourly date range must not exceed 7 days",
301
+ "error": "params-exception-error",
302
+ "path": "/v1.0/weather/time-series"
303
+ }
304
+ },
305
+ "EndDateBeforeStartDate": {
306
+ "summary": "endDate earlier than startDate",
307
+ "value": {
308
+ "timestamp": "2026-07-24T11:35:14.787Z",
309
+ "status": 400,
310
+ "message": "startDate must be before or equal to endDate",
311
+ "error": "params-exception-error",
312
+ "path": "/v1.0/weather/time-series"
313
+ }
314
+ },
315
+ "FutureDate": {
316
+ "summary": "endDate is today or in the future",
317
+ "value": {
318
+ "timestamp": "2026-07-24T11:35:14.329Z",
319
+ "status": 400,
320
+ "message": "endDate cannot be current or future date",
321
+ "error": "params-exception-error",
322
+ "path": "/v1.0/weather/time-series"
323
+ }
324
+ },
325
+ "DateOutOfRange": {
326
+ "summary": "startDate earlier than 1940-01-01",
327
+ "value": {
328
+ "timestamp": "2026-07-24T11:35:26.108Z",
329
+ "status": 400,
330
+ "message": "Parameter 'startDate' is out of allowed range from 1940-01-01 to 2026-07-24",
331
+ "error": "error",
332
+ "path": "/v1.0/weather/time-series"
333
+ }
334
+ },
335
+ "InvalidCoordinates": {
336
+ "summary": "Latitude or longitude out of range (e.g. lat=999)",
337
+ "value": {
338
+ "timestamp": "2026-07-24T11:35:15.849Z",
339
+ "status": 400,
340
+ "message": "Invalid latitude or longitude values. Latitude must be between -90 and 90, and longitude must be between -180 and 180",
341
+ "error": "invalid-params",
342
+ "path": "/v1.0/weather/time-series"
343
+ }
344
+ },
345
+ "InvalidIPAddress": {
346
+ "summary": "Invalid IP address",
347
+ "value": {
348
+ "timestamp": "2026-07-24T11:35:16.321Z",
349
+ "status": 400,
350
+ "message": "Invalid IP address",
351
+ "error": "invalid-params",
352
+ "path": "/v1.0/weather/time-series"
353
+ }
354
+ },
355
+ "LocationNotFound": {
356
+ "summary": "Location string could not be geocoded (returns 400, not 404, on this endpoint)",
357
+ "value": {
358
+ "timestamp": "2026-07-24T11:36:14.115Z",
359
+ "status": 400,
360
+ "message": "We couldn't find the location (xyzxyzxyz123nonexistent). Try a city or state level location address only.",
361
+ "error": "error",
362
+ "path": "/v1.0/weather/time-series"
363
+ }
364
+ },
365
+ "InvalidPrecision": {
366
+ "summary": "precision value outside daily/hourly",
367
+ "value": {
368
+ "timestamp": "2026-07-24T11:36:04.187Z",
369
+ "status": 400,
370
+ "message": "Invalid precision",
371
+ "error": "invalid-params",
372
+ "path": "/v1.0/weather/time-series"
373
+ }
374
+ },
375
+ "InvalidTimezone": {
376
+ "summary": "Unrecognized timezone value",
377
+ "value": {
378
+ "timestamp": "2026-07-24T11:36:04.753Z",
379
+ "status": 400,
380
+ "message": "Check whether your input value is correct; timezone = NotATimezone",
381
+ "error": "error",
382
+ "path": "/v1.0/weather/time-series"
383
+ }
384
+ }
385
+ }
386
+ }
387
+ }
388
+ }
389
+ }
390
+ }
391
+ }
392
+ },
393
+ "components": {
394
+ "securitySchemes": {
395
+ "ApiKeyAuthHeader": {
396
+ "type": "apiKey",
397
+ "in": "header",
398
+ "name": "X-apiKey",
399
+ "description": "Pass your API key via the X-apiKey request header."
400
+ },
401
+ "ApiKeyAuthQuery": {
402
+ "type": "apiKey",
403
+ "in": "query",
404
+ "name": "apiKey",
405
+ "description": "Pass your API key via the apiKey query parameter."
406
+ }
407
+ },
408
+ "schemas": {
409
+ "TimeSeriesResponse": {
410
+ "type": "object",
411
+ "properties": {
412
+ "location": {
413
+ "$ref": "#/components/schemas/WeatherLocation"
414
+ },
415
+ "historical": {
416
+ "$ref": "#/components/schemas/TimeSeriesData"
417
+ }
418
+ },
419
+ "required": ["location", "historical"],
420
+ "description": "Time-series weather response containing location data and date-keyed time-series data."
421
+ },
422
+ "LocationByCoordinates": {
423
+ "type": "object",
424
+ "required": [
425
+ "latitude",
426
+ "longitude",
427
+ "country_name",
428
+ "state_prov",
429
+ "city",
430
+ "timezone",
431
+ "timezone_abbreviation"
432
+ ],
433
+ "properties": {
434
+ "latitude": {
435
+ "type": "string",
436
+ "description": "Geographic latitude coordinate in decimal degrees, ranging from -90 (South Pole) to +90 (North Pole). Returned as a string, not a number."
437
+ },
438
+ "longitude": {
439
+ "type": "string",
440
+ "description": "Geographic longitude coordinate in decimal degrees, ranging from -180 (West) to +180 (East). Returned as a string, not a number."
441
+ },
442
+ "country_name": {
443
+ "type": "string",
444
+ "description": "Full name of the country corresponding to the provided coordinates. Empty string when the coordinates could not be reverse-geocoded (e.g. open ocean)."
445
+ },
446
+ "state_prov": {
447
+ "type": "string",
448
+ "description": "State, province, or primary administrative division name for the location. Empty string when the coordinates could not be reverse-geocoded."
449
+ },
450
+ "city": {
451
+ "type": "string",
452
+ "description": "City or municipal area name associated with the coordinate location. Empty string when the coordinates could not be reverse-geocoded."
453
+ },
454
+ "locality": {
455
+ "type": "string",
456
+ "description": "Specific locality, neighborhood, district, or village name within the broader area."
457
+ },
458
+ "elevation": {
459
+ "type": "string",
460
+ "description": "Height above mean sea level in meters for the specified coordinates. Returned as a string, not a number; can be an empty string when unavailable."
461
+ },
462
+ "timezone": {
463
+ "type": "string",
464
+ "description": "IANA timezone database identifier for the location (e.g., America/New_York, Europe/London)."
465
+ },
466
+ "timezone_abbreviation": {
467
+ "type": "string",
468
+ "description": "Abbreviated timezone representation based on current offset (e.g., EST, GMT, PST)."
469
+ }
470
+ },
471
+ "description": "Location data when the target is specified by GPS coordinates (lat/long)."
472
+ },
473
+ "LocationByIP": {
474
+ "type": "object",
475
+ "required": [
476
+ "continent_code",
477
+ "continent_name",
478
+ "country_code2",
479
+ "country_code3",
480
+ "country_name",
481
+ "country_name_official",
482
+ "state_prov",
483
+ "city",
484
+ "latitude",
485
+ "longitude",
486
+ "timezone",
487
+ "timezone_abbreviation"
488
+ ],
489
+ "properties": {
490
+ "continent_code": {
491
+ "type": "string",
492
+ "description": "Two-letter continent code (e.g., NA for North America, EU for Europe, AS for Asia)."
493
+ },
494
+ "continent_name": {
495
+ "type": "string",
496
+ "description": "Full name of the continent where the IP address is registered."
497
+ },
498
+ "country_code2": {
499
+ "type": "string",
500
+ "description": "ISO 3166-1 alpha-2 two-letter country code (e.g., US, GB, FR)."
501
+ },
502
+ "country_code3": {
503
+ "type": "string",
504
+ "description": "ISO 3166-1 alpha-3 three-letter country code (e.g., USA, GBR, FRA)."
505
+ },
506
+ "country_name": {
507
+ "type": "string",
508
+ "description": "Common name of the country associated with the IP address."
509
+ },
510
+ "country_name_official": {
511
+ "type": "string",
512
+ "description": "Official long-form country name as recognized internationally (e.g., United States of America)."
513
+ },
514
+ "is_eu": {
515
+ "type": "boolean",
516
+ "description": "Boolean flag indicating whether the country is a member state of the European Union."
517
+ },
518
+ "state_prov": {
519
+ "type": "string",
520
+ "description": "State, province, or primary administrative division associated with the IP location."
521
+ },
522
+ "state_code": {
523
+ "type": "string",
524
+ "description": "ISO 3166-2 subdivision code for the state or province (e.g., CA for California)."
525
+ },
526
+ "district": {
527
+ "type": "string",
528
+ "description": "District, county, or secondary administrative division within the region."
529
+ },
530
+ "city": {
531
+ "type": "string",
532
+ "description": "City or urban area name where the IP address is geographically registered."
533
+ },
534
+ "zipcode": {
535
+ "type": "string",
536
+ "description": "Postal code or ZIP code for the approximate location of the IP address."
537
+ },
538
+ "latitude": {
539
+ "type": "string",
540
+ "description": "Geographic latitude in decimal degrees for the IP geolocation, ranging from -90 to +90. Returned as a string, not a number."
541
+ },
542
+ "longitude": {
543
+ "type": "string",
544
+ "description": "Geographic longitude in decimal degrees for the IP geolocation, ranging from -180 to +180. Returned as a string, not a number."
545
+ },
546
+ "locality": {
547
+ "type": "string",
548
+ "description": "Specific locality, neighborhood, or small area designation within the city."
549
+ },
550
+ "elevation": {
551
+ "type": "string",
552
+ "description": "Elevation above mean sea level in meters for the IP geolocation. Returned as a string, not a number; can be an empty string when unavailable."
553
+ },
554
+ "timezone": {
555
+ "type": "string",
556
+ "description": "IANA timezone database identifier for the IP location (e.g., America/Chicago, Asia/Tokyo)."
557
+ },
558
+ "timezone_abbreviation": {
559
+ "type": "string",
560
+ "description": "Current timezone abbreviation based on local offset (e.g., CST, JST, UTC)."
561
+ }
562
+ },
563
+ "description": "Location data when the target is inferred from an IP address."
564
+ },
565
+ "LocationByAddress": {
566
+ "type": "object",
567
+ "required": [
568
+ "location_string",
569
+ "country_name",
570
+ "state_prov",
571
+ "city",
572
+ "latitude",
573
+ "longitude",
574
+ "timezone",
575
+ "timezone_abbreviation"
576
+ ],
577
+ "properties": {
578
+ "location_string": {
579
+ "type": "string",
580
+ "description": "Original location query string as submitted, including full address or place name."
581
+ },
582
+ "country_name": {
583
+ "type": "string",
584
+ "description": "Resolved country name derived from the geocoded location query."
585
+ },
586
+ "state_prov": {
587
+ "type": "string",
588
+ "description": "State, province, or primary administrative division identified from the location."
589
+ },
590
+ "city": {
591
+ "type": "string",
592
+ "description": "City or municipal area name extracted from the geocoded location."
593
+ },
594
+ "locality": {
595
+ "type": "string",
596
+ "description": "Specific locality, neighborhood, suburb, or village within the geocoded area."
597
+ },
598
+ "latitude": {
599
+ "type": "string",
600
+ "description": "Geocoded latitude coordinate in decimal degrees, ranging from -90 to +90. Returned as a string, not a number."
601
+ },
602
+ "longitude": {
603
+ "type": "string",
604
+ "description": "Geocoded longitude coordinate in decimal degrees, ranging from -180 to +180. Returned as a string, not a number."
605
+ },
606
+ "elevation": {
607
+ "type": "string",
608
+ "description": "Elevation above mean sea level in meters at the geocoded coordinates. Returned as a string, not a number; can be an empty string when unavailable."
609
+ },
610
+ "timezone": {
611
+ "type": "string",
612
+ "description": "IANA timezone database identifier for the geocoded location (e.g., America/Los_Angeles)."
613
+ },
614
+ "timezone_abbreviation": {
615
+ "type": "string",
616
+ "description": "Current timezone abbreviation for the location based on local offset (e.g., PDT, CET)."
617
+ }
618
+ },
619
+ "description": "Location data when the target is specified by a city name or address string."
620
+ },
621
+ "HistoricalDaily": {
622
+ "type": "object",
623
+ "properties": {
624
+ "timestamp": {
625
+ "type": "string",
626
+ "format": "date-time",
627
+ "description": "ISO 8601 formatted timestamp"
628
+ },
629
+ "weather_code": {
630
+ "type": "integer",
631
+ "description": "Weather condition code"
632
+ },
633
+ "temperature_2m_mean": {
634
+ "type": "number",
635
+ "description": "Daily mean air temperature at 2 meters (°C)"
636
+ },
637
+ "temperature_2m_max": {
638
+ "type": "number",
639
+ "description": "Daily maximum air temperature at 2 meters (°C)"
640
+ },
641
+ "temperature_2m_min": {
642
+ "type": "number",
643
+ "description": "Daily minimum air temperature at 2 meters (°C)"
644
+ },
645
+ "apparent_temperature_mean": {
646
+ "type": "number",
647
+ "description": "Daily mean perceived temperature (°C)"
648
+ },
649
+ "apparent_temperature_max": {
650
+ "type": "number",
651
+ "description": "Daily maximum perceived temperature (°C)"
652
+ },
653
+ "apparent_temperature_min": {
654
+ "type": "number",
655
+ "description": "Daily minimum perceived temperature (°C)"
656
+ },
657
+ "precipitation_sum": {
658
+ "type": "number",
659
+ "description": "Total precipitation (mm)"
660
+ },
661
+ "rain_sum": {
662
+ "type": "number",
663
+ "description": "Total rainfall (mm)"
664
+ },
665
+ "snowfall_sum": {
666
+ "type": "number",
667
+ "description": "Total snowfall (cm)"
668
+ },
669
+ "wind_speed_10m_max": {
670
+ "type": "number",
671
+ "description": "Maximum wind speed at 10 meters (km/h)"
672
+ },
673
+ "wind_gusts_10m_max": {
674
+ "type": "number",
675
+ "description": "Maximum wind gusts at 10 meters (km/h)"
676
+ },
677
+ "wind_speed_10m_mean": {
678
+ "type": "number",
679
+ "description": "Daily mean wind speed at 10 meters (km/h)"
680
+ },
681
+ "wind_speed_10m_min": {
682
+ "type": "number",
683
+ "description": "Minimum wind speed at 10 meters (km/h)"
684
+ },
685
+ "wind_gusts_10m_min": {
686
+ "type": "number",
687
+ "description": "Minimum wind gusts at 10 meters (km/h)"
688
+ },
689
+ "wind_gusts_10m_mean": {
690
+ "type": "number",
691
+ "description": "Daily mean wind gusts at 10 meters (km/h)"
692
+ },
693
+ "wind_direction_10m_dominant": {
694
+ "type": "integer",
695
+ "description": "Dominant wind direction at 10 meters (°)"
696
+ },
697
+ "shortwave_radiation_sum": {
698
+ "type": "number",
699
+ "description": "Daily sum of shortwave solar radiation (MJ/m²)"
700
+ },
701
+ "et0_fao_evapotranspiration_sum": {
702
+ "type": "number",
703
+ "description": "Daily sum of reference evapotranspiration (mm)"
704
+ },
705
+ "cloud_cover_mean": {
706
+ "type": "number",
707
+ "description": "Daily mean cloud cover percentage (%)"
708
+ },
709
+ "dew_point_2m_mean": {
710
+ "type": "number",
711
+ "description": "Daily mean dew point temperature at 2 meters (°C)"
712
+ },
713
+ "dew_point_2m_max": {
714
+ "type": "number",
715
+ "description": "Daily maximum dew point temperature at 2 meters (°C)"
716
+ },
717
+ "dew_point_2m_min": {
718
+ "type": "number",
719
+ "description": "Daily minimum dew point temperature at 2 meters (°C)"
720
+ },
721
+ "relative_humidity_2m_mean": {
722
+ "type": "number",
723
+ "description": "Daily mean relative humidity at 2 meters (%)"
724
+ },
725
+ "relative_humidity_2m_max": {
726
+ "type": "integer",
727
+ "description": "Daily maximum relative humidity at 2 meters (%)"
728
+ },
729
+ "relative_humidity_2m_min": {
730
+ "type": "integer",
731
+ "description": "Daily minimum relative humidity at 2 meters (%)"
732
+ },
733
+ "pressure_msl_mean": {
734
+ "type": "number",
735
+ "description": "Daily mean atmospheric pressure at mean sea level (hPa)"
736
+ },
737
+ "surface_pressure_mean": {
738
+ "type": "number",
739
+ "description": "Daily mean surface pressure at ground level (hPa)"
740
+ }
741
+ },
742
+ "required": [
743
+ "timestamp",
744
+ "weather_code",
745
+ "temperature_2m_mean",
746
+ "temperature_2m_max",
747
+ "temperature_2m_min",
748
+ "apparent_temperature_mean",
749
+ "apparent_temperature_max",
750
+ "apparent_temperature_min",
751
+ "precipitation_sum",
752
+ "rain_sum",
753
+ "snowfall_sum",
754
+ "wind_speed_10m_max",
755
+ "wind_gusts_10m_max",
756
+ "wind_speed_10m_mean",
757
+ "wind_speed_10m_min",
758
+ "wind_gusts_10m_min",
759
+ "wind_gusts_10m_mean",
760
+ "wind_direction_10m_dominant",
761
+ "shortwave_radiation_sum",
762
+ "et0_fao_evapotranspiration_sum",
763
+ "cloud_cover_mean",
764
+ "dew_point_2m_mean",
765
+ "dew_point_2m_max",
766
+ "dew_point_2m_min",
767
+ "relative_humidity_2m_mean",
768
+ "relative_humidity_2m_max",
769
+ "relative_humidity_2m_min",
770
+ "pressure_msl_mean",
771
+ "surface_pressure_mean"
772
+ ],
773
+ "description": "Daily historical weather summary with temperature, precipitation, wind, and radiation statistics."
774
+ },
775
+ "HistoricalHourly": {
776
+ "type": "object",
777
+ "properties": {
778
+ "timestamp": {
779
+ "type": "string",
780
+ "format": "date-time",
781
+ "description": "ISO 8601 formatted timestamp"
782
+ },
783
+ "temperature_2m": {
784
+ "type": "number",
785
+ "description": "Air temperature at 2 meters (°C)"
786
+ },
787
+ "relative_humidity_2m": {
788
+ "type": "number",
789
+ "description": "Relative humidity at 2 meters (%)"
790
+ },
791
+ "dew_point_2m": {
792
+ "type": "number",
793
+ "description": "Dew point temperature at 2 meters (°C)"
794
+ },
795
+ "apparent_temperature": {
796
+ "type": "number",
797
+ "description": "Perceived temperature (°C)"
798
+ },
799
+ "precipitation": {
800
+ "type": "number",
801
+ "description": "Total precipitation in this hour (mm)"
802
+ },
803
+ "rain": {
804
+ "type": "number",
805
+ "description": "Rainfall in this hour (mm)"
806
+ },
807
+ "snowfall": {
808
+ "type": "number",
809
+ "description": "Snowfall in this hour (cm)"
810
+ },
811
+ "weather_code": {
812
+ "type": "integer",
813
+ "description": "Weather condition code"
814
+ },
815
+ "pressure_msl": {
816
+ "type": "number",
817
+ "description": "Atmospheric pressure at mean sea level (hPa)"
818
+ },
819
+ "surface_pressure": {
820
+ "type": "number",
821
+ "description": "Atmospheric pressure at ground level (hPa)"
822
+ },
823
+ "cloud_cover": {
824
+ "type": "number",
825
+ "description": "Cloud cover percentage (%)"
826
+ },
827
+ "et0_fao_evapotranspiration": {
828
+ "type": "number",
829
+ "description": "Hourly reference evapotranspiration (mm)"
830
+ },
831
+ "wind_speed_10m": {
832
+ "type": "number",
833
+ "description": "Wind speed at 10 meters (km/h)"
834
+ },
835
+ "wind_direction_10m": {
836
+ "type": "integer",
837
+ "description": "Wind direction at 10 meters (°)"
838
+ },
839
+ "wind_gusts_10m": {
840
+ "type": "number",
841
+ "description": "Wind gusts at 10 meters (km/h)"
842
+ },
843
+ "albedo": {
844
+ "type": ["number", "null"],
845
+ "description": "Reflectivity of the Earth's surface. Observed as null in every sampled response; this field is not currently populated by the upstream data source."
846
+ },
847
+ "shortwave_radiation": {
848
+ "type": "number",
849
+ "description": "Incoming shortwave solar radiation (W/m²)"
850
+ },
851
+ "direct_radiation": {
852
+ "type": "number",
853
+ "description": "Direct solar radiation (W/m²)"
854
+ },
855
+ "diffuse_radiation": {
856
+ "type": "number",
857
+ "description": "Diffuse solar radiation (W/m²)"
858
+ },
859
+ "direct_normal_irradiance": {
860
+ "type": "number",
861
+ "description": "Direct solar irradiance (W/m²)"
862
+ },
863
+ "global_tilted_irradiance": {
864
+ "type": "number",
865
+ "description": "Total solar irradiance on a tilted surface (W/m²)"
866
+ }
867
+ },
868
+ "required": [
869
+ "timestamp",
870
+ "temperature_2m",
871
+ "relative_humidity_2m",
872
+ "dew_point_2m",
873
+ "apparent_temperature",
874
+ "precipitation",
875
+ "rain",
876
+ "snowfall",
877
+ "weather_code",
878
+ "pressure_msl",
879
+ "surface_pressure",
880
+ "cloud_cover",
881
+ "et0_fao_evapotranspiration",
882
+ "wind_speed_10m",
883
+ "wind_direction_10m",
884
+ "wind_gusts_10m",
885
+ "albedo",
886
+ "shortwave_radiation",
887
+ "direct_radiation",
888
+ "diffuse_radiation",
889
+ "direct_normal_irradiance",
890
+ "global_tilted_irradiance"
891
+ ],
892
+ "description": "Hourly historical weather reading with temperature, precipitation, and wind data."
893
+ },
894
+ "Astronomy": {
895
+ "type": "object",
896
+ "required": [
897
+ "date",
898
+ "mid_night",
899
+ "night_end",
900
+ "sunrise",
901
+ "solar_noon",
902
+ "sunset",
903
+ "night_begin",
904
+ "day_length",
905
+ "sun_status",
906
+ "moon_phase",
907
+ "moonrise",
908
+ "moonset",
909
+ "moon_status"
910
+ ],
911
+ "properties": {
912
+ "date": {
913
+ "type": "string",
914
+ "format": "date",
915
+ "description": "Calendar date in YYYY-MM-DD format for the astronomical data."
916
+ },
917
+ "mid_night": {
918
+ "type": "string",
919
+ "description": "Time of true solar midnight in HH:MM format."
920
+ },
921
+ "night_end": {
922
+ "type": "string",
923
+ "description": "Time when astronomical twilight ends and dawn begins in HH:MM format."
924
+ },
925
+ "sunrise": {
926
+ "type": "string",
927
+ "description": "Time when the Sun becomes visible above the horizon in HH:MM format."
928
+ },
929
+ "solar_noon": {
930
+ "type": "string",
931
+ "description": "Time when the Sun reaches its highest point in the sky in HH:MM format."
932
+ },
933
+ "sunset": {
934
+ "type": "string",
935
+ "description": "Time when the Sun disappears below the horizon in HH:MM format."
936
+ },
937
+ "night_begin": {
938
+ "type": "string",
939
+ "description": "Time when astronomical twilight begins and night starts in HH:MM format."
940
+ },
941
+ "day_length": {
942
+ "type": "string",
943
+ "description": "Total duration of daylight in HH:MM format."
944
+ },
945
+ "sun_status": {
946
+ "type": "string",
947
+ "description": "Current position of the Sun relative to the horizon (above_horizon, below_horizon, or -)."
948
+ },
949
+ "moon_phase": {
950
+ "type": "string",
951
+ "description": "Current lunar phase (NEW_MOON, WAXING_CRESCENT, FULL_MOON, WANING_GIBBOUS, etc.)."
952
+ },
953
+ "moonrise": {
954
+ "type": "string",
955
+ "description": "Time when the Moon becomes visible above the horizon in HH:MM format."
956
+ },
957
+ "moonset": {
958
+ "type": "string",
959
+ "description": "Time when the Moon disappears below the horizon in HH:MM format."
960
+ },
961
+ "moon_status": {
962
+ "type": "string",
963
+ "description": "Current visibility status of the Moon (visible, not_visible, or -)."
964
+ }
965
+ },
966
+ "description": "Astronomical data including sunrise, sunset, solar noon, day length, moon phase, and moon times."
967
+ },
968
+ "ErrorResponse": {
969
+ "type": "object",
970
+ "description": "Standard error envelope returned by the API on failed requests.",
971
+ "required": ["message"],
972
+ "properties": {
973
+ "error": {
974
+ "type": "string",
975
+ "description": "Short error category or exception type."
976
+ },
977
+ "message": {
978
+ "type": "string",
979
+ "description": "Human-readable error message describing the failure."
980
+ },
981
+ "path": {
982
+ "type": "string",
983
+ "description": "API endpoint path that produced the error."
984
+ },
985
+ "status": {
986
+ "type": "integer",
987
+ "description": "HTTP status code returned with the error."
988
+ },
989
+ "timestamp": {
990
+ "type": "string",
991
+ "format": "date-time",
992
+ "description": "Timestamp when the error occurred (ISO 8601)."
993
+ }
994
+ }
995
+ },
996
+ "WeatherLocation": {
997
+ "type": "object",
998
+ "description": "Location information",
999
+ "oneOf": [
1000
+ {
1001
+ "description": "Location data when the target is specified by GPS coordinates (lat/long).",
1002
+ "$ref": "#/components/schemas/LocationByCoordinates"
1003
+ },
1004
+ {
1005
+ "description": "Location data when the target is inferred from an IP address.",
1006
+ "$ref": "#/components/schemas/LocationByIP"
1007
+ },
1008
+ {
1009
+ "description": "Location data when the target is specified by a city name or address string.",
1010
+ "$ref": "#/components/schemas/LocationByAddress"
1011
+ }
1012
+ ]
1013
+ },
1014
+ "TimeSeriesDay": {
1015
+ "type": "object",
1016
+ "description": "Time-series weather data for a single day. Contains astronomy data plus exactly one of daily or hourly, depending on the request's precision parameter — the other key is absent, not empty, in the actual response.",
1017
+ "required": ["astronomy"],
1018
+ "properties": {
1019
+ "daily": {
1020
+ "$ref": "#/components/schemas/HistoricalDaily",
1021
+ "description": "Daily aggregate weather data for the specified day. Present only when precision=daily (the default); absent entirely when precision=hourly."
1022
+ },
1023
+ "hourly": {
1024
+ "type": "array",
1025
+ "description": "Array of hourly weather readings for this day. Present only when precision=hourly; absent entirely when precision=daily.",
1026
+ "items": {
1027
+ "$ref": "#/components/schemas/HistoricalHourly"
1028
+ }
1029
+ },
1030
+ "astronomy": {
1031
+ "$ref": "#/components/schemas/Astronomy",
1032
+ "description": "Astronomical data including sunrise, sunset, and moon phases. Present regardless of precision."
1033
+ }
1034
+ }
1035
+ },
1036
+ "TimeSeriesData": {
1037
+ "type": "object",
1038
+ "description": "Time-series data object keyed by date (YYYY-MM-DD). Each key is a date and the value is a TimeSeriesDay containing daily aggregates, hourly readings, and astronomy data.",
1039
+ "properties": {
1040
+ "date": {
1041
+ "$ref": "#/components/schemas/TimeSeriesDay"
1042
+ }
1043
+ },
1044
+ "required": ["date"]
1045
+ }
1046
+ }
1047
+ },
1048
+ "security": [
1049
+ {
1050
+ "ApiKeyAuthHeader": []
1051
+ },
1052
+ {
1053
+ "ApiKeyAuthQuery": []
1054
+ }
1055
+ ]
1056
+ }