diff --git a/README.md b/README.md index 3440f58..1176f26 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Here is where you can find all documentation for the [Pelias geocoder](https://g - [Forward geocoding](search.md) (**/v1/search**) to find a place by searching for an address or name - [Reverse geocoding](reverse.md) (**/v1/reverse**) to find what is located at a certain coordinate location - [Autocomplete](autocomplete.md) (**/v1/autocomplete**) to give real-time result suggestions without having to type the whole location -- [Structured Geocoding](structured-geocoding.md) (**/v1/search/structured**) to find a place with data already separated into housenumber, street, city, etc +- [Structured Geocoding](structured-geocoding.md) (**/v1/search/structured**) (*beta*) to find a place with data already separated into housenumber, street, city, etc - [Place endpoint](place.md) (**/v1/place**) for details on a place returned from a previous query _Not sure which Endpoint to use? We have a [page](search-workflows.md) for that_ diff --git a/structured-geocoding.md b/structured-geocoding.md index 6376480..05f53f1 100644 --- a/structured-geocoding.md +++ b/structured-geocoding.md @@ -1,5 +1,7 @@ # Structured geocoding +>**Note:** The structured endpoint is in _beta_. You may expereience issues as the structured endpoint has not been as thoroughly tested as the [`search` endpoint](search.md). + With structured geocoding, you can search for the individual parts of a location. Structured geocoding is an option on the [`search` endpoint](search.md), where a query takes the form of `/v1/search/structured`. For example, you want to find `30 West 26th Street, New York, NY`. With the geocoding parameter for `search`, you can only enter the entire location as one string, such as `text=30 West 26th Street, New York, NY`. However, with `search/structured`, you can specify that this location is composed of a street address, a locality, and a region.