sensors.Africa API

sensors.Africa API

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



# 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://sensors-api.dev.codeforafrica.org/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://sensors-api.dev.codeforafrica.org/docs/")

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

inactive-nodes

GET /inactive-nodes/ 

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action inactive-nodes 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 = ["inactive-nodes", "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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["inactive-nodes", "list"]
result = client.action(schema, action)

login

POST /login/ 

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action login 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 = ["login", "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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["login", "create"]
result = client.action(schema, action)

v1

GET /v1/data/

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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 data 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 = ["v1", "data > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "data > list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
GET /v1/data/{id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredA unique integer value identifying this sensor data.
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 data read -p id=...
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", "data > read"]
var params = {
    id: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "data > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)
GET /v1/filter/ 

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 filter 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 = ["v1", "filter > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "filter > list"]
result = client.action(schema, action)
GET /v1/node/

Show all nodes belonging to authenticated user

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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 node 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 = ["v1", "node > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "node > list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
GET /v1/node/{id}/

Show all nodes belonging to authenticated user

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredA unique integer value identifying this node.
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 node read -p id=...
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", "node > read"]
var params = {
    id: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "node > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)
GET /v1/now/

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

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 now 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 = ["v1", "now > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "now > list"]
result = client.action(schema, action)
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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 push-sensor-data 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

This endpoint is to download sensor data from the api.

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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 sensor 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 = ["v1", "sensor > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "sensor > list"]
params = {
    "page": ...,
    "page_size": ...,
}
result = client.action(schema, action, params=params)
GET /v1/sensor/{id}/

This endpoint is to download sensor data from the api.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredA unique integer value identifying this sensor.
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 sensor read -p id=...
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", "sensor > read"]
var params = {
    id: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "sensor > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)
GET /v1/sensors/{sensor_id}/

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
sensor_id required
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 sensors list -p sensor_id=...
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", "sensors > list"]
var params = {
    sensor_id: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "sensors > list"]
params = {
    "sensor_id": ...,
}
result = client.action(schema, action, params=params)
GET /v1/statistics/ 

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 statistics 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 = ["v1", "statistics > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "statistics > list"]
result = client.action(schema, action)
GET /v1/user/

Get more information about users

Query Parameters

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

ParameterDescription
orderingWhich field to use when ordering the results.
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 user list -p ordering=...
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", "user > list"]
var params = {
    ordering: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "user > list"]
params = {
    "ordering": ...,
}
result = client.action(schema, action, params=params)
GET /v1/user/{id}/

Get more information about users

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredA unique integer value identifying this user.

Query Parameters

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

ParameterDescription
orderingWhich field to use when ordering the results.
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v1 user read -p id=... -p ordering=...
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", "user > read"]
var params = {
    id: ...,
    ordering: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v1", "user > read"]
params = {
    "id": ...,
    "ordering": ...,
}
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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 cities 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

This endpoint is to download sensor data from the api.

Query Parameters

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

ParameterDescription
next_pageThe pagination cursor value.
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 data list_0 -p next_page=...
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 > list_0"]
var params = {
    next_page: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v2", "data > list_0"]
params = {
    "next_page": ...,
}
result = client.action(schema, action, params=params)
GET /v2/data/{id}/

This endpoint is to download sensor data from the api.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredA unique integer value identifying this sensor data.
 
# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 data read -p id=...
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 > read"]
var params = {
    id: ...,
}
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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v2", "data > read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)
GET /v2/data/{sensor_type}/

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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 data 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 locations 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 locations 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 meta 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 nodes 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", "nodes > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v2", "nodes > list"]
result = client.action(schema, action)
POST /v2/nodes/ 

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 nodes 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", "nodes > 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://sensors-api.dev.codeforafrica.org/docs/")

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

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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 sensor-types 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 sensor-types 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v2", "sensor-types > 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://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 sensors 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

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

# Load the schema document
$ coreapi get http://sensors-api.dev.codeforafrica.org/docs/

# Interact with the API endpoint
$ coreapi action v2 sensors 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 > 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://sensors-api.dev.codeforafrica.org/docs/")

# Interact with the API endpoint
action = ["v2", "sensors > create"]
result = client.action(schema, action)