Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LocationAPI

Location API Playground: https://developer.accuweather.com/accuweather-locations-api/apis

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

apikey

apikey: string

Accu Weather API key.

Private axiosInstance

axiosInstance: AxiosInstance

The instance that send requests to API

detail

detail: boolean

Whether return full object when searching

language

language: string

Language of retrieve data

offset

offset: number

The limit that determines the first resource to be returned

Methods

PostalCodeSearch

  • PostalCodeSearch(query: string, countryCode?: string): Promise<ICityData[]>

  • Get information for an array of Postal Codes that match the search text.

    Parameters

    • query: string

      Text to search for.

    • Optional countryCode: string

      Country code

    Returns Promise<ICityData[]>

    Search Data

SearchByLocationKey

  • SearchByLocationKey(locationKey: string): Promise<ICityData[]>

  • Get information about a specific location, by location key. You must know the location key to perform this query.

    Parameters

    • locationKey: string

      Location Key

    Returns Promise<ICityData[]>

    Search Data

TextSearch

  • TextSearch(query: string, countryCode?: string, adminCode?: string): Promise<ICityData[]>

  • Get information for an array of locations that match the search text

    Parameters

    • query: string

      Text to search for.

    • Optional countryCode: string

      Country code

    • Optional adminCode: string

      Adminstractive area code

    Returns Promise<ICityData[]>

    Search Data

autocompleteSearch

  • Get basic information about locations matching an autocomplete of the search text.

    Parameters

    • query: string

      Text to use for Autocomplete search

    Returns Promise<IAutoCompleteSearchData[]>

    Auto Complete Search Data

citySearch

  • citySearch(query: string, countryCode?: string, adminCode?: string): Promise<ICityData[]>

  • Get information for an array of cities that match the search text.

    Parameters

    • query: string

      Text to search for.

    • Optional countryCode: string

      Country code

    • Optional adminCode: string

      Adminstractive area code

    Returns Promise<ICityData[]>

    Search Data

geopositionSearch

  • geopositionSearch(lag: number, lng: number, topLevel?: boolean): Promise<ICityData[]>

  • Get information about a specific location, by GeoPosition (Latitude and Longitude).

    Parameters

    • lag: number
    • lng: number

      Longitude.

    • Optional topLevel: boolean

    Returns Promise<ICityData[]>

    Search Data

getAdminAreaList

  • Get basic information about administrative areas in the specified country.

    Parameters

    • countryCode: string

      Country Code

    Returns Promise<IAdminAreaData[]>

    Administrative areas

getCityNeighborsByLocationKey

  • getCityNeighborsByLocationKey(locationKey: string): Promise<ICityData[]>

  • Get information about neighboring cities, by location key. You must know the location key to perform this query.

    Parameters

    • locationKey: string

      Location Key

    Returns Promise<ICityData[]>

    CityNeighbors data

getCountryList

  • Get basic information about all countries within a specified region.

    Parameters

    • region: string

      region string

    Returns Promise<ICountryData[]>

    Countries Datas

getRegionList

  • Get basic information about all regions.

    Returns Promise<IRegionData[]>

    Region Datas

getTopCities

  • getTopCities(group: 50 | 100 | 150): Promise<ICityData[]>

  • Get information for the top 50, 100, or 150 cities, worldwide.

    Parameters

    • group: 50 | 100 | 150

      number of cities to return

    Returns Promise<ICityData[]>

    City Datas

Protected handleError

ipSearch

  • ipSearch(query: string): Promise<ICityData[]>

  • Get information for an array of Points of Interest that match the search text.

    Parameters

    • query: string

      Text to search for.

    Returns Promise<ICityData[]>

    Search Data

pointOfInterestSearch

  • pointOfInterestSearch(query: string, countryCode?: string, adminCode?: string): Promise<ICityData[]>

  • Get information for an array of Points of Interest that match the search text.

    Parameters

    • query: string

      Text to search for.

    • Optional countryCode: string

      Country code

    • Optional adminCode: string

      Adminstractive area code

    Returns Promise<ICityData[]>

    Search Data

Generated using TypeDoc