Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
version: 1.0.0
title: Airthings for Consumer Device API
description: The Airthings for Consumer API provides secure and authorized access for Airthings consumers to retrieve the latest data from their Airthings air quality monitors. Leveraging HTTPS and OAuth for enhanced security, this API empowers users to seamlessly access real-time information from their Airthings devices, gaining valuable insights into the air quality within their environments.
contact:
email: support@airthings.com
servers:
- url: https://consumer-api.airthings.com/v1
description: Airthings for Consumer API (prod)
tags:
- name: Device
paths:
/v1/accounts/{accountId}/devices:
get:
summary: Get all devices connected to a user
operationId: getDevices
parameters:
- $ref: '#/components/parameters/accountId'
tags:
- Device
security:
- bearerAuth: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DevicesResponse'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
DevicesResponse:
type: object
properties:
devices:
type: array
items:
$ref: '#/components/schemas/DeviceResponse'
DeviceResponse:
type: object
properties:
serialNumber:
type: string
home:
type:
- string
- 'null'
name:
type: string
type:
type: string
sensors:
type: array
items:
type: string
Error:
type: object
properties:
message:
type: string
description: A message detailing the error encountered
parameters:
accountId:
name: accountId
in: path
required: true
description: The account ID associated with the user
schema:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
externalDocs:
description: Find out more about consumerAPI
url: https://consumer-api-doc.airthings.com/