NAiOS IconNAiOS Logo
Volver al catálogo

Iqair Airvisual

iqair_airvisual

IQAir AirVisual provides global air quality data through its API, offering real-time and historical information on air pollution levels.

Acciones
10
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (10)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Get Air Quality Forecast DataIQAIR_AIRVISUAL_GET_AIR_QUALITY_FORECAST_DATAAcción

Tool to retrieve air quality forecast data for a specified city, state, and country. Use after confirming location details.

Parámetros de entrada

  • citystringObligatorio

    City name (e.g., 'Los Angeles').

  • statestringObligatorio

    State or region name (e.g., 'California').

  • countrystringObligatorio

    Country name (e.g., 'USA').

Parámetros de salida

  • dataobjectObligatorio

    Forecast data payload.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Status of the API request, e.g., 'success'.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CitiesIQAIR_AIRVISUAL_GET_CITIESAcción

Tool to list supported cities in a specified state and country. Use when you need to retrieve cities for a given state/country.

Parámetros de entrada

  • statestringObligatorio

    State's English name, for example 'California'

  • countrystringObligatorio

    Country's English name, for example 'United States'

Parámetros de salida

  • dataobject[]Obligatorio

    List of city objects

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Operation status, for example 'success'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get City Air QualityIQAIR_AIRVISUAL_GET_CITY_AIR_QUALITYAcción

Tool to retrieve air quality data for a specific city. Use when you need current pollution and weather data by specifying city, state, and country.

Parámetros de entrada

  • citystringObligatorio

    Name of the city to retrieve air quality for

  • statestringObligatorio

    Name of the state or province containing the city

  • countrystringObligatorio

    Name of the country containing the city

Parámetros de salida

  • dataobjectObligatorio

    City air quality payload.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Request status ('success' or 'fail').

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get supported countriesIQAIR_AIRVISUAL_GET_COUNTRIESAcción

Tool to list all supported countries. Use when you need to know which countries are supported by the AirVisual API.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    List of supported countries

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Request status, e.g., 'success' or error code

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Historical AQI DataIQAIR_AIRVISUAL_GET_HISTORICAL_AQI_DATAAcción

Tool to retrieve historical air quality data for a city. Use after confirming city, state, and country when you need AQI readings over time.

Parámetros de entrada

  • endstring

    End datetime in ISO8601 format (inclusive).

  • citystringObligatorio

    City name

  • startstring

    Start datetime in ISO8601 format (inclusive).

  • statestringObligatorio

    State or province name

  • countrystringObligatorio

    Country name

Parámetros de salida

  • dataobjectObligatorio

    Response data containing historical AQI readings

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    API call status, e.g., 'success' or error code

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Nearest City Air QualityIQAIR_AIRVISUAL_GET_NEAREST_CITY_AIR_QUALITYAcción

Tool to retrieve air quality data for the nearest city based on latitude/longitude or IP. Use when you have precise location data or want to geolocate an IP for air quality.

Parámetros de entrada

  • ipstring

    IPv4 address to geolocate; if neither lat/lon nor ip provided, server uses caller's IP.

  • latnumber

    Latitude in decimal degrees; must be between -90 and 90. Must be provided with lon.

  • lonnumber

    Longitude in decimal degrees; must be between -180 and 180. Must be provided with lat.

Parámetros de salida

  • dataobjectObligatorio

    Nearest city payload.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Request status ('success' or 'fail').

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Nearest Station Air QualityIQAIR_AIRVISUAL_GET_NEAREST_STATION_AIR_QUALITYAcción

Tool to get nearest station air quality. Use when you have GPS coordinates and need closest station’s AQI.

Parámetros de entrada

  • latnumberObligatorio

    Latitude in decimal degrees, must be between -90 and 90

  • lonnumberObligatorio

    Longitude in decimal degrees, must be between -180 and 180

Parámetros de salida

  • dataobjectObligatorio

    Nearest station air quality payload

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Response status, e.g. "success"

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get StatesIQAIR_AIRVISUAL_GET_STATESAcción

Tool to list supported states in a specified country. Use when you need to retrieve states/provinces for a given country.

Parámetros de entrada

  • countrystringObligatorio

    Country's English name, for example 'United States'

Parámetros de salida

  • dataobject[]Obligatorio

    List of state objects

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Operation status, for example 'success'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Station by IDIQAIR_AIRVISUAL_GET_STATION_BY_IDAcción

Tool to fetch air quality and weather data for a specific monitoring station by ID. Use when you need detailed historical, current, and forecast data for a station.

Parámetros de entrada

  • citystringObligatorio

    City’s English name; find via listing endpoint

  • statestringObligatorio

    State’s English name; find via listing endpoint

  • countrystringObligatorio

    Country’s English name; find via listing endpoint

  • stationstringObligatorio

    Station’s English name; find via listing endpoint

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Request status, e.g., 'success'

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get World AQI RankingsIQAIR_AIRVISUAL_GET_WORLD_RANKINGAcción

Tool to retrieve a ranking of cities worldwide based on current AQI. Use when you need a global AQI ranking list after authenticating with a valid AirVisual API key. If /world-rankings is not accessible, gracefully falls back to /nearest_city and returns a single-item list based on the nearest city.

Parámetros de entrada

  • ipstring

    IPv4 address to geolocate for fallback.

  • latnumber

    Latitude for fallback to nearest city.

  • lonnumber

    Longitude for fallback to nearest city.

Parámetros de salida

  • dataobject[]Obligatorio

    List of cities ranked by AQI

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    Request status (e.g., 'success')

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not