{"_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?token=xxx&latitude=48.85&longitude=2.294'","name":""}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"timestamp\":1569398400,\n  \"values\":{\n    \"NO2\":{\"value_upm\":24.2,\"pi\":12.1},\n    \"CO\":{\"value_upm\":130.88,\"pi\":0.65},\n    \"O3\":{\"value_upm\":33.93,\"pi\":13.57},\n    \"SO2\":{\"value_upm\":1.84,\"pi\":1.84},\n    \"PM10\":{\"value_upm\":15.78,\"pi\":15.78},\n    \"PM25\":{\"value_upm\":6.23,\"pi\":12.46}\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":true,"desc":"Authorization token","default":"","type":"string","name":"token"},{"_id":"56469229a74cd10d00a3f0b2","ref":"","in":"query","required":true,"desc":"Latitude (decimal)","default":"","type":"double","name":"latitude"},{"_id":"56c47fbbaeb2040d00423f49","ref":"","in":"query","required":true,"desc":"Longitude (decimal)","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":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 Index value corresponding to the  concentration of the given pollutant on the given timestamp.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"current air quality","slug":"live","type":"get","title":"/live","__v":6,"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)
[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*, *CO*, *SO2*.", "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." }, "cols": 3, "rows": 4 } [/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*, *CO*, *SO2*.", "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." }, "cols": 3, "rows": 4 } [/block]
{"_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\":1569398400,\n    \"values\":{\n      \"NO2\":{\"value_upm\":24.2, \"pi\":12.1},\n      \"CO\":{\"value_upm\":130.88, \"pi\":0.65},\n      \"O3\":{\"value_upm\":33.93, \"pi\":13.57},\n      \"SO2\":{\"value_upm\":1.84,\"pi\":1.84},\n      \"PM10\":{\"value_upm\":15.78,\"pi\":15.78},\n      \"PM25\":{\"value_upm\":6.23,\"pi\":12.46}\n    }\n  },\n  {\n    \"timestamp\":1569402000,\n    \"values\":{\n      \"NO2\":{\"value_upm\":22.03,\"pi\":11.02},\n      \"CO\":{\"value_upm\":131.01,\"pi\":0.66},\n      \"O3\":{\"value_upm\":33.81,\"pi\":13.53},\n      \"SO2\":{\"value_upm\":1.67,\"pi\":1.67},\n      \"PM10\":{\"value_upm\":23.49,\"pi\":23.49},\n      \"PM25\":{\"value_upm\":7.3,\"pi\":14.6}\n    }\n  },\n  {\n    \"timestamp\":1569405600,\n    \"values\":{\n      \"NO2\":{\"value_upm\":18.48,\"pi\":9.24},\n      \"CO\":{\"value_upm\":123.97,\"pi\":0.62},\n      \"O3\":{\"value_upm\":36.33,\"pi\":14.53},\n      \"SO2\":{\"value_upm\":1.43,\"pi\":1.43},\n      \"PM10\":{\"value_upm\":38.62,\"pi\":38.62},\n      \"PM25\":{\"value_upm\":8.14,\"pi\":16.27}\n    }\n  },\n  {\n    \"timestamp\":1569409200,\n    \"values\":{\n      \"NO2\":{\"value_upm\":14.92,\"pi\":7.46},\n      \"CO\":{\"value_upm\":116.94,\"pi\":0.58},\n      \"O3\":{\"value_upm\":38.85,\"pi\":15.54},\n      \"SO2\":{\"value_upm\":1.2,\"pi\":1.2},\n      \"PM10\":{\"value_upm\":48.07,\"pi\":48.07},\n      \"PM25\":{\"value_upm\":8.74,\"pi\":17.48}\n    }\n  },\n  {\n    \"timestamp\":1569412800,\n    \"values\":{\n      \"NO2\":{\"value_upm\":11.37,\"pi\":5.68},\n      \"CO\":{\"value_upm\":109.9,\"pi\":0.55},\n      \"O3\":{\"value_upm\":41.36,\"pi\":16.55},\n      \"SO2\":{\"value_upm\":0.97,\"pi\":0.97},\n      \"PM10\":{\"value_upm\":51.72,\"pi\":52.86},\n      \"PM25\":{\"value_upm\":9.17,\"pi\":18.33}\n    }\n  },\n  {\"timestamp\":1569416400,\n   \"values\":{\n     \"NO2\":{\"value_upm\":11.99,\"pi\":5.99},\n     \"CO\":{\"value_upm\":110.34,\"pi\":0.55},\n     \"O3\":{\"value_upm\":41.29,\"pi\":16.52},\n     \"SO2\":{\"value_upm\":0.99,\"pi\":0.99},\n     \"PM10\":{\"value_upm\":50.45,\"pi\":50.75},\n     \"PM25\":{\"value_upm\":9.23,\"pi\":18.46}\n   }\n  },\n  {\n    \"timestamp\":1569420000,\n    \"values\":{\n      \"NO2\":{\"value_upm\":12.6,\"pi\":6.3},\n      \"CO\":{\"value_upm\":110.78,\"pi\":0.55},\n      \"O3\":{\"value_upm\":41.22,\"pi\":16.49},\n      \"SO2\":{\"value_upm\":1.01,\"pi\":1.01},\n      \"PM10\":{\"value_upm\":45.41,\"pi\":45.41},\n      \"PM25\":{\"value_upm\":8.31,\"pi\":16.62}\n    }\n  },\n  {\n    \"timestamp\":1569423600,\n    \"values\":{\n      \"NO2\":{\"value_upm\":13.22,\"pi\":6.61},\n      \"CO\":{\"value_upm\":111.23,\"pi\":0.56},\n      \"O3\":{\"value_upm\":41.15,\"pi\":16.46},\n      \"SO2\":{\"value_upm\":1.03,\"pi\":1.03},\n      \"PM10\":{\"value_upm\":43.34,\"pi\":43.34},\n      \"PM25\":{\"value_upm\":8.16,\"pi\":16.32}\n    }\n  },\n  {\n    \"timestamp\":1569427200,\n    \"values\":{\n      \"NO2\":{\"value_upm\":22,\"pi\":11},\n      \"CO\":{\"value_upm\":123.97,\"pi\":0.62},\n      \"O3\":{\"value_upm\":37.39,\"pi\":14.96},\n      \"SO2\":{\"value_upm\":1.73,\"pi\":1.73},\n      \"PM10\":{\"value_upm\":41.11,\"pi\":41.11},\n      \"PM25\":{\"value_upm\":8.63,\"pi\":17.26}\n    }\n  },\n  {\n    \"timestamp\":1569430800,\n    \"values\":{\n      \"NO2\":{\"value_upm\":30.78,\"pi\":15.39},\n      \"CO\":{\"value_upm\":136.7,\"pi\":0.68},\n      \"O3\":{\"value_upm\":33.63,\"pi\":13.45},\n      \"SO2\":{\"value_upm\":2.42,\"pi\":2.42},\n      \"PM10\":{\"value_upm\":37.66,\"pi\":37.66},\n      \"PM25\":{\"value_upm\":9.32,\"pi\":18.64}\n    }\n  },\n  {\n    \"timestamp\":1569434400,\n    \"values\":{\n      \"NO2\":{\"value_upm\":39.55,\"pi\":19.78},\n      \"CO\":{\"value_upm\":149.44,\"pi\":0.75},\n      \"O3\":{\"value_upm\":29.86,\"pi\":11.95},\n      \"SO2\":{\"value_upm\":3.12,\"pi\":3.12},\n      \"PM10\":{\"value_upm\":36.15,\"pi\":36.15},\n      \"PM25\":{\"value_upm\":10.21,\"pi\":20.41}\n    }\n  },\n  {\n    \"timestamp\":1569438000,\n    \"values\":{\n      \"NO2\":{\"value_upm\":45.64,\"pi\":24.23},\n      \"CO\":{\"value_upm\":159.6,\"pi\":0.8},\n      \"O3\":{\"value_upm\":27.4,\"pi\":10.96},\n      \"SO2\":{\"value_upm\":3.6,\"pi\":3.6},\n      \"PM10\":{\"value_upm\":36.57,\"pi\":36.57},\n      \"PM25\":{\"value_upm\":11.27,\"pi\":22.54}\n    }\n  },\n  {\n    \"timestamp\":1569441600,\n    \"values\":{\n      \"NO2\":{\"value_upm\":51.73,\"pi\":28.8},\n      \"CO\":{\"value_upm\":169.76,\"pi\":0.85},\n      \"O3\":{\"value_upm\":24.94,\"pi\":9.98},\n      \"SO2\":{\"value_upm\":4.08,\"pi\":4.08},\n      \"PM10\":{\"value_upm\":38.07,\"pi\":38.07},\n      \"PM25\":{\"value_upm\":12.03,\"pi\":24.05}\n    }\n  },\n  {\n    \"timestamp\":1569445200,\n    \"values\":{\n      \"NO2\":{\"value_upm\":57.81,\"pi\":33.36},\n      \"CO\":{\"value_upm\":179.93,\"pi\":0.9},\n      \"O3\":{\"value_upm\":22.48,\"pi\":8.99},\n      \"SO2\":{\"value_upm\":4.56,\"pi\":4.56},\n      \"PM10\":{\"value_upm\":39.55,\"pi\":39.55},\n      \"PM25\":{\"value_upm\":12.07,\"pi\":24.14}\n    }\n  },\n  {\n    \"timestamp\":1569448800,\n    \"values\":{\n      \"NO2\":{\"value_upm\":52.07,\"pi\":29.05},\n      \"CO\":{\"value_upm\":168.61,\"pi\":0.84},\n      \"O3\":{\"value_upm\":24.27,\"pi\":9.71},\n      \"SO2\":{\"value_upm\":4.01,\"pi\":4.01},\n      \"PM10\":{\"value_upm\":37.75,\"pi\":37.75},\n      \"PM25\":{\"value_upm\":11.17,\"pi\":22.34}\n    }\n  },\n  {\n    \"timestamp\":1569452400,\n    \"values\":{\n      \"NO2\":{\"value_upm\":46.32,\"pi\":24.74},\n      \"CO\":{\"value_upm\":157.29,\"pi\":0.79},\n      \"O3\":{\"value_upm\":26.05,\"pi\":10.42},\n      \"SO2\":{\"value_upm\":3.47,\"pi\":3.47},\n      \"PM10\":{\"value_upm\":33.25,\"pi\":33.25},\n      \"PM25\":{\"value_upm\":9.77,\"pi\":19.54}\n    }\n  },\n  {\n    \"timestamp\":1569456000,\n    \"values\":{\n      \"NO2\":{\"value_upm\":40.57,\"pi\":20.43},\n      \"CO\":{\"value_upm\":145.97,\"pi\":0.73},\n      \"O3\":{\"value_upm\":27.84,\"pi\":11.14},\n      \"SO2\":{\"value_upm\":2.93,\"pi\":2.93},\n      \"PM10\":{\"value_upm\":29.68,\"pi\":29.68},\n      \"PM25\":{\"value_upm\":8.92,\"pi\":17.84}\n    }\n  },\n  {\n    \"timestamp\":1569459600,\n    \"values\":{\n      \"NO2\":{\"value_upm\":38.66,\"pi\":19.33},\n      \"CO\":{\"value_upm\":141.4,\"pi\":0.71},\n      \"O3\":{\"value_upm\":29.54,\"pi\":11.81},\n      \"SO2\":{\"value_upm\":2.82,\"pi\":2.82},\n      \"PM10\":{\"value_upm\":29.93,\"pi\":29.93},\n      \"PM25\":{\"value_upm\":8.61,\"pi\":17.21}\n    }\n  },\n  {\n    \"timestamp\":1569463200,\n    \"values\":{\n      \"NO2\":{\"value_upm\":36.75,\"pi\":18.38},\n      \"CO\":{\"value_upm\":136.83,\"pi\":0.68},\n      \"O3\":{\"value_upm\":31.23,\"pi\":12.49},\n      \"SO2\":{\"value_upm\":2.7,\"pi\":2.7},\n      \"PM10\":{\"value_upm\":31.49,\"pi\":31.49},\n      \"PM25\":{\"value_upm\":8.67,\"pi\":17.34}\n    }\n  },\n  {\n    \"timestamp\":1569466800,\n    \"values\":{\n      \"NO2\":{\"value_upm\":34.83,\"pi\":17.42},\n      \"CO\":{\"value_upm\":132.26,\"pi\":0.66},\n      \"O3\":{\"value_upm\":32.92,\"pi\":13.17},\n      \"SO2\":{\"value_upm\":2.58,\"pi\":2.58},\n      \"PM10\":{\"value_upm\":31.24,\"pi\":31.24},\n      \"PM25\":{\"value_upm\":8.28,\"pi\":16.57}\n    }\n  },\n  {\n    \"timestamp\":1569470400,\n    \"values\":{\n      \"NO2\":{\"value_upm\":35.78,\"pi\":17.89},\n      \"CO\":{\"value_upm\":134.26,\"pi\":0.67},\n      \"O3\":{\"value_upm\":31.86,\"pi\":12.75},\n      \"SO2\":{\"value_upm\":2.68,\"pi\":2.68},\n      \"PM10\":{\"value_upm\":30.43,\"pi\":30.43},\n      \"PM25\":{\"value_upm\":7.78,\"pi\":15.56}\n    }\n  },\n  {\n    \"timestamp\":1569474000,\n    \"values\":{\n      \"NO2\":{\"value_upm\":36.74,\"pi\":18.37},\n      \"CO\":{\"value_upm\":136.26,\"pi\":0.68},\n      \"O3\":{\"value_upm\":30.81,\"pi\":12.32},\n      \"SO2\":{\"value_upm\":2.77,\"pi\":2.77},\n      \"PM10\":{\"value_upm\":30.27,\"pi\":30.27},\n      \"PM25\":{\"value_upm\":7.52,\"pi\":15.03}\n    }\n  },\n  {\n    \"timestamp\":1569477600,\n    \"values\":{\n      \"NO2\":{\"value_upm\":37.69,\"pi\":18.84},\n      \"CO\":{\"value_upm\":138.26,\"pi\":0.69},\n      \"O3\":{\"value_upm\":29.75,\"pi\":11.9},\n      \"SO2\":{\"value_upm\":2.87,\"pi\":2.87},\n      \"PM10\":{\"value_upm\":31.12,\"pi\":31.12},\n      \"PM25\":{\"value_upm\":7.5,\"pi\":15.01}\n    }\n  },\n  {\n    \"timestamp\":1569481200,\n    \"values\":{\n      \"NO2\":{\"value_upm\":32.51,\"pi\":16.25},\n      \"CO\":{\"value_upm\":131.44,\"pi\":0.66},\n      \"O3\":{\"value_upm\":31.24,\"pi\":12.49},\n      \"SO2\":{\"value_upm\":2.56,\"pi\":2.56},\n      \"PM10\":{\"value_upm\":32.08,\"pi\":32.08},\n      \"PM25\":{\"value_upm\":7.42,\"pi\":14.84}\n    }\n  },\n  {\n    \"timestamp\":1569484800,\n    \"values\":{\n      \"NO2\":{\"value_upm\":27.33,\"pi\":13.66},\n      \"CO\":{\"value_upm\":124.61,\"pi\":0.62},\n      \"O3\":{\"value_upm\":32.72,\"pi\":13.09},\n      \"SO2\":{\"value_upm\":2.24,\"pi\":2.24},\n      \"PM10\":{\"value_upm\":33.11,\"pi\":33.11},\n      \"PM25\":{\"value_upm\":8.07,\"pi\":16.15}\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?token=xxx&latitude=48.85&longitude=2.294'","name":""}]},"method":"get","auth":"required","params":[{"_id":"56c47fd6116c0d21000bcf18","ref":"","in":"query","required":true,"desc":"Authorization token","default":"","type":"string","name":"token"},{"_id":"56469229a74cd10d00a3f0b2","ref":"","in":"query","required":true,"desc":"Latitude (decimal)","default":"","type":"double","name":"latitude"},{"_id":"56c47fbbaeb2040d00423f49","ref":"","in":"query","required":true,"desc":"Longitude (decimal)","default":"","type":"double","name":"longitude"}],"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 Index value corresponding to the  concentration of the given pollutant on the given timestamp.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"24 hours air quality forecast","slug":"pollution-forecast","type":"get","title":"/forecast","__v":5,"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)
[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*, *CO*, *SO2*.", "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." }, "cols": 3, "rows": 4 } [/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*, *CO*, *SO2*.", "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." }, "cols": 3, "rows": 4 } [/block]
{"_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)
[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "latitude", "0-1": "float", "0-2": "latitude", "1-0": "longitude", "1-1": "float", "1-2": "longitude", "2-0": "timestamp", "2-1": "integer", "2-2": "10 digits UTC epoch linux timestamp", "3-0": "uv", "3-1": "integer", "3-2": "UV index" }, "cols": 3, "rows": 4 } [/block] See World Health Organization [UV index definition](https://www.who.int/uv/intersunprogramme/activities/uv_index/en/)

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": "latitude", "1-0": "longitude", "1-1": "float", "1-2": "longitude", "2-0": "timestamp", "2-1": "integer", "2-2": "10 digits UTC epoch linux timestamp", "3-0": "uv", "3-1": "integer", "3-2": "UV index" }, "cols": 3, "rows": 4 } [/block] See World Health Organization [UV index definition](https://www.who.int/uv/intersunprogramme/activities/uv_index/en/)
{"_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)
[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "latitude", "0-1": "float", "0-2": "latitude", "1-0": "longitude", "1-1": "float", "1-2": "longitude", "2-0": "hourly", "2-1": "array", "2-2": "An array of hourly objects.", "3-0": "timestamp", "3-1": "integer", "3-2": "10 digit UTC epoch linux timestamp", "4-0": "uv", "4-1": "integer", "4-2": "UV index" }, "cols": 3, "rows": 5 } [/block] See World Health Organization [UV index definition](https://www.who.int/uv/intersunprogramme/activities/uv_index/en/)

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": "latitude", "1-0": "longitude", "1-1": "float", "1-2": "longitude", "2-0": "hourly", "2-1": "array", "2-2": "An array of hourly objects.", "3-0": "timestamp", "3-1": "integer", "3-2": "10 digit UTC epoch linux timestamp", "4-0": "uv", "4-1": "integer", "4-2": "UV index" }, "cols": 3, "rows": 5 } [/block] See World Health Organization [UV index definition](https://www.who.int/uv/intersunprogramme/activities/uv_index/en/)
{"_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)
[block:parameters] { "data": { "0-0": "timestamp", "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-1": "integer", "0-2": "10 digit UTC epoch linux timestamp", "1-0": "values", "1-1": "object", "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*.", "2-0": "value_gpm", "2-1": "float", "3-0": "nab_index", "3-1": "float", "4-0": "", "4-2": "", "5-0": "", "4-1": "", "5-1": "", "2-2": "Concentrations measured in grains/m3 (only available for Europe)", "3-2": "US national allergy bureau index" }, "cols": 3, "rows": 4 } [/block] The US National Allergy Bureau (NAB) index definition is available [here](https://www.aaaai.org/global/nab-pollen-counts/reading-the-charts).

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": { "0-0": "timestamp", "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-1": "integer", "0-2": "10 digit UTC epoch linux timestamp", "1-0": "values", "1-1": "object", "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*.", "2-0": "value_gpm", "2-1": "float", "3-0": "nab_index", "3-1": "float", "4-0": "", "4-2": "", "5-0": "", "4-1": "", "5-1": "", "2-2": "Concentrations measured in grains/m3 (only available for Europe)", "3-2": "US national allergy bureau index" }, "cols": 3, "rows": 4 } [/block] The US National Allergy Bureau (NAB) index definition is available [here](https://www.aaaai.org/global/nab-pollen-counts/reading-the-charts).
{"_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)
[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "timestamp", "0-1": "integer", "0-2": "10 digit UTC epoch linux timestamp", "1-0": "values", "1-1": "object", "2-0": "value_upm", "2-1": "float", "3-0": "nab_index", "3-1": "float", "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*.", "2-2": "Concentration expressed in grains/m3 (only available for Europe)", "3-2": "US National Allergy Bureau index" }, "cols": 3, "rows": 4 } [/block] The US National Allergy Bureau (NAB) index definition is available [here](https://www.aaaai.org/global/nab-pollen-counts/reading-the-charts).

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": "10 digit UTC epoch linux timestamp", "1-0": "values", "1-1": "object", "2-0": "value_upm", "2-1": "float", "3-0": "nab_index", "3-1": "float", "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*.", "2-2": "Concentration expressed in grains/m3 (only available for Europe)", "3-2": "US National Allergy Bureau index" }, "cols": 3, "rows": 4 } [/block] The US National Allergy Bureau (NAB) index definition is available [here](https://www.aaaai.org/global/nab-pollen-counts/reading-the-charts).
{"_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)
[block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "timestamp", "0-1": "integer", "0-2": "10 digit UTC epoch linux timestamp", "1-0": "values", "1-1": "object", "2-0": "value_upm", "2-1": "float", "2-2": "Concentration in µg/m3", "3-0": "pi", "3-1": "float", "3-2": "plume AQI", "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*." }, "cols": 3, "rows": 4 } [/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": "10 digit UTC epoch linux timestamp", "1-0": "values", "1-1": "object", "2-0": "value_upm", "2-1": "float", "2-2": "Concentration in µg/m3", "3-0": "pi", "3-1": "float", "3-2": "plume AQI", "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*." }, "cols": 3, "rows": 4 } [/block]
{"_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!

To get started, [visit our API website](https://plume.io).
To get started, [visit our API website](https://plume.io).
{"_id":"5d8b2d5efc49f804578a14aa","category":"5d8b2d5efc49f804578a14a5","project":"56468dfe36961e0d005c6228","user":"56468df0a74cd10d00a3f0ad","version":"5d8b2d5efc49f804578a14ad","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,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"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.