Interface GeolocateRequest

interface GeolocateRequest {
    data: {
        carrier?: string;
        cellTowers?: CellTower[];
        considerIp?: boolean;
        homeMobileCountryCode?: number;
        homeMobileNetworkCode?: number;
        radioType?: RadioType;
        wifiAccessPoints?: WifiAccessPoint[];
    };
    params: RequestParams;
}

Hierarchy

  • Partial<AxiosRequestConfig>
    • GeolocateRequest

Properties

data params

Properties

data

data: {
    carrier?: string;
    cellTowers?: CellTower[];
    considerIp?: boolean;
    homeMobileCountryCode?: number;
    homeMobileNetworkCode?: number;
    radioType?: RadioType;
    wifiAccessPoints?: WifiAccessPoint[];
}

Type declaration

  • Optionalcarrier?: string

    The carrier name.

  • OptionalcellTowers?: CellTower[]

    An array of cell tower objects.

  • OptionalconsiderIp?: boolean

    Specifies whether to fall back to IP geolocation if wifi and cell tower signals are not available. Defaults to true. Set considerIp to false to disable fall back.

  • OptionalhomeMobileCountryCode?: number

    The mobile country code (MCC) for the device's home network.

  • OptionalhomeMobileNetworkCode?: number

    The mobile network code (MNC) for the device's home network.

  • OptionalradioType?: RadioType

    The mobile radio type. While this field is optional, it should be included if a value is available, for more accurate results.

  • OptionalwifiAccessPoints?: WifiAccessPoint[]

    An array of WiFi access point objects.

params

params: RequestParams

Settings

Member Visibility

On This Page

Properties