interface TextSearchRequest {
    params: {
        language?: Language;
        location?: LatLng;
        maxprice?: number;
        minprice?: number;
        opennow?: boolean;
        pagetoken?: string;
        query: string;
        radius?: number;
        region?: string;
        type?: PlaceType1;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • TextSearchRequest

Properties

Properties

params: {
    language?: Language;
    location?: LatLng;
    maxprice?: number;
    minprice?: number;
    opennow?: boolean;
    pagetoken?: string;
    query: string;
    radius?: number;
    region?: string;
    type?: PlaceType1;
} & RequestParams

Type declaration

  • Optionallanguage?: Language

    The language code, indicating in which language the results should be returned, if possible. Note that we often update supported languages so this list may not be exhaustive

  • Optionallocation?: LatLng

    The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude. If you specify a location parameter, you must also specify a radius parameter.

  • Optionalmaxprice?: number

    Restricts results to only those places within the specified price level. Valid values are in the range from 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.

  • Optionalminprice?: number

    Restricts results to only those places within the specified price level. Valid values are in the range from 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.

  • Optionalopennow?: boolean

    Returns only those places that are open for business at the time the query is sent. Places that do not specify opening hours in the Google Places database will not be returned if you include this parameter in your query.

  • Optionalpagetoken?: string

    Returns the next 20 results from a previously run search. Setting a pagetoken parameter will execute a search with the same parameters used previously — all parameters other than pagetoken will be ignored.

  • query: string

    The text string on which to search, for example: "restaurant" or "123 Main Street". The Google Places service will return candidate matches based on this string and order the results based on their perceived relevance. This parameter becomes optional if the type parameter is also used in the search request.

  • Optionalradius?: number

    Defines the distance (in meters) within which to bias place results. The maximum allowed radius is 50 000 meters. Results inside of this region will be ranked higher than results outside of the search circle; however, prominent results from outside of the search radius may be included.

  • Optionalregion?: string

    The region code, specified as a ccTLD (country code top-level domain) two-character value. Most ccTLD codes are identical to ISO 3166-1 codes, with some exceptions. This parameter will only influence, not fully restrict, search results. If more relevant results exist outside of the specified region, they may be included. When this parameter is used, the country name is omitted from the resulting formatted_address for results in the specified region.

  • Optionaltype?: PlaceType1

    Restricts the results to places matching the specified type. Only one type may be specified (if more than one type is provided, all types following the first entry are ignored).