Adafruit IO REST API

OpenAPI apis-guru iot

The Internet of Things for Everyone

The Adafruit IO HTTP API provides access to your Adafruit IO data from any programming language or hardware environment that can speak HTTP. The easiest way to get started is with and .

This API documentation is hosted on GitHub Pages and is available at . For questions or comments visit the or the .

Authentication

Authentication for every API request happens through the X-AIO-Key header or query parameter and your IO API key. A simple cURL request to get all available feeds for a user with the username "io_username" and the key "io_key_12345" could look like this:

Or like this:

Using the node.js library, IO HTTP requests are as easy as:

var request = require('request');
var options = {  url: 'https://io.adafruit.com/api/v2/io_username/feeds',  headers: {    'X-AIO-Key': 'io_key_12345',    'Content-Type': 'application/json'  }};
function callback(error, response, body) {  if (!error && response.statusCode == 200) {    var feeds = JSON.parse(body);    console.log(feeds.length + " FEEDS AVAILABLE");
    feeds.forEach(function (feed) {      console.log(feed.name, feed.key);    })  }}
request(options, callback);

Using the ESP8266 Arduino HTTPClient library, an HTTPS GET request would look like this (replacing --- with your own values in the appropriate locations):

arduino

/// based on/// https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266HTTPClient/examples/Authorization/Authorization.ino
#include <Arduino.h>#include <ESP8266WiFi.h>#include <ESP8266WiFiMulti.h>#include <ESP8266HTTPClient.h>
ESP8266WiFiMulti WiFiMulti;
const char* ssid = "---";const char* password = "---";
const char* host = "io.adafruit.com";
const char* io_key = "---";const char* path_with_username = "/api/v2/---/dashboards";
// Use web browser to view and copy// SHA1 fingerprint of the certificateconst char* fingerprint = "77 00 54 2D DA E7 D8 03 27 31 23 99 EB 27 DB CB A5 4C 57 18";
void setup() {  Serial.begin(115200);
  for(uint8_t t = 4; t > 0; t--) {    Serial.printf("[SETUP] WAIT %d...\n", t);    Serial.flush();    delay(1000);  }
  WiFi.mode(WIFI_STA);  WiFiMulti.addAP(ssid, password);
  // wait for WiFi connection  while(WiFiMulti.run() != WL_CONNECTED) {    Serial.print('.');    delay(1000);  }
  Serial.println("[WIFI] connected!");
  HTTPClient http;
  // start request with URL and TLS cert fingerprint for verification  http.begin("https://" + String(host) + String(path_with_username), fingerprint);
  // IO API authentication  http.addHeader("X-AIO-Key", io_key);
  // start connection and send HTTP header  int httpCode = http.GET();
  // httpCode will be negative on error  if(httpCode > 0) {    // HTTP header has been send and Server response header has been handled    Serial.printf("[HTTP] GET response: %d\n", httpCode);
    // HTTP 200 OK    if(httpCode == HTTP_CODE_OK) {      String payload = http.getString();      Serial.println(payload);    }
    http.end();  }}
void loop() {}

Client Libraries

We have client libraries to help you get started with your project: , , , , and are available. They're all open source, so if they don't already do what you want, you can fork and add any feature you'd like.

var request = require('request');
var options = {  url: 'https://io.adafruit.com/api/v2/io_username/feeds',  headers: {    'X-AIO-Key': 'io_key_12345',    'Content-Type': 'application/json'  }};
function callback(error, response, body) {  if (!error && response.statusCode == 200) {    var feeds = JSON.parse(body);    console.log(feeds.length + " FEEDS AVAILABLE");
    feeds.forEach(function (feed) {      console.log(feed.name, feed.key);    })  }}
request(options, callback);

/// based on/// https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266HTTPClient/examples/Authorization/Authorization.ino
#include <Arduino.h>#include <ESP8266WiFi.h>#include <ESP8266WiFiMulti.h>#include <ESP8266HTTPClient.h>
ESP8266WiFiMulti WiFiMulti;
const char* ssid = "---";const char* password = "---";
const char* host = "io.adafruit.com";
const char* io_key = "---";const char* path_with_username = "/api/v2/---/dashboards";
// Use web browser to view and copy// SHA1 fingerprint of the certificateconst char* fingerprint = "77 00 54 2D DA E7 D8 03 27 31 23 99 EB 27 DB CB A5 4C 57 18";
void setup() {  Serial.begin(115200);
  for(uint8_t t = 4; t > 0; t--) {    Serial.printf("[SETUP] WAIT %d...\n", t);    Serial.flush();    delay(1000);  }
  WiFi.mode(WIFI_STA);  WiFiMulti.addAP(ssid, password);
  // wait for WiFi connection  while(WiFiMulti.run() != WL_CONNECTED) {    Serial.print('.');    delay(1000);  }
  Serial.println("[WIFI] connected!");
  HTTPClient http;
  // start request with URL and TLS cert fingerprint for verification  http.begin("https://" + String(host) + String(path_with_username), fingerprint);
  // IO API authentication  http.addHeader("X-AIO-Key", io_key);
  // start connection and send HTTP header  int httpCode = http.GET();
  // httpCode will be negative on error  if(httpCode > 0) {    // HTTP header has been send and Server response header has been handled    Serial.printf("[HTTP] GET response: %d\n", httpCode);
    // HTTP 200 OK    if(httpCode == HTTP_CODE_OK) {      String payload = http.getString();      Serial.println(payload);    }
    http.end();  }}
void loop() {}

Homepage: https://api.apis.guru/v2/specs/adafruit.com/2.0.0.json
Provider: adafruit.com
OpenAPI version: 2.0
Spec (JSON): https://api.apis.guru/v2/specs/adafruit.com/2.0.0/swagger.json
Spec (YAML): https://api.apis.guru/v2/specs/adafruit.com/2.0.0/swagger.yaml

Tool extraction failed: Only OpenAPI 3.x documents are supported. Swagger 2.x documents should be converted first..