Categorygithub.com/probakowski/go-airly
modulepackage
0.0.2
Repository: https://github.com/probakowski/go-airly.git
Documentation: pkg.go.dev

# README

go-airly

go-airly is a Go client library for accessing the Airly API

Build Go Report Card

Installation

go-airly is compatible with modern Go releases in module mode, with Go installed:

go get github.com/probakowski/go-airly

will resolve and add the package to the current development module, along with its dependencies.

Alternatively the same can be achieved if you use import in a package:

import "github.com/probakowski/go-airly"

and run go get without parameters.

Finally, to use the top-of-trunk version of this repo, use the following command:

go get github.com/probakowski/go-airly@master

Usage

import "github.com/probakowski/go-airly"

Construct a new Airly client, then you can use different method from API, for example:

client := airly.Client{
Key:        "<your API key>", //required
Language:   "pl",             //optional, options: en, pl, default en
HttpClient: client,           //optional, HTTP client to use, http.DefaultClient will be used if nil
}
installations, err := client.NearestInstallations(airly.Location{Latitude: 50.062006, Longitude: 19.940984})
...

# Packages

No description provided by the author

# Functions

MaxDistance to given points in km.
MaxResults that can be returned by API call.

# Structs

Address of Installation.
Client for Airly API.
Index showing aggregated air quality.
IndexType represents index metadata, https://developer.airly.org/docs#endpoints.meta.indexes.
Installation metadata, see https://developer.airly.org/docs#endpoints.installations.
Level metadata.
Location represents geographical location given by coordinates, used for Nearest* APIs and as part of Installation metadata.
Measurement represents aggregated values.
Measurements data, see https://developer.airly.org/docs#endpoints.measurements.
MeasurementType metadata, see https://developer.airly.org/docs#endpoints.meta.measurements.
Sponsor of Installation, see https://developer.airly.org/docs#concepts.installations.sponsors.
Standard used for measuring.
Value of measurement.

# Interfaces

HttpClient to use for requests.

# Type aliases

NearestInstallationsOption represents option to narrow search results.