{"_id":"5d8b2d5efc49f804578a14ab","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","category":"5d8b2d5efc49f804578a14a6","user":"56468df0a74cd10d00a3f0ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-29T09:44:25.550Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/3.0/live?latitude=45.9&longitude=2.298&token=xxxx'","name":""}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"timestamp\":1614168000,\n \"values\":{\n \"NO2\":{\n \"value_upm\":0,\n \"pi\":0,\n \"aqi\":0,\n \"caqi\":0,\n \"aqi_cn\":0,\n \"aqi_ad\":0\n },\n \"CO\":{\n \"value_upm\":91.97,\n \"pi\":0.46,\n \"aqi\":0.91,\n \"caqi\":0.46,\n \"aqi_cn\":0.92,\n \"aqi_ad\":0.31\n },\n \"O3\":{\n \"value_upm\":64.46,\n \"pi\":28.67,\n \"aqi\":25.99,\n \"caqi\":26.86,\n \"aqi_cn\":20.14,\n \"aqi_ad\":32.23\n },\n \"SO2\":{\n \"value_upm\":2.62,\n \"pi\":2.62,\n \"aqi\":1.43,\n \"caqi\":1.31,\n \"aqi_cn\":0.87,\n \"aqi_ad\":0.87\n },\n \"PM10\":{\n \"value_upm\":10.2,\n \"pi\":10.2,\n \"aqi\":9.44,\n \"caqi\":10.2,\n \"aqi_cn\":10.2,\n \"aqi_ad\":6.8\n },\n \"PM25\":{\n \"value_upm\":4.06,\n \"pi\":8.12,\n \"aqi\":16.92,\n \"caqi\":6.77,\n \"aqi_cn\":5.8,\n \"aqi_ad\":11.28\n }\n }\n}\n","name":""},{"status":400,"language":"json","code":"{\n \"error\": \"Invalid position given\"\n}","name":""},{"code":"{\n\t\"error\": \"Authentification token is missing or invalid\"\n}","language":"json","status":401}]},"auth":"required","params":[{"name":"token","type":"string","default":"","desc":"Authorization token","required":true,"in":"query","ref":"","_id":"56c47fd6116c0d21000bcf18"},{"name":"latitude","type":"double","default":"","desc":"Latitude (decimal)","required":true,"in":"query","ref":"","_id":"56469229a74cd10d00a3f0b2"},{"name":"longitude","type":"double","default":"","desc":"Longitude (decimal)","required":true,"in":"query","ref":"","_id":"56c47fbbaeb2040d00423f49"},{"name":"timestamp","type":"timestamp","default":"current","desc":"[optional] The targeted timestamp (between -4 hours and the current timestamp)","required":false,"in":"query","ref":"","_id":"595cf1e791f29200158113b7"}],"url":"/live"},"isReference":false,"order":0,"body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"timestamp\",\n \"0-1\": \"integer\",\n \"0-2\": \"UTC timestamp 10 digits long.\",\n \"1-0\": \"values\",\n \"1-1\": \"object\",\n \"1-2\": \"List of available pollutants present on the requested location for the given timestamp. Each object key could be any string of *NO2*, *PM10*, *PM25*, *O3*, *CO*, *SO2*.\",\n \"2-0\": \"value_upm\",\n \"2-1\": \"float\",\n \"2-2\": \"Concentration measured in µg/m3.\",\n \"3-0\": \"pi\",\n \"3-1\": \"float\",\n \"3-2\": \"Plume Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"4-0\": \"aqi\",\n \"4-1\": \"float\",\n \"4-2\": \"US Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"5-0\": \"caqi\",\n \"5-1\": \"float\",\n \"5-2\": \"European Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"6-0\": \"aqi_cn\",\n \"6-1\": \"float\",\n \"6-2\": \"Chinese Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"7-0\": \"aqi_ad\",\n \"7-1\": \"float\",\n \"7-2\": \"UAE Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\"\n },\n \"cols\": 3,\n \"rows\": 8\n}\n[/block]","excerpt":"current air quality","slug":"live","type":"get","title":"/live","__v":8,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}get/live
current air quality
Query Params
token:
required
string
Authorization token
latitude:
required
double
Latitude (decimal)
longitude:
required
double
Longitude (decimal)
timestamp:
timestampcurrent
[optional] The targeted timestamp (between -4 hours and the current timestamp)
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d8b2d5efc49f804578a14a8","category":"5d8b2d5efc49f804578a14a6","user":"56468df0a74cd10d00a3f0ad","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-14T01:45:13.851Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"timestamp\":1614160800,\n \"values\":{\n \"NO2\":{\n \"value_upm\":1.6,\n \"pi\":0.8,\n \"aqi\":0.8,\n \"caqi\":0.8,\n \"aqi_cn\":0.8,\n \"aqi_ad\":0.4\n },\n \"CO\":{\n \"value_upm\":97.9,\n \"pi\":0.49,\n \"aqi\":0.97,\n \"caqi\":0.49,\n \"aqi_cn\":0.98,\n \"aqi_ad\":0.33\n },\n \"O3\":{\n \"value_upm\":69.69,\n \"pi\":31.81,\n \"aqi\":28.1,\n \"caqi\":29.04,\n \"aqi_cn\":21.78,\n \"aqi_ad\":34.84\n },\n \"SO2\":{\n \"value_upm\":1.03,\n \"pi\":1.03,\n \"aqi\":0.56,\n \"caqi\":0.52,\n \"aqi_cn\":0.34,\n \"aqi_ad\":0.34\n },\n \"PM10\":{\n \"value_upm\":13.38,\n \"pi\":13.38,\n \"aqi\":12.39,\n \"caqi\":13.38,\n \"aqi_cn\":13.38,\n \"aqi_ad\":8.92\n },\n \"PM25\":{\n \"value_upm\":8.57,\n \"pi\":17.13,\n \"aqi\":35.7,\n \"caqi\":14.28,\n \"aqi_cn\":12.24,\n \"aqi_ad\":23.8\n }\n }\n },\n {\n \"timestamp\":1614164400,\n \"values\":{\n \"NO2\":{\n \"value_upm\":1.41,\n \"pi\":0.71,\n \"aqi\":0.71,\n \"caqi\":0.71,\n \"aqi_cn\":0.71,\n \"aqi_ad\":0.35\n },\n \"CO\":{\n \"value_upm\":96.91,\n \"pi\":0.48,\"aqi\":0.96,\n \"caqi\":0.48,\n \"aqi_cn\":0.97,\n \"aqi_ad\":0.32\n },\n \"O3\":{\n \"value_upm\":73.04,\n \"pi\":33.82,\n \"aqi\":29.45,\n \"caqi\":30.43,\n \"aqi_cn\":22.82,\n \"aqi_ad\":36.52\n },\"SO2\":{\n \"value_upm\":1.58,\n \"pi\":1.58,\n \"aqi\":0.86,\n \"caqi\":0.79,\n \"aqi_cn\":0.53,\n \"aqi_ad\":0.53\n },\n \"PM10\":{\n \"value_upm\":8.34,\n \"pi\":8.34,\n \"aqi\":7.72,\n \"caqi\":8.34,\n \"aqi_cn\":8.34,\n \"aqi_ad\":5.56\n },\n \"PM25\":{\n \"value_upm\":6.93,\n \"pi\":13.85,\n \"aqi\":28.86,\n \"caqi\":11.55,\n \"aqi_cn\":9.9,\n \"aqi_ad\":19.24\n }\n }\n },\n {\n \"timestamp\":1614168000,\n \"values\":{\n \"NO2\":{\n \"value_upm\":1.22,\n \"pi\":0.61,\n \"aqi\":0.61,\n \"caqi\":0.61,\n \"aqi_cn\":0.61,\n \"aqi_ad\":0.31\n },\n \"CO\":{\n \"value_upm\":95.92,\n \"pi\":0.48,\n \"aqi\":0.95,\n \"caqi\":0.48,\n \"aqi_cn\":0.96,\n \"aqi_ad\":0.32\n },\n \"O3\":{\n \"value_upm\":76.38,\n \"pi\":35.83,\n \"aqi\":30.8,\n \"caqi\":31.83,\n \"aqi_cn\":23.87,\n \"aqi_ad\":38.19\n },\n \"SO2\":{\n \"value_upm\":2.13,\n \"pi\":2.13,\n \"aqi\":1.16,\n \"caqi\":1.07,\n \"aqi_cn\":0.71,\n \"aqi_ad\":0.71\n },\n \"PM10\":{\n \"value_upm\":3.34,\n \"pi\":3.34,\n \"aqi\":3.1,\n \"caqi\":3.34,\n \"aqi_cn\":3.34,\n \"aqi_ad\":2.23\n },\n \"PM25\":{\n \"value_upm\":5.86,\n \"pi\":11.72,\n \"aqi\":24.41,\n \"caqi\":9.76,\n \"aqi_cn\":8.37,\n \"aqi_ad\":16.27\n }\n }\n },\n {\n \"timestamp\":1614171600,\n \"values\":{\n \"NO2\":{\n \"value_upm\":1.25,\n \"pi\":0.62,\n \"aqi\":0.62,\n \"caqi\":0.62,\n \"aqi_cn\":0.62,\n \"aqi_ad\":0.31\n },\n \"CO\":{\n \"value_upm\":97.33,\n \"pi\":0.49,\n \"aqi\":0.97,\n \"caqi\":0.49,\n \"aqi_cn\":0.97,\n \"aqi_ad\":0.32\n },\n \"O3\":{\n \"value_upm\":76.38,\n \"pi\":35.83,\n \"aqi\":30.8,\n \"caqi\":31.83,\n \"aqi_cn\":23.87,\n \"aqi_ad\":38.19\n },\n \"SO2\":{\n \"value_upm\":2.45,\n \"pi\":2.45,\n \"aqi\":1.34,\n \"caqi\":1.23,\n \"aqi_cn\":0.82,\n \"aqi_ad\":0.82\n },\n \"PM10\":{\n \"value_upm\":0,\n \"pi\":0,\n \"aqi\":0,\n \"caqi\":0,\n \"aqi_cn\":0,\n \"aqi_ad\":0\n },\n \"PM25\":{\n \"value_upm\":5.06,\n \"pi\":10.12,\n \"aqi\":21.09,\n \"caqi\":8.44,\n \"aqi_cn\":7.23,\n \"aqi_ad\":14.06\n }\n }\n },\n {...}\n]","name":""},{"status":400,"language":"json","code":"{\n \"error\": \"Invalid position given\"\n}","name":""},{"code":"{\n\t\"error\": \"Authentification token is missing or invalid\"\n}","language":"json","status":401}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/3.0/forecast?latitude=45.9&longitude=2.298&token=xxxx'","name":""}]},"method":"get","auth":"required","params":[{"name":"token","type":"string","default":"","desc":"Authorization token","required":true,"in":"query","ref":"","_id":"56c47fd6116c0d21000bcf18"},{"name":"latitude","type":"double","default":"","desc":"Latitude (decimal)","required":true,"in":"query","ref":"","_id":"56469229a74cd10d00a3f0b2"},{"name":"longitude","type":"double","default":"","desc":"Longitude (decimal)","required":true,"in":"query","ref":"","_id":"56c47fbbaeb2040d00423f49"}],"url":"/forecast"},"isReference":false,"order":1,"body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"timestamp\",\n \"0-1\": \"integer\",\n \"0-2\": \"UTC timestamp 10 digits long.\",\n \"1-0\": \"values\",\n \"1-1\": \"object\",\n \"1-2\": \"List of available pollutants present on the requested location for the given timestamp. Each object key could be any string of *NO2*, *PM10*, *PM25*, *O3*, *CO*, *SO2*.\",\n \"2-0\": \"value_upm\",\n \"2-1\": \"float\",\n \"2-2\": \"Concentration measured in µg/m3.\",\n \"3-0\": \"pi\",\n \"3-1\": \"float\",\n \"3-2\": \"Plume Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"4-0\": \"aqi\",\n \"5-0\": \"caqi\",\n \"6-0\": \"aqi_cn\",\n \"7-0\": \"aqi_ad\",\n \"4-1\": \"float\",\n \"4-2\": \"US Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"5-2\": \"European Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"6-2\": \"Chinese Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\",\n \"7-2\": \"UAE Air Quality Index value corresponding to the concentration of the given pollutant on the given timestamp.\"\n },\n \"cols\": 3,\n \"rows\": 8\n}\n[/block]","excerpt":"24 hours air quality forecast","slug":"pollution-forecast","type":"get","title":"/forecast","__v":8,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}get/forecast
24 hours air quality forecast
Query Params
token:
required
string
Authorization token
latitude:
required
double
Latitude (decimal)
longitude:
required
double
Longitude (decimal)
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d8b3fefe83f7e0024e19a07","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","category":"5d8b2d5efc49f804578a14a7","user":"56468df0a74cd10d00a3f0ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-25T10:22:39.848Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/3.0/uv/live?token=xxx&latitude=48.85&longitude=2.294'"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"latitude\": 48.85,\n \"longitude\": 2.34,\n \"timestamp\": 1455577200,\n \"uv\": 0\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"59f8aa2cd6af89001a1d1873","ref":"","in":"query","required":true,"desc":"Authorization token","default":"","type":"string","name":"token"},{"_id":"59f8aa2cd6af89001a1d1875","ref":"","in":"query","required":true,"desc":"Latitude (decimal)","default":"","type":"double","name":"latitude"},{"_id":"59f8aa2cd6af89001a1d1874","ref":"","in":"query","required":true,"desc":"Longitude (decimal)","default":"","type":"double","name":"longitude"}],"url":"/uv/live"},"isReference":false,"order":0,"body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"latitude\",\n \"0-1\": \"float\",\n \"0-2\": \"latitude\",\n \"1-0\": \"longitude\",\n \"1-1\": \"float\",\n \"1-2\": \"longitude\",\n \"2-0\": \"timestamp\",\n \"2-1\": \"integer\",\n \"2-2\": \"10 digits UTC epoch linux timestamp\",\n \"3-0\": \"uv\",\n \"3-1\": \"integer\",\n \"3-2\": \"UV index\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]\nSee World Health Organization [UV index definition](https://www.who.int/uv/intersunprogramme/activities/uv_index/en/)","excerpt":"current UV index","slug":"uvlive","type":"get","title":"/uv/live","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}get/uv/live
current UV index
Query Params
token:
required
string
Authorization token
latitude:
required
double
Latitude (decimal)
longitude:
required
double
Longitude (decimal)
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d8b2d5efc49f804578a14ac","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","category":"5d8b2d5efc49f804578a14a7","user":"56468df0a74cd10d00a3f0ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-31T16:49:10.139Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"latitude\": 48.85,\n \"longitude\": 2.34,\n \"hourly\": [\n {\n \"timestamp\": 1455577200,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455580800,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455584400,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455588000,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455591600,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455595200,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455598800,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455602400,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455606000,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455609600,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455613200,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455616800,\n \"uv\": 1\n },\n {\n \"timestamp\": 1455620400,\n \"uv\": 1\n },\n {\n \"timestamp\": 1455624000,\n \"uv\": 1\n },\n {\n \"timestamp\": 1455627600,\n \"uv\": 1\n },\n {\n \"timestamp\": 1455631200,\n \"uv\": 1\n },\n {\n \"timestamp\": 1455634800,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455638400,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455642000,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455645600,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455649200,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455652800,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455656400,\n \"uv\": 0\n },\n {\n \"timestamp\": 1455660000,\n \"uv\": 0\n }\n ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"59f8aa2cd6af89001a1d1873","ref":"","in":"query","required":true,"desc":"Authorization token","default":"","type":"string","name":"token"},{"_id":"59f8aa2cd6af89001a1d1875","ref":"","in":"query","required":true,"desc":"Latitude (decimal)","default":"","type":"double","name":"latitude"},{"_id":"59f8aa2cd6af89001a1d1874","ref":"","in":"query","required":true,"desc":"Longitude (decimal)","default":"","type":"double","name":"longitude"}],"url":"/uv/forecast","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/3.0/uv/forecast?token=xxx&latitude=48.85&longitude=2.294'"}]},"method":"get"},"isReference":false,"order":1,"body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"latitude\",\n \"0-1\": \"float\",\n \"0-2\": \"latitude\",\n \"1-0\": \"longitude\",\n \"1-1\": \"float\",\n \"1-2\": \"longitude\",\n \"2-0\": \"hourly\",\n \"2-1\": \"array\",\n \"2-2\": \"An array of hourly objects.\",\n \"3-0\": \"timestamp\",\n \"3-1\": \"integer\",\n \"3-2\": \"10 digit UTC epoch linux timestamp\",\n \"4-0\": \"uv\",\n \"4-1\": \"integer\",\n \"4-2\": \"UV index\"\n },\n \"cols\": 3,\n \"rows\": 5\n}\n[/block]\nSee World Health Organization [UV index definition](https://www.who.int/uv/intersunprogramme/activities/uv_index/en/)","excerpt":"24 hour UV index forecast","slug":"uv","type":"get","title":"/uv/forecast","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}get/uv/forecast
24 hour UV index forecast
Query Params
token:
required
string
Authorization token
latitude:
required
double
Latitude (decimal)
longitude:
required
double
Longitude (decimal)
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d8b32f0c6155b0012e51dce","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","category":"5d8b2ef6847e3b04744ae4f2","user":"56468df0a74cd10d00a3f0ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-25T09:27:12.441Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{ \n \"timestamp\":1569403927,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}}\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5d8b33a6d44ec7005a88434f","ref":"","in":"query","required":true,"desc":"Authorized token","default":"","type":"string","name":"token"},{"_id":"5d8b33a6d44ec7005a88434e","ref":"","in":"query","required":true,"desc":"Latitude (decimal)","default":"","type":"float","name":"latitude"},{"_id":"5d8b33a6d44ec7005a88434d","ref":"","in":"query","required":true,"desc":"Longitude (decimal)","default":"","type":"float","name":"longitude"}],"url":"/pollen/live","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/3.0/pollen/live?token=xxx&latitude=48.85&longitude=2.35'"}]},"method":"get"},"isReference":false,"order":0,"body":"[block:parameters]\n{\n \"data\": {\n \"0-0\": \"timestamp\",\n \"h-0\": \"Field\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-1\": \"integer\",\n \"0-2\": \"10 digit UTC epoch linux timestamp\",\n \"1-0\": \"values\",\n \"1-1\": \"object\",\n \"1-2\": \"List of available pollen species for the requested location and time. Object key could be any string of *birch*, *grass*, *trees*, *olive* and *ragweed*.\",\n \"2-0\": \"value_gpm\",\n \"2-1\": \"float\",\n \"3-0\": \"nab_index\",\n \"3-1\": \"float\",\n \"4-0\": \"\",\n \"4-2\": \"\",\n \"5-0\": \"\",\n \"4-1\": \"\",\n \"5-1\": \"\",\n \"2-2\": \"Concentrations measured in grains/m3 (only available for Europe)\",\n \"3-2\": \"US national allergy bureau index\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]\nThe US National Allergy Bureau (NAB) index definition is available [here](https://www.aaaai.org/global/nab-pollen-counts/reading-the-charts).","excerpt":"current pollen levels","slug":"pollenlive","type":"get","title":"/pollen/live","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}get/pollen/live
current pollen levels
Query Params
token:
required
string
Authorized token
latitude:
required
float
Latitude (decimal)
longitude:
required
float
Longitude (decimal)
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d8b3339e6d3f900f7070c57","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","category":"5d8b2ef6847e3b04744ae4f2","user":"56468df0a74cd10d00a3f0ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-25T09:28:25.801Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"timestamp\":1569402000,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569405600,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569409200,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569412800,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569416400,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569420000,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569423600,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569427200,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569430800,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569434400,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569438000,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569441600,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569445200,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569448800,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569452400,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569456000,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569459600,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569463200,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569466800,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569470400,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569474000,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569477600,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569481200,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n },\n {\n \"timestamp\":1569484800,\n \"values\":{\n \"birch\":{\"value_gpm\":0,\"nab_index\":0},\n \"olive\":{\"value_gpm\":0,\"nab_index\":0},\n \"grass\":{\"value_gpm\":0,\"nab_index\":0},\n \"ragweed\":{\"value_gpm\":0,\"nab_index\":0}\n }\n }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5d8b3aa5e7b73f03363d530d","ref":"","in":"query","required":true,"desc":"Authorized token","default":"","type":"string","name":"token"},{"_id":"5d8b3aa5e7b73f03363d530c","ref":"","in":"query","required":true,"desc":"Latitude (decimal)","default":"","type":"float","name":"latitude"},{"_id":"5d8b3aa5e7b73f03363d530b","ref":"","in":"query","required":true,"desc":"Longitude (decimal)","default":"","type":"float","name":"longitude"}],"url":"/pollen/forecast","examples":{"codes":[{"code":"curl -X GET 'https://api.plume.io/3.0/pollen/forecast?token=xxx&latitude=48.85&longitude=2.35'","language":"curl"}]},"method":"get"},"isReference":false,"order":1,"body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"timestamp\",\n \"0-1\": \"integer\",\n \"0-2\": \"10 digit UTC epoch linux timestamp\",\n \"1-0\": \"values\",\n \"1-1\": \"object\",\n \"2-0\": \"value_upm\",\n \"2-1\": \"float\",\n \"3-0\": \"nab_index\",\n \"3-1\": \"float\",\n \"1-2\": \"List of available pollen species for the requested location and time. Object key could be any string of *birch*, *grass*, *trees*, *olive* and *ragweed*.\",\n \"2-2\": \"Concentration expressed in grains/m3 (only available for Europe)\",\n \"3-2\": \"US National Allergy Bureau index\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]\nThe US National Allergy Bureau (NAB) index definition is available [here](https://www.aaaai.org/global/nab-pollen-counts/reading-the-charts).","excerpt":"24 hours pollen levels forecast","slug":"pollenforecast","type":"get","title":"/pollen/forecast","__v":9,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}get/pollen/forecast
24 hours pollen levels forecast
Query Params
token:
required
string
Authorized token
latitude:
required
float
Latitude (decimal)
longitude:
required
float
Longitude (decimal)
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d8b5422e7b73f03363d5674","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","category":"5d8b523425e74f031c7f18f6","user":"56468df0a74cd10d00a3f0ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-25T11:48:50.501Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/2.0/street-level/live?token=xxx&city=Paris&latitude=48.865562&longitude=2.321145'"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"timestamp\":1569409200,\n \"values\":{\n \"NO2\":{\"value_upm\":44.3,\"pi\":23.224999999999994},\n \"PM25\":{\"value_upm\":11.5,\"pi\":23},\n \"PM10\":{\"value_upm\":32.4,\"pi\":32.4},\n \"O3\":{\"value_upm\":62.4,\"pi\":27.439999999999998}\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5d8b5422e7b73f03363d5678","ref":"","in":"query","required":true,"desc":"Authorized token","default":"","type":"string","name":"token"},{"_id":"5d8b5422e7b73f03363d5677","ref":"","in":"query","required":true,"desc":"city which contains the requested coordinates","default":"","type":"string","name":"city"},{"_id":"5d8b5422e7b73f03363d5676","ref":"","in":"query","required":true,"desc":"Latitude (decimal)","default":"","type":"float","name":"latitude"},{"_id":"5d8b5422e7b73f03363d5675","ref":"","in":"query","required":true,"desc":"Longitude (decimal)","default":"","type":"float","name":"longitude"}],"url":"/street-level/live"},"isReference":false,"order":999,"body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"timestamp\",\n \"0-1\": \"integer\",\n \"0-2\": \"10 digit UTC epoch linux timestamp\",\n \"1-0\": \"values\",\n \"1-1\": \"object\",\n \"2-0\": \"value_upm\",\n \"2-1\": \"float\",\n \"2-2\": \"Concentration in µg/m3\",\n \"3-0\": \"pi\",\n \"3-1\": \"float\",\n \"3-2\": \"plume AQI\",\n \"1-2\": \"List of available pollutants present on the requested location for the given timestamp. Each object key could be any string of *NO2*, *PM10*, *PM25*, *O3*.\"\n },\n \"cols\": 3,\n \"rows\": 4\n}\n[/block]","excerpt":"current air quality from our street-level model","slug":"street-levellive","type":"get","title":"/street-level/live","__v":0,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}get/street-level/live
current air quality from our street-level model
Query Params
token:
required
string
Authorized token
city:
required
string
city which contains the requested coordinates
latitude:
required
float
Latitude (decimal)
longitude:
required
float
Longitude (decimal)
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d8b2d5efc49f804578a14a9","category":"5d8b2d5efc49f804578a14a5","user":"56468df0a74cd10d00a3f0ad","project":"56468dfe36961e0d005c6228","version":"5d8b2d5efc49f804578a14ad","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-14T01:27:28.116Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"To get started, [visit our API website](https://plume.io).","excerpt":"This page will help you get started with Plume API. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Getting Started with the Plume API","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}Getting Started with the Plume API
This page will help you get started with Plume API. You'll be up and running in a jiffy!
{"_id":"5d8b2d5efc49f804578a14aa","category":"5d8b2d5efc49f804578a14a5","project":"56468dfe36961e0d005c6228","user":"56468df0a74cd10d00a3f0ad","version":"5d8b2d5efc49f804578a14ad","updates":["60f91b0d532cf2002d98c7c1"],"next":{"pages":[],"description":""},"createdAt":"2015-11-14T01:44:04.681Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"code":"{}","language":"json","status":400,"name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Please keep your access token we sent you secret as it will be used to authenticate all requests you make to the Plume API.","excerpt":"","slug":"authentication","type":"basic","title":"Authentication","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}