REST API

Use REST API calls to create and update ThingSpeak™ channels and charts

Representational state transfer (REST) is an architectural style designed as a request-response model that communicates over HTTP. ThingSpeak, an IoT platform, uses the REST API calls GET, POST, PUT, and DELETE to create and delete channels, read and write channel data, and clear the data in a channel. A web browser or client sends a request to the server, which responds with data in the requested format. Web browsers use this interface to retrieve web pages or to send data to remote servers.

You can also use REST API calls with Act on Data which let you interact with social media, web services, and devices.

REST API Reference

expand all

Read Data

`Read Data`	Read data from all fields in channel with HTTP GET
`Read Field`	Read data from single field of channel with HTTP GET
`Read Status`	Read status field of channel with HTTP GET
`Read Last Entry`	Read last entry in channel with HTTP GET
`Read Last Field Entry`	Read last entry in channel field with HTTP GET
`Read Last Status`	Read last status of channel with HTTP GET

Write Data

`Write Data`	Update channel data with HTTP GET or POST
`Bulk Write JSON Data`	Write many entries to channel in JSON format with single HTTP POST
`Bulk Write CSV Data`	Write many entries to channel in CSV format with single HTTP POST

Write Images

`Write Image`	Write channel image with HTTP POST
`Delete Image`	Delete image from channel with HTTP DELETE
`Read Status of Image Request`	Read status of image request with HTTP GET

View Channels and Channel Settings

`List Your Public Channels`	List channels for username with HTTP GET
`List Your Channels`	List your channels with HTTP GET
`List Channels`	List public channels with HTTP GET
`Read Settings`	Read channel settings with HTTP GET
`Write Settings`	Update channel settings with HTTP PUT

Create and Delete

`Create Channel`	Create new channel with HTTP POST
`Clear Channel`	Clear all data from channel with HTTP DELETE
`Delete Channel`	Delete channel with HTTP DELETE

Read Entry Age

`Read Last Entry Age`	Read number of seconds since last entry in channel with HTTP GET
`Read Last Field Entry Age`	Read number of seconds since last entry in field with HTTP GET

Charts

Create Chart Generate chart with HTTP GET

Maps

Show Channel Map Show channel location on map

TalkBack

`Add Command`	Add TalkBack command to TalkBack queue
`Get Command`	Get TalkBack command from TalkBack queue
`Get All Commands`	Get all TalkBack commands from TalkBack queue
`Get Last Command`	Get last executed TalkBack command from TalkBack queue
`Update Command`	Update command in TalkBack queue
`Execute Command`	Execute next TalkBack command in TalkBack queue
`Write Data and Execute TalkBack Command`	Update channel data with HTTP GET or POST and execute TalkBack command
`Delete Command`	Delete TalkBack command from TalkBack queue
`Delete All Commands`	Delete all TalkBack commands in TalkBack queue

Alerts

`Send Alert`	Create email alert with HTTP POST
`Get Alert History`	Get alerts history with HTTP GET

Topics

Choose Between REST API and MQTT API
Learn when to use REST and MQTT to update a channel.
Bulk-Update Using an Arduino or an ESP8266
This example shows how to use either an Arduino® MKR1000 board or an ESP8266 board connected to a Wi-Fi® network to continuously collect Wi-Fi signal strength and bulk-update a ThingSpeak™ channel.
Bulk-Update a ThingSpeak Channel Using a Particle Photon Board
This example shows how to use a Particle Photon board connected to a Wi-Fi® network to bulk-update a ThingSpeak™ channel.
Bulk-Update Using a Raspberry Pi Board
This example shows how to collect data using a Wi-Fi-connected Raspberry Pi board running Python 2.7.
Time Zones Reference
Add time zone parameter to your HTTP request.

Troubleshooting

Error Codes

See the details of ThingSpeak REST API error messages and corresponding HTTP status codes.

Related Information

Featured Examples

Prototyping with Sonar Proximity Sensor

Prototype with ThingSpeak™ using a Wi-Fi connected Arduino® board.

Open Live Script

Post Temperature Data and Read from Channel

Collect environmental data from a device and post it from your device to a ThingSpeak™ channel. The example uses an ESP8266 and the ThingSpeak Communication Library to post data and retrieve data from a channel.

Open Live Script

Wireless Network Signal Strength with ESP32 with Arduino IDE

Use the wireless network functionality of ESP32 to post data to ThingSpeak™. The ESP32 records and posts the signal strength of the wireless network that it is connected to. Press a button on the board to take three measurements of the wireless network signal strength and post the average result to a ThingSpeak channel. The device also posts a counter value so you can track measurements.

Open Live Script

Write Image to ThingSpeak from Raspberry Pi with Python

Write an image to a ThingSpeak image channel from a Raspberry Pi^® board using Python^®.

Open Live Script

Write Image to ThingSpeak from ESP32 Camera Board

Capture an image from an ESP32 camera board and write it to a ThingSpeak image channel.

Open Live Script

How useful was this information?

Unrated 1 star 2 stars 3 stars 4 stars 5 stars