Product Description

STREAMS Gateway is primarily a machine interface that exposes STREAMS data to enable other systems or applications to deliver functionality to end users.

These systems and applications can be developed by customers, Transmax or third parties. The platform is hosted in Transmax’s managed service environment and this environment supports the processes that are required to quickly deliver customer requests, can scale to meet any demand and is efficient to maintain.

Transmax offers customers a suite of three product options for STREAMS Gateway.

STREAMS Gateway Access enables road authorities to programmatically access data from their STREAMS systems via a suite of reliable, easy to consume APIs. Customers can use data from STREAMS Gateway Access to power a light live application or to populate a data lake with aggregations.

STREAMS Gateway Access provides customers the opportunity to experience and explore many features of the STREAMS Gateway product line at no additional cost when bundled with other STREAMS Gateway licensed options.

Customers wishing to trial the STREAMS Gateway product should contact Transmax to discuss the possibility of a product trial using STREAMS Gateway Access.

STREAMS Gateway Access is also made available to customers who purchase other services such as the STREAMS Smart Motorways dashboard.

FEATURES
  • Offers access to the full range of endpoint types and delivery mechanisms, with some restrictions on the number of log endpoints or event feeds available

  • Endpoints are semantically versioned and maintained with new STREAMS releases, reducing reliance on brittle scripts

  • Access to a broad range of STREAMS data via REST APIs

  • Traffic aggregation endpoints allow customers to extract the last full day of data

  • Data is presented in self-describing JSON where feasible, with comprehensive API documentation also available.

STREAMS GATEWAY ACCESS FOR A SIMPLE SCHEMATIC

STREAMS Gateway Extract enables customers to build their own data lake by simplifying the process to extract accurate logs – typically to be consumed by data exchange type platforms – without having to reconstruct them from frequent polling of live data.

Road agency customers using STREAMS Gateway Extract to populate a data lake benefit from the ability to use the data to:

  • optimise an arterial network through the use of historical traffic and intersection configuration data
  • perform whole network optimisation through the use of artificial intelligence
  • fine-tune algorithm parameters of a new Smart Motorways algorithm and analyse its long-term effects.

Local Government Authorities can use STREAMS Gateway Extract to populate a data lake to:

  • use historical traffic and intersection configuration data to optimise the arterial network
  • Identify unusual congestion by building congestion profiles according to day type (weekends and public holidays for example)
FEATURES
  • Log endpoints

  • Aggregation endpoints

  • Endpoints are semantically versioned and maintained with new STREAMS releases, reducing reliance on brittle scripts

  • Data is presented in self-describing JSON where feasible, with comprehensive API documentation available. High volume data is presented in comma separated value format, to save bandwidth

  • Log and aggregation endpoints allow customers to recent data, i.e. logs and aggregations from the current and prior day.

GENERATE INSIGHT FROM STREAMS GATEWAY EXTRACT LOGS

STREAMS Gateway Live can power customer applications by providing access to live STREAMS data through low-latency REST APIs, and event-driven interfaces. Customers can use external applications that display or respond to STREAMS data in real-time, enabling them to:

  • fuse STREAMS data with data from other sources facilitate real-time incident response
  • periodically synchronise the GIS model of an external application with STREAMS transport network
  • create situational awareness dashboards with live traffic measure and device status information
  • inform road users of current road status and safety information on in-vehicle displays.

STREAMS Gateway Live facilitates the provision of accurate information to inform decision making and facilitate real-time incident response. It becomes a tool for customers to:

  • improve customer journeys
  • provide enhanced services to customers
  • improve network performance.
FEATURES
  • Real-time snapshot endpoints

  • Event feed – Low-latency push notification of changes to devices/objects

  • Endpoints are semantically versioned and maintained with new STREAMS releases

  • Data is presented in self-describing JSON where feasible, with comprehensive API documentation also available

  • Supports up to 30 light applications and up to 10 heavy applications

  • These applications can be built by the customers themselves, or provided by another party, including Transmax, under a separate agreement.

STREAMS GATEWAY LIVE TO IN-CAR APPLICATION

STREAMS Gateway Product Summary

Light Application Connectors 1 0 30
Heavy Application Connectors 0 1 10
Developer 20 100 100
Real Time Snapshot Endpoints All None All
Log Endpoints 1 All None
Aggregation Endpoints All All None
Event Driven Interfaces 1 None Up to 200
(On request)
Data Window 48 Hours 48 Hours N/A

API Keys

At the discretion of the System Owner, Application API keys will be assigned to one of two usage plans. These plans control the monthly usage and throttling of the API calls, but do not apply to event feeds.

KEY
TYPE
INTENDED
USE 
PRODUCTION
LIMIT
STAGING
LIMIT
API THROTTLING LIMIT
Developer For development only 500 requests/day 500 requests/day 20 requests/second
Light Application Single Application 10,000 requests/day 20,000 requests/month 20 requests/second
Heavy Application Single Application 50,000 requests/day 100,000 requests/month 20 requests/second

Endpoint types

ENDPOINT TYPE DESCRIPTION EXAMPLES
Real-time  snapshot endpoints REST API endpoints returning the current values of static or dynamic data
  • A list of active queues that have been detected by the queue detection algorithm.
  • The current state of all vehicle detectors.
  • A list of links including their name, STREAMS ID and polyline.
  • All active traffic events, their start time and how they were categorised.
  • The speed, volume and occupancy data for all vehicle detectors, identified by detector ID.
Aggregation endpoints REST API endpoints returning aggregated traffic measures for defined time periods Detector site minute measures aggregated into 5 minute, 15 minute, 30 minute, 60 minute and 1 day buckets
Log endpoints REST API endpoints returning the record of all changes for an object over a defined time period
  • All detector site minute measures for a period
  • All intersection configuration changes for a period
  • A log of changes to queues detected by the queue detection algorithm, including state changes