---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geolocation.md
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geolocation.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt

# geolocation

Статический объект.

Предоставляет информацию о местоположении пользователя.

[Методы ](#methods-summary)

## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geolocation.md#get)(\[[options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geolocation.md#get-param-options)]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Пытается определить местоположение пользователя. Возвращает объект-promise, который будет либо подтверждён объектом с полем geoObjects, либо отклонён с сообщением об ошибке. Поле geoObjects является экземпляром [GeoObjectCollection](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObjectCollection.md). В коллекцию будет добавлен объект, обозначающий текущее местоположение пользователя. ||
|#

# Описание методов {#method_detail}

### get {#get}

```javascript
{vow.Promise} get([options])
```

Пытается определить местоположение пользователя. Возвращает объект-promise, который будет либо подтверждён объектом с полем geoObjects, либо отклонён с сообщением об ошибке. Поле geoObjects является экземпляром [GeoObjectCollection](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObjectCollection.md). В коллекцию будет добавлен объект, обозначающий текущее местоположение пользователя.

**Возвращает** объект-promise.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`options`](#get-param-options) | — | Тип: ||
|| [`options.autoReverseGeocode`](#get-param-options.autoReverseGeocode) | true | Тип:

true - автоматически прогеокодировать положение пользователя, false - вернуть как есть. В случае автоматического геокодирования объект, обозначающий текущее местоположение пользователя, будет иметь структуру, аналогичную результату выполнения [geocode](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geocode.md). ||
|| [`options.mapStateAutoApply`](#get-param-options.mapStateAutoApply) | false | Тип:

true - при добавлении на карту автоматически выставить центр и уровень масштабрования карты так, чтобы показать текущее местоположение пользователя, false - ничего не делать. ||
|| [`options.provider`](#get-param-options.provider) | 'auto' | Тип:

Провайдер геолокации. Допустимые значения: 'yandex' - геолокация по данным Яндекса на основе ip пользователя, 'browser' - встроенная браузерная геолокация, 'auto' - провести геолокацию всеми доступными способами и выбрать лучшее значение. ||
|| [`options.timeout`](#get-param-options.timeout) | 30000 | Тип:

Время ожидания ответа в мс. ||
|| [`options.useMapMargin`](#get-param-options.useMapMargin) | true | Тип: Boolean

Нужно ли учитывать отступы карты [map.margin.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md) при автоматическом выставлении центра и уровня масштаба карте. ||
|#


**Примеры:**

**1.**

```javascript
ymaps.geolocation.get({
    // Выставляем опцию для определения положения по ip    
    provider: 'yandex',
    // Карта автоматически отцентрируется по положению пользователя.
    mapStateAutoApply: true
}).then(function (result) {
    myMap.geoObjects.add(result.geoObjects);
});
```

**2.**

```javascript
ymaps.geolocation.get({
    // Зададим способ определения геолокации
    // на основе ip пользователя.
    provider: 'yandex',
    // Включим автоматическое геокодирование результата.
    autoReverseGeocode: true
}).then(function (result) {
    // Выведем результат геокодирования.
    console.log(result.geoObjects.get(0).properties.get('metaDataProperty'));
});
```

<!-- XLIFF_FARM_YTYzMzIx_CACHING -->