Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -44,30 +44,13 @@

- <h3 class="parameter-name" id="types">types</h3>

The types of suggestion to return. Multiple types can be passed using the pipe character (`|`) as a separator.

- `city`: includes city localities
- `town`: includes town localities
- `village`: includes village localities
- `hamlet`: includes hamlet localities
- `borough`: includes borough localities
- `suburb`: includes suburb localities
- `quarter`: includes quarter localities
- `neighbourhood`: includes neighbourhood localities
- `locality`: an alias that groups all localities (`city`, `town`, `village`, `hamlet`, `borough`, `suburb`, `quarter` and `neighbourhood`)
- `postal_code`: publicly-used postal codes around the world
- `address`: addresses
- `admin_level`: most commonly used administrative areas
- `country`: countries as whole point of interest
- `airport`: includes all medium sized to international sized airports
- `train_station`: includes all train stations
- `metro_station`: includes all metro stations
- `shopping`: includes shopping malls (or "shopping centers") - *may include private retail brands*
- `museum`: includes museums
- `tourist_attraction`: includes tourist attractions like the Eiffel tower
- `amusement_park`: includes amusement parks like Disneyland Paris
- `art_gallery`: includes art galleries
- `zoo`: includes zoos
Specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:

- Standard locality types (e.g., cities, administrative areas, postal codes)
- Points of Interest (POI) categories
- POI aliases

These classifications enable flexible geographic data representation and querying.


<p style="text-align: right; font-size: smaller;">Generated from the <a data-label="openapi-github" href="https://github.com/woosmap/openapi-specification" title="Woosmap OpenAPI Specification" class="external">OpenAPI specification</a>.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -43,30 +43,14 @@

- <h3 class="parameter-name" id="types">types</h3>

Specify the types of geocoding responses to return by separating multiple types with a pipe character (|). This parameter is ignored when used with the `latlng` parameter. When executing a geocode request with the `address` parameter, use this to select the expected result type.

- `city`: includes city localities
- `town`: includes town localities
- `village`: includes village localities
- `hamlet`: includes hamlet localities
- `borough`: includes borough localities
- `suburb`: includes suburb localities
- `quarter`: includes quarter localities
- `neighbourhood`: includes neighbourhood localities
- `locality`: includes all previous locality names
- `postal_code`: publicly-used postal codes around the world
- `address`: addresses
- `admin_level`: most commonly used administrative areas
- `country`: countries as whole point of interest
- `airport`: includes all medium sized to international sized airports
- `train_station`: includes all train stations
- `metro_station`: includes all metro stations
- `shopping`: includes shopping malls (or "shopping centers") - *may include private retail brands*
- `museum`: includes museums
- `tourist_attraction`: includes tourist attractions like the Eiffel tower
- `amusement_park`: includes amusement parks like Disneyland Paris
- `art_gallery`: includes art galleries
- `zoo`: includes zoos
When executing a geocode request with the `address` parameter, it specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:

- Standard locality types (e.g., cities, administrative areas, postal codes)
- Points of Interest (POI) categories
- POI aliases

These classifications enable flexible geographic data representation and querying.
This parameter is ignored when used with the `latlng` parameter.


<p style="text-align: right; font-size: smaller;">Generated from the <a data-label="openapi-github" href="https://github.com/woosmap/openapi-specification" title="Woosmap OpenAPI Specification" class="external">OpenAPI specification</a>.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,17 @@ Localities Collection Response containing Localities
}
},
{
"public_id": "4Ew1mvbob3vobGMQ44AdRNY/5xE=",
"public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
"type": "locality",
"types": [
"locality",
"village"
],
"description": "Little London, Hampshire, United Kingdom",
"description": "London Apprentice, Cornwall, United Kingdom",
"matched_substrings": {
"description": [
{
"offset": 7,
"offset": 0,
"length": 4
}
]
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Attributes describing a locality. Not all attributes will be available for all l
| <h4 id="LocalitiesAutocompleteResponse-public_id" class="add-link schema-object-property-key"><code>public_id</code></h4> | optional | string | <div class="nonref-property-description"><p>Contains a unique ID for each suggestion. Please use this ID if you need to give us feedbacks on results. This ID is also required to perform Localities Details request.</p></div> |
| <h4 id="LocalitiesAutocompleteResponse-related" class="add-link schema-object-property-key"><code>related</code></h4> | optional | [LocalitiesAutocompleteRelated](#LocalitiesAutocompleteRelated "LocalitiesAutocompleteRelated") | See [LocalitiesAutocompleteRelated](#LocalitiesAutocompleteRelated "LocalitiesAutocompleteRelated") for more information. |
| <h4 id="LocalitiesAutocompleteResponse-type" class="add-link schema-object-property-key deprecated-item hide-from-toc"><code>type</code></h4> | optional | string | <aside class="deprecated"><code>type</code> is deprecated.</aside><div class="nonref-property-description"><p>this field might be removed in the future, please use the <code>types</code> field which is more exhaustive</p></div> |
| <h4 id="LocalitiesAutocompleteResponse-types" class="add-link schema-object-property-key"><code>types</code></h4> | optional | Array&lt;[LocalitiesTypes](#LocalitiesTypes "LocalitiesTypes")&gt; | <div class="ref-property-description"><p>An array containing the types of the result</p><p>See <a href="#LocalitiesTypes">LocalitiesTypes</a> for more information.</div> |
| <h4 id="LocalitiesAutocompleteResponse-types" class="add-link schema-object-property-key"><code>types</code></h4> | optional | Array&lt;[LocalitiesTypesAll](#LocalitiesTypesAll "LocalitiesTypesAll")&gt; | <div class="ref-property-description"><p>An array containing the types of the result</p><p>See <a href="#LocalitiesTypesAll">LocalitiesTypesAll</a> for more information.</div> |

<h4 class="schema-object-example" id="LocalitiesAutocompleteResponse-example">Example</h4>

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading