pynspd.Nspd

`pynspd.Nspd`

Клиент для НСПД

Example:

with pynspd.Nspd() as nspd:
    feat = nspd.find_zu("77:05:0001005:19")

Parameters:

Name	Type	Description	Default
`timeout`	`Optional[int]`	Время ожидания ответа. Если не установлен - есть вероятность бесконечного ожидания. По умолчанию None.	`None`
`retries`	`int`	Количество попыток при неудачном запросе (таймаут, неожиданный обрыв соединения, 5хх ошибки). По умолчанию 10.	`10`
`proxy`	`Optional[ProxyTypes]`	Использовать прокси для запросов. По умолчанию None.	`None`
`cache_storage`	`Optional[BaseStorage]`	Настройка хранения кэша (см. https://hishel.com/advanced/storages/). Если установлен, то при повторном запросе результат будет извлекаться из хранилища кэша, что сильно увеличивает производительность и снижает риск ошибки 429 - Too many requests. По умолчанию None.	`None`

`close()`

Завершение сессии

`find(query, theme_id=ThemeId.REAL_ESTATE_OBJECTS)`

Найти объект по предустановленной теме

Parameters:

Name	Type	Description	Default
`query`	`str`	Поисковой запрос	required
`theme_id`	`ThemeId`	Вид объекта (кадастровое деление, объект недвижимости и т.д.). По умолчанию: объекты недвижимости	`REAL_ESTATE_OBJECTS`

Returns:

Type	Description
`Optional[NspdFeature]`	Положительный ответ от сервиса, либо None, если ничего не найдено

`find_building(query)`

Найти ОКС по кадастровому номеру

`find_in_layer(query, layer_def)`

Найти объект по определению слоя

Parameters:

Name	Type	Description	Default
`query`	`str`	Поисковой запрос	required
`layer_def`	`Type[Feat]`	Определение слоя	required

Returns:

Type	Description
`Optional[Feat]`	Валидированная модель слоя, если найдено

`find_landplot(query)`

Найти ЗУ по кадастровому номеру

`find_oks(query)`

Найти ОКС по кадастровому номеру

`find_zu(query)`

Найти ЗУ по кадастровому номеру

`request(method, url, params=None, json=None)`

Базовый запрос к API НСПД

`safe_request(method, url, params=None, json=None)`

Базовый запрос к api НСПД с обработкой ошибок

`search(query, theme_id=ThemeId.REAL_ESTATE_OBJECTS)`

Поисковой запрос по предустановленной теме

Parameters:

Name	Type	Description	Default
`query`	`str`	Поисковой запрос	required
`theme_id`	`ThemeId`	Вид объекта (кадастровое деление, объект недвижимости и т.д.). По умолчанию: объекты недвижимости	`REAL_ESTATE_OBJECTS`

Returns:

Type	Description
`Optional[list[NspdFeature]]`	Положительный ответ от сервиса, либо None, если ничего не найдено

`search_at_coords(lat, lng, layer_def)`

Поиск объектов слоя в координатах

Parameters:

Name	Type	Description	Default
`lat`	`float`	Широта	required
`lng`	`float`	Долгота	required
`layer_def`	`Type[Feat]`	Тип слоя	required

Returns:

Type	Description
`Optional[list[Feat]]`	Типизированный список объектов, если найдены

`search_at_point(pt, layer_def)`

Поиск объектов слоя в точке (с типизацией)

Parameters:

Name	Type	Description	Default
`pt`	`Point`	Точка поиска	required
`layer_def`	`Type[Feat]`	Тип слоя	required

Returns:

Type	Description
`Optional[list[Feat]]`	Типизированный список объектов, если найдены

`search_buildings(cn)`

Поиск ОКС по кадастровому номеру

`search_buildings_at_coords(lat, lng)`

Поиск ОКС в координатах

`search_buildings_at_point(pt)`

Поиск ОКС в точке

`search_buildings_in_contour(countour)`

Поиск ОКС в контуре

`search_buildings_in_contour_iter(countour, *, only_intersects=False)`

Поиск ОКС в контуре

`search_in_contour(countour, layer_def)`

Поиск объектов слоя в контуре

Parameters:

Name	Type	Description	Default
`countour`	`Union[Polygon, MultiPolygon]`	Геометрический объект с контуром	required
`layer_def`	`Type[Feat]`	Модель слоя	required

Raises:

Type	Description
`TooBigContour`	Слишком много объектов в контуре

Returns:

Type	Description
`Optional[list[Feat]]`	Список объектов, пересекающихся с контуром, если найден хоть один

`search_in_contour_iter(countour, layer_def, *, only_intersects=False)`

Поиск объектов в указанных границах.

Внимание: количество запросов кратно зависит от площади поиска. Если вы хотите вручную обрабатывать ошибку TooBigContour, используйте метод search_in_contour(...)

Parameters:

Name	Type	Description	Default
`countour`	`Union[Polygon, MultiPolygon]`	Геометрический объект с контуром	required
`layer_def`	`Type[Feat]`	Модель слоя	required
`only_intersects`	`bool`	Возвращать только те объекты, которые пересекаются с изначальным контуром. По умолчанию False	`False`

Returns:

Type	Description
`None`	Генератор объектов слоя в указанной области

`search_in_layer(query, layer_def)`

Поиск объекта по определению слоя

Parameters:

Name	Type	Description	Default
`query`	`str`	Поисковой запрос	required
`layer_def`	`Type[Feat]`	Определение слоя	required

Returns:

Type	Description
`Optional[list[Feat]]`	Валидированная модель слоя, если найдено

`search_landplots(cn)`

Поиск ЗУ по кадастровому номеру

`search_landplots_at_coords(lat, lng)`

Поиск ЗУ в координатах

`search_landplots_at_point(pt)`

Поиск ЗУ в точке

`search_landplots_in_contour(countour)`

Поиск ЗУ в контуре

`search_landplots_in_contour_iter(countour, *, only_intersects=False)`

Поиск ЗУ в контуре

`search_oks(cn)`

Поиск ОКС по кадастровому номеру

`search_oks_at_coords(lat, lng)`

Поиск ОКС в координатах

`search_oks_at_point(pt)`

Поиск ОКС в точке

`search_oks_in_contour(countour)`

Поиск ОКС в контуре

`search_oks_in_contour_iter(countour, *, only_intersects=False)`

Поиск ОКС в контуре

`search_zu(cn)`

Поиск ЗУ по кадастровому номеру

`search_zu_at_coords(lat, lng)`

Поиск ЗУ в координатах

`search_zu_at_point(pt)`

Поиск ЗУ в точке

`search_zu_in_contour(countour)`

Поиск ЗУ в контуре

`search_zu_in_contour_iter(countour, *, only_intersects=False)`

Поиск ЗУ в контуре

`tab_build_parts(feat)`

Получение данных с вкладки "Части ОКС"

`tab_composition_land(feat)`

Получение данных с вкладки "Состав ЕЗП"

`tab_land_links(feat)`

Получение данных с вкладки "Связанные ЗУ"

`tab_land_parts(feat)`

Получение данных с вкладки "Части ЗУ"

`tab_objects_list(feat)`

Получение данных с вкладки "Объекты"

`tab_permission_type(feat)`

Получение данных с вкладки "Виды разрешенного использования"