SmartCambridge API

SmartCambridge API

Programmatic access to data held by the Smartcambridge project.

See the main API documentation for important information about using this API, in particular about the need for authentication.

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

<!-- Load the JavaScript client library -->
<script src="/static_web/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/api/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

aq

GET /api/v1/aq/

Return metadata for all stations, including each station's station_id.

# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action aq 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 = ["aq", "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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["aq", "list"]
result = client.action(schema, action)
GET /api/v1/aq/{station_id}/

Return metadata for a single station identified by station_id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
station_id requiredAir quality sensor station id (e.g. 'S-1134')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action aq read -p station_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 = ["aq", "read"]
var params = {
    station_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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["aq", "read"]
params = {
    "station_id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/aq/history/{station_id}/{sensor_type}/{month}/

Return historic data for a single sensor identified by sensor_type on a station identified by station_id for a particular month.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
station_id requiredAir quality station id (e.g. 'S-1134')
sensor_type requiredAir quality sensor id (e.g. 'NO2')
month requiredThe month for which to return data. YYYY-MM (e.g. '2016-06')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action aq history read -p station_id=... -p sensor_type=... -p month=...

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 = ["aq", "history &gt; read"]
var params = {
    station_id: ...,
    sensor_type: ...,
    month: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["aq", "history &gt; read"]
params = {
    "station_id": ...,
    "sensor_type": ...,
    "month": ...,
}
result = client.action(schema, action, params=params)

parking

GET /api/v1/parking/

List metadata for all known car parks, including each car park's parking-id.

# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action parking 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 = ["parking", "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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["parking", "list"]
result = client.action(schema, action)
GET /api/v1/parking/{parking_id}/

Return the metadata for a single car park identified by parking_id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
parking_id requiredCar park identifier (e.g. 'grafton-east-car-park')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action parking read -p parking_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 = ["parking", "read"]
var params = {
    parking_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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["parking", "read"]
params = {
    "parking_id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/parking/history/{parking_id}/

Return historic car park occupancy data for a single car park identified by parking_id. Data is returned in 24-hour chunks from start_date to end_date inclusive. A most 31 day's data can be retrieved in a single request.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
parking_id requiredCar park identifier (e.g. 'grafton-east-car-park')

Query Parameters

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

ParameterDescription
start_date requiredStart date for returned data. YYYY-MM-DD (e.g. '2018-01-01')
end_dateEnd date for returned data. YYYY-MM-DD (e.g. '2018-01-15'). Defaults to start_date and must be no more than 31 days from start_date
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action parking history read -p parking_id=... -p start_date=... -p end_date=...

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 = ["parking", "history &gt; read"]
var params = {
    parking_id: ...,
    start_date: ...,
    end_date: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["parking", "history &gt; read"]
params = {
    "parking_id": ...,
    "start_date": ...,
    "end_date": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/parking/latest/{parking_id}/

Return most recent car park occupancy data for the car park identified by parking_id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
parking_id requiredCar park identifier (e.g. 'grafton-east-car-park')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action parking latest read -p parking_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 = ["parking", "latest &gt; read"]
var params = {
    parking_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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["parking", "latest &gt; read"]
params = {
    "parking_id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/parking/previous/{parking_id}/

Return previous most recent car park occupancy data for the car park identified by parking_id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
parking_id requiredCar park identifier (e.g. 'grafton-east-car-park')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action parking previous read -p parking_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 = ["parking", "previous &gt; read"]
var params = {
    parking_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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["parking", "previous &gt; read"]
params = {
    "parking_id": ...,
}
result = client.action(schema, action, params=params)

traffic

GET /api/v1/traffic/btjourney/history/{id}/

Return historic journey time data for the 'link' (journey segment between a pair of sensors) or 'route' (journey segments built from multiple links) identified by id. Data is returned in 24-hour chunks from start_date to end_date inclusive. At most 31 day's data can be retrieved in a single request.

Links and routes are occasionally added. This endpoint might return journey time data for links or routes for which metadata is not yet available.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredIdentifier for a link or route (e.g. 'CAMBRIDGE_JTMS|9800W1CHALH6' or 'CAMBRIDGE_JTMS|9800WMBVAGBF')

Query Parameters

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

ParameterDescription
start_date requiredStart date for returned data. YYYY-MM-DD (e.g. '2018-01-01')
end_dateEnd date for returned data. YYYY-MM-DD (e.g. '2018-01-15'). Defaults to start_date and must be no more than 31 days from start_date
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney history read -p id=... -p start_date=... -p end_date=...

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 = ["traffic", "btjourney &gt; history &gt; read"]
var params = {
    id: ...,
    start_date: ...,
    end_date: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; history &gt; read"]
params = {
    "id": ...,
    "start_date": ...,
    "end_date": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/traffic/btjourney/latest/

Return most recent journey times for all currently monitored 'links' (journey segments between pairs of sensors) and 'routes' (journey segments built from multiple links)

Links and routes are occasionally added. This endpoint might return journey time data for links or routes for which metadata is not yet available.

# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney latest 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 = ["traffic", "btjourney &gt; latest &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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; latest &gt; list"]
result = client.action(schema, action)
GET /api/v1/traffic/btjourney/latest/{id}/

Return most recent journey time data for the 'link' (journey segment between a pair of sensors) or 'route' (journey segments built from multiple links) identified by id.

Links and routes are occasionally added. This endpoint might return journey time data for links or routes for which metadata is not yet available.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredIdentifier for a link or route (e.g. 'CAMBRIDGE_JTMS|9800W1CHALH6' or 'CAMBRIDGE_JTMS|9800WMBVAGBF')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney latest 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 = ["traffic", "btjourney &gt; latest &gt; 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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; latest &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/traffic/btjourney/link/

List metadata for all known 'links' (journey segments between pairs of sensors).

Links are added and removed from the monitoring system from time to time so journey time data will not be available for all of these links all of the time.

# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney link 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 = ["traffic", "btjourney &gt; link &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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; link &gt; list"]
result = client.action(schema, action)
GET /api/v1/traffic/btjourney/link_or_route/{id}/

Return the metadata for a single 'link' (journey segment between a pair of sensors) or 'route' (journey segments built from multiple links) identified by id.

Links and routes are added and removed from the monitoring system from time to time so journey time data will not necessarily be available for this links or route all of the time.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredIdentifier for a link or route (e.g. 'CAMBRIDGE_JTMS|9800W1CHALH6' or 'CAMBRIDGE_JTMS|9800WMBVAGBF')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney link_or_route 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 = ["traffic", "btjourney &gt; link_or_route &gt; 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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; link_or_route &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/traffic/btjourney/route/

List metadata for all known 'routes' (journey segments built from multiple links).

Routes are added and removed from the monitoring system from time to time so journey time data will not be available for all of these routes all of the time.

# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney route 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 = ["traffic", "btjourney &gt; route &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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; route &gt; list"]
result = client.action(schema, action)
GET /api/v1/traffic/btjourney/site/

List metadata for all known sensor 'sites'.

# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney site 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 = ["traffic", "btjourney &gt; site &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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; site &gt; list"]
result = client.action(schema, action)
GET /api/v1/traffic/btjourney/site/{site_id}/

Return the metadata for a single sensor 'site' identified by site_id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
site_id requiredSite identifier (e.g. '{0D7C672E-EEE9-4924-815E-B49CC382DFFA}')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic btjourney site read -p site_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 = ["traffic", "btjourney &gt; site &gt; read"]
var params = {
    site_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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "btjourney &gt; site &gt; read"]
params = {
    "site_id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/traffic/zone/

List metadata for all known zones, including each zone's zone_id.

# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic zone 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 = ["traffic", "zone &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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "zone &gt; list"]
result = client.action(schema, action)
GET /api/v1/traffic/zone/{zone_id}/

Return the metadata for a single zone identified by zone_id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
zone_id requiredZone identifier (e.g. 'east_road_in')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic zone read -p zone_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 = ["traffic", "zone &gt; read"]
var params = {
    zone_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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "zone &gt; read"]
params = {
    "zone_id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/traffic/zone/history/{zone_id}/

Return historic zone data for the single zone identified by zone_id. Data is returned in 24-hour chunks from start_date to end_date inclusive. A most 31 day's data can be retrieved in a single request.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
zone_id requiredZone identifier (e.g. 'east_road_in')

Query Parameters

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

ParameterDescription
start_date requiredStart date for returned data. YYYY-MM-DD (e.g. '2018-01-01')
end_dateEnd date for returned data. YYYY-MM-DD (e.g. '2018-01-15'). Defaults to start_date and must be no more than 31 days from start_date
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action traffic zone history read -p zone_id=... -p start_date=... -p end_date=...

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 = ["traffic", "zone &gt; history &gt; read"]
var params = {
    zone_id: ...,
    start_date: ...,
    end_date: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["traffic", "zone &gt; history &gt; read"]
params = {
    "zone_id": ...,
    "start_date": ...,
    "end_date": ...,
}
result = client.action(schema, action, params=params)

transport

GET /api/v1/transport/journey/{id}/

Return information about the vehicle journey identified by id.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
id requiredJourney identifier (e.g. 'ea-20-PR2-_-y08-1-429-UL')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action transport journey 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 = ["transport", "journey &gt; 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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["transport", "journey &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/transport/journeys/

Return a list of all known vehicle journeys.

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set (e.g. 2). Default 1
page_sizeNumber of results to return per page. (e.g. 10). Default 25, maximum 50.
lineLimit results to journeys whose 'line name' is this. (e.g. 'Universal U')
operatorLimit results to journeys whose operator name or operator code is this. (e.g. 'Whippet Coaches' or 'WHIP')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action transport journeys list -p page=... -p page_size=... -p line=... -p operator=...

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 = ["transport", "journeys &gt; list"]
var params = {
    page: ...,
    page_size: ...,
    line: ...,
    operator: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["transport", "journeys &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
    "line": ...,
    "operator": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/transport/journeys_by_time_and_stop/

Return the timetabled vehicle journeys expected for a given stop identified by stop_id from a specific date and time identified by datetime_from (optional, default = now).

All results are paginated based on nresults and a next attribute is returned containing the URL to use to retrieve more results. The pagination can return up to nresults or less if there are no more results for a day, for example.

Query Parameters

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

ParameterDescription
stop_id requiredStop atco_code (e.g. '0500CCITY111')
datetime_fromStart datetime or time for returned results. If time is given insetad of a datetime, today is used as date. Defaults to now. YYYY-MM-DDTHH:MM:SS or HH:MM:SS (e.g. '2018-06-01T12:00:00')
nresultsMaximum number of journeys to return, default 10. (e.g. 20)
expand_journeyExpands the resulting journey into a full journey object
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action transport journeys_by_time_and_stop list -p stop_id=... -p datetime_from=... -p nresults=... -p expand_journey=...

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 = ["transport", "journeys_by_time_and_stop &gt; list"]
var params = {
    stop_id: ...,
    datetime_from: ...,
    nresults: ...,
    expand_journey: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["transport", "journeys_by_time_and_stop &gt; list"]
params = {
    "stop_id": ...,
    "datetime_from": ...,
    "nresults": ...,
    "expand_journey": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/transport/stop/{atco_code}/

Return information about the bus stop identified by atco_code.

Path Parameters

The following parameters should be included in the URL path.

ParameterDescription
atco_code requiredStop atco_code (e.g. '0500CCITY111')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action transport stop read -p atco_code=...

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 = ["transport", "stop &gt; read"]
var params = {
    atco_code: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["transport", "stop &gt; read"]
params = {
    "atco_code": ...,
}
result = client.action(schema, action, params=params)
GET /api/v1/transport/stops/

Return a list of bus stops.

Query Parameters

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

ParameterDescription
pageA page number within the paginated result set (e.g. 2). Default 1
page_sizeNumber of results to return per page. (e.g. 10). Default 50, maximum 200.
searchLimit results to stops that contain this text somewhere within their stop_id, common_name or locality_name fields (e.g. 'madingley')
orderingField to sort results by. One of 'atco_code', 'common_name', or 'locality_name'.
bounding_boxLimit results to stops within a bounding box, specified as 'southwest_lng,southwest_lat,northeast_lng,northeast_lat', (e.g. '0.08,52.20,0.11,52.21')
 
# Load the schema document
$ coreapi get https://smartcambridge.org/api/docs/

# Interact with the API endpoint
$ coreapi action transport stops list -p page=... -p page_size=... -p search=... -p ordering=... -p bounding_box=...

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 = ["transport", "stops &gt; list"]
var params = {
    page: ...,
    page_size: ...,
    search: ...,
    ordering: ...,
    bounding_box: ...,
}
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("https://smartcambridge.org/api/docs/")

# Interact with the API endpoint
action = ["transport", "stops &gt; list"]
params = {
    "page": ...,
    "page_size": ...,
    "search": ...,
    "ordering": ...,
    "bounding_box": ...,
}
result = client.action(schema, action, params=params)