1---
2category: Sensors
3---
4 
5# useGeolocation
6 
7Reactive [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API). It allows the user to provide their location to web applications if they so desire. For privacy reasons, the user is asked for permission to report location information.
8 
9## Usage
10 
11```ts
12import { useGeolocation } from '@vueuse/core'
13 
14const { coords, locatedAt, error, resume, pause } = useGeolocation()
15```
16 
17| State     | Type                                                                          | Description                                                              |
18| --------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
19| coords    | [`Coordinates`](https://developer.mozilla.org/en-US/docs/Web/API/Coordinates) | information about the position retrieved like the latitude and longitude |
20| locatedAt | `Date`                                                                        | The time of the last geolocation call                                    |
21| error     | `string`                                                                      | An error message in case geolocation API fails.                          |
22| resume    | `function`                                                                    | Control function to resume updating geolocation                          |
23| pause     | `function`                                                                    | Control function to pause updating geolocation                           |
24 
25## Config
26 
27`useGeolocation` function takes [PositionOptions](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions) object as an optional parameter.
28 
29## Component Usage
30 
31```vue
32<template>
33  <UseGeolocation v-slot="{ coords: { latitude, longitude } }">
34    Latitude: {{ latitude }}
35    Longitude: {{ longitude }}
36  </UseGeolocation>
37</template>
38```
39 
40## Type Declarations
41 
42```ts
43export interface UseGeolocationOptions
44  extends Partial<PositionOptions>, ConfigurableNavigator {
45  immediate?: boolean
46}
47export interface UseGeolocationReturn extends Supportable {
48  coords: Ref<Omit<GeolocationPosition["coords"], "toJSON">>
49  locatedAt: ShallowRef<number | null>
50  error: ShallowRef<GeolocationPositionError | null>
51  resume: () => void
52  pause: () => void
53}
54/**
55 * Reactive Geolocation API.
56 *
57 * @see https://vueuse.org/useGeolocation
58 * @param options
59 */
60export declare function useGeolocation(
61  options?: UseGeolocationOptions,
62): UseGeolocationReturn
63```
64