Create a link to add to an e-mail, blog (Short for weblog. An online journal. Each entry typically contains personal thoughts and Web links, with the newest entries listed first.) , or personal website that opens Bing Maps to a specific location, map view, and zoom level. You can customize your link to display specific search results, driving directions, or items in your places.
Start with the base URL (Uniform Resource Locator. The unique address for a file that is accessible on the Internet.) for Bing Maps, and then use parameters (A value appended to a web address that lets you pass specific information from your browser to a server. A parameter begins with a question mark and takes the form ?parameter=value.) to specify your location and define options such as zoom level, map view, search panels, and more.
Start with the base address:
http://bing.com/maps/default.aspx
Add a question mark (?) to the end of the address:
http://bing.com/maps/default.aspx?
Add the first parameter that you want to use, and then set the value of the parameter by using an equal sign (=):
http://bing.com/maps/default.aspx?v=2
The different available parameters are described in the following tables.
Add the other parameters that you want to use, separating each parameter with an ampersand (&):
http://bing.com/maps/default.aspx?v=2&yp.gouda
Available parameters
Add parameters to your URL to customize what others see when they click your link.
Defines the version of the URL API (Application Programming Interface. The language used by an application program to communicate with a computer's operating system.) . If you use this parameter, you should always assign it a value of 2. If you omit this parameter, the latest version of the API is used by default.
mkt
Market
mkt=en-us
Defines the market for your URL using universal two-letter language codes and two-letter ISO (International Organization for Standardization) country codes separated by a hyphen.
cp
Center point
cp=47.677797~-122.122013
Defines where the center of the map should be. Use the following format for the cp parameter:
Latitude~Longitude
Both values must be expressed in decimal degrees.
lvl
Zoom level (2D view only)
lvl=5
Defines the zoom level of the map view in 2D mode. Valid values are 1-19; for oblique, 1-2. This parameter is ignored if you don't include the cp parameter.
alt
Zoom level (3D view only)
alt=1000
Defines the zoom level of the map view in 3D mode. The value that you assign to this parameter equals the number of meters above sea level that you want the zoom level to be. For example, alt=1000 sets the zoom level at 1000 meters above sea level. Valid values are 0 to 20,000,000.
style
Map view
style=r
Defines the map view. Valid values for this parameter include:
a: Display an aerial view of the map.
r: Display a road view of the map.
h: Display an aerial view of the map with labels.
o: Use this value to display a bird's eye (oblique) view of the map.
b: Display a bird's eye (oblique) with labels view of the map.
Note
If you set the view to o or b, you must also provide the scene parameter to specify a view or angle.
scene
Scene ID reference
scene=3715328
Specifies the ID of the bird's eye (oblique) image tile to display. Use this parameter to specify a view or angle. This parameter is required if the style parameter is set to o or b.
tilt
Camera tilt
tilt=-45
Specifies the angle of the camera. Valid values are from -90 (straight down) to 0 (horizontal). This value is ignored in 2D view.
dir
Direction
dir=180
Specifies in degrees the direction that the camera is pointing toward. Valid values are 0 to 360, where 0 is North, 90 is East, 180 is South, and 270 is West. This value is ignored in 2D view.
Examples
The following example opens Bing Maps with the map centered on a specific location with a zoom level of 12, and the map view set to the road map view:
The following example opens Bing Maps with the map centered on a specific location, the map view set to bird's eye (oblique) image, and a specified zoom level and scene:
To build a link that displays specific search results, use the base address http://bing.com/maps/default.aspx and any of the following parameters.
Parameter
Definition
Example
Details
where1
Location
where1=1 Microsoft Way, Redmond, WA
Defines a location to center the map based on a specific address or a place name. The text is the same text that you type in the upper search box in Bing Maps to search for a specific address or place name.
ss
Search type search
ss=yp.coffee
Defines the searches that you want to display.
Use this parameter to display search results for a business, person, or collection.
You can add a prefix to each search string that specifies whether the search is a yellow pages search (for business listings), a white pages search (for individuals), or a collection (for community-generated data). Use the yp. prefix for yellow pages searches, the wp. prefix for white pages searches, and the Cl. prefix for collections.
If you don't specify a prefix, a yellow pages search is performed by default.
sst
Search type sort
sst.1
You can add a prefix to each search string that specifies whether the search sort is displayed by relevance, distance, rating, or page number. Use the following values to define the type of sort you want:
0 = Relevance
1 = Distance
2 = Rating
Use the page. prefix to specify which page number of search results that you want to display.
Examples
The following example opens Bing Maps to a specific address:
To build a link that displays directions from a specific start and end point, use the base address http://bing.com/maps/default.aspx and any of the following parameters.
Parameter
Definition
Example
Details
rtp
Route
Rtp=adr. Seattle,WA ~adr.1Microsoft Way, Redmond, WA
Defines the start and end of a route to draw on the map, each separated by a tilde (~). Each of the waypoints (Coordinates that identify a point on the map.) are defined by either a pos (position) or adr (address) identifier, both of which are described in the next table.
A complete route contains at least two waypoints. For example, a route with two waypoints is defined by the following:
rtp="A"~"B"
You can also specify an incomplete route. For example, you can define only the start of a route:
rtp="A"~
Or, you can enter only the end of a route:
rtp=~"B"
If you provide only one waypoint, the driving directions panel is displayed with the provided waypoint, but no route is drawn.
Identifier
Definition
Example
Details
pos
Position
Rtp= pos.42.2_ -122.3~ pos.55.2_-127.
Defines a waypoint as a specific position on the map. Use the following format:
rtp=pos.latitude_longitude_name
adr
Address
Rtp= adr.Seattle, WA~adr.1 Microsoft Way, Redmond, WA
Defines a waypoint as an address. Use the following format:
rtp=adr.address
rtop
Route options
Rtop=0~0~E
Defines options for the route. There are three possible options, each separated by a tilde (~). The default value of 0~0~0 (non-abbreviated, quickest, without traffic) will be used if an option is not specified.
0 = Quickest
1 = Shortest
0 = Don't use traffic
1 = Use traffic
0 = No abbreviation
E = End only
S = Start Only
Note
The pos and adr identifiers must be used with the rtp parameter.
To create directions for a party and let others view those directions in the 1-click Directions map view, start with the following base address: http://bing.com/maps/OnceClickDirections.aspx.
You can use any of the parameters listed in the previous tables to specify your waypoints.
The destination is specified using the rtp and pos parameters described above. Make sure that you specify only the end location, for example rtp=~pos.45.21_-123.2. You can use the following parameter to specify the default view index that you want displayed.
Parameter
Definition
Example
Details
rtv
View index
rtv=4
This is an optional parameter that specifies the start view for a route.
0 = Show all (default)
1 = Start from the first direction
2 = Start from the second direction
3 = Start from the third direction
4 = Start from the fourth direction
Examples
The following example shows a route on the map from a specific address to a specific point:
To build a link that displays information from the collections editor or a specific collection, use the base address http://bing.com/maps/default.aspx and any of the following parameters.
Parameter
Definition
Example
Details
sp
Collections editor
sp=adr.1 microsoft way, redmond, wa
Defines a specific entity, address, or pin (A marker containing information such as notes and links, which you can place at a specific point on a map.) to add to the collections editor.
Collections editor items are defined as a pairing: the category and the value, separated by a period. There are six valid categories: adr, an, point, polyline, polygon,and yp. These are described in the next table.
Separate multiple collections editor items with tildes (~). If the item you specify contains a tilde, make sure the tilde is encoded as %7E.
cid
Collection ID
cid=15A41C376
Specifies the collection that you want to display by using the ID assigned to that collection. For the collection ID parameter, use the following format:
cid=collection ID
mapurl
Map URL
maprul=http://myurl/ goodstuff.xml
Displays a collection of items by using the location specified in the URL. For the map URL parameter, use the following format:
mapurl=url
fave
Favorites
fave=1
Displays the viewer's Favorites, if they are signed in to Bing Maps. If the viewer isn't signed in to Bing Maps, they'll receive a notification to sign in.
You should always set the fave parameter to 1.
explore
Explore mode
explore=sst. 1~tag.food
Forces Bing Maps to open in exploration task mode. There are three ways to sort results in exploration task mode:
1 = Distance
3 = Static rank
4 = Chronological
For the explore parameter, use the following format:
explore= sst.sorttype ~tag.tagstring
tour
Tour mode
tour=1
Displays a collection in 3D tour mode. Use either of the following options to determine how the tour that is loaded is displayed:
0 = Loads the collection tour in a paused state
1 = Loads the collection tour in an automatic playing state
Category
Definition
Details
adr
Address
Specifies an address to add to the collections editor. For the address, the value can be the address string, the address string and title, or the address string, title, and description:
sp=adr.addressString
sp=adr.addressString_title
sp=adr.addressString_title_description
Make sure that the addresses you provide are as specific as possible.
point
Point
Specifies a point to add to the collections editor by using latitude and longitude. For points, the value includes the latitude, longitude, title, notes, link URL, and photo URL to display, each separated by an underscore (_):
sp=point.position_ title string_notes, string_link URL_photo URL
polyline
Polyline
Specifies a point to add to the collections editor by using the vertex positions on the map. For polylines, the value includes the latitude, longitude, title, notes, link URL, photo URL, fill color, line color, line weight, and line style to display, each separated by an underscore (_):
Specifies a point to add to the collections editor by using the vertex positions on the map. For polygons, the value includes the latitude, longitude, title, notes, link URL, photo URL, fill color, line color, line weight, and line style to display, each separated by an underscore (_):
The following example shows how to open a collection in Bing Maps:
http://bing.com/maps/?v=2&cid=1234567890ABCDEF!
Notes
The tour parameter must be used with the cid or mapurl parameter.
The collection ID in the previous example does not exist. It is for this example only. You must change the collection ID to the collection ID that you want to open.
Note
The tables in this topic list the parameters currently supported by the Bing Maps URL API (Application Programming Interface. The language used by an application program to communicate with a computer's operating system.) .
These parameters may change in future versions.