{"_id":"5954c8ddcf1c05001b2c0ea6","category":"5954c8ddcf1c05001b2c0e9e","user":"56468df0a74cd10d00a3f0ad","project":"56468dfe36961e0d005c6228","version":"5954c8ddcf1c05001b2c0e9d","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-14T01:27:28.116Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"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,"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!

To get started, [visit our API website](https://plume.io).
To get started, [visit our API website](https://plume.io).
{"_id":"5954c8ddcf1c05001b2c0ea7","category":"5954c8ddcf1c05001b2c0e9e","project":"56468dfe36961e0d005c6228","user":"56468df0a74cd10d00a3f0ad","version":"5954c8ddcf1c05001b2c0e9d","updates":[],"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":0,"childrenPages":[]}

Authentication


Please keep your access token we sent you secret as it will be used to authenticate all requests you make to the Plume API.
Please keep your access token we sent you secret as it will be used to authenticate all requests you make to the Plume API.
{"_id":"5954c8ddcf1c05001b2c0ea2","category":"5954c8ddcf1c05001b2c0e9f","user":"56468df0a74cd10d00a3f0ad","project":"56468dfe36961e0d005c6228","version":"5954c8ddcf1c05001b2c0e9d","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    {\n        \"timestamp\": 1498726800,\n        \"values\": {\n            \"NO\": {\n                \"value_upm\": 49.22\n            },\n            \"NO2\": {\n                \"value_upm\": 41.21,\n                \"pi\": 21,\n                \"aqi\": 20.68,\n                \"caqi\": 20.61,\n                \"aqi_cn\": 20.61\n            },\n            \"NOX\": {\n                \"value_upm\": 117.87\n            },\n            \"CO\": {\n                \"value_upm\": 460,\n                \"pi\": 2,\n                \"aqi\": 4.57,\n                \"caqi\": 2.3,\n                \"aqi_cn\": 4.6\n            },\n            \"SO2\": {\n                \"value_upm\": 1,\n                \"pi\": 1,\n                \"aqi\": 0.55,\n                \"caqi\": 0.5,\n                \"aqi_cn\": 0.33\n            },\n            \"O3\": {\n                \"value_upm\": 41.8,\n                \"pi\": 17,\n                \"aqi\": 16.85,\n                \"caqi\": 17.42,\n                \"aqi_cn\": 13.06\n            },\n            \"PM10\": {\n                \"value_upm\": 20.98,\n                \"pi\": 21,\n                \"aqi\": 19.43,\n                \"caqi\": 20.98,\n                \"aqi_cn\": 20.98\n            },\n            \"PM25\": {\n                \"value_upm\": 7.53,\n                \"pi\": 15,\n                \"aqi\": 31.38,\n                \"caqi\": 12.55,\n                \"aqi_cn\": 10.76\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498730400,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 35.7346,\n                \"pi\": 18,\n                \"aqi\": 17.93,\n                \"caqi\": 17.87,\n                \"aqi_cn\": 17.87\n            },\n            \"O3\": {\n                \"value_upm\": 43.972,\n                \"pi\": 18,\n                \"aqi\": 17.73,\n                \"caqi\": 18.32,\n                \"aqi_cn\": 13.74\n            },\n            \"PM10\": {\n                \"value_upm\": 14.3701,\n                \"pi\": 14,\n                \"aqi\": 13.31,\n                \"caqi\": 14.37,\n                \"aqi_cn\": 14.37\n            },\n            \"PM25\": {\n                \"value_upm\": 2.64119,\n                \"pi\": 5,\n                \"aqi\": 11,\n                \"caqi\": 4.4,\n                \"aqi_cn\": 3.77\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498734000,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 41.2493,\n                \"pi\": 21,\n                \"aqi\": 20.7,\n                \"caqi\": 20.62,\n                \"aqi_cn\": 20.62\n            },\n            \"O3\": {\n                \"value_upm\": 50.1881,\n                \"pi\": 20,\n                \"aqi\": 20.24,\n                \"caqi\": 20.91,\n                \"aqi_cn\": 15.68\n            },\n            \"PM10\": {\n                \"value_upm\": 13.0872,\n                \"pi\": 13,\n                \"aqi\": 12.12,\n                \"caqi\": 13.09,\n                \"aqi_cn\": 13.09\n            },\n            \"PM25\": {\n                \"value_upm\": 2.98208,\n                \"pi\": 6,\n                \"aqi\": 12.43,\n                \"caqi\": 4.97,\n                \"aqi_cn\": 4.26\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498737600,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 46.0989,\n                \"pi\": 25,\n                \"aqi\": 23.13,\n                \"caqi\": 23.05,\n                \"aqi_cn\": 23.05\n            },\n            \"O3\": {\n                \"value_upm\": 52.2845,\n                \"pi\": 21,\n                \"aqi\": 21.08,\n                \"caqi\": 21.79,\n                \"aqi_cn\": 16.34\n            },\n            \"PM10\": {\n                \"value_upm\": 13.716,\n                \"pi\": 14,\n                \"aqi\": 12.7,\n                \"caqi\": 13.72,\n                \"aqi_cn\": 13.72\n            },\n            \"PM25\": {\n                \"value_upm\": 3.58949,\n                \"pi\": 7,\n                \"aqi\": 14.96,\n                \"caqi\": 5.98,\n                \"aqi_cn\": 5.13\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498741200,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 50.1733,\n                \"pi\": 28,\n                \"aqi\": 25.18,\n                \"caqi\": 25.09,\n                \"aqi_cn\": 25.09\n            },\n            \"O3\": {\n                \"value_upm\": 54.2956,\n                \"pi\": 23,\n                \"aqi\": 21.89,\n                \"caqi\": 22.62,\n                \"aqi_cn\": 16.97\n            },\n            \"PM10\": {\n                \"value_upm\": 14.8336,\n                \"pi\": 15,\n                \"aqi\": 13.73,\n                \"caqi\": 14.83,\n                \"aqi_cn\": 14.83\n            },\n            \"PM25\": {\n                \"value_upm\": 4.60733,\n                \"pi\": 9,\n                \"aqi\": 19.2,\n                \"caqi\": 7.68,\n                \"aqi_cn\": 6.58\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498744800,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 54.1404,\n                \"pi\": 31,\n                \"aqi\": 27.17,\n                \"caqi\": 27.07,\n                \"aqi_cn\": 27.07\n            },\n            \"O3\": {\n                \"value_upm\": 54.5698,\n                \"pi\": 23,\n                \"aqi\": 22,\n                \"caqi\": 22.74,\n                \"aqi_cn\": 17.05\n            },\n            \"PM10\": {\n                \"value_upm\": 15.4721,\n                \"pi\": 15,\n                \"aqi\": 14.33,\n                \"caqi\": 15.47,\n                \"aqi_cn\": 15.47\n            },\n            \"PM25\": {\n                \"value_upm\": 6.50487,\n                \"pi\": 13,\n                \"aqi\": 27.1,\n                \"caqi\": 10.84,\n                \"aqi_cn\": 9.29\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498748400,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 56.3811,\n                \"pi\": 32,\n                \"aqi\": 28.29,\n                \"caqi\": 28.19,\n                \"aqi_cn\": 28.19\n            },\n            \"O3\": {\n                \"value_upm\": 51.931,\n                \"pi\": 21,\n                \"aqi\": 20.94,\n                \"caqi\": 21.64,\n                \"aqi_cn\": 16.23\n            },\n            \"PM10\": {\n                \"value_upm\": 15.3847,\n                \"pi\": 15,\n                \"aqi\": 14.25,\n                \"caqi\": 15.38,\n                \"aqi_cn\": 15.38\n            },\n            \"PM25\": {\n                \"value_upm\": 6.50655,\n                \"pi\": 13,\n                \"aqi\": 27.11,\n                \"caqi\": 10.84,\n                \"aqi_cn\": 9.3\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498752000,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 59.081,\n                \"pi\": 34,\n                \"aqi\": 29.65,\n                \"caqi\": 29.54,\n                \"aqi_cn\": 29.54\n            },\n            \"O3\": {\n                \"value_upm\": 50.5294,\n                \"pi\": 20,\n                \"aqi\": 20.37,\n                \"caqi\": 21.05,\n                \"aqi_cn\": 15.79\n            },\n            \"PM10\": {\n                \"value_upm\": 15.0053,\n                \"pi\": 15,\n                \"aqi\": 13.89,\n                \"caqi\": 15.01,\n                \"aqi_cn\": 15.01\n            },\n            \"PM25\": {\n                \"value_upm\": 6.78282,\n                \"pi\": 14,\n                \"aqi\": 28.26,\n                \"caqi\": 11.3,\n                \"aqi_cn\": 9.69\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498755600,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 58.6889,\n                \"pi\": 34,\n                \"aqi\": 29.45,\n                \"caqi\": 29.34,\n                \"aqi_cn\": 29.34\n            },\n            \"O3\": {\n                \"value_upm\": 47.7626,\n                \"pi\": 19,\n                \"aqi\": 19.26,\n                \"caqi\": 19.9,\n                \"aqi_cn\": 14.93\n            },\n            \"PM10\": {\n                \"value_upm\": 14.8407,\n                \"pi\": 15,\n                \"aqi\": 13.74,\n                \"caqi\": 14.84,\n                \"aqi_cn\": 14.84\n            },\n            \"PM25\": {\n                \"value_upm\": 6.82436,\n                \"pi\": 14,\n                \"aqi\": 28.43,\n                \"caqi\": 11.37,\n                \"aqi_cn\": 9.75\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498759200,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 58.1885,\n                \"pi\": 34,\n                \"aqi\": 29.2,\n                \"caqi\": 29.09,\n                \"aqi_cn\": 29.09\n            },\n            \"O3\": {\n                \"value_upm\": 48.1709,\n                \"pi\": 19,\n                \"aqi\": 19.42,\n                \"caqi\": 20.07,\n                \"aqi_cn\": 15.05\n            },\n            \"PM10\": {\n                \"value_upm\": 15.5129,\n                \"pi\": 16,\n                \"aqi\": 14.36,\n                \"caqi\": 15.51,\n                \"aqi_cn\": 15.51\n            },\n            \"PM25\": {\n                \"value_upm\": 7.3393,\n                \"pi\": 15,\n                \"aqi\": 30.58,\n                \"caqi\": 12.23,\n                \"aqi_cn\": 10.48\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498762800,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 53.4926,\n                \"pi\": 30,\n                \"aqi\": 26.84,\n                \"caqi\": 26.75,\n                \"aqi_cn\": 26.75\n            },\n            \"O3\": {\n                \"value_upm\": 46.6595,\n                \"pi\": 19,\n                \"aqi\": 18.81,\n                \"caqi\": 19.44,\n                \"aqi_cn\": 14.58\n            },\n            \"PM10\": {\n                \"value_upm\": 15.8275,\n                \"pi\": 16,\n                \"aqi\": 14.66,\n                \"caqi\": 15.83,\n                \"aqi_cn\": 15.83\n            },\n            \"PM25\": {\n                \"value_upm\": 7.56104,\n                \"pi\": 15,\n                \"aqi\": 31.5,\n                \"caqi\": 12.6,\n                \"aqi_cn\": 10.8\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498766400,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 45.3651,\n                \"pi\": 24,\n                \"aqi\": 22.76,\n                \"caqi\": 22.68,\n                \"aqi_cn\": 22.68\n            },\n            \"O3\": {\n                \"value_upm\": 45.7393,\n                \"pi\": 18,\n                \"aqi\": 18.44,\n                \"caqi\": 19.06,\n                \"aqi_cn\": 14.29\n            },\n            \"PM10\": {\n                \"value_upm\": 14.2196,\n                \"pi\": 14,\n                \"aqi\": 13.17,\n                \"caqi\": 14.22,\n                \"aqi_cn\": 14.22\n            },\n            \"PM25\": {\n                \"value_upm\": 7.03189,\n                \"pi\": 14,\n                \"aqi\": 29.3,\n                \"caqi\": 11.72,\n                \"aqi_cn\": 10.05\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498770000,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 38.509,\n                \"pi\": 19,\n                \"aqi\": 19.32,\n                \"caqi\": 19.25,\n                \"aqi_cn\": 19.25\n            },\n            \"O3\": {\n                \"value_upm\": 44.618,\n                \"pi\": 18,\n                \"aqi\": 17.99,\n                \"caqi\": 18.59,\n                \"aqi_cn\": 13.94\n            },\n            \"PM10\": {\n                \"value_upm\": 12.4047,\n                \"pi\": 12,\n                \"aqi\": 11.49,\n                \"caqi\": 12.4,\n                \"aqi_cn\": 12.4\n            },\n            \"PM25\": {\n                \"value_upm\": 7.42703,\n                \"pi\": 15,\n                \"aqi\": 30.95,\n                \"caqi\": 12.38,\n                \"aqi_cn\": 10.61\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498773600,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 35.89,\n                \"pi\": 18,\n                \"aqi\": 18.01,\n                \"caqi\": 17.95,\n                \"aqi_cn\": 17.95\n            },\n            \"O3\": {\n                \"value_upm\": 44.6606,\n                \"pi\": 18,\n                \"aqi\": 18.01,\n                \"caqi\": 18.61,\n                \"aqi_cn\": 13.96\n            },\n            \"PM10\": {\n                \"value_upm\": 11.8329,\n                \"pi\": 12,\n                \"aqi\": 10.96,\n                \"caqi\": 11.83,\n                \"aqi_cn\": 11.83\n            },\n            \"PM25\": {\n                \"value_upm\": 5.95926,\n                \"pi\": 12,\n                \"aqi\": 24.83,\n                \"caqi\": 9.93,\n                \"aqi_cn\": 8.51\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498777200,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 30.4728,\n                \"pi\": 15,\n                \"aqi\": 15.29,\n                \"caqi\": 15.24,\n                \"aqi_cn\": 15.24\n            },\n            \"O3\": {\n                \"value_upm\": 45.6418,\n                \"pi\": 18,\n                \"aqi\": 18.4,\n                \"caqi\": 19.02,\n                \"aqi_cn\": 14.26\n            },\n            \"PM10\": {\n                \"value_upm\": 10.1157,\n                \"pi\": 10,\n                \"aqi\": 9.37,\n                \"caqi\": 10.12,\n                \"aqi_cn\": 10.12\n            },\n            \"PM25\": {\n                \"value_upm\": 5.82141,\n                \"pi\": 12,\n                \"aqi\": 24.26,\n                \"caqi\": 9.7,\n                \"aqi_cn\": 8.32\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498780800,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 21.4392,\n                \"pi\": 11,\n                \"aqi\": 10.76,\n                \"caqi\": 10.72,\n                \"aqi_cn\": 10.72\n            },\n            \"O3\": {\n                \"value_upm\": 47.6346,\n                \"pi\": 19,\n                \"aqi\": 19.21,\n                \"caqi\": 19.85,\n                \"aqi_cn\": 14.89\n            },\n            \"PM10\": {\n                \"value_upm\": 8.50765,\n                \"pi\": 9,\n                \"aqi\": 7.88,\n                \"caqi\": 8.51,\n                \"aqi_cn\": 8.51\n            },\n            \"PM25\": {\n                \"value_upm\": 3.76759,\n                \"pi\": 8,\n                \"aqi\": 15.7,\n                \"caqi\": 6.28,\n                \"aqi_cn\": 5.38\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498784400,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 14.6931,\n                \"pi\": 7,\n                \"aqi\": 7.37,\n                \"caqi\": 7.35,\n                \"aqi_cn\": 7.35\n            },\n            \"O3\": {\n                \"value_upm\": 45.5382,\n                \"pi\": 18,\n                \"aqi\": 18.36,\n                \"caqi\": 18.97,\n                \"aqi_cn\": 14.23\n            },\n            \"PM10\": {\n                \"value_upm\": 7.08177,\n                \"pi\": 7,\n                \"aqi\": 6.56,\n                \"caqi\": 7.08,\n                \"aqi_cn\": 7.08\n            },\n            \"PM25\": {\n                \"value_upm\": 3.16269,\n                \"pi\": 6,\n                \"aqi\": 13.18,\n                \"caqi\": 5.27,\n                \"aqi_cn\": 4.52\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498788000,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 10.5725,\n                \"pi\": 5,\n                \"aqi\": 5.31,\n                \"caqi\": 5.29,\n                \"aqi_cn\": 5.29\n            },\n            \"O3\": {\n                \"value_upm\": 44.0451,\n                \"pi\": 18,\n                \"aqi\": 17.76,\n                \"caqi\": 18.35,\n                \"aqi_cn\": 13.76\n            },\n            \"PM10\": {\n                \"value_upm\": 6.18424,\n                \"pi\": 6,\n                \"aqi\": 5.73,\n                \"caqi\": 6.18,\n                \"aqi_cn\": 6.18\n            },\n            \"PM25\": {\n                \"value_upm\": 2.45913,\n                \"pi\": 5,\n                \"aqi\": 10.25,\n                \"caqi\": 4.1,\n                \"aqi_cn\": 3.51\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498791600,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 12.2409,\n                \"pi\": 6,\n                \"aqi\": 6.14,\n                \"caqi\": 6.12,\n                \"aqi_cn\": 6.12\n            },\n            \"O3\": {\n                \"value_upm\": 43.3382,\n                \"pi\": 17,\n                \"aqi\": 17.48,\n                \"caqi\": 18.06,\n                \"aqi_cn\": 13.54\n            },\n            \"PM10\": {\n                \"value_upm\": 6.0163,\n                \"pi\": 6,\n                \"aqi\": 5.57,\n                \"caqi\": 6.02,\n                \"aqi_cn\": 6.02\n            },\n            \"PM25\": {\n                \"value_upm\": 2.6475,\n                \"pi\": 5,\n                \"aqi\": 11.03,\n                \"caqi\": 4.41,\n                \"aqi_cn\": 3.78\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498795200,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 21.6224,\n                \"pi\": 11,\n                \"aqi\": 10.85,\n                \"caqi\": 10.81,\n                \"aqi_cn\": 10.81\n            },\n            \"O3\": {\n                \"value_upm\": 42.2961,\n                \"pi\": 17,\n                \"aqi\": 17.05,\n                \"caqi\": 17.62,\n                \"aqi_cn\": 13.22\n            },\n            \"PM10\": {\n                \"value_upm\": 8.3188,\n                \"pi\": 8,\n                \"aqi\": 7.7,\n                \"caqi\": 8.32,\n                \"aqi_cn\": 8.32\n            },\n            \"PM25\": {\n                \"value_upm\": 3.70715,\n                \"pi\": 7,\n                \"aqi\": 15.45,\n                \"caqi\": 6.18,\n                \"aqi_cn\": 5.3\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498798800,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 40.3959,\n                \"pi\": 20,\n                \"aqi\": 20.27,\n                \"caqi\": 20.2,\n                \"aqi_cn\": 20.2\n            },\n            \"O3\": {\n                \"value_upm\": 41.3758,\n                \"pi\": 17,\n                \"aqi\": 16.68,\n                \"caqi\": 17.24,\n                \"aqi_cn\": 12.93\n            },\n            \"PM10\": {\n                \"value_upm\": 12.6027,\n                \"pi\": 13,\n                \"aqi\": 11.67,\n                \"caqi\": 12.6,\n                \"aqi_cn\": 12.6\n            },\n            \"PM25\": {\n                \"value_upm\": 6.16014,\n                \"pi\": 12,\n                \"aqi\": 25.67,\n                \"caqi\": 10.27,\n                \"aqi_cn\": 8.8\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498802400,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 52.1365,\n                \"pi\": 29,\n                \"aqi\": 26.16,\n                \"caqi\": 26.07,\n                \"aqi_cn\": 26.07\n            },\n            \"O3\": {\n                \"value_upm\": 41.1138,\n                \"pi\": 16,\n                \"aqi\": 16.58,\n                \"caqi\": 17.13,\n                \"aqi_cn\": 12.85\n            },\n            \"PM10\": {\n                \"value_upm\": 16.108,\n                \"pi\": 16,\n                \"aqi\": 14.91,\n                \"caqi\": 16.11,\n                \"aqi_cn\": 16.11\n            },\n            \"PM25\": {\n                \"value_upm\": 7.08285,\n                \"pi\": 14,\n                \"aqi\": 29.51,\n                \"caqi\": 11.8,\n                \"aqi_cn\": 10.12\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498806000,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 52.4496,\n                \"pi\": 29,\n                \"aqi\": 26.32,\n                \"caqi\": 26.22,\n                \"aqi_cn\": 26.22\n            },\n            \"O3\": {\n                \"value_upm\": 40.4739,\n                \"pi\": 16,\n                \"aqi\": 16.32,\n                \"caqi\": 16.86,\n                \"aqi_cn\": 12.65\n            },\n            \"PM10\": {\n                \"value_upm\": 16.4473,\n                \"pi\": 16,\n                \"aqi\": 15.23,\n                \"caqi\": 16.45,\n                \"aqi_cn\": 16.45\n            },\n            \"PM25\": {\n                \"value_upm\": 6.31915,\n                \"pi\": 13,\n                \"aqi\": 26.33,\n                \"caqi\": 10.53,\n                \"aqi_cn\": 9.03\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498809600,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 47.422,\n                \"pi\": 26,\n                \"aqi\": 23.8,\n                \"caqi\": 23.71,\n                \"aqi_cn\": 23.71\n            },\n            \"O3\": {\n                \"value_upm\": 38.9137,\n                \"pi\": 16,\n                \"aqi\": 15.69,\n                \"caqi\": 16.21,\n                \"aqi_cn\": 12.16\n            },\n            \"PM10\": {\n                \"value_upm\": 17.102,\n                \"pi\": 17,\n                \"aqi\": 15.84,\n                \"caqi\": 17.1,\n                \"aqi_cn\": 17.1\n            },\n            \"PM25\": {\n                \"value_upm\": 5.75545,\n                \"pi\": 12,\n                \"aqi\": 23.98,\n                \"caqi\": 9.59,\n                \"aqi_cn\": 8.22\n            }\n        }\n    },\n    {\n        \"timestamp\": 1498813200,\n        \"values\": {\n            \"NO2\": {\n                \"value_upm\": 8.87,\n                \"pi\": 4,\n                \"aqi\": 4.45,\n                \"caqi\": 4.44,\n                \"aqi_cn\": 4.44\n            },\n            \"O3\": {\n                \"value_upm\": 64.39,\n                \"pi\": 29,\n                \"aqi\": 25.96,\n                \"caqi\": 26.83,\n                \"aqi_cn\": 20.12\n            },\n            \"PM10\": {\n                \"value_upm\": 6.8,\n                \"pi\": 7,\n                \"aqi\": 6.3,\n                \"caqi\": 6.8,\n                \"aqi_cn\": 6.8\n            },\n            \"PM25\": {\n                \"value_upm\": 4.03,\n                \"pi\": 8,\n                \"aqi\": 16.79,\n                \"caqi\": 6.72,\n                \"aqi_cn\": 5.76\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/2.0/forecast?token=xxx&latitude=48.85&longitude=2.294","name":""}]},"method":"get","auth":"required","params":[{"_id":"56c47fd6116c0d21000bcf18","ref":"","in":"query","required":false,"desc":"Authorization token","default":"","type":"string","name":"token"},{"_id":"56469229a74cd10d00a3f0b2","ref":"","in":"query","required":false,"desc":"Latitude","default":"","type":"double","name":"latitude"},{"_id":"56c47fbbaeb2040d00423f49","ref":"","in":"query","required":false,"desc":"Longitude","default":"","type":"double","name":"longitude"}],"url":"/forecast"},"isReference":false,"order":3,"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*.\",\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 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\": \"American Air Quality Index value.\",\n    \"5-0\": \"aqi_cn\",\n    \"5-1\": \"float\",\n    \"5-2\": \"Chinese Air Quality Index value.\",\n    \"6-0\": \"caqi\",\n    \"6-1\": \"float\",\n    \"6-2\": \"Common Air Quality Index value (mainly used in Europe).\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"pollution-forecast","type":"get","title":"/forecast","__v":0,"childrenPages":[]}

get/forecast


Query Params

token:
string
Authorization token
latitude:
double
Latitude
longitude:
double
Longitude
[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "timestamp", "0-1": "integer", "0-2": "UTC timestamp 10 digits long.", "1-0": "values", "1-1": "object", "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*.", "2-0": "value_upm", "2-1": "float", "2-2": "Concentration measured in µg/m3.", "3-0": "pi", "3-1": "float", "3-2": "Plume Index value corresponding to the concentration of the given pollutant on the given timestamp.", "4-0": "aqi", "4-1": "float", "4-2": "American Air Quality Index value.", "5-0": "aqi_cn", "5-1": "float", "5-2": "Chinese Air Quality Index value.", "6-0": "caqi", "6-1": "float", "6-2": "Common Air Quality Index value (mainly used in Europe)." }, "cols": 3, "rows": 7 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "timestamp", "0-1": "integer", "0-2": "UTC timestamp 10 digits long.", "1-0": "values", "1-1": "object", "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*.", "2-0": "value_upm", "2-1": "float", "2-2": "Concentration measured in µg/m3.", "3-0": "pi", "3-1": "float", "3-2": "Plume Index value corresponding to the concentration of the given pollutant on the given timestamp.", "4-0": "aqi", "4-1": "float", "4-2": "American Air Quality Index value.", "5-0": "aqi_cn", "5-1": "float", "5-2": "Chinese Air Quality Index value.", "6-0": "caqi", "6-1": "float", "6-2": "Common Air Quality Index value (mainly used in Europe)." }, "cols": 3, "rows": 7 } [/block]
{"_id":"5954cbf97a147f001b918960","project":"56468dfe36961e0d005c6228","version":"5954c8ddcf1c05001b2c0e9d","category":"5954c8ddcf1c05001b2c0e9f","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/2.0/live?token=xxx&latitude=48.85&longitude=2.294","name":""}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"timestamp\": 1498726800,\n  \"values\": {\n    \"NO2\": {\n      \"value_upm\": 1.19,\n      \"pi\": 1,\n      \"aqi\": 0.6,\n      \"caqi\": 0.6,\n      \"aqi_cn\": 0.6\n    },\n    \"O3\": {\n      \"value_upm\": 54.93,\n      \"pi\": 23,\n      \"aqi\": 22.15,\n      \"caqi\": 22.89,\n      \"aqi_cn\": 17.17\n    },\n    \"PM10\": {\n      \"value_upm\": 7.5,\n      \"pi\": 8,\n      \"aqi\": 6.94,\n      \"caqi\": 7.5,\n      \"aqi_cn\": 7.5\n    },\n    \"PM25\": {\n      \"value_upm\": 4.52,\n      \"pi\": 9,\n      \"aqi\": 18.83,\n      \"caqi\": 7.53,\n      \"aqi_cn\": 6.46\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":[{"_id":"56c47fd6116c0d21000bcf18","ref":"","in":"query","required":false,"desc":"Authorization token","default":"","type":"string","name":"token"},{"_id":"56469229a74cd10d00a3f0b2","ref":"","in":"query","required":false,"desc":"Latitude","default":"","type":"double","name":"latitude"},{"_id":"56c47fbbaeb2040d00423f49","ref":"","in":"query","required":false,"desc":"Longitude","default":"","type":"double","name":"longitude"},{"_id":"595cf1e791f29200158113b7","ref":"","in":"query","required":false,"desc":"[optional] The targeted timestamp (between -4 hours and the current timestamp)","default":"current","type":"timestamp","name":"timestamp"}],"url":"/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\": \"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*.\",\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 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\": \"American Air Quality Index value.\",\n    \"5-0\": \"aqi_cn\",\n    \"5-1\": \"float\",\n    \"5-2\": \"Chinese Air Quality Index value.\",\n    \"6-0\": \"caqi\",\n    \"6-1\": \"float\",\n    \"6-2\": \"Common Air Quality Index value (mainly used in Europe).\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"","slug":"live","type":"get","title":"/live","__v":2,"childrenPages":[]}

get/live


Query Params

token:
string
Authorization token
latitude:
double
Latitude
longitude:
double
Longitude
timestamp:
timestampcurrent
[optional] The targeted timestamp (between -4 hours and the current timestamp)
[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "timestamp", "0-1": "integer", "0-2": "UTC timestamp 10 digits long.", "1-0": "values", "1-1": "object", "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*.", "2-0": "value_upm", "2-1": "float", "2-2": "Concentration measured in µg/m3.", "3-0": "pi", "3-1": "float", "3-2": "Plume Index value corresponding to the concentration of the given pollutant on the given timestamp.", "4-0": "aqi", "4-1": "float", "4-2": "American Air Quality Index value.", "5-0": "aqi_cn", "5-1": "float", "5-2": "Chinese Air Quality Index value.", "6-0": "caqi", "6-1": "float", "6-2": "Common Air Quality Index value (mainly used in Europe)." }, "cols": 3, "rows": 7 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "timestamp", "0-1": "integer", "0-2": "UTC timestamp 10 digits long.", "1-0": "values", "1-1": "object", "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*.", "2-0": "value_upm", "2-1": "float", "2-2": "Concentration measured in µg/m3.", "3-0": "pi", "3-1": "float", "3-2": "Plume Index value corresponding to the concentration of the given pollutant on the given timestamp.", "4-0": "aqi", "4-1": "float", "4-2": "American Air Quality Index value.", "5-0": "aqi_cn", "5-1": "float", "5-2": "Chinese Air Quality Index value.", "6-0": "caqi", "6-1": "float", "6-2": "Common Air Quality Index value (mainly used in Europe)." }, "cols": 3, "rows": 7 } [/block]
{"_id":"59f8a986cbcc09001a51b8f8","project":"56468dfe36961e0d005c6228","version":"5954c8ddcf1c05001b2c0e9d","category":"59f8a96300c900001000415e","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":false,"desc":"Authorization token","default":"","type":"string","name":"token"},{"_id":"59f8aa2cd6af89001a1d1875","ref":"","in":"query","required":false,"desc":"Latitude","default":"","type":"double","name":"latitude"},{"_id":"59f8aa2cd6af89001a1d1874","ref":"","in":"query","required":false,"desc":"Longitude","default":"","type":"double","name":"longitude"}],"url":"/uv","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.plume.io/2.0/uv?token=xxx&latitude=48.85&longitude=2.294"}]},"method":"get"},"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\": \"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]","excerpt":"","slug":"uv","type":"get","title":"/uv","__v":6,"childrenPages":[]}

get/uv


Query Params

token:
string
Authorization token
latitude:
double
Latitude
longitude:
double
Longitude
[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "latitude", "0-1": "float", "0-2": "The latitude wanted in the request.", "1-0": "longitude", "1-1": "float", "1-2": "The longitude wanted in the request.", "2-0": "hourly", "2-1": "array", "2-2": "An array of hourly objects.", "3-0": "timestamp", "3-1": "integer", "3-2": "UTC timestamp 10 digits long.", "4-0": "uv", "4-1": "integer", "4-2": "The UV index on the current location for the given timestamp." }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "latitude", "0-1": "float", "0-2": "The latitude wanted in the request.", "1-0": "longitude", "1-1": "float", "1-2": "The longitude wanted in the request.", "2-0": "hourly", "2-1": "array", "2-2": "An array of hourly objects.", "3-0": "timestamp", "3-1": "integer", "3-2": "UTC timestamp 10 digits long.", "4-0": "uv", "4-1": "integer", "4-2": "The UV index on the current location for the given timestamp." }, "cols": 3, "rows": 5 } [/block]