You are on page 1of 14

Specification 

Document for Real­time Traffic Data 
 
 
 

Waze Traffic­data 

Specification Document 
 
Version 2.0 
 
 

  

Waze Proprietary and Confidential 1 
Specification Document for Real­time Traffic Data 
 
 
 
Revision History 
The following revision table presents the changes made for each version of this document. 

Revision  Date  State/Description 


1.5  February 2014  Creation based on GeoRSS API spec­doc (Chen Barshai) 
2.0  August 2014  Updated (Noam Reshef) 
     
     
     
 

   

  

Waze Proprietary and Confidential 2 
Specification Document for Real­time Traffic Data 
 
 
 
Table of Contents 
 
Overview 
Terms and Acronyms 
Retrieving Waze traffic­data 
Using Waze traffic­data 
Traffic Alerts 
Traffic Alerts ­ example 
JSON format 
XML format 
Alert Types Table 
Traffic Jams information 
Traffic jam results ­ example 
JSON Format 
XML Format 
Appendix 
Road types table 
 
 
 
 
   

  

Waze Proprietary and Confidential 3 
Specification Document for Real­time Traffic Data 
 
 
 

Introduction 
 

Overview 
 
This document details the structure and content of the Waze real­time traffic data. 
Waze maps provide information about specific routes to assist motorists in avoiding traffic jams. 
Waze maps and traffic are dynamically updated by a continually expanding network of drivers 
worldwide. This, of course, reduces the importance of predefined routes. The most accurate 
representations are through poly­lines – where the traffic is geographically­based, independent of 
specific map attributes.  
We provide information about traffic jams and events that affect road conditions, either from 
Wazers or from external sources. Wazers provide community road reports or UGI 
(user­generated incidents) which provide detailed information about specific traffic and road 
incidents. They may issue reports from the location at which they are currently located or, if no 
longer at the location, within 30 minutes after the event occurred.  
The time period that affects the results can be internally adjusted by the Waze server 
configuration to provide best results, based upon local conditions. Events include weather 
conditions, a car stopped at the shoulder and so forth. 
To the driver, the question is very simple: should I choose an alternate route or not? Waze 
provides updates from anywhere our drivers are. The information is provided in real time and, in 
the case of major events, in considerable detail. 

 
 

   

  

Waze Proprietary and Confidential 4 
Specification Document for Real­time Traffic Data 
 
 
 

Terms and Acronyms 
 
The following table provides a list of terms and acronyms used in this document. 

Term or Acronym  Definition 
GPS  Global Positioning System 
TMC  Traffic Message Channel 
UGI  User­Generated Incident 
Wazer  An active member of the Waze network 
WGS 84  World Geodetic System (1984) 
GeoRSS  a standard for encoding location as part of a Web feed. 
JSON/XML  A format used to transmit data between a server and web 
application 
 

   

  

Waze Proprietary and Confidential 5 
Specification Document for Real­time Traffic Data 
 
 
 

Retrieving Waze traffic­data 
Waze uses the GeoRSS API to internally­retrieve its traffic data. 
It will then provide it’s partner with an XML/JSON file containing all the data which is approved for 
sharing with the partner. 
A file containing real­time information about traffic jams and road incidents in the pre­defined 
geographical area will be created every 5 minutes, where each new file will be overriding the 
previous one.  
The file will be compressed and password­protected using a 7Z format, and the file name will be 
using the following convention: https://<hosting_path>/<State>rss.json.7z. 
In order to retrieve the latest­generated file, Waze will provide each partner with the following 
access­details: 
● URL ­ a web address from which the partner can retrieve the file using a standard HTTP 
request. The response will include a content­type header (“text/xml” or “text/x­json”) and 
the data.  
● Password ­ an alpha­numeric string to be used in order to open the retrieved file 
Please note that the password will be delivered to the partner using an alternative, personal 
communication channel. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

  

Waze Proprietary and Confidential 6 
Specification Document for Real­time Traffic Data 
 
 
 
 

Using Waze traffic­data 
 
Waze traffic data will consist of several types of information: 
1. General information: time­stamp of the file, geographic area from which the data was 
retrieved etc. 
2. Traffic alerts: traffic incidents reported by users. 
3. Traffic jams: traffic slowdown information generated by the service based on users 
location and speed. 
4. Irregularities: alerts and traffic jams that affect an exceptionally large number of users. 
 
Note: from time to time new and optional fields may be added to the feed. Once those fields will 
be permanently available ­­ this document will be modified and re­distributed to the relevant 
partners. 

Traffic Alerts 
 
The ‘Alerts’ section includes all traffic data reported by Waze users through the Waze mobile 
application.  
Those events are relevant for the specific time and location of the report. Each alert gets a 
confidence score based on other users reaction (‘Thumbs up’, ‘Not there’ etc.) which indicates 
how reliable it is.  
 
The data will include an array of alerts with the following attributes: 
 
Element  Value  Description 
location  Object  x and y of the location 
Description  String  Geometry type description 
Guid  String  Unique system ID 
Link  URL  Link to the geometry type 
author  Linqmap  Creator of the returning document 
pubDate  Timestamp  Publication date (Unix time – milliseconds 
since epoch) 
location  Coordinates  Location per report 
entitiyid  String  Unique system ID 
uuid  String  Unique system ID (Internal tool, ignore) 
magvar  Integer (0­359)  Event direction (Driver heading at report 
time. 0 degrees at North) 
speed  float  Driving speed (meters/second) of the 
reporting user? 
type  See alert type table  Event type 
subtype  See alert sub types table  Event sub type ­ depends on atof parameter 
inscale  Boolean  If the returning results amount is smaller 
than requested in ma (maximum alerts), the 

  

Waze Proprietary and Confidential 7 
Specification Document for Real­time Traffic Data 
 
 
 
system will send more items outside of the 
desired scale.  (see alerts parameters bo) 
reportDescription  String  Report description (optional) 
street  String  Street name (as is written in database, no 
canonical form, may be null) 
city  String  City and state name [City, State] in case both 
are available, [State] if not associated with a 
city. Optional.  
country  String  available on EU (world) server (see two 
letters codes in 
http://en.wikipedia.org/wiki/ISO_3166­1)  
roadType  Integer  Road type (see road types table in the 
appendix)  
reportMood  Integer  Internal ­ Wazer mood icon 
reportRating  Integer  User rank between 1­6 ( 6 = high ranked 
user) 
showFacebookPic  Boolean  NA 
comment    NA 
jamID  string  If the alert is connected to a jam ­ jam ID 
Confidence  0­5  A score predicting reliability ­ 5 means 
“almost definitely there” 
Image  ID  A pic taken by a user and uploaded with the 
alert. It can be found using the following 
paths:  
  
Image thumbnails: 
https://s3.amazonaws.com/waze.pho
tos/thumbs/thumb[IMAGE 
SIZE]_[IMAGE_ID] 
 
Image size can be either 32, 100 or 
347 ­ enter the desired value instead 
of “image size” in the URL 
 
The original image in full size can be 
found in the following URL: 
https://s3.amazonaws.com/waze.pho
tos/[IMAGE_ID] 
 
isJamUnifiedAler  Boolean  Waze internal ­ should be ignored 

 
 

Traffic Alerts ­ example 
 

JSON format 
 
{"inscale":true,"roadType":3,"location":{"y":26.242112,"x":­81.736962},"speed":0,"street":"I­75 
S","type":"WEATHERHAZARD","reportRating":2,"nThumbsUp":0,"country":"US","city":"Naples, 
FL","id":"alert­1180116831/2b03cebc­db60­3bb0­9fec­7dbb90ff02ea","pubMillis":1409482955254,
  

Waze Proprietary and Confidential 8 
Specification Document for Real­time Traffic Data 
 
 
 
"showFacebookPic":false,"subtype":"HAZARD_ON_SHOULDER_CAR_STOPPED","reportMood
":1,"uuid":"2b03cebc­db60­3bb0­9fec­7dbb90ff02ea","nComments":0,"comments":[],"magvar":17
6,"isJamUnifiedAlert":false} 
 

XML format 
 
<item>
<title>alert</title>
<description>Point consists of a Latitude Longitude location</description>
<guid>urn:uuid:d496f4e3-7fd8-4169-ac6208e36dffa7f0</guid>
<link>http://georss.org/example/simple/point</link>
<author>LinQmap</author>
<pubDate>Sun Aug 31 11:02:35 +0000 2014</pubDate>
<georss:point>26.242112 -81.736962</georss:point>
<linqmap:entityid>
alert-1180116831/2b03cebc-db60-3bb0-9fec-7dbb90ff02ea
</linqmap:entityid>
<linqmap:uuid>2b03cebc-db60-3bb0-9fec-7dbb90ff02ea</linqmap:uuid>
<linqmap:isJamUnifiedAlert>false</linqmap:isJamUnifiedAlert>
<linqmap:magvar>176</linqmap:magvar>
<linqmap:speed>0.0</linqmap:speed>
<linqmap:type>WEATHERHAZARD</linqmap:type>
<linqmap:subtype>HAZARD_ON_SHOULDER_CAR_STOPPED</linqmap:subtype>
<linqmap:inscale>true</linqmap:inscale>
<linqmap:street>I-75 S</linqmap:street>
<linqmap:city>Naples, FL</linqmap:city>
<linqmap:country>US</linqmap:country>
<linqmap:roadType>3</linqmap:roadType>
<linqmap:reportMood>1</linqmap:reportMood>
<linqmap:reportRating>2</linqmap:reportRating>
<linqmap:showFacebookPic>false</linqmap:showFacebookPic>
<nComments>0</nComments>
<nThumbsUp>0</nThumbsUp>
<confidence>1</confidence>
<wazeData>
usa,-81.736962,26.242112,2b03cebc-db60-3bb0-9fec-7dbb90ff02ea,1180116831
</wazeData>
</item>
 
 
   

  

Waze Proprietary and Confidential 9 
Specification Document for Real­time Traffic Data 
 
 
 

Alert Types 
 
Waze currently supports the following types and subtypes of user­generated alerts: 
 
ID  Alert type  Alert Subtype   
  OTHER / CHIT_CHAT     
  POLICEMAN / POLICE  ● POLICE_VISIBLE   
● POLICE_HIDING 
  ACCIDENT  ● ACCIDENT_MINOR   
● ACCIDENT_MAJOR 
  JAM  ● JAM_MODERATE_TRAFFIC   
● JAM_HEAVY_TRAFFIC 
● JAM_STAND_STILL_TRAFFIC 
● JAM_LIGHT_TRAFFIC 
  WEATHERHAZARD /  ● HAZARD_ON_ROAD   
HAZARD  ● HAZARD_ON_SHOULDER 
● HAZARD_WEATHER 
● HAZARD_ON_ROAD_OBJECT 
● HAZARD_ON_ROAD_POT_HOLE 
● HAZARD_ON_ROAD_ROAD_KILL 
● HAZARD_ON_SHOULDER_CAR_STOPPED 
● HAZARD_ON_SHOULDER_ANIMALS 
● HAZARD_ON_SHOULDER_MISSING_SIGN 
● HAZARD_WEATHER_FOG 
● HAZARD_WEATHER_HAIL 
● HAZARD_WEATHER_HEAVY_RAIN 
● HAZARD_WEATHER_HEAVY_SNOW 
● HAZARD_WEATHER_FLOOD 
● HAZARD_WEATHER_MONSOON 
● HAZARD_WEATHER_TORNADO 
● HAZARD_WEATHER_HEAT_WAVE 
● HAZARD_WEATHER_HURRICANE 
● HAZARD_WEATHER_FREEZING_RAIN 
● HAZARD_ON_ROAD_LANE_CLOSED 
● HAZARD_ON_ROAD_OIL 
● HAZARD_ON_ROAD_ICE 
● HAZARD_ON_ROAD_CONSTRUCTION 
● HAZARD_ON_ROAD_CAR_STOPPED 
  MISC     
  CONSTRUCTION     
  ROAD_CLOSED  ● ROAD_CLOSED_HAZARD   
● ROAD_CLOSED_CONSTRUCTION 
● ROAD_CLOSED_EVENT 
 

  

Waze Proprietary and Confidential 10 


Specification Document for Real­time Traffic Data 
 
 
 
 

Traffic Jams information 
 
The jams section includes data about traffic slowdown in specific road segments based on data 
the system gathers in real time.  
 
A file will include an array of jams and the start time and date of the report. each jam will include 
the parameters detailed below.  
 
Waze generates its traffic­jams information by processing the following data­sources: 
● GPS location­points sent from users phones (users who drive while using the app) and 
calculations of the actual speed vs. average speed (on specific time­slot) and free­flow 
speed (maximum speed measured on the road­segment) 
● User­generated reports ­ reports shared by Waze users who encounter traffic­jams. 
These appear as regular alerts, and also affect the way we identify and present traffic 
jams. 
 
Traffic jam parameters are described in the following table: 

Element  Value  Description 


updateMillis  Long Integer  Last update date (Unix time – milliseconds since epoch) 
Type  String  TRAFFIC_JAM 
Line  List of Longitude  Traffic jam line string (optional) 
and Latitude 
coordinates 
speed  Float  Current average speed on jammed segments in 
meter/second 
length  Integer  Jam length in meters 
delay  Integer  Delay of jam compared to free flow speed, in seconds 
street  String  Street name (as is written in database, no canonical 
form. Optional) 
city  String  City and state name [City, State] in case both are 
available, [State] if not associated with a city. Optional 
country  String  available on EU (world) server (see two letters codes in 
http://en.wikipedia.org/wiki/ISO_3166­1) 
roadType  Integer  Road type (see road types table in the appendix)  
startNode  String  Nearest Junction/steet/city to jam start (optional, 
supplied when available) 
endNode  String  Nearest Junction/steet/city to jam end (optional, supplied 
when available) 
severity  0 ­ 5  Weighted score of congestion level and relevance (5 = 
blocked) 
level  0 ­ 5  Traffic congestion level (0 = lightest 5 = blocked). 

  

Waze Proprietary and Confidential 11 


Specification Document for Real­time Traffic Data 
 
 
 
ID  String  Unique jam ID 
turnLine  Coordinates  A set of coordinates of a turn ­ only when the jam is in a 
turn (optional) 
turnType  String  What kind of turn is it ­ left, right, exit R or L, continue 
straight or none (no info) (optional) 
blockingalertID  string  if the jam is connected to a block (see alerts) + 
expiration, start time, block type, block description, block 
update 
 
 
 
 

Traffic jam results ­ example   
 

JSON Format 
 
 
{"jams":[{"segments":[{"isForward":true,"fromNode":52906356,"ID":61527044,"toNode":52906293
}],"speed":4.957840071772535,"roadType":6,"updateMillis":1409483096000,"street":"SR­85","line
":[{"y":30.809087,"x":­86.544583},{"y":30.809408,"x":­86.543965},{"y":30.809758,"x":­86.543361},{
"y":30.810164,"x":­86.542764},{"y":30.81064,"x":­86.542202},{"y":30.811071,"x":­86.541771},{"y":3
0.811489,"x":­86.541403},{"y":30.811939,"x":­86.541078},{"y":30.812437,"x":­86.540753},{"y":30.8
1307638084561,"x":­86.54040315010334}],"severity":1,"type":"TRAFFIC_JAM","endNode":"SR­8
5","city":"Crestview, FL","country":"US","level":3,"length":608,"delay":98,"turnType":"NONE"}, 
 
 
 
Block example (When a traffic jam is related to a blocked road report): 
 
jsonJam.put("blockingAlertID", blockingAlert.getID().getId()); 
jsonJam.put("blockExpiration", AlertHelper.getAlertTimeoutMillis(blockingAlert)); 
jsonJam.put("blockStartTime", blockingAlert.getStartTime()); 
jsonJam.put("blockType", blockingAlert.getSubType().name());  
if (blockingAlert.getDescription() != null) { 
jsonJam.put("blockDescription", blockingAlert.getDescription()); 

jsonJam.put("blockUpdate", blockingAlert.getReportTime()); 
 

  

Waze Proprietary and Confidential 12 


Specification Document for Real­time Traffic Data 
 
 
 

XML Format 
 
<item>
<title>jam</title>
<description>LineString consists of lat, lon pairs</description>
<guid>urn:uuid:d496f4e3-7fd8-4169-ac6208e36dffa7f0</guid>
<link>http://georss.org/example/simple/point</link>
<author>LinQmap</author>
<pubDate>Sun Aug 31 11:16:31 +0000 2014</pubDate>
<updDate>Sun Aug 31 11:06:45 +0000 2014</updDate>
<linqmap:type>TRAFFIC_JAM</linqmap:type>
<georss:line>
28.552835 -81.410734 28.552798 -81.413845 28.552797 -81.414747 28.552779
-81.415979 28.552754 -81.418004 28.55275 -81.418429 28.552751 -81.418429
28.552741 -81.420073
</georss:line>
<linqmap:speed>6.24577195002948</linqmap:speed>
<linqmap:length>914.0</linqmap:length>
<linqmap:delay>60</linqmap:delay>
<linqmap:street>W Colonial Dr</linqmap:street>
<linqmap:city>Orlando, FL</linqmap:city>
<linqmap:country>US</linqmap:country>
<linqmap:roadType>6</linqmap:roadType>
<linqmap:severity>1</linqmap:severity>
<linqmap:level>3</linqmap:level>
<linqmap:turnType>NONE</linqmap:turnType>
</item>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

  

Waze Proprietary and Confidential 13 


Specification Document for Real­time Traffic Data 
 
 
 

Appendix 

Road types table  
 
 
Value  Type 
1  Streets 
2  Primary Street 
3  Freeways 
4  Ramps 
5  Trails 
6  Primary 
7  Secondary 
8, 14  4X4 Trails 
15  Ferry crossing 
9  Walkway 
10  Pedestrian 
11  Exit 
16  Stairway 
17  Private road 
18  Railroads 
19  Runway/Taxiway 
20  Parking lot road 
21  Service road 
 
 
 
 
 

  

Waze Proprietary and Confidential 14 

You might also like