Class AirthingsClient

Returns AirthingsClient

const client = new AirthingsClient({
    clientId: 'clientId',
    clientSecret: 'clientSecret'
});
Copy

Returns Promise<Accounts>

Lists all accounts the current user is member of. The data returned by this endpoint changes when a user is added or removed from business accounts. It is safe to assume that the accountId remains constant for Consumer users. The accountId returned by this endpoint is used to fetch the devices and sensors from the other endpoints.

Returns Promise<Devices>

List all devices (and their sensor abilities) connected to a user’s account. The data returned by this endpoint changes when a device is registered, unregistered or renamed.

const devicesResponse = await client.getDevices();
devicesResponse.devices.forEach((device) => {
  console.log(device);
});
Copy

Returns Promise<SensorResults>

Get sensors for a set of devices. The response will contain the latest sensor values for the devices. The sensor values are updated depending on the device types sampling rate. It is recommended to poll the API at a regular interval to get the latest sensor values. The response will be paginated with a maximum of 50 records per page.

const sensorsResponse = await client.getSensors(SensorUnits.Imperial);
sensorsResponse.results.forEach((sensor) => {
  console.log(sensor);
});
Copy

Returns Promise<RemoteControlState>

The last reported operational mode of a Renew (AP_1) air purifier. The state reflects what the device last reported, not necessarily the command last sent. If the device has never synced a mode, a 404 error is returned.

const state = await client.getRemoteControl('4100007329');
console.log(state.mode);
Copy

Returns Promise<void>

Set the operational mode of a Renew (AP_1) air purifier. Available modes are OFF, AUTO, SLEEP, BOOST, and MANUAL. Fan speed (1-5) is required for MANUAL mode. The command is forwarded to the device asynchronously. Use getRemoteControl to confirm the device has applied the new mode.

import { RemoteControlMode } from 'airthings-consumer-api';

await client.setRemoteControl('4100007329', {
    mode: RemoteControlMode.Manual,
    fanSpeed: 3
});
Copy

Returns SensorResultsRateLimitMetrics

Current rate limit metrics reflecting the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers from the most recent getSensors call. Before any getSensors call has been made, all rate limit metrics are initialised to -1.