Skip to main content
The sensor data endpoints provide access to simulated and real-time sensor readings from IoT devices. These endpoints require specific permissions for access.

​
CPSI data

GET /api/cpsi

Retrieve CPSI (Cell Performance Signaling Information) data

​
Authentication

Requires device-cpsi permission.

​
Response

​
cpsi
object
required
CPSI measurement data with signal quality metrics

​
Example request

curl -X GET http://localhost:8000/api/cpsi \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
Response: 
{
  "mode": "LTE",
  "mcc": 310,
  "mnc": 260,
  "lac": 1234,
  "cellId": 56789,
  "rssi": -75,
  "rsrp": -95,
  "rsrq": -10,
  "sinr": 12
}
​
mode
string
Network mode (e.g., LTE, 5G, 3G)
​
mcc
number
Mobile Country Code
​
mnc
number
Mobile Network Code
​
lac
number
Location Area Code
​
cellId
number
Cell tower identifier
​
rssi
number
Received Signal Strength Indicator (dBm)
​
rsrp
number
Reference Signal Received Power (dBm)
​
rsrq
number
Reference Signal Received Quality (dB)
​
sinr
number
Signal-to-Interference-plus-Noise Ratio (dB)

​
Battery data

GET /api/battery

Retrieve battery voltage, current, and power consumption data

​
Authentication

Requires device-battery permission.

​
Response

​
voltage
number
required
Battery voltage in millivolts (mV). Range: 3200-4500 mV
​
current
number
required
Battery current in milliamps (mA). Range: 50-500 mA
​
power
number
required
Power consumption in milliwatts (mW). Calculated as voltage × current
​
consumption
number
required
Total power consumption in milliwatt-hours (mWh). Range: 0-1400 mWh

​
Example request

curl -X GET http://localhost:8000/api/battery \
  -H "X-API-Key: dev-api-key-12345"
Response: 
{
  "voltage": 3842.57,
  "current": 234.12,
  "power": 899851.34,
  "consumption": 567.89
}

​
GPS data

GET /api/gps

Retrieve GPS coordinates and altitude information

​
Authentication

Requires device-gps permission.

​
Response

​
latitude
number
required
Latitude in decimal degrees. Range: -90 to 90
​
longitude
number
required
Longitude in decimal degrees. Range: -180 to 180
​
altitude
number
required
Altitude in meters above sea level. Range: 10-110 meters

​
Example request

curl -X GET http://localhost:8000/api/gps \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
Response: 
{
  "latitude": 37.778956,
  "longitude": -122.412384,
  "altitude": 45.78
}

​
IMU data

GET /api/imu

Retrieve IMU (Inertial Measurement Unit) accelerometer data

​
Authentication

Requires device-imu permission.

​
Response

​
x
number
required
X-axis acceleration in g-force
​
y
number
required
Y-axis acceleration in g-force
​
z
number
required
Z-axis acceleration in g-force

​
Example request

curl -X GET http://localhost:8000/api/imu \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
Response: 
{
  "x": 0.234,
  "y": -0.145,
  "z": 1.023
}

​
Error responses

​
401 Unauthorized

{
  "success": false,
  "error": "Authentication required"
}

​
403 Forbidden

{
  "success": false,
  "error": "Missing required permissions: device-gps"
}

​
Data generation

The sensor data endpoints currently return simulated data for development and testing purposes. The values:
  • Follow realistic ranges for each sensor type
  • Include randomization for realistic variation
  • Update in real-time with each request
  • Can be used to test UI components and data visualization

Build docs developers (and LLMs) love

Get started for freeTalk to us