---
title: "search for places by text around a GPS point"
method: GET
path: "/fulltext/search"
tags: ["fulltext - autocomplete"]
---

# search for places by text around a GPS point

`GET /fulltext/search`

The full text service allows you to search for features / places / street and do autocompletion . you can : Specify one or more words search on part of the name (auto completion / suggestion) Search for text or zip code Specify a GPS restriction (promote nearest, not sorted but has an impact on the score), Limit the results to a specific Language, Country, place type, Paginate the results, Specify the output verbosity, Tells if you want the output to be indented, Tells that all words are required or not, The search is case insensitive, use synonyms (Saint/st, ..), separator characters stripping, ...

## Query parameters

- `q` string, required
- `allwordsrequired` boolean, required
- `spellchecking` string
- `lat` number, double
- `lng` number, double
- `radius` number, double
- `suggest` boolean
- `style` 'SHORT' | 'MEDIUM' | 'LONG' | 'FULL'
- `country` string
- `lang` string
- `format` 'XML' | 'JSON' | 'PHP' | 'RUBY' | 'PYTHON' | 'YAML' | 'ATOM' | 'GEORSS'
- `from` integer
- `to` integer
- `callback` string
- `indent` boolean

## Response `200`

Sucessfully processed

- FulltextResultsDto
  - `message` string — a message
  - `numFound` integer — how many results were found whatever the pagination
  - `QTime` integer — how long the query took
  - `resultsSize` integer — how many results are return
  - `maxScore` number, float — the max score value accross all the results found
  - `result` SolrResponseDto[]
    - `name` string — The name of the feature
    - `score` number, float — a number that indicates the relevance of the result
    - `name_alternates` string[] — The alternate names of the feature that without specific language code
    - `feature_id` integer — A unique id that identify the feature
    - `feature_class` string — The feature Class.
    - `feature_code` string — The feature Code.
    - `name_ascii` string — The ASCII name
    - `elevation` integer — Elevation in meters
    - `gtopo30` integer — Average elevation of 30'x30' (ca 900mx900m) area in meters
    - `timezone` string — The timezone (e.g :Europe/Paris).
    - `fully_qualified_name` string — A name of the form : (adm1Name et adm2Name are printed) Paris, Département de Ville-De-Paris, Ile-De-France, (FR)
    - `placetype` string — The place Type of the Feature
    - `population` integer — How many people live in this feature
    - `lat` number, double — The latitude (north-south)
    - `lng` number, double — The longitude (east-West)
    - `adm1_code` string — The internal code for the administrative division of level 1
    - `adm2_code` string — The internal code for the administrative division of level 2
    - `adm3_code` string — The internal code for the administrative division of level 3
    - `adm4_code` string — The internal code for the administrative division of level 4
    - `continent` string — The continent the country belongs (only for country placetype)
    - `currency_code` string — The ISO 4217 Currency from the curencycode (only for country placetype)
    - `currency_name` string — The name of the currency of the country (only for country placetype)
    - `fips_code` string — The FIPS Code of the country (only for country placetype)
    - `isoalpha2_country_code` string — The ISO 3166 alpha 2 code of the country (only for country placetype)
    - `isoalpha3_country_code` string — The ISO 3166 alpha 3 code of the country (only for country placetype)
    - `postal_code_mask` string — The mask that postal codes should verify. e.g : ##### (only for country placetype)
    - `postal_code_regex` string — The regular expression that postal codes should verify (only for country placetype)
    - `phone_prefix` string — The phone prefix of the country. e.g : +33 .(only for country placetype)
    - `spoken_languages` string[] — List of languages spoken in the country (only for country placetype)
    - `tld` string — Top level domain of the country (only for country placetype)
    - `capital_name` string — Name of the capital of the country(only for country placetype)
    - `area` number, double — Area of the country in m² (only for country placetype)
    - `level` integer — Level of the Adm 1 , 2, 3, or 4(only for Adm placetype)
    - `adm1_name` string — The name of the administrative division of level 1
    - `adm1_names_alternate` string[] — The alternate names of the administrative division of level 1 without specific language code
    - `adm2_name` string — The name of the administrative division of level 2
    - `adm2_names_alternate` string[] — The alternate names of the administrative division of level 2 without specific language code
    - `adm3_name` string — The name of the administrative division of level 3
    - `adm4_name` string — The name of the administrative division of level 4
    - `zipcodes` string[] — The zipcodes
    - `country_code` string — The ISO 3166 country code
    - `country_name` string — The name of the country the features belongs to
    - `country_names_alternate` string[] — The alternate names of the country without specific language code
    - `country_flag_url` string — The relative URL to get the country flag image
    - `google_map_url` string — The URL to get the location on Google Map
    - `yahoo_map_url` string — The URL to get the location on Yahoo Map
    - `openstreetmap_map_url` string — The URL to get the location on OpenStreetMap.org
    - `one_way` boolean — whether the street is one way or not (only for placetype street)
    - `length` number, double — The length of the street (only for placetype street)
    - `street_type` string — The type of the street (only for placetype street)
    - `openstreetmap_id` integer — The OpenStreetMap unique id of the street (only for placetype street)
    - `is_in` string — Information on the city where the street / POI is (depends on OpenStreetMap 'is_in' field), the city in general (only for placetype street)
    - `is_in_place` string — Information on the place where the street / POI is (quater, common place). Generally a place at a lower level than city
    - `is_in_adm` string — Information of the administration division where the street / POI is.
    - `is_in_zip` string[] — Information of the zipcode where the street / POI is (often fill for placetype street)
    - `fully_qualified_address` string — NOT USED YET
    - `house_numbers` HouseNumberDto[] — a list of all the house numbers sorted and their coordinates (only for placetype street)
      - `location` string — The lat / long coordinate
      - `number` string — the house number value
    - `municipality` boolean — if the place is a municipality. it is usefull for geonames feature that don't have concept of 'city' but a populated place (that can be a quarter)
    - `amenity` string — Informations on category of OpenStreetMap POIs

## Other responses

- `401` — Need auth. The API key parameter is missing or wrong, or doesn't correspond to any subscriptions
- `403` — Unhauthorize (auth will change nothing).Your IP is not allowed.
- `412` — Missing parameter. Some parameters required for the webservices ar missing, please consult documentation
- `429` — Too many requests. You exceed the authorized rate
- `500` — Internal error

---

[API](https://skmtc.net/gisgraphy/apis/gisgraphy-webservices.md) · [All operations](https://skmtc.net/gisgraphy/apis/gisgraphy-webservices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gisgraphy/gisgraphy-webservices/versions/3f91690c0e06/schema)