interface PlacesNearbyRequest {
    params: {
        keyword?: string;
        language?: Language;
        location: LatLng;
        maxprice?: number;
        minprice?: number;
        name?: string;
        opennow?: boolean;
        pagetoken?: string;
        radius?: number;
        rankby?: PlacesNearbyRanking;
        type?: string;
    } & RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • PlacesNearbyRequest

Properties

Properties

params: {
    keyword?: string;
    language?: Language;
    location: LatLng;
    maxprice?: number;
    minprice?: number;
    name?: string;
    opennow?: boolean;
    pagetoken?: string;
    radius?: number;
    rankby?: PlacesNearbyRanking;
    type?: string;
} & RequestParams

Type declaration

  • Optionalkeyword?: string

    A term to be matched against all content that Google has indexed for this place, including but not limited to name, type, and address, as well as customer reviews and other third-party content.

  • 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.

  • location: LatLng

    The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude.

  • Optionalmaxprice?: number

    Restricts results to only those places within the specified range. Valid values range between 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 range. Valid values range between 0 (most affordable) to 4 (most expensive), inclusive. The exact amount indicated by a specific value will vary from region to region.

  • Optionalname?: string

    A term to be matched against all content that Google has indexed for this place. Equivalent to keyword. The name field is no longer restricted to place names. Values in this field are combined with values in the keyword field and passed as part of the same search string. We recommend using only the keyword parameter for all search terms.

  • 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.

  • Optionalradius?: number

    Defines the distance (in meters) within which to return place results. The maximum allowed radius is 50 000 meters. Note that radius must not be included if rankby=distance is specified.

  • Optionalrankby?: PlacesNearbyRanking

    Specifies the order in which results are listed. Note that rankby must not be included if radius is specified.

    PlacesNearbyRanking.prominence
    
  • Optionaltype?: string

    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).