API Overview

API Overview

The SiliconWit.IO API provides programmatic access to your devices and data.

Base URL

https://api.siliconwit.io/v1

Authentication

All API requests require authentication via API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.siliconwit.io/v1/devices

Getting an API Key

1. Go to Dashboard → Settings → API Keys
2. Click Create API Key
3. Name your key and set permissions
4. Copy the key (shown only once)

Key Permissions

Permission	Access
read:devices	List and view devices
write:devices	Create, update, delete devices
read:data	Query telemetry data
write:data	Push data via API
read:alerts	View alerts
write:alerts	Manage alert rules

Request Format

Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Request Body

JSON format for POST/PUT requests:

{
  "name": "New Device",
  "type": "sensor"
}

Response Format

Success Response

{
  "success": true,
  "data": {
    "id": "dev_abc123",
    "name": "New Device"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Device name is required"
  }
}

HTTP Status Codes

Code	Meaning
200	Success
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
429	Rate Limited
500	Server Error

Rate Limits

Plan	Requests/min
Starter	60
Business	300
Enterprise	Custom

Rate limit headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1704067260

Pagination

List endpoints support pagination:

GET /v1/devices?page=1&limit=20

Response includes pagination info:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "pages": 3
  }
}

Filtering

Filter results with query parameters:

# Devices by type
GET /v1/devices?type=sensor

# Devices by status
GET /v1/devices?status=online

# Data by time range
GET /v1/devices/abc123/data?from=2024-01-01&to=2024-01-31

Quick Reference

Devices

Method	Endpoint	Description
GET	/devices	List all devices
POST	/devices	Create device
GET	/devices/:id	Get device
PUT	/devices/:id	Update device
DELETE	/devices/:id	Delete device

Data

Method	Endpoint	Description
GET	/devices/:id/data	Get device data
POST	/devices/:id/data	Push data point

Alerts

Method	Endpoint	Description
GET	/alerts	List alert rules
POST	/alerts	Create alert
GET	/alerts/history	Get alert history

SDKs & Libraries

Official libraries:

• JavaScript/Node.js: npm install @siliconwit/sdk
• Python: pip install siliconwit

Next Steps

• Devices API - Device management
• Data API - Query and push data
• Alerts API - Manage alerts