{"_id":"56468e0036961e0d005c622e","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"title":"Getting Started with the Plume API","updates":[],"user":"56468df0a74cd10d00a3f0ad","__v":3,"category":"56468dff36961e0d005c622c","createdAt":"2015-11-14T01:27:28.116Z","excerpt":"This page will help you get started with Plume API. You'll be up and running in a jiffy!","link_url":"","body":"To get started, send us a mail [here](mailto:team@plumelabs.com?subject=[Plume.io] Access Token Request) and we will send you an access token.","githubsync":"","link_external":false,"project":"56468dfe36961e0d005c6228","sync_unique":"","type":"basic","version":"56468dfe36961e0d005c622b","hidden":false,"isReference":false,"order":0,"slug":"getting-started","childrenPages":[]}

{"_id":"564691e4c7687d0d00739f68","updates":[],"__v":1,"createdAt":"2015-11-14T01:44:04.681Z","githubsync":"","hidden":false,"order":1,"project":"56468dfe36961e0d005c6228","slug":"authentication","version":"56468dfe36961e0d005c622b","excerpt":"","type":"basic","body":"Once you create an account on Plume.io, you will get an access token.\n\nPlease keep this access token secret as it will be used to authenticate all requests you make to the Plume API.","category":"56468dff36961e0d005c622c","isReference":false,"sync_unique":"","title":"Authentication","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"link_external":false,"link_url":"","user":"56468df0a74cd10d00a3f0ad","childrenPages":[]}

{"_id":"56469229a74cd10d00a3f0b0","link_external":false,"link_url":"","type":"get","updates":[],"user":"56468df0a74cd10d00a3f0ad","api":{"params":[{"default":"","desc":"Authorization token","name":"token","ref":"","required":false,"type":"string","in":"query","_id":"56c47fd6116c0d21000bcf18"},{"required":false,"type":"double","in":"query","_id":"56469229a74cd10d00a3f0b2","default":"","desc":"Latitude","name":"lat","ref":""},{"desc":"Longitude","name":"lon","ref":"","required":false,"type":"double","in":"query","_id":"56c47fbbaeb2040d00423f49","default":""}],"results":{"codes":[{"name":"","code":"{\n  \"latitude\": 39.908148,\n  \"longitude\": 116.394121,\n  \"hourly\": [\n    {\n      \"timestamp\": 1482314400,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 497,\n          \"aqi\": 464.42,\n          \"aqi_cn\": 464.35\n        },\n        \"NO2\": {\n          \"value_upm\": 195.546,\n          \"pi\": 98,\n          \"aqi\": 100.58,\n          \"aqi_cn\": 97.77\n        },\n        \"PM10\": {\n          \"value_upm\": 479.003,\n          \"pi\": 349,\n          \"aqi\": 368.67,\n          \"aqi_cn\": 373.75\n        },\n        \"PM2_5\": {\n          \"value_upm\": 446.531,\n          \"pi\": 497,\n          \"aqi\": 464.42,\n          \"aqi_cn\": 464.35\n        },\n        \"O3\": {\n          \"value_upm\": 5.77404,\n          \"pi\": 2,\n          \"aqi\": 2.33,\n          \"aqi_cn\": 1.8\n        },\n        \"overall\": {\n          \"pi\": 497,\n          \"aqi\": 464.42,\n          \"aqi_cn\": 464.35\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482318000,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 523,\n          \"aqi\": 481.6,\n          \"aqi_cn\": 481.69\n        },\n        \"NO2\": {\n          \"value_upm\": 188.225,\n          \"pi\": 95,\n          \"aqi\": 99.83,\n          \"aqi_cn\": 94.11\n        },\n        \"PM10\": {\n          \"value_upm\": 478.868,\n          \"pi\": 349,\n          \"aqi\": 368.51,\n          \"aqi_cn\": 373.59\n        },\n        \"PM2_5\": {\n          \"value_upm\": 472.537,\n          \"pi\": 523,\n          \"aqi\": 481.6,\n          \"aqi_cn\": 481.69\n        },\n        \"O3\": {\n          \"value_upm\": 8.00165,\n          \"pi\": 3,\n          \"aqi\": 3.23,\n          \"aqi_cn\": 2.5\n        },\n        \"overall\": {\n          \"pi\": 523,\n          \"aqi\": 481.6,\n          \"aqi_cn\": 481.69\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482321600,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 554,\n          \"aqi\": 502.11,\n          \"aqi_cn\": 502.4\n        },\n        \"NO2\": {\n          \"value_upm\": 179.465,\n          \"pi\": 91,\n          \"aqi\": 95.07,\n          \"aqi_cn\": 89.73\n        },\n        \"PM10\": {\n          \"value_upm\": 475.159,\n          \"pi\": 347,\n          \"aqi\": 363.86,\n          \"aqi_cn\": 368.95\n        },\n        \"PM2_5\": {\n          \"value_upm\": 503.595,\n          \"pi\": 554,\n          \"aqi\": 502.11,\n          \"aqi_cn\": 502.4\n        },\n        \"O3\": {\n          \"value_upm\": 11.4307,\n          \"pi\": 5,\n          \"aqi\": 4.61,\n          \"aqi_cn\": 3.57\n        },\n        \"overall\": {\n          \"pi\": 554,\n          \"aqi\": 502.11,\n          \"aqi_cn\": 502.4\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482325200,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 577,\n          \"aqi\": 517.43,\n          \"aqi_cn\": 517.86\n        },\n        \"NO2\": {\n          \"value_upm\": 172.535,\n          \"pi\": 89,\n          \"aqi\": 91.06,\n          \"aqi_cn\": 86.27\n        },\n        \"PM10\": {\n          \"value_upm\": 472.993,\n          \"pi\": 346,\n          \"aqi\": 361.14,\n          \"aqi_cn\": 366.24\n        },\n        \"PM2_5\": {\n          \"value_upm\": 526.796,\n          \"pi\": 577,\n          \"aqi\": 517.43,\n          \"aqi_cn\": 517.86\n        },\n        \"O3\": {\n          \"value_upm\": 12.5996,\n          \"pi\": 5,\n          \"aqi\": 5.08,\n          \"aqi_cn\": 3.94\n        },\n        \"overall\": {\n          \"pi\": 577,\n          \"aqi\": 517.43,\n          \"aqi_cn\": 517.86\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482328800,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 575,\n          \"aqi\": 516.33,\n          \"aqi_cn\": 516.75\n        },\n        \"NO2\": {\n          \"value_upm\": 166.717,\n          \"pi\": 86,\n          \"aqi\": 87.69,\n          \"aqi_cn\": 83.36\n        },\n        \"PM10\": {\n          \"value_upm\": 470.041,\n          \"pi\": 344,\n          \"aqi\": 357.44,\n          \"aqi_cn\": 362.55\n        },\n        \"PM2_5\": {\n          \"value_upm\": 525.13,\n          \"pi\": 575,\n          \"aqi\": 516.33,\n          \"aqi_cn\": 516.75\n        },\n        \"O3\": {\n          \"value_upm\": 12.1358,\n          \"pi\": 5,\n          \"aqi\": 4.89,\n          \"aqi_cn\": 3.79\n        },\n        \"overall\": {\n          \"pi\": 575,\n          \"aqi\": 516.33,\n          \"aqi_cn\": 516.75\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482332400,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 558,\n          \"aqi\": 505.23,\n          \"aqi_cn\": 505.54\n        },\n        \"NO2\": {\n          \"value_upm\": 161.41,\n          \"pi\": 84,\n          \"aqi\": 84.63,\n          \"aqi_cn\": 80.71\n        },\n        \"PM10\": {\n          \"value_upm\": 461.962,\n          \"pi\": 339,\n          \"aqi\": 347.32,\n          \"aqi_cn\": 352.45\n        },\n        \"PM2_5\": {\n          \"value_upm\": 508.315,\n          \"pi\": 558,\n          \"aqi\": 505.23,\n          \"aqi_cn\": 505.54\n        },\n        \"O3\": {\n          \"value_upm\": 11.4748,\n          \"pi\": 5,\n          \"aqi\": 4.63,\n          \"aqi_cn\": 3.59\n        },\n        \"overall\": {\n          \"pi\": 558,\n          \"aqi\": 505.23,\n          \"aqi_cn\": 505.54\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482336000,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 545,\n          \"aqi\": 496.28,\n          \"aqi_cn\": 496.51\n        },\n        \"NO2\": {\n          \"value_upm\": 156.134,\n          \"pi\": 82,\n          \"aqi\": 81.58,\n          \"aqi_cn\": 78.07\n        },\n        \"PM10\": {\n          \"value_upm\": 450.76,\n          \"pi\": 332,\n          \"aqi\": 333.28,\n          \"aqi_cn\": 338.45\n        },\n        \"PM2_5\": {\n          \"value_upm\": 494.764,\n          \"pi\": 545,\n          \"aqi\": 496.28,\n          \"aqi_cn\": 496.51\n        },\n        \"O3\": {\n          \"value_upm\": 11.3561,\n          \"pi\": 5,\n          \"aqi\": 4.58,\n          \"aqi_cn\": 3.55\n        },\n        \"overall\": {\n          \"pi\": 545,\n          \"aqi\": 496.28,\n          \"aqi_cn\": 496.51\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482339600,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 538,\n          \"aqi\": 491.77,\n          \"aqi_cn\": 491.96\n        },\n        \"NO2\": {\n          \"value_upm\": 150.249,\n          \"pi\": 79,\n          \"aqi\": 78.17,\n          \"aqi_cn\": 75.12\n        },\n        \"PM10\": {\n          \"value_upm\": 436.78,\n          \"pi\": 323,\n          \"aqi\": 315.76,\n          \"aqi_cn\": 320.98\n        },\n        \"PM2_5\": {\n          \"value_upm\": 487.946,\n          \"pi\": 538,\n          \"aqi\": 491.77,\n          \"aqi_cn\": 491.96\n        },\n        \"O3\": {\n          \"value_upm\": 12.2052,\n          \"pi\": 5,\n          \"aqi\": 4.92,\n          \"aqi_cn\": 3.81\n        },\n        \"overall\": {\n          \"pi\": 538,\n          \"aqi\": 491.77,\n          \"aqi_cn\": 491.96\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482343200,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 506,\n          \"aqi\": 470.45,\n          \"aqi_cn\": 470.44\n        },\n        \"NO2\": {\n          \"value_upm\": 143.553,\n          \"pi\": 76,\n          \"aqi\": 74.3,\n          \"aqi_cn\": 71.78\n        },\n        \"PM10\": {\n          \"value_upm\": 425.999,\n          \"pi\": 316,\n          \"aqi\": 302.25,\n          \"aqi_cn\": 307.5\n        },\n        \"PM2_5\": {\n          \"value_upm\": 455.653,\n          \"pi\": 506,\n          \"aqi\": 470.45,\n          \"aqi_cn\": 470.44\n        },\n        \"O3\": {\n          \"value_upm\": 14.1424,\n          \"pi\": 6,\n          \"aqi\": 5.7,\n          \"aqi_cn\": 4.42\n        },\n        \"overall\": {\n          \"pi\": 506,\n          \"aqi\": 470.45,\n          \"aqi_cn\": 470.44\n        }\n      }\n    },\n    {\n      \"timestamp\": 1482346800,\n      \"avg\": {\n        \"PM\": {\n          \"pi\": 445,\n          \"aqi\": 430.62,\n          \"aqi_cn\": 430.23\n        },\n        \"NO2\": {\n          \"value_upm\": 136.037,\n          \"pi\": 73,\n          \"aqi\": 69.96,\n          \"aqi_cn\": 68.02\n        },\n        \"PM10\": {\n          \"value_upm\": 412.976,\n          \"pi\": 308,\n          \"aqi\": 284.18,\n          \"aqi_cn\": 289.97\n        },\n        \"PM2_5\": {\n          \"value_upm\": 395.351,\n          \"pi\": 445,\n          \"aqi\": 430.62,\n          \"aqi_cn\": 430.23\n        },\n        \"O3\": {\n          \"value_upm\": 16.8759,\n          \"pi\": 7,\n          \"aqi\": 6.8,\n          \"aqi_cn\": 5.27\n        },\n        \"overall\": {\n          \"pi\": 445,\n          \"aqi\": 430.62,\n          \"aqi_cn\": 430.23\n        }\n      }\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{\n\t\"error\": \"Unable to retrieve pollution forecast for the given position\"\n}","language":"json","status":400},{"status":401,"language":"json","code":"{\n\t\"error\": \"Authentification token is missing or invalid\"\n}"}]},"settings":"","url":"/pollution/forecast","auth":"required","examples":{"codes":[{"name":"","code":"curl -X GET 'https://api.plume.io/1.0/pollution/forecast?token=xxx&lat=48.85&lon=2.294","language":"curl"}]},"method":"get"},"editedParams":true,"hidden":false,"order":1,"project":"56468dfe36961e0d005c6228","sync_unique":"","title":"/pollution/forecast","version":"56468dfe36961e0d005c622b","createdAt":"2015-11-14T01:45:13.851Z","category":"5646907f56fb450d004100e1","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\": \"The latitude wanted in the request.\",\n    \"1-0\": \"longitude\",\n    \"1-1\": \"float\",\n    \"1-2\": \"The longitude wanted in the request.\",\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\": \"UTC timestamp 10 digits long.\",\n    \"4-0\": \"avg\",\n    \"4-1\": \"object\",\n    \"4-2\": \"List of available pollutants present on the requested location for the given timestamp. Each object key could be any string of *NO2*, *PM10*, *PM2_5*, *PM*, *O3*, *overall*. The *PM* object is the maximum between the *PM10* and the *PM2_5* Plume Index value.\",\n    \"5-0\": \"value_upm\",\n    \"5-1\": \"float\",\n    \"5-2\": \"Concentration measured in µg/m3. This field does not exists in the *PM* object nor in the *overall* object.\",\n    \"6-0\": \"pi\",\n    \"6-1\": \"float\",\n    \"6-2\": \"Plume Index value corresponding to the  concentration of the given pollutant on the given timestamp. In the *overall* object it is the maximum of all the pollutants Plume Indexes.\",\n    \"7-0\": \"aqi\",\n    \"7-1\": \"float\",\n    \"7-2\": \"American Air Quality Index value.\",\n    \"8-0\": \"aqi_cn\",\n    \"8-1\": \"float\",\n    \"8-2\": \"Chinese Air Quality Index value.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","editedParams2":true,"excerpt":"","githubsync":"","isReference":false,"next":{"description":"","pages":[]},"__v":5,"slug":"pollution-forecast","childrenPages":[]}

{"_id":"56c2086833a0870d00feb333","category":"56c20827e35f170d004b55b5","editedParams":true,"excerpt":"","githubsync":"","isReference":false,"next":{"description":"","pages":[]},"slug":"uv-forecast","type":"get","user":"56468df0a74cd10d00a3f0ad","title":"/uv/forecast","editedParams2":true,"api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/1.0/uv/forecast?token=xxx&lat=48.85&lon=2.294"}]},"method":"get","params":[{"required":false,"type":"string","in":"query","_id":"56c3626a106c12170020db50","default":"","desc":"Authorization token","name":"token","ref":""},{"required":false,"type":"double","in":"query","_id":"56c2086833a0870d00feb335","default":"","desc":"Latitude","name":"lat","ref":""},{"desc":"Longitude","name":"lon","ref":"","required":false,"type":"double","in":"query","_id":"56c2086833a0870d00feb334","default":""}],"results":{"codes":[{"name":"","code":"\n{\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}\n","language":"json","status":200},{"name":"","code":"{\n\t\"error\": \"Unable to retrieve uv forecast for the given position\"\n}","language":"json","status":400},{"status":401,"language":"json","code":"{\n\t\"error\": \"Authentification token is missing or invalid\"\n}"}]},"settings":"","url":"/uv/forecast"},"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\": \"The latitude wanted in the request.\",\n    \"1-0\": \"longitude\",\n    \"1-1\": \"float\",\n    \"1-2\": \"The longitude wanted in the request.\",\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\": \"UTC timestamp 10 digits long.\",\n    \"4-0\": \"uv\",\n    \"4-1\": \"integer\",\n    \"4-2\": \"The UV index on the current location for the given timestamp.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","link_external":false,"order":0,"sync_unique":"","updates":[],"version":"56468dfe36961e0d005c622b","__v":3,"hidden":false,"link_url":"","project":"56468dfe36961e0d005c6228","createdAt":"2016-02-15T17:18:32.965Z","childrenPages":[]}