> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# openweather

> OpenWeather API

**Server path:** `/openweather` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                | Description                       |
| ----------------------------------------------------------------------------------- | --------------------------------- |
| [`openweather_geocode_by_name`](#openweather_geocode_by_name)                       | Geocode location by name          |
| [`openweather_geocode_by_zip`](#openweather_geocode_by_zip)                         | Geocode by zip/postal code        |
| [`openweather_get_air_pollution_forecast`](#openweather_get_air_pollution_forecast) | Get air pollution forecast        |
| [`openweather_get_air_pollution_history`](#openweather_get_air_pollution_history)   | Get historical air pollution data |
| [`openweather_get_current_air_pollution`](#openweather_get_current_air_pollution)   | Get current air pollution data    |
| [`openweather_get_current_weather`](#openweather_get_current_weather)               | Get current weather data          |
| [`openweather_get5day_forecast`](#openweather_get5day_forecast)                     | Get 5-day weather forecast        |
| [`openweather_reverse_geocode`](#openweather_reverse_geocode)                       | Reverse geocode coordinates       |

***

## openweather\_geocode\_by\_name

Geocode location by name

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                                       |
| --------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `q`       | string  | Yes      | —       | City name, optionally with state code and country code separated by commas (e.g. 'London,GB' or 'New York,NY,US') |
| `limit`   | integer | No       | —       | Number of results to return (max 5, default 5)                                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "q": {
        "type": "string",
        "description": "City name, optionally with state code and country code separated by commas (e.g. 'London,GB' or 'New York,NY,US')"
      },
      "limit": {
        "type": "integer",
        "description": "Number of results to return (max 5, default 5)"
      }
    },
    "required": [
      "PCID",
      "q"
    ]
  }
  ```
</Expandable>

***

## openweather\_geocode\_by\_zip

Geocode by zip/postal code

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                   |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------- |
| `zip`     | string | Yes      | —       | Zip/postal code with optional country code (e.g. '10001,US' or 'SW1A 1AA,GB') |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "zip": {
        "type": "string",
        "description": "Zip/postal code with optional country code (e.g. '10001,US' or 'SW1A 1AA,GB')"
      }
    },
    "required": [
      "PCID",
      "zip"
    ]
  }
  ```
</Expandable>

***

## openweather\_get\_air\_pollution\_forecast

Get air pollution forecast

**Parameters:**

| Parameter | Type   | Required | Default | Description               |
| --------- | ------ | -------- | ------- | ------------------------- |
| `lat`     | number | Yes      | —       | Latitude of the location  |
| `lon`     | number | Yes      | —       | Longitude of the location |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "lat": {
        "type": "number",
        "description": "Latitude of the location"
      },
      "lon": {
        "type": "number",
        "description": "Longitude of the location"
      }
    },
    "required": [
      "PCID",
      "lat",
      "lon"
    ]
  }
  ```
</Expandable>

***

## openweather\_get\_air\_pollution\_history

Get historical air pollution data

**Parameters:**

| Parameter | Type    | Required | Default | Description                        |
| --------- | ------- | -------- | ------- | ---------------------------------- |
| `lat`     | number  | Yes      | —       | Latitude of the location           |
| `lon`     | number  | Yes      | —       | Longitude of the location          |
| `start`   | integer | Yes      | —       | Start date as Unix timestamp (UTC) |
| `end`     | integer | Yes      | —       | End date as Unix timestamp (UTC)   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "lat": {
        "type": "number",
        "description": "Latitude of the location"
      },
      "lon": {
        "type": "number",
        "description": "Longitude of the location"
      },
      "start": {
        "type": "integer",
        "description": "Start date as Unix timestamp (UTC)"
      },
      "end": {
        "type": "integer",
        "description": "End date as Unix timestamp (UTC)"
      }
    },
    "required": [
      "PCID",
      "lat",
      "lon",
      "start",
      "end"
    ]
  }
  ```
</Expandable>

***

## openweather\_get\_current\_air\_pollution

Get current air pollution data

**Parameters:**

| Parameter | Type   | Required | Default | Description               |
| --------- | ------ | -------- | ------- | ------------------------- |
| `lat`     | number | Yes      | —       | Latitude of the location  |
| `lon`     | number | Yes      | —       | Longitude of the location |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "lat": {
        "type": "number",
        "description": "Latitude of the location"
      },
      "lon": {
        "type": "number",
        "description": "Longitude of the location"
      }
    },
    "required": [
      "PCID",
      "lat",
      "lon"
    ]
  }
  ```
</Expandable>

***

## openweather\_get\_current\_weather

Get current weather data

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                         |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------- |
| `lat`     | number | Yes      | —       | Latitude of the location (-90 to 90)                                                |
| `lon`     | number | Yes      | —       | Longitude of the location (-180 to 180)                                             |
| `units`   | string | No       | —       | Units of measurement. standard (Kelvin), metric (Celsius), or imperial (Fahrenheit) |
| `lang`    | string | No       | —       | Language code for weather descriptions (e.g. en, es, fr, de, ja, zh\_cn)            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "lat": {
        "type": "number",
        "description": "Latitude of the location (-90 to 90)"
      },
      "lon": {
        "type": "number",
        "description": "Longitude of the location (-180 to 180)"
      },
      "units": {
        "type": "string",
        "description": "Units of measurement. standard (Kelvin), metric (Celsius), or imperial (Fahrenheit)",
        "enum": [
          "standard",
          "metric",
          "imperial"
        ]
      },
      "lang": {
        "type": "string",
        "description": "Language code for weather descriptions (e.g. en, es, fr, de, ja, zh_cn)"
      }
    },
    "required": [
      "PCID",
      "lat",
      "lon"
    ]
  }
  ```
</Expandable>

***

## openweather\_get5day\_forecast

Get 5-day weather forecast

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                         |
| --------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------- |
| `lat`     | number  | Yes      | —       | Latitude of the location (-90 to 90)                                                |
| `lon`     | number  | Yes      | —       | Longitude of the location (-180 to 180)                                             |
| `units`   | string  | No       | —       | Units of measurement. standard (Kelvin), metric (Celsius), or imperial (Fahrenheit) |
| `lang`    | string  | No       | —       | Language code for weather descriptions (e.g. en, es, fr, de, ja, zh\_cn)            |
| `cnt`     | integer | No       | —       | Number of forecast data points to return (max 40)                                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "lat": {
        "type": "number",
        "description": "Latitude of the location (-90 to 90)"
      },
      "lon": {
        "type": "number",
        "description": "Longitude of the location (-180 to 180)"
      },
      "units": {
        "type": "string",
        "description": "Units of measurement. standard (Kelvin), metric (Celsius), or imperial (Fahrenheit)",
        "enum": [
          "standard",
          "metric",
          "imperial"
        ]
      },
      "lang": {
        "type": "string",
        "description": "Language code for weather descriptions (e.g. en, es, fr, de, ja, zh_cn)"
      },
      "cnt": {
        "type": "integer",
        "description": "Number of forecast data points to return (max 40)"
      }
    },
    "required": [
      "PCID",
      "lat",
      "lon"
    ]
  }
  ```
</Expandable>

***

## openweather\_reverse\_geocode

Reverse geocode coordinates

**Parameters:**

| Parameter | Type    | Required | Default | Description                                    |
| --------- | ------- | -------- | ------- | ---------------------------------------------- |
| `lat`     | number  | Yes      | —       | Latitude of the location                       |
| `lon`     | number  | Yes      | —       | Longitude of the location                      |
| `limit`   | integer | No       | —       | Number of results to return (max 5, default 1) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "lat": {
        "type": "number",
        "description": "Latitude of the location"
      },
      "lon": {
        "type": "number",
        "description": "Longitude of the location"
      },
      "limit": {
        "type": "integer",
        "description": "Number of results to return (max 5, default 1)"
      }
    },
    "required": [
      "PCID",
      "lat",
      "lon"
    ]
  }
  ```
</Expandable>