Air Quality API - Ruby Gem

Air Quality is a simple tool for getting air quality data. It returns the air quality index, o3, pm2, and more.

Installation

Add this line to your application's Gemfile:

gem 'apiverve_airquality'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install apiverve_airquality

Getting Started

Get your API key at APIVerve

Basic Usage

require 'apiverve_airquality'

# Initialize the client
client = APIVerve::Airquality::Client.new(api_key: "YOUR_API_KEY")

# Make a request
response = client.execute({ city: "San Francisco" })

# Print the response
puts response

Error Handling

begin
  response = client.execute({ city: "San Francisco" })
  puts response["data"]
rescue APIVerve::Airquality::ValidationError => e
  puts "Validation error: #{e.errors.join(', ')}"
rescue APIVerve::Airquality::APIError => e
  puts "API error: #{e.message}"
  puts "Status code: #{e.status_code}"
end

Debug Mode

# Enable debug logging
client = APIVerve::Airquality::Client.new(
  api_key: "YOUR_API_KEY",
  debug: true
)

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "pm2_5": 16.75,
    "pm10": 18.85,
    "carbonMonoxide": 387.85,
    "ozone": 9,
    "nitrogenDioxide": 38.55,
    "sulfurdioxide": 5.95,
    "usEpaIndex": 2,
    "gbDefraIndex": 2,
    "recommendation": "The air quality in San Francisco is good. It is safe to go outside.",
    "city": "San Francisco"
  }
}

Documentation

For more information, visit the API Documentation.

Support

License

This gem is available under the MIT License.