openaq.OpenAQ.parameters¶

OpenAQ.parameters(**kwargs)[source]¶

Provides a simple listing of parameters within the platform.

Parameters:	order_by (string or list) – order by one or more fields (ex. order_by=[‘preferredUnit’, ‘id’]). Default value is ‘country’ sort (string) – define the sort order for one or more fields (ex. sort=’desc’)
Returns:	a dictionary containing the id, name, description, and preferredUnit.
Example:

>>> import openaq
>>> api = openaq.OpenAQ()
>>> status, resp = api.parameters()
>>> resp['results']
[
    {
        "id": "pm25",
       "name": "PM2.5",
       "description": "Particulate matter less than 2.5 micrometers in diameter",
       "preferredUnit": "ug/m3"
    }
    ...
]