Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adafruit IO Activities API

The Activities API from Adafruit IO — 2 operation(s) for activities.

Adafruit IO Activities API is one of 12 APIs that Adafruit IO publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Activities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 3 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against 2 base URLs: https://io.adafruit.com/api/v2, http://io.adafruit.com/api/v2.

3 operations 2 paths 1 schemas 1 DELETE2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://io.adafruit.com/api/v2
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Adafruit IO Activities API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-AIO-Key (HeaderKey). An API key is passed in the query as X-AIO-Key (QueryKey). An API key is passed in the header as X-AIO-Signature (HeaderSignature). By default, every request must be authenticated.

  • HeaderKey — The AIO Key is used to restrict or grant access to your data. The key is unique, and you can generate a key per feed, and control it in many different ways. Th…
  • QueryKey — The AIO Key is used to restrict or grant access to your data. The key is unique, and you can generate a key per feed, and control it in many different ways. Th…
  • HeaderSignature — The AIO Signature is an AWS inspired request signature.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 2 GET. Each is listed below with its method, path, parameters, and response codes.

Activities 3
GET
/{username}/activities
All activities for current user
allActivities 4 params → 200401403404500
DELETE
/{username}/activities
All activities for current user
destroyActivities 1 param → 200401403404500
GET
/{username}/activities/{type}
Get activities by type for current user
getActivity 5 params → 200401403404500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Activity (7 properties). Each schema is shown below with its type and property counts.

Activity
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adafruit-io-activities-api-openapi.yml Raw ↑

Other APIs Adafruit IO publishes across the network.

Adafruit IO MQTT API
Adafruit IO Blocks API
Adafruit IO Dashboards API
Adafruit IO Data API
Adafruit IO Feeds API
Adafruit IO Groups API
Adafruit IO Permissions API
Adafruit IO Tokens API
Adafruit IO Triggers API
Adafruit IO Users API
Adafruit IO Webhooks API