From a6d8ad47bcf422fd539ca166852568305055fab3 Mon Sep 17 00:00:00 2001 From: Riordan Date: Tue, 29 Sep 2015 00:18:21 -0400 Subject: [PATCH 1/6] pelias.bigdev.mapzen.com -> search.mapzen.com --- getting-started/002-search.md | 18 +++++++++--------- getting-started/005-place.md | 4 ++-- getting-started/006-response.md | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/getting-started/002-search.md b/getting-started/002-search.md index fd22c67..9adf7cd 100644 --- a/getting-started/002-search.md +++ b/getting-started/002-search.md @@ -67,7 +67,7 @@ Sometimes your work might require that all the search results be from a particul Now, you want to search for YMCA again, but this time only in Great Britain. To do this, you will need to know that the alpha-3 code for Great Britain is *GBR* and set the parameters like this: -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=GBR___](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=GBR) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=GBR___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=GBR) | parameter | value | | :--- | :--- | @@ -90,7 +90,7 @@ Note that all the results reside within Great Britain: If you attempt the same search request with different country codes, the results change to reflect YMCA locations within this region. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=USA___](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=USA) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=USA___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=USA) Results in the United States: @@ -115,7 +115,7 @@ For example, to find a YMCA within the state of Texas, you can set the `boundary Tip: You can look up a bounding box for a known region with this [web tool](http://boundingbox.klokantech.com/)* - [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51___](https://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51) + [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51) | parameter | value | | :--- | :--- | @@ -145,7 +145,7 @@ Sometimes you don't have a rectangle to work with, but rather you have a point o In this example, you want to find all YMCA locations within a 35-kilometer radius of a location in Ontario, Canada. This time, you can use the `boundary.circle.*` parameter group, where `boundary.circle.lat` and `boundary.circle.lon` represents your location in Ontario and `boundary.circle.radius` is the acceptable distance from that location. Note that the `boundary.circle.radius` parameter is always specified in kilometers. -> [/v1/search?api_key={YOUR_API_KEY}&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) +> [/v1/search?api_key={YOUR_API_KEY}&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) | parameter | value | | :--- | :--- | @@ -181,7 +181,7 @@ By specifying a `focus.point`, nearby places will be scored higher depending on To find YMCA again, but this time near the a specific coordinate location (representing the Sydney Opera House) in Sydney, Australia. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -212,7 +212,7 @@ Now that you have seen how to use boundary and focus to narrow and sort your res Going back to the YMCA search you conducted with a focus around a point in Sydney, the results came back from distant parts of the world, as expected. But say you wanted to only see results from the country in which your focus point lies. You can combine that same focus point in Sydney with the country boundary of Australia like this. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -241,7 +241,7 @@ The results below look very different from the ones you saw previously with only If you are looking for the nearest YMCA locations, and are willing to travel no farther than 50 kilometers from your current location, you likely would want the results to be sorted by distance from current location to make your selection process easier. You can get this behavior by using `focus.point` in combination with `boundary.circle.*`. You can use the `focus.point.*` values as the `boundary.circle.lat` and `boundary.circle.lon`, and add the required `boundary.circle.radius` value in kilometers. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) | parameter | value | | :--- | :--- | @@ -284,7 +284,7 @@ The search examples so far have returned a mix of results from all the data sour If you use the `sources` parameter, you can choose which of these data sources to include in your search. So if you're only interested in finding a YMCA in data from OpenAddresses, for example, you can build a query specifying that data source. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=oa___](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=oa___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | @@ -307,7 +307,7 @@ Because OpenAddresses is, as the name suggests, only address data, here's what y If you wanted to combine several data sources together, set `sources` to a comma separated list of desired source names. Note that the order of the comma separated values does not impact sorting order of the results; they are still sorted based on the linguistic match quality to `text` and distance from `focus`, if you specified one. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=osm,gn___](http://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=osm,gn___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | diff --git a/getting-started/005-place.md b/getting-started/005-place.md index e8c0dd1..59f7da5 100644 --- a/getting-started/005-place.md +++ b/getting-started/005-place.md @@ -12,7 +12,7 @@ If you have all of those, join them together with semicolon and pass them in wit For example, this `/place` query looks up the Eiffel Tower in OSM: -http://pelias.bigdev.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:venue:5013364 +http://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:venue:5013364 ***From Rhonda -- looks like this returns a radio station in Michigan? Also need to redo the query to include production server and the reader's API key*** @@ -22,7 +22,7 @@ http://pelias.bigdev.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:venue:50 To search for more than one `/place` in a request, join multiple values together and separate them with a comma. For example, this /place query looks up the Eiffel Tower in OSM and `30 West 26th St, New York, NY` in OpenAddresses: -http://pelias.bigdev.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 +http://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 The results are returned in the order requested. diff --git a/getting-started/006-response.md b/getting-started/006-response.md index c55c871..cfc0d57 100644 --- a/getting-started/006-response.md +++ b/getting-started/006-response.md @@ -63,8 +63,8 @@ By default, Mapzen Search results 10 places, unless otherwise specified. If you | `text` | YMCA | | `size` | ***1*** | -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___size=1___](https://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&size=1) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___size=1___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&size=1) If you want 25 results, you can build the query where `size` is 25. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___size=25___](https://pelias.bigdev.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&size=25) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___size=25___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&size=25) From b8376b29bd3c4166786ca02685f2f94144ac1ae1 Mon Sep 17 00:00:00 2001 From: Riordan Date: Tue, 29 Sep 2015 00:19:13 -0400 Subject: [PATCH 2/6] :lock: SSL for all demo links --- getting-started/002-search.md | 14 +++++++------- getting-started/005-place.md | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/getting-started/002-search.md b/getting-started/002-search.md index 9adf7cd..e82ac76 100644 --- a/getting-started/002-search.md +++ b/getting-started/002-search.md @@ -90,7 +90,7 @@ Note that all the results reside within Great Britain: If you attempt the same search request with different country codes, the results change to reflect YMCA locations within this region. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=USA___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=USA) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=USA___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=USA) Results in the United States: @@ -145,7 +145,7 @@ Sometimes you don't have a rectangle to work with, but rather you have a point o In this example, you want to find all YMCA locations within a 35-kilometer radius of a location in Ontario, Canada. This time, you can use the `boundary.circle.*` parameter group, where `boundary.circle.lat` and `boundary.circle.lon` represents your location in Ontario and `boundary.circle.radius` is the acceptable distance from that location. Note that the `boundary.circle.radius` parameter is always specified in kilometers. -> [/v1/search?api_key={YOUR_API_KEY}&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) +> [/v1/search?api_key={YOUR_API_KEY}&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) | parameter | value | | :--- | :--- | @@ -181,7 +181,7 @@ By specifying a `focus.point`, nearby places will be scored higher depending on To find YMCA again, but this time near the a specific coordinate location (representing the Sydney Opera House) in Sydney, Australia. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -212,7 +212,7 @@ Now that you have seen how to use boundary and focus to narrow and sort your res Going back to the YMCA search you conducted with a focus around a point in Sydney, the results came back from distant parts of the world, as expected. But say you wanted to only see results from the country in which your focus point lies. You can combine that same focus point in Sydney with the country boundary of Australia like this. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -241,7 +241,7 @@ The results below look very different from the ones you saw previously with only If you are looking for the nearest YMCA locations, and are willing to travel no farther than 50 kilometers from your current location, you likely would want the results to be sorted by distance from current location to make your selection process easier. You can get this behavior by using `focus.point` in combination with `boundary.circle.*`. You can use the `focus.point.*` values as the `boundary.circle.lat` and `boundary.circle.lon`, and add the required `boundary.circle.radius` value in kilometers. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) | parameter | value | | :--- | :--- | @@ -284,7 +284,7 @@ The search examples so far have returned a mix of results from all the data sour If you use the `sources` parameter, you can choose which of these data sources to include in your search. So if you're only interested in finding a YMCA in data from OpenAddresses, for example, you can build a query specifying that data source. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=oa___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=oa___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | @@ -307,7 +307,7 @@ Because OpenAddresses is, as the name suggests, only address data, here's what y If you wanted to combine several data sources together, set `sources` to a comma separated list of desired source names. Note that the order of the comma separated values does not impact sorting order of the results; they are still sorted based on the linguistic match quality to `text` and distance from `focus`, if you specified one. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=osm,gn___](http://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=osm,gn___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | diff --git a/getting-started/005-place.md b/getting-started/005-place.md index 59f7da5..16b6024 100644 --- a/getting-started/005-place.md +++ b/getting-started/005-place.md @@ -12,7 +12,7 @@ If you have all of those, join them together with semicolon and pass them in wit For example, this `/place` query looks up the Eiffel Tower in OSM: -http://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:venue:5013364 +https://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:venue:5013364 ***From Rhonda -- looks like this returns a radio station in Michigan? Also need to redo the query to include production server and the reader's API key*** @@ -22,7 +22,7 @@ http://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:venue:5013364 To search for more than one `/place` in a request, join multiple values together and separate them with a comma. For example, this /place query looks up the Eiffel Tower in OSM and `30 West 26th St, New York, NY` in OpenAddresses: -http://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 +https://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 The results are returned in the order requested. From ff2bf358b4734852b34d3789ecd4428de42be479 Mon Sep 17 00:00:00 2001 From: Riordan Date: Tue, 29 Sep 2015 01:24:42 -0400 Subject: [PATCH 3/6] Removed API key from this commit, but still needs to be expunged from the logs --- getting-started/005-place.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/005-place.md b/getting-started/005-place.md index 16b6024..5105d8f 100644 --- a/getting-started/005-place.md +++ b/getting-started/005-place.md @@ -12,7 +12,7 @@ If you have all of those, join them together with semicolon and pass them in wit For example, this `/place` query looks up the Eiffel Tower in OSM: -https://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:venue:5013364 +https://search.mapzen.com/v1/place?api_key={YOUR-API-KEY}&ids=osm:venue:5013364 ***From Rhonda -- looks like this returns a radio station in Michigan? Also need to redo the query to include production server and the reader's API key*** From e1cccb1885ce5d569f026346aca5b736289cbf87 Mon Sep 17 00:00:00 2001 From: Riordan Date: Tue, 29 Sep 2015 01:26:49 -0400 Subject: [PATCH 4/6] Removed API key from this commit, but still needs to be expunged from the logs --- getting-started/005-place.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/getting-started/005-place.md b/getting-started/005-place.md index 5105d8f..00a076d 100644 --- a/getting-started/005-place.md +++ b/getting-started/005-place.md @@ -22,7 +22,7 @@ https://search.mapzen.com/v1/place?api_key={YOUR-API-KEY}&ids=osm:venue:5013364 To search for more than one `/place` in a request, join multiple values together and separate them with a comma. For example, this /place query looks up the Eiffel Tower in OSM and `30 West 26th St, New York, NY` in OpenAddresses: -https://search.mapzen.com/v1/place?api_key=pelias-M7dcnto&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 +https://search.mapzen.com/v1/place?api_key={YOUR-API-KEY}&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 The results are returned in the order requested. From 443bc0c897df88c2096e35f30234b6eaf2c5ff8e Mon Sep 17 00:00:00 2001 From: Riordan Date: Tue, 29 Sep 2015 01:28:08 -0400 Subject: [PATCH 5/6] unified all user api key syntax to {YOUR-API-KEY} --- getting-started/002-search.md | 22 +++++++++++----------- getting-started/004-reverse.md | 10 +++++----- getting-started/006-response.md | 4 ++-- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/getting-started/002-search.md b/getting-started/002-search.md index e82ac76..4c19ed1 100644 --- a/getting-started/002-search.md +++ b/getting-started/002-search.md @@ -23,7 +23,7 @@ In the simplest search, you can provide only one parameter, the text you want to For example, if you want to find a [YMCA](https://en.wikipedia.org/wiki/YMCA) facility, here's what you'd need to append to the base URL of the service, `search.mapzen.com`. -> [/v1/search?api_key={YOUR-KEY}&___text=YMCA___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA) +> [/v1/search?api_key={YOUR-API-KEY}&___text=YMCA___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA) Note the parameter values are set as follows: @@ -51,7 +51,7 @@ In the example above, you will find the name of each matched locations in a prop Spelling matters, but not capitalization when performing a query with Mapzen Search. You can type `ymca`, `YMCA`, or even `yMcA`. See for yourself by comparing the results of the previous search to the following: -> [/v1/search?api_key={YOUR-KEY}&___text=yMcA___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=yMcA) +> [/v1/search?api_key={YOUR-API-KEY}&___text=yMcA___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=yMcA) Note that the results are spread out throughout the world because you have not given your current location or provided any other geographic context in which to search. @@ -67,7 +67,7 @@ Sometimes your work might require that all the search results be from a particul Now, you want to search for YMCA again, but this time only in Great Britain. To do this, you will need to know that the alpha-3 code for Great Britain is *GBR* and set the parameters like this: -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=GBR___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=GBR) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___boundary.country=GBR___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.country=GBR) | parameter | value | | :--- | :--- | @@ -90,7 +90,7 @@ Note that all the results reside within Great Britain: If you attempt the same search request with different country codes, the results change to reflect YMCA locations within this region. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.country=USA___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.country=USA) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___boundary.country=USA___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.country=USA) Results in the United States: @@ -115,7 +115,7 @@ For example, to find a YMCA within the state of Texas, you can set the `boundary Tip: You can look up a bounding box for a known region with this [web tool](http://boundingbox.klokantech.com/)* - [/v1/search?api_key={YOUR-KEY}&text=YMCA&___boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51) + [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51) | parameter | value | | :--- | :--- | @@ -145,7 +145,7 @@ Sometimes you don't have a rectangle to work with, but rather you have a point o In this example, you want to find all YMCA locations within a 35-kilometer radius of a location in Ontario, Canada. This time, you can use the `boundary.circle.*` parameter group, where `boundary.circle.lat` and `boundary.circle.lon` represents your location in Ontario and `boundary.circle.radius` is the acceptable distance from that location. Note that the `boundary.circle.radius` parameter is always specified in kilometers. -> [/v1/search?api_key={YOUR_API_KEY}&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) | parameter | value | | :--- | :--- | @@ -181,7 +181,7 @@ By specifying a `focus.point`, nearby places will be scored higher depending on To find YMCA again, but this time near the a specific coordinate location (representing the Sydney Opera House) in Sydney, Australia. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -212,7 +212,7 @@ Now that you have seen how to use boundary and focus to narrow and sort your res Going back to the YMCA search you conducted with a focus around a point in Sydney, the results came back from distant parts of the world, as expected. But say you wanted to only see results from the country in which your focus point lies. You can combine that same focus point in Sydney with the country boundary of Australia like this. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -241,7 +241,7 @@ The results below look very different from the ones you saw previously with only If you are looking for the nearest YMCA locations, and are willing to travel no farther than 50 kilometers from your current location, you likely would want the results to be sorted by distance from current location to make your selection process easier. You can get this behavior by using `focus.point` in combination with `boundary.circle.*`. You can use the `focus.point.*` values as the `boundary.circle.lat` and `boundary.circle.lon`, and add the required `boundary.circle.radius` value in kilometers. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) | parameter | value | | :--- | :--- | @@ -284,7 +284,7 @@ The search examples so far have returned a mix of results from all the data sour If you use the `sources` parameter, you can choose which of these data sources to include in your search. So if you're only interested in finding a YMCA in data from OpenAddresses, for example, you can build a query specifying that data source. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=oa___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___sources=oa___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | @@ -307,7 +307,7 @@ Because OpenAddresses is, as the name suggests, only address data, here's what y If you wanted to combine several data sources together, set `sources` to a comma separated list of desired source names. Note that the order of the comma separated values does not impact sorting order of the results; they are still sorted based on the linguistic match quality to `text` and distance from `focus`, if you specified one. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___sources=osm,gn___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___sources=osm,gn___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | diff --git a/getting-started/004-reverse.md b/getting-started/004-reverse.md index a119940..12f1179 100644 --- a/getting-started/004-reverse.md +++ b/getting-started/004-reverse.md @@ -81,17 +81,17 @@ Distance from `point.lat`/`point.lon` | Confidence score This section shows how the various parameters can be combined to form complex use cases. -* All results near the Tower of London >[/v1/reverse?api\_key={YOUR-KEY}&point.lat=51.5081124&point.lon=-0.0759493](https://search.mapzen.com/v1/reverse?api_key={YOUR_API_KEY}&point.lat=51.5081124&point.lon=-0.0759493) +* All results near the Tower of London >[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493) * Only OpenStreetMap results near the Tower of London ->[/v1/reverse?api\_key={YOUR-KEY}&point.lat=51.5081124&point.lon=-0.0759493&sources=osm](https://search.mapzen.com/v1/reverse?api_key={YOUR_API_KEY}&point.lat=51.5081124&point.lon=-0.0759493&sources=osm) +>[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&sources=osm](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&sources=osm) * Only street addresses near the Tower of London ->[/v1/reverse?api\_key={YOUR-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address](https://search.mapzen.com/v1/reverse?api_key={YOUR_API_KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address) +>[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address) * Only OpenStreetMap street addresses near the Tower of London ->[/v1/reverse?api\_key={YOUR-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm](https://search.mapzen.com/v1/reverse?api_key={YOUR_API_KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm) +>[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm) * Only the first OpenStreetMap address near the Tower of London ->[/v1/reverse?api\_key={YOUR-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1](https://search.mapzen.com/v1/reverse?api_key={YOUR_API_KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1) +>[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1) diff --git a/getting-started/006-response.md b/getting-started/006-response.md index cfc0d57..b0a6842 100644 --- a/getting-started/006-response.md +++ b/getting-started/006-response.md @@ -63,8 +63,8 @@ By default, Mapzen Search results 10 places, unless otherwise specified. If you | `text` | YMCA | | `size` | ***1*** | -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___size=1___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&size=1) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___size=1___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&size=1) If you want 25 results, you can build the query where `size` is 25. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___size=25___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YMCA&size=25) +> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___size=25___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&size=25) From b7774f00644d7b044e4cb4b10136b90d6da6fd64 Mon Sep 17 00:00:00 2001 From: Riordan Date: Tue, 29 Sep 2015 11:16:20 -0400 Subject: [PATCH 6/6] :x: :x: :x: :x: :x: :x: :x: standardizing api key syntax --- getting-started/002-search.md | 22 +++++++++++----------- getting-started/004-reverse.md | 10 +++++----- getting-started/005-place.md | 4 ++-- getting-started/006-response.md | 4 ++-- transition.md | 6 +++--- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/getting-started/002-search.md b/getting-started/002-search.md index 4c19ed1..6685f5a 100644 --- a/getting-started/002-search.md +++ b/getting-started/002-search.md @@ -23,7 +23,7 @@ In the simplest search, you can provide only one parameter, the text you want to For example, if you want to find a [YMCA](https://en.wikipedia.org/wiki/YMCA) facility, here's what you'd need to append to the base URL of the service, `search.mapzen.com`. -> [/v1/search?api_key={YOUR-API-KEY}&___text=YMCA___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA) +> [/v1/search?api_key=search-XXXXXXX&___text=YMCA___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA) Note the parameter values are set as follows: @@ -51,7 +51,7 @@ In the example above, you will find the name of each matched locations in a prop Spelling matters, but not capitalization when performing a query with Mapzen Search. You can type `ymca`, `YMCA`, or even `yMcA`. See for yourself by comparing the results of the previous search to the following: -> [/v1/search?api_key={YOUR-API-KEY}&___text=yMcA___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=yMcA) +> [/v1/search?api_key=search-XXXXXXX&___text=yMcA___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=yMcA) Note that the results are spread out throughout the world because you have not given your current location or provided any other geographic context in which to search. @@ -67,7 +67,7 @@ Sometimes your work might require that all the search results be from a particul Now, you want to search for YMCA again, but this time only in Great Britain. To do this, you will need to know that the alpha-3 code for Great Britain is *GBR* and set the parameters like this: -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___boundary.country=GBR___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.country=GBR) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&___boundary.country=GBR___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&boundary.country=GBR) | parameter | value | | :--- | :--- | @@ -90,7 +90,7 @@ Note that all the results reside within Great Britain: If you attempt the same search request with different country codes, the results change to reflect YMCA locations within this region. -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___boundary.country=USA___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.country=USA) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&___boundary.country=USA___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&boundary.country=USA) Results in the United States: @@ -115,7 +115,7 @@ For example, to find a YMCA within the state of Texas, you can set the `boundary Tip: You can look up a bounding box for a known region with this [web tool](http://boundingbox.klokantech.com/)* - [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51) + [/v1/search?api_key=search-XXXXXXX&text=YMCA&___boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&boundary.rect.min_lat=25.84&boundary.rect.min_lon=-106.65&boundary.rect.max_lat=36.5&boundary.rect.max_lon=-93.51) | parameter | value | | :--- | :--- | @@ -145,7 +145,7 @@ Sometimes you don't have a rectangle to work with, but rather you have a point o In this example, you want to find all YMCA locations within a 35-kilometer radius of a location in Ontario, Canada. This time, you can use the `boundary.circle.*` parameter group, where `boundary.circle.lat` and `boundary.circle.lon` represents your location in Ontario and `boundary.circle.radius` is the acceptable distance from that location. Note that the `boundary.circle.radius` parameter is always specified in kilometers. -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&__boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35__](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&boundary.circle.lon=-79.186484&boundary.circle.lat=43.818156&boundary.circle.radius=35) | parameter | value | | :--- | :--- | @@ -181,7 +181,7 @@ By specifying a `focus.point`, nearby places will be scored higher depending on To find YMCA again, but this time near the a specific coordinate location (representing the Sydney Opera House) in Sydney, Australia. -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -212,7 +212,7 @@ Now that you have seen how to use boundary and focus to narrow and sort your res Going back to the YMCA search you conducted with a focus around a point in Sydney, the results came back from distant parts of the world, as expected. But say you wanted to only see results from the country in which your focus point lies. You can combine that same focus point in Sydney with the country boundary of Australia like this. -> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) +> [/v1/search?api_key={YOUR-KEY}&text=YMCA&___focus.point.lat=-33.856680&focus.point.lon=151.215281___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281) | parameter | value | | :--- | :--- | @@ -241,7 +241,7 @@ The results below look very different from the ones you saw previously with only If you are looking for the nearest YMCA locations, and are willing to travel no farther than 50 kilometers from your current location, you likely would want the results to be sorted by distance from current location to make your selection process easier. You can get this behavior by using `focus.point` in combination with `boundary.circle.*`. You can use the `focus.point.*` values as the `boundary.circle.lat` and `boundary.circle.lon`, and add the required `boundary.circle.radius` value in kilometers. -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&___boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&focus.point.lat=-33.856680&focus.point.lon=151.215281&boundary.circle.lat=-33.856680&boundary.circle.lon=151.215281&boundary.circle.radius=50) | parameter | value | | :--- | :--- | @@ -284,7 +284,7 @@ The search examples so far have returned a mix of results from all the data sour If you use the `sources` parameter, you can choose which of these data sources to include in your search. So if you're only interested in finding a YMCA in data from OpenAddresses, for example, you can build a query specifying that data source. -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___sources=oa___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&___sources=oa___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | @@ -307,7 +307,7 @@ Because OpenAddresses is, as the name suggests, only address data, here's what y If you wanted to combine several data sources together, set `sources` to a comma separated list of desired source names. Note that the order of the comma separated values does not impact sorting order of the results; they are still sorted based on the linguistic match quality to `text` and distance from `focus`, if you specified one. -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___sources=osm,gn___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&sources=oa) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&___sources=osm,gn___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&sources=oa) | parameter | value | | :--- | :--- | diff --git a/getting-started/004-reverse.md b/getting-started/004-reverse.md index 12f1179..ad3b9fe 100644 --- a/getting-started/004-reverse.md +++ b/getting-started/004-reverse.md @@ -81,17 +81,17 @@ Distance from `point.lat`/`point.lon` | Confidence score This section shows how the various parameters can be combined to form complex use cases. -* All results near the Tower of London >[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493) +* All results near the Tower of London >[/v1/reverse?api\_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493](https://search.mapzen.com/v1/reverse?api_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493) * Only OpenStreetMap results near the Tower of London ->[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&sources=osm](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&sources=osm) +>[/v1/reverse?api\_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&sources=osm](https://search.mapzen.com/v1/reverse?api_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&sources=osm) * Only street addresses near the Tower of London ->[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address) +>[/v1/reverse?api\_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&layers=address](https://search.mapzen.com/v1/reverse?api_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&layers=address) * Only OpenStreetMap street addresses near the Tower of London ->[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm) +>[/v1/reverse?api\_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm](https://search.mapzen.com/v1/reverse?api_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm) * Only the first OpenStreetMap address near the Tower of London ->[/v1/reverse?api\_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1](https://search.mapzen.com/v1/reverse?api_key={YOUR-API-KEY}&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1) +>[/v1/reverse?api\_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1](https://search.mapzen.com/v1/reverse?api_key=search-XXXXXXX&point.lat=51.5081124&point.lon=-0.0759493&layers=address&sources=osm&size=1) diff --git a/getting-started/005-place.md b/getting-started/005-place.md index 00a076d..15b2771 100644 --- a/getting-started/005-place.md +++ b/getting-started/005-place.md @@ -12,7 +12,7 @@ If you have all of those, join them together with semicolon and pass them in wit For example, this `/place` query looks up the Eiffel Tower in OSM: -https://search.mapzen.com/v1/place?api_key={YOUR-API-KEY}&ids=osm:venue:5013364 +https://search.mapzen.com/v1/place?api_key=search-XXXXXXX&ids=osm:venue:5013364 ***From Rhonda -- looks like this returns a radio station in Michigan? Also need to redo the query to include production server and the reader's API key*** @@ -22,7 +22,7 @@ https://search.mapzen.com/v1/place?api_key={YOUR-API-KEY}&ids=osm:venue:5013364 To search for more than one `/place` in a request, join multiple values together and separate them with a comma. For example, this /place query looks up the Eiffel Tower in OSM and `30 West 26th St, New York, NY` in OpenAddresses: -https://search.mapzen.com/v1/place?api_key={YOUR-API-KEY}&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 +https://search.mapzen.com/v1/place?api_key=search-XXXXXXX&ids=osm:country:5013364,oa:address:65cf57e4eb5548eca9bb548fb1461633 The results are returned in the order requested. diff --git a/getting-started/006-response.md b/getting-started/006-response.md index b0a6842..90967b8 100644 --- a/getting-started/006-response.md +++ b/getting-started/006-response.md @@ -63,8 +63,8 @@ By default, Mapzen Search results 10 places, unless otherwise specified. If you | `text` | YMCA | | `size` | ***1*** | -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___size=1___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&size=1) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&___size=1___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&size=1) If you want 25 results, you can build the query where `size` is 25. -> [/v1/search?api_key={YOUR-API-KEY}&text=YMCA&___size=25___](https://search.mapzen.com/v1/search?api_key={YOUR-API-KEY}&text=YMCA&size=25) +> [/v1/search?api_key=search-XXXXXXX&text=YMCA&___size=25___](https://search.mapzen.com/v1/search?api_key=search-XXXXXXX&text=YMCA&size=25) diff --git a/transition.md b/transition.md index abe990b..826ee6c 100644 --- a/transition.md +++ b/transition.md @@ -144,7 +144,7 @@ The `/autocomplete` endpoint serves as a renamed `/suggest` to indicate that the # `/reverse` Reverse geocoding finds the places closest to geospatial coordinates. -```https://search.mapzen.com/v1/reverse?point.lon={longitude}&point.lat={latitude}&api_key={your-api-key} +```https://search.mapzen.com/v1/reverse?point.lon={longitude}&point.lat={latitude}&api_key=search-XXXXXXX ``` Used to be (Beta) | New Parameter (V1) | New Behavior (if any) | @@ -159,7 +159,7 @@ New parameters: ## Reverse Coarse Geocoding Reverse coarse geocoding is not a point-in-polygon lookup (finding the hierarchy for the polygon that the point falls in), but instead looks for the hierarchy of points nearby. To use reverse coarse geocoding, use: -```https://search.mapzen.com/v1/reverse?point.lon={longitude}&point.lat={latitude}&layers=coarse&api_key={your-api-key} +```https://search.mapzen.com/v1/reverse?point.lon={longitude}&point.lat={latitude}&layers=coarse&api_key=search-XXXXXXX ``` # `/place` (formerly `/doc`) @@ -167,7 +167,7 @@ Reverse coarse geocoding is not a point-in-polygon lookup (finding the hierarchy If a search returns `id: "geonames:3544:adm1:fr:fra:paris"` as the matching ID for a record, the complete underlying place record can be returned with: ``` -https://search.mapzen.com/v1/place?ids=geonames:3544:adm1:fr:fra:paris&api_key={your-api-key} +https://search.mapzen.com/v1/place?ids=geonames:3544:adm1:fr:fra:paris&api_key=search-XXXXXXX ``` # In-Browser Cross-Site Scripting