pelias
/
documentation
mirror of https://github.com/pelias/documentation.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

Update 002-search.md

pull/4/head^2
Diana Shkolnikov 9 years ago
parent
55fcbadb18
commit
b776441043
1 changed files with 7 additions and 8 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 15
      getting-started/002-search.md

15
getting-started/002-search.md
Unescape View File

@ -15,32 +15,31 @@ _{search text, global, no options}_
Let's say you wanted to find **Stinky Beach**, you would simply query the search API as follows: Let's say you wanted to find **Stinky Beach**, you would simply query the search API as follows:
> [/v1/search?___text=stinky beach___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=stinky beach) > [/v1/search?api_key={YOUR-KEY}&___text=stinky beach___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=stinky beach)
_...go ahead, and click that link, we'll wait_ _...go ahead, and click that link, we'll wait_
Maybe you'd like to find an address, like this: Maybe you'd like to find an address, like this:
> [/v1/search?___text=30 west 26th street___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=30 west 26th street) > [/v1/search?api_key={YOUR-KEY}&___text=30 west 26th street___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=30 west 26th street)
Or even a landmark, like **Yankee Stadium**: Or even a landmark, like **Yankee Stadium**:
> [/v1/search?___text=yankee stadium___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=yankee stadium) > [/v1/search?api_key={YOUR-KEY}&___text=yankee stadium___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=yankee stadium)
You may have noticed already that cApiTaliZAtioN isn't a big deal for search. You may have noticed already that cApiTaliZAtioN isn't a big deal for search.
You can type **yankee stadium** or **Yankee Stadium** or even **YANKEE STADIUM** if you're really excited about finding it. You can type **yankee stadium** or **Yankee Stadium** or even **YANKEE STADIUM** if you're really excited about finding it.
See for yourself: See for yourself:
> [/v1/search?___text=YANKEE STADIUM___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YANKEE STADIUM) > [/v1/search?api_key={YOUR-KEY}&___text=YANKEE STADIUM___](https://search.mapzen.com/v1/search?api_key={YOUR_API_KEY}&text=YANKEE STADIUM)
#### Results #### Results
Now that you've seen some examples of search, let's examine the results closer. Now that you've seen some examples of search, let's examine the results closer.
When searching for **30 West 26th Street** you got back a `GeoJSON` formatted response. When requesting search results you will always get back `GeoJSON` results, unless something goes terribly wrong, in which case you'll get a really helpful error.
You'll always get back `GeoJSON` results, unless something goes terribly wrong, in which case you'll get a really helpful error.
You can go [here](link.to.geojson.spec.com) to learn more about the `GeoJSON` data format specification. _You can go [here](link.to.geojson.spec.com) to learn more about the `GeoJSON` data format specification.
We'll assume you're familiar with the general layout and only point out some important details here. We'll assume you're familiar with the general layout and only point out some important details here._
You will find the following top-level structure to every response: You will find the following top-level structure to every response:

Write Preview
Loading…
Cancel
Save