The BloomSky API is Here

The BloomSky API, now available to developers, will allow programmers and architects of connected homes to link their weather station to any number of outputs.


 

 

It’s been a long time coming. From day one, our community was interested in connecting their home weather station to…everything. Some users had designed custom climate control for their homes, other users wanted to link their station to a weather website. The BloomSky API will export the latest weather data, picture, and recent time-lapse videos from a specific station in JSON format for any number of purposes.

 

Don’t Know JSON? Try IFTTT

The API requires a certain level of programming knowledge to implement. If you don’t have the background to work with a web API, fear not! Try the BloomSky IFTTT channel to connect your weather station. IFTTT (if this then that) can connect your station to other devices around your home, automatically save images or time-lapse videos from your BloomSky, and a lot more. Read more about what IFTTT and BloomSky can do together here.

 

Programmers, Start Your Engines

To get an API Key, BloomSky station owners can go to their Dashboard, and click “Developers.”  Below is more documentation on the BloomSky API.  A download link is provided for offline convenience. If you have further questions, please post them below so an engineer can respond directly with more details. However, please be aware that due to the level of knowledge required to install the code our support team can’t walk users through this process. In these cases, please review our IFTTT channel to connect and otherwise automate your weather station.


5/30/17 API Update: STORM rain data fields

A small STORM data update allowing users to select which rain total method they prefer:

  • ‘RainDaily’ – this now calculates the daily rainfall from 12am-11:59pm (NWS standard); an update from the previous rolling 24 hour window
  • Add ’24hRain’ – this field will show the rolling 24 hour rainfall total

 

5/16/17 API Update: STORM station integration

The STORM station data is now (finally) integrated into the API!

  • Precipitation: rate, daily accumulation
  • Wind: 10 minute sustained speed, 10 min peak wind speed (gust), direction
  • UV: STORM UV data will supersede SKY1 data; additional data point if bound with a SKY2 station

 

2/2/16 API Update:

1. The endpoint /api/skydata/ can take an argument now: ‘unit=intl’, which will transfer all the imperial units to international units. If no argument is given, the units default to imperial ones.

2. As a result, we no longer provide both units in one response, so the key ‘Temperature_f’ is gone. Please make sure to change your program accordingly, otherwise you may get a key error.

3. The time-lapse videos are also in either Fahrenheit or Celsius, according to the request argument, so you don’t need to modify the video URLs if you did before.

4. Added ‘ImageTS’ to specify the timestamp of the image. It can be useful during the night, when the image is always the same but the other data is not. ‘imageTS’ and ‘TS’ differ in this case.

5. UVIndex is now converted to 1 – 11+ (string) scales automatically for you, please undo your own convert if you have one.


 

Download (PDF, 248KB)

click above to download the API documentation

 

Recommended Posts
  • Snowman2000

    Is it also now possible to embed our own “snapshot” widget using an HTML snippet in a webpage like the one labelled “Live Weather Station” for BloomSky HQ on this page? I would love to be able to just share that simple view without writing code.

    • john

      Hi Snowman,
      The ‘live widget’ is a different code, and unfortunately we haven’t been able to scale that to a larger distribution yet – each instance has to be manually written and managed by our engineers. However, we are working on a scalable solution for the visual widget and we’ll make sure to let the community know!

  • Victor Newman

    Thank you for finally getting this out. Using the API was not difficult at all. Within an hour I was able to use “Automagic for Android” to create an automated routine to get the data and upload it to another service where I have indoor and outdoor conditions, energy use and HVAC monitoring all combined.

    Questions:

    1: When will we be able to take the current live photo and embed it into a web page?

    2: Does the “UV” property have any units or is this an arbitrary scale?

    3: What is the “Luminance” property?

    Thanks again

    • john

      Hi Victor,

      Glad to hear it was so easy! To answer your questions:

      1. We are working on a solution for widespread ‘picture widget’ distribution, currently each of those visual widgets are coded and maintained manually which requires a lot internal resources (see the answer to Snowman’s question below for more).
      2. Although UV does not have units associated to it, it’s not an arbitrary scale; it’s a standardized index of 1-11 index by the WHO. Find more info here: http://www.epa.gov/sunsafety/uv-index-scale-1

      3. The ‘luminance property’ is data coming from the light sensor which is positioned next to the camera lens (the left sensor if you’re looking down at the lens). Note that this is different than the UV sensor, which sits on the other side of the camera lens. The luminance sensor collects and reports the amount of ambient light, and can be affected significantly by the angle at which it’s pointing. The sensor collects the info however we’re not using the data at the moment. Hopefully down the road we’ll be able to utilize it for something.

      • Bill

        The UVIndex value I am getting is “1282”, that doesn’t seem to jive with the scale you mentioned above, do you have some insight why I would be seeing numbers like this?

        Also could you update the docs with the unit information for the other data points?

        • john

          Hi Bill,
          The above post has been updated with the chart showing the raw data/UV Index equivalent. Hope that helps!

  • Giovany Vega

    Awesome, this is just what we were waiting for to connect field audio recordings to weather data.

  • Jacques-D. Piguet

    How (if possible) can I request data from the past?
    Thanks, Jacques-D.

    • john

      Hi Jacques,
      The API is limited to current data, for weather websites, home connectivity and other use where the most recent data is relevant. However the user dashboard (here: http://weatherlution.com/bloomsky-dashboard/) will give you access to all the historical data from your station; you can even export the data to a spreadsheet for archiving. Thanks for the question!

  • Rainman32

    Would it be possible to get a “Pressure_in”: inHg value please

    • john

      Yes! The request has been submitted to the API developers. We will update with news as they develop the new output.

  • Josefdz

    Would it be posible to show Dew Point?
    And Keep the Good Work!
    Thank You..

    • john

      Hello! Thanks for the request, it has been submitted to the engineers so they can work on implementing it. We have several new updates to the app that will be rolled out in the coming weeks, so we hope to fit it in. We’ll keep you posted!

      • Mia305

        Thank You John!

  • Jacques-D. Piguet

    The new format of the UVIndex is somehow misleading: we have loose a magnitude of information.
    Would it be possible to still get the new value?
    And some information about the conversion from the raw to the index?
    Thanks for the new TS information!
    Regards, Jacques-D.

    • john

      Hi Jacques,
      The earlier format was the raw number and had no inherent meaning; the new value returned is the international index of 1-11+. You can find out more information on the UV Index scale here: http://www.who.int/uv/intersunprogramme/activities/uv_index/en/index1.html.
      Hope this helps! Let us know if you need more info.

      • Jacques-D. Piguet

        Hi John,
        I checked the page you linked.
        I don’t have found information on how to convert the raw data from the sensor to the UV index.
        Do you have any hint?
        Regards, Jacques-D.

        • john

          Hi Jacques- Can you share the format that you’re getting back from the API? I believe it should be the 1-11+ scale; if it’s still the raw value then you can use this scale to convert:
          Raw UV value=UV index
          2333 = 11+

          • Jacques-D. Piguet

            Hi John,
            Below an extract of the JSON data I’m getting.
            The UVIndex has changed from integer to string and the value has now only 11 possible values.
            I find very nice to have the WHO value, but it is a pity to have a so small scale.
            I would prefer to get both values…

            Regards, Jacques-D.

            “Data”: {
            “Humidity”: 80,
            “ImageTS”: 1456075930,
            “ImageURL”: “http://storage.googleapis.com/bloomsky-img/eaB1rJytnZSmnJmoqJ1kq5unnJatm5U=.jpg”,
            “Luminance”: 35,
            “Night”: true,
            “Pressure”: 950,
            “Rain”: false,
            “TS”: 1456084104,
            “Temperature”: 7.67,
            “UVIndex”: “1”,
            “Voltage”: 2619
            },

          • john

            Hi Jacques,
            This site will explain the UV Index scale- http://www.epa.gov/sunsafety/uv-index-scale-1.
            UV Index is scale of 1-11+, the value is based on intensity of UV exposure.

    • john

      Hi Jacques,
      The earlier format was the raw number and had no inherent meaning; the new value returned is the international index of 1-11+. You can find out more information on the UV Index scale here: http://www.who.int/uv/intersunprogramme/activities/uv_index/en/index1.html.
      Hope this helps! Let us know if you need more info.

  • Mia305

    Why on the API response I don’t get Rain = True. If is raining? For example right now is raining in my area. And if you call the API still not showing True. But in the APP I got the alert that is raining.

    • john

      Hi Mia, sounds like a bug in the API. I’ll pass that along to the engineers. Thanks for the heads up!

  • Mark Swift

    Guys, what is the range of the battery, i.e. what Mv is counted as low battery, what is fully discharged (device turns off) what is the fully charged?

    • john

      Hi Mark,
      According to the engineers, the battery is full at roughly 2.6v and will shut off below 2.4v. The battery indicator within the app will turn red when the charge is below 2.5v. Hope this helps!

  • Chris Emry

    How do I link my station to weather underground?

    • Rainman32

      Here it is, simple signup process: http://bloomsky.com/wun
      easy setup and works great, not sure why this is not better advertised

      • Sam Shovel

        That doesn’t work for me, I just get the same “add webcam” form looped back to me endlessly. I see others have made it work though.

        • Rainman32

          Try the Bloomsky board on WXForum, there may be others who have already run into the same issue or who could offer assistance there: http://www.wxforum.net/index.php?board=125.0

          • Sam Shovel

            Thanks, that was a good lead. I seem to be the only person having this problem though. I’ve started with an email to Wunderground about the form not being approved, I’ll wait for their response.

          • Bryan Lynch

            Late to the party, but I’m having the same problem. Ever figure out a solution?

          • john

            Hi Bryan, You can find an article regarding linking your station to WU here: https://bloomsky.desk.com/customer/en/portal/articles/2293006-registering-device-with-weather-underground.
            If you have trouble, please contact our support team at ‘support@bloomsky.com’. Thanks!

          • Bryan Lynch

            Yeah, tried the article, tried emailing support for BloomSky AND WU, but no response. The FTP webcam form just sticks you in a loop.

    • Rainman32

      Here it is, simple signup process: http://bloomsky.com/wun
      easy setup and works great, not sure why this is not better advertised

  • Jรกchym Brzezina

    I have created a plugin specifically for Bloomsky for my template if anyone is interested you can have a look at http://www.meteotemplate.com. A functional demo is for example here: http://sacrey.info/meteotemplate/plugins/bloomSky/.

    • john

      This is great! Thanks for your work on this, we’ll spread this throughout our community.

  • J?chym Brzezina

    I have created a plugin specifically for Bloomsky for my template if anyone is interested you can have a look at http://www.meteotemplate.com. A functional demo is for example here: http://sacrey.info/meteotemplate/plugins/bloomSky/.

  • Andrew Ventura

    Would it be possible to get wifi connection data (signal strength, etc) via the api? Battery data is nice but wifi signal metrics are very valuable for troubleshooting connection issues!

    • john

      Hi Andrew,
      Thanks for your question! Theoretically it would be possible, however according to the engineers the wifi signal strength is only one piece of a large “connectivity puzzle”. For example, the wifi signal on the device could be showing at full strength but the wifi channel could be under heavy use and cause a slowdown. So, yes it’s possible, but it won’t tell the entire story of connection issues. Unfortunately with our resources stretched thin with new hardware on the horizon, we don’t have the man-power to add that to the API. However we’ll keep it on the table for down the road.
      If you’re having connection issues please feel free to contact our support team (support@bloomSky.com), they should be able to walk you through troubleshooting.

  • Jeffrey S. Musmacher

    So confused. So – I have a webpage. How do I put this data on it?

    • john

      Hi Jeffrey, The API is not exclusively for website output, it can be put to any number of uses. So in this sense it’s not a pre-built website plugin; setting up the framework to display the API outputs on a website does indeed require familiarity with JSON – a form of JavaScript programming. We don’t have a ‘plug and play’ website widget yet, but there perhaps down the road. Meanwhile, take a look at a plugin built by a user here: http://www.meteotemplate.com/web/plugins/bloomSky.php. This might be easier to implement into your site.

  • JK Hankins

    Hello. I have created a wordpress website for my dad who is a BloomSky member. The only option I can find is creating a link to his BloomSky account. Is there any html code, widget or other options that I can add to a page or post for this purpose? Thanks!

    • john

      Hi JK, If you’re familiar with implementing API code, then this would be your best option. We don’t have a publicly available widget at the moment but we are working on one; no firm timeline on that project as we’re still in the early stages, we’ll make updates on that as we progress. You could also connect the WordPress site to your BloomSky camera via IFTTT, but that would trigger a new post with every picture rather than update the existing picture you had previously posted.

      Hope this info helps!

    • Rainman32

      Here is another idea. you could publish the station to Weather Underground https://bloomsky.desk.com/customer/en/portal/articles/2293006-registering-device-with-weather-underground and then use their PWS widgets and image links

  • david.novice

    Hello, just one question. It is possible to add bloomsky in a home automation system ?
    Thank you for your answer.
    Best regards

  • JP

    Hello,
    I’m probably just doing something wrong, but are the servers currently up? I keep getting http error 404
    Thanks

    • john

      Hi JP, please send an email to ‘info@bloomsky.com’ with your device name and the site that your API leads to so we can look into the issue. Thanks!

  • JP

    Hello,
    I’m probably just doing something wrong, but are the servers currently up? I keep getting http error 404
    Thanks

  • Mia305

    Hello, When I use the API, I don’t see the Dew Point on the result. Is there a way I can get it? or is not available for now.

    • john

      We’re working on adding that data point to the API, however it’s a calculation done “on-the-fly” in the app, then “discarded” so unfortunately it doesn’t reside on the server. Upcoming back-end updates will change that and provide dew point as an additional data point. We’ll keep this page updated with changes to the API and modify the documentation with the new script. Thanks for the feedback!

  • Mia305

    Hello, When I use the API, I don’t see the Dew Point on the result. Is there a way I can get it? or is not available for now.

  • Mia305

    Hello, I’m wondering if the API server is down?
    Thanks

    • john

      Hi Mia, Yes- we had an unfortunate server outage over the weekend which affected all BloomSky services. We’ve gotten everything under control and back online, however if you continue to see issues please contact our customer support team at ‘support@bloomsky.com’.
      Sorry for the inconvenience, and thanks for your patience!

      • Mia305

        Hello John, After this weekend maintenance, the API part is not working again like last week. Still down because you guys haven’t finished the maintenance? Or there is an issue with the API server.
        Thank you in Advance.

        • john

          Hello Mia,
          Would you please send an email to ‘info@bloomsky.com’ so we can follow up with you on this? Please include your BloomSky user id/login email, your station name(s), and the destination for the API? Thanks!

          • Jacques-D. Piguet

            Hi John,
            I have problems too: the field “ImageTS” has disappeard from the JSON data…
            Regards, Jacques-D.

  • Bernie Herman

    When will the API be updated with the Storms data?

    • john

      Hi Bernie, Apologies for the late reply. We’ll be rolling out Storm-compatible API’s in the next two to three weeks. We’ll post updated info as soon as we’re up and running!

  • John Beck

    I’m trying to integrate the API into my PWS website and receiving an error that my authorization code is not recognized? Is the server down again?

    • john

      Hi John, Apologies this comment went unnoticed; if you’re still having issues please email our support team at ‘support@bloomsky.com’. Thanks!

  • Roger Mamer

    Any word when the API will include the storm data? and Any word when the dashboard will include the data from the storm device. Also
    has anyone got the storm data going to The weather underground?

    • john

      Hi Roger, We expect to have all the API’s (BloomSky and WU) updated with the Storm data in the next two to three weeks. We’re testing a version of the user dashboard with the Storm data now, and if it’s glitch-free we’ll roll that out next week. We’ll be sure to make an announcement on all of these updates as they happen. Thanks for checking in!

      • Brian Hamilton

        storm data is in the api data feed now I have noticed ๐Ÿ™‚

        • john

          Yes! Let us know how it’s working for you, or if you’re noticing any issues.

  • Brian Hamilton

    HI
    thanks or a great api
    i have created a windows 10 app ๐Ÿ™‚
    I will update it to support the new Storm too ๐Ÿ™‚
    https://www.microsoft.com/en-us/store/p/pc-bloomsky/9p7qqf2qs824
    Thanks
    Brian

    • john

      Hi Brian, That’s great! We’ll pass the link around. Thanks for your efforts!

      • Brian Hamilton

        kewl. New update ready soon (once it passes the windows 10 certification)
        that enables a user to select either the sky 1 or 2 to use if they have both in use ๐Ÿ™‚

      • Brian Hamilton

        Hi John
        Daniel Han,Director of Marketing, has emailed me and he wants me to not use the bloomsky logo or name in my app
        which basicly kills the app, as with out the name bloomsky, no one is going to find it very easily on the windows 10 store
        So looks like I will have to remove it ๐Ÿ™
        Brian

        • Rainman32

          hmm. somehow that just doesn’t seem right. sure they may have copyright on the name and image but why would they want to kill an app that makes their device more useful? perhaps there could be a licensing agreement, or I wonder what their stance would be if it were freeware? Anyhow not sure they can legally prevent you from using the name so long as its clear that the program is for use with the Bloomsky but not written nor supported by them. just change the name to “PC For BloomSky” with appropriate disclaimers

          • Brian Hamilton

            that’s lawyers for you.
            He has asked me to not use the word bloomsky or their logo
            I have removed the app from the windows 10 store
            as without the name bloomsky their customers will not easily find an app that works with their hardware
            their loss
            shame really
            as I had made contact via here and was encouraged to do what I am doing. But someone did not tell their marketing person
            in nearly 20 years of being a 3rd party software developer for all the popular weather station hardware, this is the first time I have had this happen

          • Brian Hamilton

            i have changed the name of the app, removed the logo, and made it a windows 7 and up app available now from
            http://www.weather-display.com/downloadfiles/pcsky.zip
            if anyone is interested

  • Jรกchym Brzezina

    Guys Im really disappointed with this.
    1. there is no detailed documentation for the API – making it useless. If this is to be used be developers, then not having a proper documentation makes it useless. For example, rain rate – is it in in/h? in/min? What about solar radiation, it is not there.
    2. I suspect there are bugs, the pressure is most likely not converted to sea-level so the values differ and this is even in your default app!
    3. the api file is over year old and outdated
    4. last but not least, what you have done to Brian (post below) is ridiculous, he offered it for free, you could benefit from it and you even encouraged him to do it.

    • john

      Hello Jachym, I’m sorry you’re so disappointed. There is in fact detailed documentation for the API (see above), however you are correct – it is outdated. There is a new version of the API doc pending upload to the site, but we’re having issues getting the new version on the page due to some changes we’ve made to the blog host. A request for the updated version would suffice, rather than a complaint about how thoroughly disappointed you are. Please send an email to ‘info@bloomsky.com’ and we can forward you the updated document while we get this page corrected.
      As for the issue with the Windows 10 app – although we appreciated the effort Brian put into building the app, we had to have it taken down as there were legal issues around him providing an app that purported to be an official BloomSky app, regardless if the app was free or not.

  • Michael Hasak

    If you want your BloomSky readings in your Mac menu bar, here’s a simple solution using BitBar. I just wanted the temperature, so this only does that, but it’s really easy to extend using the BitBar plugin format.

    1) Get BitBar at http://getbitbar.com
    2) Edit the following script with your API key and python path, and put it in your BitBar plugins directory:

    https://gist.github.com/mphasak/45855465cbd1d4338a207d33a6983747

    • john

      Hi Michael, Thank you for this! This is a very cool feature.