@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Weatherbit - Interactive Swagger UI Documentation
@base https://api.weatherbit.io/v2.0
@version 2.0.0
@auth ApiKey key in query
@common_fields {key: any, lat: any, lon: any}
@endpoints 18
@toc alerts(1), current(3), history(7), forecast(6), normals(1)

@group alerts
@endpoint GET /alerts
@optional {city_id: any, city: any, postal_code: any, country: any, station: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group current
@endpoint GET /current
@optional {include: any, city_id: any, city: any, postal_code: any, country: any, station: any, stations: any, points: any, cities: any, units: any, lang: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group history
@endpoint GET /history/lightning
@required {date: any}
@optional {limit: any, skip: any, search_distance_km: any, sort: any, output_type: any, tz: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group current
@endpoint GET /current/lightning
@optional {limit: any, skip: any, search_distance_km: any, search_mins: any, sort: any, output_type: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group forecast
@endpoint GET /forecast/daily
@optional {city_id: any, city: any, postal_code: any, country: any, station: any, days: any, units: any, lang: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endpoint GET /forecast/minutely
@optional {city_id: any, city: any, postal_code: any, country: any, station: any, units: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endpoint GET /forecast/airquality
@optional {city_id: any, city: any, postal_code: any, country: any, hours: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group history
@endpoint GET /history/airquality
@optional {city_id: any, city: any, postal_code: any, country: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group current
@endpoint GET /current/airquality
@optional {city_id: any, city: any, postal_code: any, country: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group forecast
@endpoint GET /forecast/hourly
@optional {city_id: any, city: any, postal_code: any, country: any, station: any, units: any, lang: any, hours: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endpoint GET /forecast/agweather
@required {start_date: any, end_date: any}
@optional {units: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group history
@endpoint GET /history/agweather
@required {start_date: any, end_date: any, tp: any}
@optional {units: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group normals
@endpoint GET /normals
@required {start_day: any, end_day: any, tp: any, series_year: any}
@optional {units: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group history
@endpoint GET /history/daily
@required {start_date: any, end_date: any}
@optional {city_id: any, city: any, postal_code: any, country: any, station: any, units: any, lang: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endpoint GET /history/hourly
@required {start_date: any, end_date: any}
@optional {city_id: any, city: any, postal_code: any, country: any, station: any, units: any, lang: any, tz: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endpoint GET /history/subhourly
@required {start_date: any, end_date: any}
@optional {city_id: any, city: any, postal_code: any, country: any, station: any, units: any, lang: any, tz: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group forecast
@endpoint GET /forecast/energy
@optional {threshold: any, units: any, tp: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@group history
@endpoint GET /history/energy
@required {start_date: any, end_date: any}
@optional {tp: any, threshold: any, units: any}
@returns(200)
@returns(204)
@errors {400, 403, 429, 500}

@endgroup

@end