Use our support resources
What is CityIQ?
CityIQ is the all-in-one IoT platform developed and supported by Current, powered by GE. This platform transforms urban lighting footprints into a digital infrastructure. Current’s unique, intelligent nodes embedded with multiple sensors and on-board computing power for edge analytics, are upgradable through over the air updates and installed on all street lights across cities. It is extensible by connecting to neighboring devices and perform multi-sensor fusion over a secure network connection.
At the heart of this IoT platform, Current’s Intelligent Cities APIs make the vast amount of sensor data actionable through the Cloud. These open, yet highly secured, APIs deliver real-time intelligence to cities allowing them to enhance their open data policies and begin civic engagement models. Engagement that connects citizens with the local developer community, entrepreneurs, start-ups, universities, and companies that have niche expertise globally. The objective is to transform the collected data into applications that drive new city services, optimize operations and improve citizens’ quality of life in real time.
CityIQ provides seven API services:
1. Parking Planning
2. Pedestrian Planning
3. Bicycle Planning
4. Traffic Planning
6. Environmental Planning
7. Energy Metering Planning
Please go to https://developer.currentbyge.com/developers-guide for more information.
Using the APIs
Your city should provide you with three things:
1. Your client_id and client_secret. You need your own unique client_id and client_secret to access the system. This will be provided through an email sent from firstname.lastname@example.org which will also direct the user to accept a EULA agreement.
2. The URLs necessary to access APIs which will be provided once the EULA agreement is accepted:
Absolutely. Remember to keep track of the original data source, especially which PREDIX-Zone-Id the assets originate from. A client access might have one, two, or several different ZoneIDs; they may also have disparate data sources and are separated by the ZoneID.
For example, you might be attending a CURRENT hackathon event that gives you access to both Smart Cities and Smart Buildings APIs, but they use the same CURRENT client_id and client_secret.
Once again, think of these as separate; the data itself is separated by a ZoneID, and in many cases, different ZoneIDs can rely on separate backend data sources, even if the front-end login credentials are the same.
The Subscription ID will need to be changed before calling an API in a different PREDIX ZoneID. Once again, find a way to keep track of the Postman Collection | PREDIX ZoneID | AssetId lineage from which the specific dataset originated.
• Pedestrian Data comprises of one type of event called a pedestrian event (PEDEVT). These events are 30 second summaries of the group pedestrian activity. These aggregated summary events provide cardinal directions across a trip wire location (WALKWAY locationType) with the pedestrian count and average speed.
• Traffic Data comprises of one type of event called a traffic event (TFEVT). These events are 30 second summaries of the group traffic activity categorized by vehicle type (i.e. small_vehicle and large_vehicle). These aggregated summary events provide cardinal direction across a tripwire location (TRAFFIC_LANE locationType) with the vehicle count and average speed.
• Bicycle Data comprises of one type of event called a traffic event (BICYCLE). These events are 30 second summaries of the group bicycle activity. These aggregated summary events provide cardinal direction across a tripwire location (TRAFFIC_LANE or WALKWAY locationTypes) with the bicycle count and average speed.
• Environmental Data comprises of three types of events each indicative of an individual measurement. They are TEMPERATURE, PRESSURE and ACCELERATION. Each of these events is reported every 15 minutes and provides the mean, average, maximum and minimum measurements of their respective units. The units selected are SI units and have power of tens that are required to multiply by to get the consumable value. For example, temperature is reported in Kelvin. For help on this calculation, please reference the documentation with the Environmental API Map.
• Energy Metering Data comprises of two types of events each indicative of an individual measurement. They are METROLOGY and ENERGY_TIMESERIES. Each of these events is reported every 15 minutes and provides the mean, average, maximum and minimum measurement of their respective units. Please reference the documentation for more information.
• Media Data comprises of three types of media: Image, Video and Audio. Media data is extremely restricted and may be based on municipal policy. The availability of this data is custom to your municipality. Often the city enables an App Partner to access the data for law enforcement purposes. This data is available only on the node (not saved in the Cloud databases) and are only available for the last 5 days maximum (some municipalities have opted for less than 5 days of data).
• Pedestrian, Traffic and Bicycle events are summary events that are reported every 30 seconds.
• Environmental and Energy Metering events are summary events reported every 15 minutes.
• Media is stored on the node for a maximum of 5 days (configurable by the municipality).
• Events are time dependent information detailing new occurrences in the camera view or node region. We recommend first visualizing the space using the metadata and then proceeding to consume event data since metadata details such as assetUids and locationUids will be necessary to obtain event data.
• Media is comprised of audio and video recording that can be extracted. This data is extremely restricted in order to respect privacy. Given the access rights, video sequences, audio recordings and individual images can be extracted. Metadata is required in order to obtain this data.