Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benjaminhansen/nws-php

PHP Library for the National Weather Service REST API
https://github.com/benjaminhansen/nws-php

api-weather-gov national-weather-service nws php weather-gov weather-gov-api

Last synced: 26 days ago
JSON representation

PHP Library for the National Weather Service REST API

Awesome Lists containing this project

README 

        
# PHP Library for the National Weather Service REST API



Provides an intuitive interface to use the NWS REST API (https://api.weather.gov) in any PHP application.



Pairs well with my ArcGIS Geocode API wrapper as well.

https://github.com/benjaminhansen/arcgis-geocode



## NWS Documentation

https://www.weather.gov/documentation/services-web-api



## Installation

```

composer require benjaminhansen/nws-php

```



## Usage

Notes

* Requires PHP 8.2 or greater

* All requests can be cached locally to reduce outbound requests to the API endpoint

* All datetime fields are automatically returned as a Carbon object

* Any timezone fields are automatically returned as a PHP DateTimeZone object

* A raw() method is available on most calls to print out the raw API data



### Example



```php

useCache();

// $api->useCache(lifetime: 3600, driver: 'Files'); // override the default cache lifetime seconds and/or storage driver, if necessary



/*

** You can make sure that the API's status returns OK before allowing any

** requests to be made. An exception will be thrown if the API status is not OK.

*/

$api->assertOk();

// $api->assertOk(message: 'custom exception message can be placed here');



/*

**  We can set a timezone for the entire API callstack.

**  All datetime objects will be converted to this timezone.

**

**  If you pass a string version of a timezone, the method will auto-convert it

**  to a DateTimeZone object.

*/

$timezone = "America/Chicago";

// $timezone = new DateTimeZone("America/Chicago");

$api->timezone($timezone);

/*

    var_dump($api->timezone())



    object(DateTimeZone)#18 (2) {

        ["timezone_type"]=>

        int(3)

        ["timezone"]=>

        string(15) "America/Chicago"

    }

*/



/*

**  We can provide lat/lon coordinates for a specific location

**  Dallas, TX for example

*/

$lat = 32.7767;

$lon = -96.7970;

$location = $api->point($lat, $lon);



/*

**  Get the location's county information

*/

$county = $location->county;

echo $county->name;

echo $county->id;

echo $county->state->name;

echo $county->state->abbreviation;

var_dump($county->timezone);

var_dump($county->timezones);



/*

** Get information about the location

*/

echo $location->radarStationId;

echo $location->city;

var_dump($location->state);



/*

** Get any active alerts for the location and loop through them

*/

$alerts = $location->activeAlerts->get();

foreach($alerts as $alert) {

    var_dump($alert);

}



/*

** Get current observations from the nearest observation station to your location

*/

$observations = $location->latestObservations;

$raw_data = $observations->raw();

var_dump($raw_data);



echo $observations->temperature(show_units: true);

// echo $observations->temperature;

echo $observations->dewpoint;

// other methods are available for the other data points as well



/*

** Get the current forecast for the location

*/

$forecast = $location->forecast;

var_dump($forecast->raw());

var_dump($forecast->periods->get());



/*

** Get the current hourly forecast for the location

*/

$hourly_forecast = $location->hourlyForecast;

var_dump($hourly_forecast->raw());

var_dump($hourly_forecast->periods->get());



/*

** We can also get a specific forecast office

** Little Rock, Arkansas for example

*/

$office_id = "LZK";

$forecast_office = $api->forecastOffice($office_id);

echo $forecast_office->name;

echo $forecast_office->phone;

echo $forecast_office->email;

echo $forecast_office->addresss;

var_dump($forecast_office->counties);

var_dump($forecast_office->forecastZones);

var_dump($forecast_office->observationStations);

var_dump($forecast_office->fireZones);

var_dump($forecast_office->activeAlerts->get());



/*

** We can also get a specific observation station

** Little Rock, Arkansas Airport KLIT for example

*/

$station_id = "KLIT";

$observation_station = $api->observationStation($station_id);

echo $observation_station->name;

echo $observation_station->id;

var_dump($observation_station->timezone);

var_dump($observation_station->county);

var_dump($observation_station->latestObservations);

var_dump($observation_station->activeAlerts->get());

```