---
name: "getWeatherQuality"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "getWeatherQuality - Get Weather Quality"
---

## getWeatherQuality

> [VERSION] @ray-js/ray >= 1.5.2

### Description

Get today’s weather and air quality by device ID

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `IGetWeatherQuality` | Yes | Request parameters |

### Return Value

Type: `Promise<IGetWeatherQualityResponse>`

Weather and air quality information, including city info, temperature, humidity, wind direction, wind speed, air quality index, etc.

##### IGetWeatherQualityResponse

| Property | Type | Description |
| --- | --- | --- |
| `c` | `Object[]` | City list |
| `w` | `Object[]` | Weather and air quality information |

##### IGetWeatherQualityResponse.c[] properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `name` | `string` | Yes | - | City name |
| `id` | `number` | Yes | - | City ID |


##### IGetWeatherQualityResponse.w[] properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `windDir` | `string` | Yes | - | Wind direction |
| `tips` | `string` | Yes | - | Summary |
| `realFeel` | `number` | Yes | - | Feels-like temperature |
| `no2` | `number` | Yes | - | Nitrogen dioxide |
| `so2` | `number` | Yes | - | Sulfur dioxide |
| `zoneId` | `string` | Yes | - | Time zone |
| `humidity` | `number` | Yes | - | Humidity |
| `windSpeed` | `string` | Yes | - | Wind speed, m/s worldwide |
| `temp` | `number` | Yes | - | Temperature, in degrees Celsius worldwide |
| `o3` | `number` | Yes | - | Ozone |
| `pm10` | `number` | Yes | - | PM10 |
| `pressure` | `number` | Yes | - | Atmospheric pressure |
| `co` | `number` | Yes | - | Carbon monoxide |
| `qualityLevel` | `number` | Yes | - | Air quality grade |
| `quality` | `string` | Yes | - | Air quality score |
| `condition` | `string` | Yes | - | Weather description |
| `pm25` | `number` | Yes | - | PM2.5 |
| `condIconUrl` | `string` | Yes | - | Weather icon URL |
| `aqi` | `number` | Yes | - | Air quality |
| `conditionNum` | `string` | Yes | - | Weather text code |
| `sunRise` | `string` | Yes | - | Sunrise time text |
| `sunSet` | `string` | Yes | - | Sunset time text |
| `sunSetTimestamp` | `number` | Yes | - | Sunset timestamp |
| `sunRiseTimestamp` | `number` | Yes | - | Sunrise timestamp |


### Referenced Types

##### `interface` IGetWeatherQuality

| Property | Type | Description |
| --- | --- | --- |
| `devId` | `string` | Device ID |
| `isLocal` | `boolean` | Whether to query local weather |


### Examples

#### Basic usage

```ts
import { getWeatherQuality } from '@ray-js/ray';

getWeatherQuality({
  devId: 'vdevo169477319679442',
  isLocal: true,
}).then((res) => {
  console.log('Weather info:', res);
}).catch((error) => {
  console.error(error);
});
```