PM2.5 Open Data Portal Getting Started: Quickstart Guide (2026)

Getting started overview

The PM2.5 Open Data Portal offers a straightforward approach to accessing air quality data, particularly for PM2.5 concentrations. Unlike many APIs that require elaborate authentication mechanisms, this portal provides public data without the need for API keys or tokens. This design choice accelerates the initial setup for developers, researchers, and anyone interested in integrating air quality information into their applications or analyses. The API supports requests for both real-time sensor data and historical records, making it suitable for a range of applications from live dashboards to long-term environmental studies. The primary interaction method is a RESTful interface, which returns data in JSON format, a common standard for web APIs that is widely supported across programming languages and platforms (see the official JSON data interchange format definition).

The process of getting started involves understanding the available endpoints and constructing a basic HTTP GET request. The portal's documentation outlines the structure of these requests and the parameters available for filtering and querying data. Because no authentication is required, developers can immediately proceed to making their first API call after reviewing the documentation.

To begin, consider these steps:

1. Review the PM2.5 Open Data Portal's API documentation for available endpoints.
2. Formulate an HTTP GET request to retrieve data from a specific endpoint.
3. Process the JSON response to extract the desired air quality information.

This quick-start guide focuses on enabling you to make your first successful API call and interpret the results.

Create an account and get keys

The PM2.5 Open Data Portal does not require an account or API keys for accessing its public air quality data. This simplifies the onboarding process significantly, as developers can bypass registration and credential management steps. The data is openly accessible via direct HTTP requests to the specified API endpoints. This approach aligns with the principles of open data initiatives, aiming to provide environmental information freely to the public and research communities.

While an account is not needed for API access, users may still visit the PM2.5 Open Data Portal homepage to explore data visually or understand the project's scope. However, for programmatic access, no specific setup other than understanding the API endpoints is necessary. This means there are no API keys to generate, rotate, or secure, which can be a benefit for projects with simpler security requirements or those focused solely on public data consumption.

For developers accustomed to API key-based authentication, this absence might seem unusual. However, it means that your application can make requests directly without needing to manage secrets or implement complex authentication flows like OAuth 2.0 authorization. This can be particularly advantageous for rapid prototyping or educational projects where the overhead of authentication could be a barrier.

Your first request

To make your first request to the PM2.5 Open Data Portal, you will target a specific endpoint. The portal provides endpoints for real-time data and historical data. We will focus on a real-time data endpoint for this example, as it is generally the most straightforward to access initially. The primary endpoint for real-time data is typically structured to provide the latest observations from various sensors.

Example: Fetching real-time sensor data

The API reference indicates that real-time data can be accessed via an endpoint that returns a list of all current sensor readings. A common endpoint pattern might look like https://pm25.lass-net.org/data/current.json. This URL, when accessed, should return a JSON object containing an array of sensor data.

Using curl

curl is a command-line tool for making HTTP requests and is widely available on most operating systems. To make your first request using curl, open your terminal or command prompt and execute the following command:

curl "https://pm25.lass-net.org/data/current.json"

This command sends an HTTP GET request to the specified URL. The response, which will be a JSON string, will be printed directly to your terminal. It typically includes information such as sensor ID, location coordinates, PM2.5 concentration, and timestamp.

Expected JSON response structure

The JSON response will likely contain a top-level object with keys such as feeds or sensors, which will hold an array of individual sensor readings. Each object within this array represents a single sensor's data at a specific point in time. A simplified example of what you might see is:

{
  "feeds": [
    {
      "device_id": "74DA38B00001",
      "gps_lat": 25.04,
      "gps_lon": 121.56,
      "s_d0": 15.2, // PM2.5 concentration
      "timestamp": 1678886400,
      "name": "Sensor A"
    },
    {
      "device_id": "74DA38B00002",
      "gps_lat": 25.05,
      "gps_lon": 121.57,
      "s_d0": 18.5,
      "timestamp": 1678886405,
      "name": "Sensor B"
    }
  ]
}

In this example, s_d0 represents the PM2.5 concentration. The exact field names and structure are detailed in the PM2.5 Open Data Portal API documentation.

Using a web browser

You can also make a GET request simply by pasting the API URL directly into your web browser's address bar:

https://pm25.lass-net.org/data/current.json

Your browser will display the raw JSON response. Many browsers offer extensions that can format JSON for better readability, such as the Firefox JSON Viewer or similar tools for Chrome.

Common next steps

After successfully retrieving data for the first time, you might consider these common next steps to further integrate with the PM2.5 Open Data Portal:

1. Explore additional endpoints: Review the API documentation to discover other available endpoints. The portal often provides ways to query historical data, data for specific regions, or data from particular sensor types. Understanding these options will allow you to retrieve more targeted datasets relevant to your project needs.

2. Filter and process data: Once you have the raw JSON response, the next step is typically to parse and filter the data. Depending on your programming language, you'll use built-in JSON parsing libraries (e.g., json module in Python, JSON.parse() in JavaScript) to convert the string into an accessible data structure. You can then extract specific fields, filter by sensor ID, location, or time, and perform calculations.

3. Integrate into an application: Incorporate the API calls into a larger application. This could involve displaying real-time PM2.5 levels on a dashboard, storing historical data in a database for trend analysis, or triggering alerts when PM2.5 levels exceed certain thresholds. For example, you might build a web application using JavaScript's fetch API or a backend service using Python's requests library to periodically pull data.

4. Implement data visualization: Turn the raw numerical data into meaningful visual representations. Libraries like D3.js for web-based visualizations, Matplotlib or Seaborn for Python, or even charting components in various frameworks can help you create graphs, maps, or other visual aids that make the air quality data easier to understand for end-users.

5. Consider data refresh rates: Understand the update frequency of the data provided by the portal. For real-time applications, you'll need to implement a strategy for periodically fetching new data without overwhelming the API server. While the PM2.5 Open Data Portal does not specify rate limits for public data, it is good practice to implement reasonable delays between requests, typically not more frequent than every few minutes for real-time data, unless otherwise indicated by the service.

6. Error handling: While the PM2.5 Open Data Portal is generally robust, implementing error handling in your code is crucial. This includes handling network issues, malformed responses, or scenarios where no data is returned. Your application should gracefully manage these situations to prevent crashes and provide a better user experience.

Troubleshooting the first call

When making your first API call to the PM2.5 Open Data Portal, you might encounter issues. Here are some common problems and their solutions:

Always refer to the official PM2.5 Open Data Portal API documentation for the most up-to-date and specific guidance on endpoints, parameters, and expected response formats. The documentation is the definitive source for understanding the API's behavior.