Read Settings

Read channel settings with HTTP GET

Request

HTTP Method

GET

URL

https://api.thingspeak.com/channels/<channel_id>.<format>

URL Parameters

Name	Description
<channel_id>	(Required) Channel ID for the channel of interest.
<format>	(Required) Format for the HTTP response, specified as json or xml.

Example: https://api.thingspeak.com/channels/266256.json

Query String Parameters

Name	Description	Value Type
api_key	(Required for private channels) Specify User API Key, which you can find in your profile. This key is different from the channel API keys.	string

Response

Success

HTTP Status Code

200 OK

Body

 JSON Example

GET https://api.thingspeak.com/channels/9.json

The response is a JSON object of the public channel 9: { "id": 9, "name": "my_house", "description": "Netduino Plus connected to sensors around the house", "latitude": "40.44", "longitude": "-79.9965", "created_at": "2010-12-14T01:20:06Z", "elevation": "", "last_entry_id": 11684395, "public_flag': true "url": "" "ranking": 100, "tags": [ { "id": 9, "name": "temp" }, { "id": 25, "name": "light" }, { "id": 3, "name": "sensor" } ] }

 XML Example

GET https://api.thingspeak.com/channels/9.xml

The response is an XML object of the public channel 9: <?xml version="1.0" encoding="UTF-8"?> <channel> <id type="integer">9</id> <name>my_house</name> <description> Netduino Plus connected to sensors around the house.</description> <latitude type="decimal">40.5</latitude> <longitude type="decimal">-79.9965</longitude> <created-at type="dateTime">2010-12-14T01:20:06Z</created-at> <elevation></elevation> <last-entry-id type="integer">11684395</last-entry-id> <public_flag>true</public_flag> <url></url> <ranking type="integer">100</ranking> <tags type="array"> <tag> <id type="integer">9</id> <name>temp</name> </tag> <tag> <id type="integer">25</id> <name>light</name> </tag> <tag> <id type="integer">3</id> <name>sensor<name> </tag> </tags> </channel>

Error

For the full list, see Error Codes.

Examples

View Channel Settings

You can use your web browser to complete GET HTTP requests to the RESTful API for ThingSpeak™.

To see the format for an HTTP response, copy the following URL to the address bar of your web browser, changing <channel_ID> to your channel ID and <XXXXXXXXXXXXXXXX> to your User API Key, which is found in Account > My Profile.

https://api.thingspeak.com/channels/<channel_ID>.json?api_key=<XXXXXXXXXXXXXXXX>

The response is a JSON object of the channel settings, as shown in the response section.