WeatherXM Pro API Community n8n Node

This is a community node for n8n that integrates with the WeatherXM Pro API. It allows you to interact with WeatherXM Pro services to retrieve weather data and perform other API operations.

Features

• Fetch real-time weather data.
• Access historical weather information.
• Search for cells by region name (H3 geospatial index).
• Get all stations in a specific H3 cell.
• Retrieve weather forecasts (daily/hourly) for a cell.
• Integrate WeatherXM Pro API with your n8n workflows.

Requirements

• API key from WeatherXM Pro.

Installation

1. Clone this repository into your n8n custom nodes directory:

   git clone [email protected]:JohnFrontzos/n8n-nodes-weatherxm-pro.git

2. Install dependencies and build the node:

   cd /path/to/n8n/custom/nodes/wxm-pro
   npm install
   npm run build

3. Restart your n8n instance.

Configuration

1. Obtain your API key from the WeatherXM Pro API dashboard.
2. Configure the node in your n8n workflow with the API key and other required parameters.

Usage

1. Add the WeatherXM Pro node to your n8n workflow.
2. Configure the node with the required inputs, such as API key and endpoint parameters.
3. Execute the workflow to interact with the WeatherXM Pro API.

Supported Actions

• Observation: Get Latest Observation – Fetch the latest observation data for a station.
• Observation: Get Historical Observations – Fetch historical observations for a station and date.
• Stations: Get Stations Near – Get stations within a radius from a location.
• Stations: Get Stations in Bounding Box – Get stations within a bounding box.
• Stations: Get All Stations – Get all available stations.
• Stations: Get Stations in Cell – Get all stations in a H3 cell.
• Cells: Search for Cell in Region – Search for cells by region name.
• Forecast: Get Forecast for a Cell – Get weather forecast (daily/hourly) for a cell.

Parameters and Example Values

| Parameter | Description | Example Value | Used In Actions | |-----------------------|-----------------------------------------------------------------------------|------------------------|-------------------------------------------------| | station_id | The unique identifier of the station. | f8fdee70-bf55-11ed-95eb-b351f0b0cc44 | getLatestObservation, getHistoricalObservations | | date | Date (YYYY-MM-DD) for historical observations. | 2024-04-01 | getHistoricalObservations | | lat | Latitude of the center of the area. | 51.5074 | getStationsNear | | lon | Longitude of the center of the area. | -0.1278 | getStationsNear | | radius | Radius (in meters) for which stations are queried. | 1000 | getStationsNear | | min_lat | Minimum latitude of the bounding box. | 37.9 | getStationsBounds | | min_lon | Minimum longitude of the bounding box. | 23.7 | getStationsBounds | | max_lat | Maximum latitude of the bounding box. | 38.0 | getStationsBounds | | max_lon | Maximum longitude of the bounding box. | 23.8 | getStationsBounds | | region_query | The name of the region to search for cells. | London | searchCellsInRegion | | cell_index | The H3 index of the cell to return stations for. | 87194ad33ffffff | getStationsInCell | | forecast_cell_index | The H3 index of the cell to get forecast for. | 87194ad33ffffff | getForecastForCell | | forecast_from | The first day for which to get forecast data (YYYY-MM-DD). | 2024-04-01 | getForecastForCell | | forecast_to | The last day for which to get forecast data (YYYY-MM-DD). | 2024-04-07 | getForecastForCell | | forecast_include | Types of forecast to include. Choose daily for summaries or hourly for details. | daily or hourly | getForecastForCell |

Typical Use Cases

• Real-time Weather Monitoring: Use getLatestObservation to fetch the most recent data for a specific station.
• Weather Analytics & Reporting: Use getHistoricalObservations to analyze trends for a station on a specific date.
• Find Nearest Stations: Use getStationsNear with latitude, longitude, and radius to locate nearby stations.
• Regional Station Mapping: Use getStationsBounds to get all stations within a bounding box.
• Spatial Queries: Use getStationsInCell or searchCellsInRegion for H3 cell-based queries.
• Forecasting: Use getForecastForCell to retrieve daily or hourly forecasts for a cell.

AI/Automation Tips

• The node is AI Tool enabled and will appear in n8n's AI Agent tool selection.
• Each action is described in detail and includes example values for easy automation.
• Use the example workflows above as templates for your own automations.

Example Workflow

{
  "nodes": [
    {
      "parameters": {
        "action": "getStationsNear",
        "lat": 51.5074,
        "lon": -0.1278,
        "radius": 1000
      },
      "name": "WeatherXM Pro",
      "type": "n8n-nodes-weatherxm-pro.WeatherXMPro",
      "typeVersion": 1,
      "position": [450, 300],
      "credentials": {
        "weatherXMProApi": {
          "apiKey": "YOUR_API_KEY"
        }
      }
    }
  ]
}

Example: Search for Cells by Region Name

{
  "parameters": {
    "action": "searchCellsInRegion",
    "region_query": "London"
  }
}

Example: Get Stations in a Cell

{
  "parameters": {
    "action": "getStationsInCell",
    "cell_index": "87194ad33ffffff"
  }
}

Example: Get Forecast for a Cell

{
  "parameters": {
    "action": "getForecastForCell",
    "forecast_cell_index": "87194ad33ffffff",
    "forecast_from": "2025-04-20",
    "forecast_to": "2025-04-27",
    "forecast_include": "daily"
  }
}

Build

To build the node after making changes:

npm install
npm run build

Documentation

For detailed API documentation, visit the WeatherXM Pro API Docs.

License

This project is licensed under the MIT License.