sensors.Africa API

sensors.Africa API

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.8851fb9336c9.js"></script>
<script src="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

get-auth-token

POST /get-auth-token/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

ParameterDescription
username requiredValid username for authentication
password requiredValid password for authentication
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action get-auth-token create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["get-auth-token", "create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["get-auth-token", "create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

v1

POST /v1/push-sensor-data/

This endpoint is to POST data from the sensor to the api.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

ParameterDescription
sensor
sampling_ratein milliseconds
timestamp
sensordatavalues required
software_versionsensor software version
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v1 push-sensor-data &gt; create -p sensor=... -p sampling_rate=... -p timestamp=... -p sensordatavalues=... -p software_version=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v1", "push-sensor-data &gt; create"]
var params = {
    sensor: ...,
    sampling_rate: ...,
    timestamp: ...,
    sensordatavalues: ...,
    software_version: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v1", "push-sensor-data &gt; create"]
params = {
    "sensor": ...,
    "sampling_rate": ...,
    "timestamp": ...,
    "sensordatavalues": ...,
    "software_version": ...,
}
result = client.action(schema, action, params=params)

v2

GET /v2/cities/

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber of results to return per page.
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 cities &gt; list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "cities &gt; list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "cities &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
GET /v2/data/

View for retrieving and downloading detailed sensor data records, with access controlled based on user permissions and ownership. This endpoint allows authenticated users to retrieve sensor data records, with the following access rules: - Users in the `show_me_everything` group have access to all sensor data records. - Other users can access data from sensors they own, sensors owned by members of their groups, or public sensors. - Non-authenticated users can only access public sensor data.

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
next_pageThe pagination cursor value.
sensor
sensor__public
location__country
location__city
timestamp__gte
timestamp__lte
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 data &gt; list -p next_page=... -p sensor=... -p sensor__public=... -p location__country=... -p location__city=... -p timestamp__gte=... -p timestamp__lte=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "data &gt; list"]
var params = {
    next_page: ...,
    sensor: ...,
    sensor__public: ...,
    location__country: ...,
    location__city: ...,
    timestamp__gte: ...,
    timestamp__lte: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "data &gt; list"]
params = {
    "next_page": ...,
    "sensor": ...,
    "sensor__public": ...,
    "location__country": ...,
    "location__city": ...,
    "timestamp__gte": ...,
    "timestamp__lte": ...,
}
result = client.action(schema, action, params=params)
GET /v2/data/{id}/

View for retrieving and downloading detailed sensor data records, with access controlled based on user permissions and ownership. This endpoint allows authenticated users to retrieve sensor data records, with the following access rules: - Users in the `show_me_everything` group have access to all sensor data records. - Other users can access data from sensors they own, sensors owned by members of their groups, or public sensors. - Non-authenticated users can only access public sensor data.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredA unique integer value identifying this sensor data.

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
sensor
sensor__public
location__country
location__city
timestamp__gte
timestamp__lte
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 data &gt; read -p id=... -p sensor=... -p sensor__public=... -p location__country=... -p location__city=... -p timestamp__gte=... -p timestamp__lte=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "data &gt; read"]
var params = {
    id: ...,
    sensor: ...,
    sensor__public: ...,
    location__country: ...,
    location__city: ...,
    timestamp__gte: ...,
    timestamp__lte: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "data &gt; read"]
params = {
    "id": ...,
    "sensor": ...,
    "sensor__public": ...,
    "location__country": ...,
    "location__city": ...,
    "timestamp__gte": ...,
    "timestamp__lte": ...,
}
result = client.action(schema, action, params=params)
GET /v2/data/stats/{sensor_type}/

View to retrieve summarized statistics for specific sensor types (e.g., air quality) within a defined date range, filtered by city and grouped by specified intervals (hourly, daily, or monthly). **URL Parameters:** - `sensor_type` (str): The type of sensor data to retrieve (e.g., air_quality). **Query Parameters:** - `city` (str, optional): Comma-separated list of city slugs to filter data by location. - `from` (str, optional): Start date in "YYYY-MM-DD" format. Required if `to` is specified. - `to` (str, optional): End date in "YYYY-MM-DD" format. Defaults to 24 hours before `to_date` if unspecified. - `interval` (str, optional): Aggregation interval for results - either "hour", "day", or "month". Defaults to "day". - `value_type` (str, optional): Comma-separated list of value types to filter (e.g., "PM2.5, PM10"). **Caching:** - Results are cached for 1 hour (`@cache_page(3600)`) to reduce server load. **Returns:** - A list of sensor data statistics, grouped by city, value type, and specified interval. - Each entry includes: - `value_type` (str): Type of sensor value (e.g., PM2.5). - `city_slug` (str): City identifier. - `truncated_timestamp` (datetime): Timestamp truncated to the specified interval. - `start_datetime` (datetime): Start of the aggregated time period. - `end_datetime` (datetime): End of the aggregated time period. - `calculated_average` (float): Weighted average of sensor values. - `calculated_minimum` (float): Minimum recorded value within the period. - `calculated_maximum` (float): Maximum recorded value within the period.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
sensor_type required

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber of results to return per page.
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 data &gt; stats &gt; list -p sensor_type=... -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "data &gt; stats &gt; list"]
var params = {
    sensor_type: ...,
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "data &gt; stats &gt; list"]
params = {
    "sensor_type": ...,
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
GET /v2/locations/

View for retrieving and creating sensor entries.

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber of results to return per page.
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 locations &gt; list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "locations &gt; list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "locations &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
POST /v2/locations/

View for retrieving and creating sensor entries.

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 locations &gt; create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "locations &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "locations &gt; create"]
result = client.action(schema, action)
GET /v2/meta/ 

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 meta &gt; list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "meta &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "meta &gt; list"]
result = client.action(schema, action)
GET /v2/nodes/list-nodes/

List all public nodes with active sensors.

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 nodes &gt; list_nodes

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "nodes &gt; list_nodes"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "nodes &gt; list_nodes"]
result = client.action(schema, action)
GET /v2/nodes/my-nodes/

List only the nodes owned by the authenticated user.

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 nodes &gt; list_my_nodes

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "nodes &gt; list_my_nodes"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "nodes &gt; list_my_nodes"]
result = client.action(schema, action)
POST /v2/nodes/register-node/

Create and list nodes, with the option to list authenticated user's nodes.

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 nodes &gt; register_node

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "nodes &gt; register_node"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "nodes &gt; register_node"]
result = client.action(schema, action)
GET /v2/now/

Show all public sensors active in the last 5 minutes with newest value

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 now &gt; list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "now &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "now &gt; list"]
result = client.action(schema, action)
GET /v2/sensor-types/

View for retrieving and creating sensor type entries.

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber of results to return per page.
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 sensor-types &gt; list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "sensor-types &gt; list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "sensor-types &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
POST /v2/sensor-types/

View for retrieving and creating sensor type entries.

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 sensor-types &gt; create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "sensor-types &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "sensor-types &gt; create"]
result = client.action(schema, action)
GET /v2/sensors/

Query Parameters

The following parameters should be included as part of a URL query string.

ParameterDescription
pageA page number within the paginated result set.
page_sizeNumber of results to return per page.
 
# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 sensors &gt; list -p page=... -p page_size=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "sensors &gt; list"]
var params = {
    page: ...,
    page_size: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "sensors &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
POST /v2/sensors/ 

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 sensors &gt; create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "sensors &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "sensors &gt; create"]
result = client.action(schema, action)
GET /v2/statistics/ 

# Load the schema document
$ coreapi get http://api.sensors.africa/docs/

# Interact with the API endpoint
$ coreapi action v2 statistics &gt; list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["v2", "statistics &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://api.sensors.africa/docs/")

# Interact with the API endpoint
action = ["v2", "statistics &gt; list"]
result = client.action(schema, action)