firms-java

💡 TIPS

如果你是中文用户，请从 README-ZH.md 获取帮助。

❓ What is firms-java?

A Java client for satellite data from NASA's Fire Information for Resource Management System (FIRMS), designed to easily construct requests for satellite data from NASA FIRMS. It can be integrated into Java projects and SpringBoot projects.

❓ What is FIRMS?

The Fire Information for Resource Management System (FIRMS) distributes near real-time (NRT) active fire data from the Moderate Resolution Imaging Spectroradiometer (MODIS) aboard the Aqua and Terra satellites, as well as the Visible Infrared Imaging Radiometer Suite (VIIRS) aboard S-NPP, NOAA 20, and NOAA 21 (officially named JPSS-1 and JPSS-2).

Official Website: https://firms.modaps.eosdis.nasa.gov

📦 Structure

1. satellite-core: The core package, containing the basic SatelliteClient and core methods.
2. satellite-spring: Adds auto-configuration with Spring dependencies, providing support for Spring and SpringBoot.
3. satellite-application: A demonstration of SpringBoot integration services.

🔑 Obtaining the API Key

To access FIRMS satellite data, you need to obtain a MapKey from the official website. You can get it through the following two methods:

Method 1

You can obtain the key by entering your email address in the dialog box on the official API Key Acquisition page.

Method 2

If you are running a web project integrated with the Spring package via SpringBoot:

1. After importing the dependencies and starting the project, access http://127.0.0.1:[actual running port]/satellite.html
2. Enter your email address and click "Send Email" to obtain the MapKey.

⚙️ Spring Configuration File

nasa:
  # Obtained API key
  map-key: 35ece758e7525ad595b401b65fa1c83b
  # Latitude and longitude range
  area: 116.2,34.5,122,38

⭐ Examples

package com.nodcat.satellite;

import io.github.nodcat.enums.Satellite;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * @author nodcat
 * @version 1.0
 * @since 24 Feb 2026 08:19 AM
 */
@Service
public class CustomSatelliteServiceImpl implements CustomSatelliteService {
    
    
    // When the configuration file is used, autowiring can be applied
    @Autowired
    SatelliteClient satelliteClient;

    // Or

    // Customize client initialization
//    static final SatelliteClient satelliteClient = new SatelliteClientImpl(
//            new SatelliteClientProperties(
//                    "35ece758e7525ad595b401b65fa1c83b", // mapKey
//                    "116.2,34.5,122,38" // Area range (longitude/latitude)
//            ));
    
    @Override
    public List<SatelliteScanData> getSatelliteData() {
        // Get VIIRS_SNPP_NRT satellite data for 5 days starting from 2026-01-22
        return satelliteClient.getSatelliteScanData(
                Satellite.VIIRS_SNPP_NRT, 
                "5", 
                "2026-01-22");
    }
}

⬇️ Install

Maven

Core

<dependency>
    <groupId>io.github.nodcat</groupId>
    <artifactId>satellite-core</artifactId>
    <version>1.0.1</version>
</dependency>

Spring

<dependency>
    <groupId>io.github.nodcat</groupId>
    <artifactId>satellite-spring</artifactId>
    <version>1.0.1</version>
</dependency>

🤝 Contributions and Feedback

If you have any suggestions or find any bugs, please submit an Issue or Pull Request!

If you found this project helpful, please give it a ⭐ Star!