Główny Urząd Geodezji i Kartografii

Specyfikacja usługi ULDK

Usługa ULDK umożliwia wyszukiwanie obiektów oraz współrzędnych na podstawie identyfikatora szukanego obiektu lub poprzez wskazanie współrzędnych XY punktu, który znajduje się wewnątrz obiektu.

Metody wywołania usługi (Endpoints)

API obsługuje zapytania typu GET. Poniżej znajdują się dostępne metody strukturyzacji zapytań:

1. Przez identyfikator szukanego obiektu

GET https://uldk.gugik.gov.pl/?request={request}&id={id}&result={result}

2. Przez pełen identyfikator działki lub nazwę obrębu i numer działki

GET https://uldk.gugik.gov.pl/?request=GetParcelByIdOrNr&id={id}&result={result}

3. Wyszukanie obiektu we wskazanym punkcie (Przez współrzędne)

GET https://uldk.gugik.gov.pl/?request={request}&xy={xy}&result={result}

4. Snapowanie (Przyciąganie do najbliższego punktu załamania działki)

GET https://uldk.gugik.gov.pl/?request=SnapToPoint&xy={xy}&radius={radius}&result={result}

5. Łączenie geometrii działek o podanych identyfikatorach

GET https://uldk.gugik.gov.pl/?request=GetAggregateArea&id={id}&result={result}

Konsola testowa API

Wybierz metodę, uzupełnij parametry i przetestuj działanie usługi ULDK na żywo.

Parametr request (Operacja)

Identyfikator (id)

Współrzędne (xy)

Identyfikator (id)

Promień wyszukiwania (radius w metrach)

Zwracane atrybuty (result - opcjonalnie, rozdzielane przecinkiem)

Układ współrzędnych wyników (srid)

Generowany URL testowy:

https://uldk.gugik.gov.pl/?request=GetParcelById&id=141201_1.0001.6509&result=id,teryt,parcel,voivodeship&srid=2180

Pobieranie danych z serwera GUGiK...

Odpowiedź z serwera:

Parametry zapytania (Query Parameters)

Parametr	Typ	Opis	Wartości / Format / Przykłady
`request`	string wymagany	Określa rodzaj operacji oraz poszukiwanego obiektu.	Dla identyfikatora / współrzędnych: `GetParcelById` / `GetParcelByXY` - działka `GetBuildingById` / `GetBuildingByXY` - budynek `GetRegionById` / `GetRegionByXY`- obręb (PRG) `GetRegionByNameOrId` - obręb po ID lub nazwie TERYT (PRG) `GetCommuneById` / `GetCommuneByXY` gmina (PRG) `GetCountyById` / `GetCountyByXY` - powiat (PRG) `GetVoivodeshipById` / `GetVoivodeshipByXY` - województwo (PRG) Inne metody: `GetParcelByIdOrNr` - działka po indentyfikatorze (np. 141201_1.0001.6509) lub nazwie obrębu i numerze działki (np. Krzewina 134), `SnapToPoint`, `GetAggregateArea`
`id`	string	Identyfikator obiektu lub obiektów (rozdzielone przecinkami dla `GetAggregateArea`).	• Działka: `WWPPGG_R.OOOO.[AR_NR.].NR_DZ` (np. 141201_1.0001.6509) • Budynek: `WWPPGG_R.OOOO.NR_DZ.Nr_BUD` (np. 141301_1.0010.713/2.5_BUD) • Obręb: `WWPPGG_R.OOOO` • Gmina: `WWPPGG_R` \| Powiat: `WWPP` \| Województwo: `WW` • Dla `GetParcelByIdOrNr` dopuszczalne również: `Nazwa numer` (np. Krzewina 134)
`xy`	string	Współrzędne punktu wyszukiwania. Kolejność zgodna z reprezentacją WKT dla wybranego układu.	• `X,Y` - domyślny układ PUWG 1992 • `X,Y,SRID` - specyficzny układ (np. `460166.4,313380.5,2180`)
`radius`	double	Promień wyszukiwania w metrach stosowany wyłącznie przy funkcji `SnapToPoint`.	Domyślnie: `1` (np. `radius=15`)
`srid`	integer	Kod EPSG układu współrzędnych, w którym ma zostać zwrócona geometria.	Domyślnie: `2180` (PUWG 1992). Przykład: `srid=4326`
`result`	string	Opcjonalny parametr określający zwracane atrybuty (wartości oddzielone przecinkami).	`geom_wkb` - geometria w formacie wbk (domyślny), `geom_wkt` - geometria w formacie wbk, `geom_extent` - zasięg geometryczny obiektu (bbox), `teryt` - identyfikator TERYT obiektu (np. 141201_1.0001.6509), `id` - identyfikator TERYT obiektu (np. 141201_1.0001.6509), `function` - funkcja (dla budynków), `voivodeship` - nazwa województwa, `county` - nazwa powiatu, `commune` - nazwa gminy , `region` - nazwa obrębu lub numer, `parcel` - numer działki, `datasource` - informacja o pochodzeniu danych zwróconych przez usługę

Uwagi techniczne:

Geometria zwracana jest domyślnie w układzie PUWG 1992 (EPSG:2180).
Dla metody GetParcelByIdOrNr w pierwszym wierszu odpowiedzi zwracana jest liczba znalezionych działek.
Funkcja SnapToPoint oprócz geometrii punktu zwraca również odległość wskazanego punktu od punktu znalezionego.
Funkcja GetAggregateArea zwraca pojedynczą geometrię typu POLYGON dla działek sąsiadujących, a w przypadku działek niegraniczących ze sobą - MULTIPOLYGON.
voivodeship, county, commune, region jeśli informacja dot. działki z powiatu nie zawiera takich pól, to są one uzupełniane z PRG

Przykłady wykorzystania

Metody wywołania usługi (Endpoints)

1. Przez identyfikator szukanego obiektu

2. Przez pełen identyfikator działki lub nazwę obrębu i numer działki

3. Wyszukanie obiektu we wskazanym punkcie (Przez współrzędne)

4. Snapowanie (Przyciąganie do najbliższego punktu załamania działki)

5. Łączenie geometrii działek o podanych identyfikatorach

Konsola testowa API

Parametry zapytania (Query Parameters)

Przykłady wykorzystania

1. Wyszukanie działki przez identyfikator (parametry podstawowe)

2. Wyszukanie działki po nazwie obrębu i numerze z określeniem rezultatu

3. Wyszukanie obiektu we wskazanych współrzędnych XY

4. Snapowanie do najbliższego punktu załamania

5. Łączenie geometrii dla kilku sąsiadujących działek