Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelnabil230/laravel-weather
Free Weather Forecast API
https://github.com/michaelnabil230/laravel-weather
laravel laravel-framework php weather
Last synced: 5 days ago
JSON representation
Free Weather Forecast API
- Host: GitHub
- URL: https://github.com/michaelnabil230/laravel-weather
- Owner: michaelnabil230
- License: mit
- Created: 2022-09-20T18:00:40.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T01:52:58.000Z (26 days ago)
- Last Synced: 2024-09-25T21:48:13.975Z (10 days ago)
- Topics: laravel, laravel-framework, php, weather
- Language: PHP
- Homepage: https://open-meteo.com/en
- Size: 280 KB
- Stars: 8
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# 🌤 Open-Meteo Weather API
[](https://packagist.org/packages/michaelnabil230/laravel-weather)
[](https://github.com/michaelnabil230/laravel-weather/actions?query=workflow%3Arun-tests+branch%3Amaster)
[](https://github.com/michaelnabil230/laravel-weather/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amaster)
[](https://packagist.org/packages/michaelnabil230/laravel-weather)
[](https://open-meteo.com/en)
Download Meteorological Data from OPEN-METEO API (https://open-meteo.com/en)
Open-Meteo collaborates with National Weather Services providing Open Data with 11 to 2 km resolution. Our high performance APIs select the best weather model for your location and provide data as a simple JSON API.
APIs are free without any API key for open-source developers and non-commercial use. You can embed them directly into your app.
## Installation
You can install the package via composer:
```bash
composer require michaelnabil230/laravel-weather
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="laravel-weather-config"
```
This is the contents of the published config file:
```php
return [
'temperature_unit' => 'celsius',
'wind_speed_unit' => 'kmh',
'precipitation_unit' => 'mm',
'time_format' => 'iso8601',
'timezone' => 'GMT',
];
```
## Usage
```php
$weather = \MichaelNabil230\Weather\Weather::location(30.0812558, 31.2511902)
->current()
->get();
```
Functions:
| **Parameter** | **Format** | **Required** | **Default** |
|---------------------|----------------|--------------|-------------|
| currentWeather | Bool | No | false |
| temperatureUnit | String | No | celsius |
| windSpeedUnit | String | No | kmh |
| precipitationUnit | String | No | kmh |
| timeFormat | String | No | iso8601 |
| timezone | String | No | UTC |
| pastDays | Integer (0-2) | No | 0 |
15-minutely Functions:
| **Variable** | **Valid time** | **Unit** |
|------------------------------|---------------------------|------------------------|
| temperature_2m_15min | Instant | °C (°F) |
| relativeHumidity_2m_15min | Instant | % |
| dewPoint_2m_15min | Instant | °C (°F) |
| apparentTemperature_15min | Instant | °C (°F) |
| windSpeed_10m_15min | Instant | km/h (mph, m/s, knots) |
| windSpeed_80m_15min | Instant | km/h (mph, m/s, knots) |
| windDirection_10m_15min | Instant | ° |
| windDirection_80m_15min | Instant | ° |
| windGusts_10m_15min | Preceding 15 minutes max | km/h (mph, m/s) |
| shortwaveRadiation_15min | Preceding 15 minutes mean | W/m² |
| directRadiation_15min | Preceding 15 minutes mean | W/m² |
| directNormalIrradiance_15min | Preceding 15 minutes mean | W/m² |
| diffuseRadiation_15min | Preceding 15 minutes mean | W/mv² |
| globalTiltedIrradiance_15min | Preceding 15 minutes mean | W/mv² |
| sunshineDuration_15Min | Preceding 15 minutes sum | Seconds |
| precipitation_15min | Preceding 15 minutes sum | mm (inch) |
| snowfall_15min | Preceding 15 minutes sum | cm (inch) |
| rain_15min | Preceding 15 minutes sum | mm (inch) |
| cape_15min | Instant | J/kg |
| visibility_15min | Instant | meters |
| weatherCode_15min | Instant | WMO code |
Hourly Functions:
| **Variable** | **Valid time** | **Unit** |
|--------------------------|----------------------------|------------------------|
| temperature_2m | Instant | °C (°F) |
| relativeHumidity_2m | Instant | % |
| dewPoint_2m | Instant | °C (°F) |
| apparentTemperature | Instant | °C (°F) |
| pressureMsl | Instant | hPa |
| cloudCover | Instant | % |
| cloudCoverLow | Instant | % |
| cloudCoverMid | Instant | % |
| cloudCoverHigh | Instant | % |
| windSpeed_10m | Instant | km/h (mph, m/s, knots) |
| windSpeed_80m | Instant | km/h (mph, m/s, knots) |
| windSpeed_120m | Instant | km/h (mph, m/s, knots) |
| windSpeed_180m | Instant | km/h (mph, m/s, knots) |
| windDirection_10m | Instant | ° |
| windDirection_80m | Instant | ° |
| windDirection_120m | Instant | ° |
| windDirection_180m | Instant | ° |
| windGusts_10m | Preceding hour max | km/h (mph, m/s) |
| shortwaveRadiation | Preceding hour mean W/m² | |
| directRadiation | Preceding hour mean | W/m² |
| diffuseRadiation | Preceding hour mean | W/mv² |
| vaporPressureDeficit | Instant | kPa |
| evapotranspiration | Preceding hour sum | mm (inch) |
| precipitation | Preceding hour sum | mm (inch) |
| precipitationProbability | Preceding hour probability | % |
| hourlyWeatherCode | Instant | WMO code |
| snowHeight | Instant | meters |
| freezingLevelHeight | Instant | meters |
| soilTemperature_0cm | Instant | °C (°F) |
| soilTemperature_6cm | Instant | °C (°F) |
| soilTemperature_18cm | Instant | °C (°F) |
| soilTemperature_54cm | Instant | °C (°F) |
| soilMoisture_0_1cm | Instant | m³/m³ |
| soilMoisture_1_3cm | Instant | m³/m³ |
| soilMoisture_3_9cm | Instant | m³/m³ |
| soilMoisture_9_27cm | Instant | m³/m³ |
| soilMoisture_27_81cm | Instant | m³/m³ |
| allHourly | - | - |
Daily Functions:
| **Variable** | **Unit** |
|----------------------------|------------------------|
| temperature_2mMax | °C (°F) |
| temperature_2mMin | °C (°F) |
| apparentTemperatureMax | °C (°F) |
| apparentTemperatureMin | °C (°F) |
| precipitationSum | mm |
| precipitationHours | hours |
| dailyWeatherCode | WMO code |
| sunrise | iso8601 |
| sunset | iso8601 |
| windSpeed_10mMax | km/h (mph, m/s, knots) |
| windGusts_10mMax | km/h (mph, m/s, knots) |
| windDirection_10mDominant | ° |
| shortwaveRadiationSum | MJ/m² |
| allDaily | - |
WMO Weather interpretation codes (WW):
| **Code** | **Description** |
|-------------------------------------------|--------------------------------------------------|
| 0 | Clear sky |
| 1, 2, 3 | Mainly clear, partly cloudy, and overcast |
| 45, 48 | Fog and depositing rime fog |
| 51, 53, 55 | Drizzle: Light, moderate, and dense intensity |
| 56, 57 | Freezing Drizzle: Light and dense intensity |
| 61, 63, 65 | Rain: Slight, moderate, and heavy intensity |
| 66, 67 | Freezing Rain: Light and heavy intensity |
| 71, 73, 75 | Snowfall: Slight, moderate, and heavy intensity |
| 77 | Snow grains |
| 80, 81, 82 | Rain showers: Slight, moderate, and violent |
| 85, 86 | Snow showers slight and heavy |
| 95 * | Thunderstorm: Slight or moderate |
| 96, 99 * | Thunderstorm with slight and heavy hail |
## Testing
```bash
composer test
```
## Support
[](https://github.com/sponsors/michaelnabil230)
Or
[](https://ko-fi.com/michaelnabil230)[](https://www.buymeacoffee.com/michaelnabil230)[](https://www.paypal.com/paypalme/MichaelNabil23)
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Michael Nabil](https://github.com/MichaelNabil230)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.