CheerLights API

CheerLights listens to Twitter for the keyword “cheerlights” in real-time along with a color. When a Tweet matches, the CheerLights service updates a content feed at ThingSpeak, Adafruit IO, and the CheerLights MQTT server. Devices and apps can subscribe to one of the feeds and display the latest color.

Once you are familiar with the CheerLights API, try building your own CheerLights display.

ThingSpeak Channel

The CheerLights ThingSpeak Channel gets updated with the latest CheerLights color. You can use the ThingSpeak Channel API to read our data using HTTP or MQTT. CheerLights uses channel 1417 and stores the color name in field1 and the HEX color value in field2. 

CheerLights Last Color Name

CheerLights Last HEX Color Value

Full CheerLights Feed

Adafruit IO

CheerLights has a public data feed hosted at Adafruit IO under the username cheerlights and the color feed or hex feed. To get the latest color value from Adafruit IO, you can use their Web, HTTP, or MQTT API found in the Adafruit IO documentation.

CheerLights MQTT

CheerLights supports MQTT direct from the source.

  • Server: mqtt.cheerlights.com:1883
  • Color Topic: cheerlights
  • RGB Color Topic: cheerlightsRGB

Controlling CheerLights

To control CheerLights, send a tweet to @cheerlights or include “#cheerlights” somewhere in your message with the name of a color.

Example Tweet

@CheerLights Paint the town red

This will cause a chain reaction and all of the CheerLights displays and apps will change their color to red.

The Colors of CheerLights

  • red (#FF0000)
  • green (#008000)
  • blue (#0000FF)
  • cyan (#00FFFF)
  • white (#FFFFFF)
  • oldlace (#FDF5E6)
  • purple (#800080)
  • magenta (#FF00FF)
  • yellow (#FFFF00)
  • orange (#FFA500)
  • pink (#FFC0CB)

You can check previous Tweets using Twitter Search.