1. Przegląd

Usługi REST/JSON dostarczające powyższych funkcjonalności opierając się o dane referencyjne.

1.1. Informacja o wersji

Wersja : 1.0.2

1.2. Informacja o licencji

Licencja : Komercyjna
Warunki użycia : Wykorzystanie usługi wyszukiwania, identyfikacji, geokodowania i odwrotnego geokodowania w celach komercyjnych lub niekomercyjnych dozwolone jest bezpłatnie, pod warunkiem podania źródła.

1.3. Schemat URI

Host : geo.stat.gov.pl
Ścieżka bazowa : /
Schematy : HTTPS

1.4. Tagi

  • Usługa geokodowania : Usługa dostarcza funkcjonalności geokodowania w oparciu o dane referencyjne, tj. zwraca geometrię (oraz atrybuty powiązane z tą geometrią) w oparciu o alfanumeryczne dane określające lokalizacje. Podstawą geokodowania mogą być zarówno dane ustrukturalizowane (czyli dla adresu osobno miejscowość, ulica, numer), jak i dane zgromadzone w jedym polu (adres). Możliwa jest też kombinacja obu sposobów. Dane ustrukturalizowane zapewnią lepszą trafność usługi.

  • Usługa wyszukiwania danych referencyjnych : Wyszukiwanie pełnotekstowe i przestrzenne dla danych referencyjnych. Przeszukiwane są wybrane (lub wszystkie) referencyjne zasoby systemu.

2. Lokalizacja (URL) API

2.1. Środowisko produkcyjne

Adres usługi:

https://geo.stat.gov.pl/api/fts/

Ścieżki w poniższej dokumentacji podane względem:

https://geo.stat.gov.pl/

2.2. Środowisko testowe

Adres usługi:

https://testgeo.stat.gov.pl/api/fts/

Ścieżki w poniższej dokumentacji podane względem:

https://testgeo.stat.gov.pl/

3. Zasoby

3.1. Usługa Geokodowania

Usługa dostarcza funkcjonalności geokodowania w oparciu o dane referencyjne, tj. zwraca geometrię (oraz atrybuty powiązane z tą geometrią) w oparciu o alfanumeryczne dane określające lokalizacje. Podstawą geokodowania mogą być zarówno dane ustrukturalizowane (czyli dla adresu osobno miejscowość, ulica, numer), jak i dane zgromadzone w jedym polu (adres). Możliwa jest też kombinacja obu sposobów. Dane ustrukturalizowane zapewnią lepszą trafność usługi.

3.1.1. Geokodowanie gmin

POST /api/fts/gc/gmi
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

req

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

< GcResult > array

201

Created

Bez zawartości

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json

Przykład: Treść zapytania POST
  • Metoda HTTP: POST

  • Content-Type: application/json

  • Body:

{  "reqs": [
        {
          "teryt": "1204023",
          "gm_nazwa": "Dąbrowa Tarnowska"
        }
        ]
    }
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{  "reqs": [
        {
          "teryt": "1204023",
          "gm_nazwa": "Dąbrowa Tarnowska"
        }
        ]
    }
' \
https://geo.stat.gov.pl/api/fts/gc/gmi
Przykład: Odpowiedź
[
  {
    "id": null,
    "src": null,
    "single": {
      "id": 47228,
      "desc": "1204023 dąbrowski Małopolskie",
      "name": "Dąbrowa Tarnowska",
      "ftsid": "GUS_Admin/47228",
      "sort1": "dąbrowa tarnowska",
      "teryt": "1204023",
      "center": "50.1712465308548, 21.0226560738934",
      "record": {
        "id": 47228,
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                21.009171744,
                50.25003119
              ],
              [
                21.011147689,
                50.249970008
              ],
              ...
            ]
          ]
        },
        "properties": {
          "id": 47228,
          "gm_nazwa": "Dąbrowa Tarnowska",
          "pow_nazwa": "dąbrowski",
          "woj_nazwa": "Małopolskie",
          "gm_idteryt": "1204023",
          "pow_idteryt": "1204",
          "woj_idteryt": "12",
          "gm_id_wersjaid": "2021",
          "gm_id_lokalnyid": 47228,
          "pow_id_wersjaid": "2021",
          "woj_id_wersjaid": "2021",
          "pow_id_lokalnyid": 7228,
          "woj_id_lokalnyid": 305,
          "gm_id_przestrzenNazw": "GUS_Admin",
          "pow_id_przestrzenNazw": "GUS_Admin",
          "woj_id_przestrzenNazw": "GUS_Admin"
        }
      },
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              21.009171744,
              50.25003119
            ],
            [
              21.011147689,
              50.249970008
            ],
            ...
          ]
        ]
      },
      "gm_nazwa": "Dąbrowa Tarnowska",
      "longDesc": "dąbrowski Małopolskie GUS_Admin/47228",
      "pow_nazwa": "dąbrowski",
      "shortDesc": "Dąbrowa Tarnowska 1204023 47228",
      "woj_nazwa": "Małopolskie",
      "filterKeys": [
        "gmina"
      ],
      "es_metadata_id": "47228"
    },
    "relevance": 1.0,
    "source": "FTS"
  }
]

3.1.2. Geokodowanie jpa

POST /api/fts/gc/jpa
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

req

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

< GcResult > array

201

Created

Bez zawartości

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json

Przykład: Treść zapytania POST
  • Metoda HTTP: POST

  • Content-Type: application/json

  • Body:

{  "reqs": [
    {
      "teryt": "1204023",
      "gm_nazwa": "Dąbrowa Tarnowska"
    }
]}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{  "reqs": [
        {
          "teryt": "1204023",
          "gm_nazwa": "Dąbrowa Tarnowska"
        }
    ]}
' \
https://geo.stat.gov.pl/api/fts/gc/jpa
Przykład: Odpowiedź
[
  {
    "id": null,
    "src": null,
    "single": {
      "id": 47228,
      "desc": "1204023 dąbrowski Małopolskie",
      "name": "Dąbrowa Tarnowska",
      "ftsid": "GUS_Admin/47228",
      "sort1": "dąbrowa tarnowska",
      "teryt": "1204023",
      "center": "50.1712465308548, 21.0226560738934",
      "record": {
        "id": 47228,
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                21.009171744,
                50.25003119
              ],
              [
                21.011147689,
                50.249970008
              ],
              ...
            ]
          ]
        },
        "properties": {
          "id": 47228,
          "gm_nazwa": "Dąbrowa Tarnowska",
          "pow_nazwa": "dąbrowski",
          "woj_nazwa": "Małopolskie",
          "gm_idteryt": "1204023",
          "pow_idteryt": "1204",
          "woj_idteryt": "12",
          "gm_id_wersjaid": "2021",
          "gm_id_lokalnyid": 47228,
          "pow_id_wersjaid": "2021",
          "woj_id_wersjaid": "2021",
          "pow_id_lokalnyid": 7228,
          "woj_id_lokalnyid": 305,
          "gm_id_przestrzenNazw": "GUS_Admin",
          "pow_id_przestrzenNazw": "GUS_Admin",
          "woj_id_przestrzenNazw": "GUS_Admin"
        }
      },
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              21.009171744,
              50.25003119
            ],
            [
              21.011147689,
              50.249970008
            ],
            ...
          ]
        ]
      },
      "gm_nazwa": "Dąbrowa Tarnowska",
      "longDesc": "dąbrowski Małopolskie GUS_Admin/47228",
      "pow_nazwa": "dąbrowski",
      "shortDesc": "Dąbrowa Tarnowska 1204023 47228",
      "woj_nazwa": "Małopolskie",
      "filterKeys": [
        "gmina"
      ],
      "es_metadata_id": "47228"
    },
    "relevance": 1.0,
    "source": "FTS"
  }
]

3.1.3. Geokodowanie punktów adresowych

POST /api/fts/gc/pkt
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

req

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

< GcResult > array

201

Created

Bez zawartości

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json

Przykład: Treść zapytania POST
  • Metoda HTTP: POST

  • Content-Type: application/json

  • Body:

{  "reqs": [
        {
           "miejsc_nazwa": "dabrowa gornicza",
           "ul_pelna": "orzeszkowej",
           "pkt_numer": "15"
    }
    ],
    "useExtServiceIfNotFound": false
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{
  "reqs": [
    {
           "miejsc_nazwa": "dabrowa gornicza",
           "ul_pelna": "orzeszkowej",
           "pkt_numer": "15"
    }
  ],
    "useExtServiceIfNotFound": false
}
' \
https://geo.stat.gov.pl/api/fts/gc/pkt
Przykład: Odpowiedź
[
  {
    "id": null,
    "src": null,
    "single": {
      "id": 2717634,
      "ulc": "15209",
      "desc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
      "name": "Orzeszkowej 15 - Dąbrowa Górnicza",
      "simc": "0939473",
      "ftsid": null,
      "sort1": "15",
      "teryt": "2465011",
      "center": "50.3241846953428, 19.1971362995839",
      "loduri": null,
      "record": {
        "id": 2717634,
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            19.1971363,
            50.324184695
          ]
        },
        "properties": {
          "id": 2717634,
          "loduri": null,
          "ul_typ": null,
          "gm_nazwa": "Dąbrowa Górnicza",
          "pkt_numer": "15",
          "pow_nazwa": "Dąbrowa Górnicza",
          "woj_nazwa": "ŚLĄSKIE",
          "gm_idteryt": "2465011",
          "pkt_status": "opracowany",
          "ul_idTERYT": "15209",
          "pow_idteryt": "2465",
          "woj_idteryt": "24",
          "miejsc_nazwa": "Dąbrowa Górnicza",
          "miejsc_idTERYT": "0939473",
          "miejsc_n_nazwa": "Dąbrowa Górnicza",
          "ul_nazwa_czesc": null,
          "pkt_id_wersjaid": null,
          "pkt_kodPocztowy": "41-300",
          "ul_nazwa_glowna": "Orzeszkowej",
          "ul_nazwa_przed1": null,
          "ul_nazwa_przed2": null,
          "pkt_id_lokalnyid": null,
          "pkt_id_przestrzenNazw": null
        }
      },
      "ul_typ": null,
      "geometry": {
        "type": "Point",
        "coordinates": [
          19.1971363,
          50.324184695
        ]
      },
      "gm_nazwa": "Dąbrowa Górnicza",
      "longDesc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
      "ul_pelna": "Orzeszkowej",
      "pkt_numer": "15",
      "pow_nazwa": "Dąbrowa Górnicza",
      "shortDesc": "Orzeszkowej 15 Dąbrowa Górnicza",
      "woj_nazwa": "ŚLĄSKIE",
      "filterKeys": [
        "Dąbrowa Górnicza",
        "ŚLĄSKIE",
        "Dąbrowa Górnicza"
      ],
      "miejsc_nazwa": "Dąbrowa Górnicza",
      "miejsc_pelna": "Dąbrowa Górnicza",
      "pkt_numer_n1": null,
      "pkt_numer_n2": null,
      "miejsc_n_nazwa": "Dąbrowa Górnicza",
      "ul_nazwa_czesc": null,
      "pkt_kodPocztowy": "41-300",
      "ul_nazwa_glowna": "Orzeszkowej",
      "ul_nazwa_przed1": null,
      "ul_nazwa_przed2": null,
      "es_metadata_id": "2717634"
    },
    "relevance": 0.95,
    "source": "FTS"
  }
]
Przykład: Treść zapytania POST - pojedyncza linia
  • Metoda HTTP: POST

  • Content-Type: application/json

  • Body:

{  "reqs": [
        {
          "q": "Prezydencka 5 Warszawa",
          "src":"abc",
          "id": 123
        }
    ],
    "useExtServiceIfNotFound": false
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{  "reqs": [
            {
              "q": "Prezydencka 5 Warszawa",
              "src":"abc",
              "id": 123
            }
        ],
        "useExtServiceIfNotFound": false
    }

' \
https://geo.stat.gov.pl/api/fts/gc/pkt
Przykład: Odpowiedź
[
  {
    "id": 123,
    "src": "abc",
    "single": {
      "id": 5300270,
      "ulc": "17482",
      "desc": "gm. Ochota pow. Warszawa woj. MAZOWIECKIE",
      "name": "Prezydencka 5 - Ochota",
      "simc": "0918643",
      "ftsid": null,
      "sort1": "5",
      "teryt": "1465068",
      "center": "52.2174767130277, 21.001056836489",
      "loduri": null,
      "record": {
        "id": 5300270,
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            21.001056836,
            52.217476713
          ]
        },
        "properties": {
          "id": 5300270,
          "loduri": null,
          "ul_typ": null,
          "gm_nazwa": "Ochota",
          "pkt_numer": "5",
          "pow_nazwa": "Warszawa",
          "woj_nazwa": "MAZOWIECKIE",
          "gm_idteryt": "1465068",
          "pkt_status": "opracowana",
          "ul_idTERYT": "17482",
          "pow_idteryt": "1465",
          "woj_idteryt": "14",
          "miejsc_nazwa": "Ochota",
          "miejsc_idTERYT": "0918643",
          "miejsc_n_nazwa": "Ochota",
          "ul_nazwa_czesc": null,
          "pkt_id_wersjaid": null,
          "pkt_kodPocztowy": null,
          "ul_nazwa_glowna": "Prezydencka",
          "ul_nazwa_przed1": null,
          "ul_nazwa_przed2": null,
          "pkt_id_lokalnyid": null,
          "pkt_id_przestrzenNazw": null
        }
      },
      "ul_typ": null,
      "geometry": {
        "type": "Point",
        "coordinates": [
          21.001056836,
          52.217476713
        ]
      },
      "gm_nazwa": "Ochota",
      "longDesc": "gm. Ochota pow. Warszawa woj. MAZOWIECKIE",
      "ul_pelna": "Prezydencka",
      "pkt_numer": "5",
      "pow_nazwa": "Warszawa",
      "shortDesc": "Prezydencka 5 Ochota",
      "woj_nazwa": "MAZOWIECKIE",
      "filterKeys": [
        "Ochota",
        "MAZOWIECKIE",
        "Ochota"
      ],
      "miejsc_nazwa": "Ochota",
      "miejsc_pelna": "Ochota",
      "pkt_numer_n1": null,
      "pkt_numer_n2": null,
      "miejsc_n_nazwa": "Ochota",
      "ul_nazwa_czesc": null,
      "pkt_kodPocztowy": null,
      "ul_nazwa_glowna": "Prezydencka",
      "ul_nazwa_przed1": null,
      "ul_nazwa_przed2": null,
      "es_metadata_id": "5300270"
    },
    "relevance": 1.0,
    "source": "FTS"
  }
]

3.1.4. Geokodowanie powiatu

POST /api/fts/gc/pow
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

req

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

< GcResult > array

201

Created

Bez zawartości

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json

Przykład: Treść zapytania POST
  • Metoda HTTP: POST

  • Content-Type: application/json

  • Body:

{  "reqs": [
        {
            "pow_nazwa": "dabrowa gornicza"
        }
    ]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{  "reqs": [
            {
                "pow_nazwa": "dabrowa gornicza"
            }
        ]
    }
' \
https://geo.stat.gov.pl/api/fts/gc/pow
Przykład: Odpowiedź
[
  {
    "id": null,
    "src": null,
    "single": {
      "id": 7263,
      "desc": "2465 Śląskie",
      "name": "Dąbrowa Górnicza",
      "type": "Feature",
      "ftsid": "GUS_Admin/7263",
      "sort1": "dąbrowa górnicza",
      "teryt": "2465",
      "center": "50.3542638847427, 19.2997071450359",
      "record": {
        "id": 7263,
        "type": "Feature",
        "geometry": {
          "type": "MultiPolygon",
          "coordinates": [
            [
              [
                [
                  19.249781169,
                  50.43690859
                ],
                [
                  19.252943989,
                  50.435696282
                ],
                ...
              ]
            ]
          ]
        },
        "properties": {
          "id": 7263,
          "gm_nazwa": null,
          "pow_nazwa": "Dąbrowa Górnicza",
          "woj_nazwa": "Śląskie",
          "gm_idteryt": null,
          "pow_idteryt": "2465",
          "woj_idteryt": "24",
          "gm_id_wersjaid": null,
          "gm_id_lokalnyid": null,
          "pow_id_wersjaid": "2021",
          "woj_id_wersjaid": "2021",
          "pow_id_lokalnyid": 7263,
          "woj_id_lokalnyid": 306,
          "gm_id_przestrzenNazw": null,
          "pow_id_przestrzenNazw": "GUS_Admin",
          "woj_id_przestrzenNazw": "GUS_Admin"
        }
      },
      "geometry": {
        "type": "MultiPolygon",
        "coordinates": [
          [
            [
              [
                19.249781169,
                50.43690859
              ],
              [
                19.252943989,
                50.435696282
              ],
              ...
            ]
          ]
        ]
      },
      "longDesc": "Śląskie GUS_Admin/7263",
      "pow_nazwa": "Dąbrowa Górnicza",
      "shortDesc": "Dąbrowa Górnicza 2465 7263",
      "woj_nazwa": "Śląskie",
      "filterKeys": [
        "powiat"
      ],
      "es_metadata_id": "7263"
    },
    "relevance": 0.9,
    "source": "FTS"
  }
]

3.1.5. Geokodowanie województwa

POST /api/fts/gc/woj
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

req

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

< GcResult > array

201

Created

Bez zawartości

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json

Przykład: Treść zapytania POST
  • Metoda HTTP: POST

  • Content-Type: application/json

  • Body:

{  "reqs": [
        {
            "woj_nazwa": "lubelskie"
        }
    ]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{  "reqs": [
            {
            "woj_nazwa": "lubelskie"
            }
        ]
    }
' \
https://geo.stat.gov.pl/api/fts/gc/woj
Przykład: Odpowiedź
[
  {
    "id": null,
    "src": null,
    "single": {
      "id": 317,
      "desc": "06",
      "name": "Lubelskie",
      "type": "Feature",
      "ftsid": "GUS_Admin/317",
      "sort1": "lubelskie",
      "teryt": "06",
      "center": "51.2167052809027, 22.9031415994601",
      "record": {
        "id": 317,
        "type": "Feature",
        "geometry": {
          "type": "MultiPolygon",
          "coordinates": [
            [
              [
                [
                  23.178339686,
                  52.283143223
                ],
                [
                  23.181561913,
                  52.283235956
                ],
                ...
            ]
          ]
        ]
      },
      "longDesc": "GUS_Admin/317",
      "shortDesc": "Lubelskie 06 317",
      "woj_nazwa": "Lubelskie",
      "filterKeys": [
        "województwo"
      ],
      "es_metadata_id": "317"
    },
    "relevance": 1.0,
    "source": "FTS"
  }
]

3.2. Usługa Wyszukiwania Danych Referencyjnych

Wyszukiwanie pełnotekstowe i przestrzenne dla danych referencyjnych. Przeszukiwane są wybrane (lub wszystkie) referencyjne zasoby systemu.

3.2.1. Autocomplete

GET /api/fts/ref/ac
Opis

returns list of autocomplete words, based on before cursor (partial text) and after cursor text.Returned strings contains completed before text, without after part

Parametry
Typ Nazwa Opis Schemat Domyślnie

Query

a
opcjonalne

tekst po kursorze, pełne słowa

string

Query

b
opcjonalne

tekst przed kursorem, może zawierać częściowe słowo

string

Query

bbox
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty)

string

"all"

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

ter
opcjonalne

ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty)

string

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

< string > array

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json


TODO

Przykład: Treść (URL) zapytania GET
  • Metoda HTTP: GET

  • URL:

https://geo.stat.gov.pl/api/fts/ref/ac?b=mierzej&a=&cnt=10&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=18.681,54.586,18.828,54.660&bboxm=soft
Przykład: cURL
curl -X GET 'https://geo.stat.gov.pl/api/fts/ref/ac?b=mierzej&a=&cnt=10&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=18.681,54.586,18.828,54.660&bboxm=soft'
Przykład: Odpowiedź
["mierzejewskiego", "mierzejewskich", "mierzejowa", "mierzeja"]

3.2.2. Wyszukiwanie najbliższych , wywoływane przez POST

POST /api/fts/ref/qn
Opis

Zwraca listę wyników posortowaną wg. trafności i odległości od podanego zasięgu. Wyszukiwanie odbywa się na podstawie podanego tekstu oraz listy identyfikatorów zasobów podlegających wyszukiwaniu.Podany tekst może być pusty - wówczas wyszukiwanie obejmuje wszystkie rekordy. Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów.Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.

Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

req

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

string

201

Created

Bez zawartości

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json

Przykład: Treść zapytania POST
  • Metoda HTTP: POST

  • Content-Type: application/json

  • Body:

{
    "bbox": "16.73,44.41,21.26,58",
    "bboxm": "soft",
    "r": "pkt,ulc,jpa,prngof,prngjo",
    "cnt": 2,
    "offs": 0,
    "q": "1 maja 3 dabrowa gornicza",
    "tags": [
      ""
    ],
    "top": [
      "or"
    ]
  }
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{
    "bbox": "16.73,44.41,21.26,58",
    "bboxm": "soft",
    "r": "pkt,ulc,jpa,prngof,prngjo",
    "cnt": 2,
    "offs": 0,
    "q": "1 maja 3 dabrowa gornicza",
    "tags": [
      ""
    ],
    "top": [
      "or"
    ]
  }' \
https://geo.stat.gov.pl/api/fts/ref/qn
Przykład: Odpowiedź
{
  "type": "FeatureCollection",
  "crs": {
    "type": "name",
    "properties": {
      "name": "EPSG:4326"
    }
  },
  "_search": {
    "cntPerRes": {
      "pkt": 2
    },
    "tags": [
      {
        "tag": "Dąbrowa Górnicza",
        "cnt": 2
      },
      {
        "tag": "ŚLĄSKIE",
        "cnt": 2
      }
    ],
    "tagsPerRes": {
      "pkt": [
        {
          "tag": "Dąbrowa Górnicza",
          "cnt": 2
        },
        {
          "tag": "ŚLĄSKIE",
          "cnt": 2
        }
      ]
    },
    "time": 279,
    "total": 2,
    "extraTotal": 0,
    "max_score": 64.118835
  },
  "features": [
    {
      "id": "pkt#2720262",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          19.183817153,
          50.325114865
        ]
      },
      "properties": {
        "id": 2720262,
        "loduri": null,
        "ul_typ": null,
        "gm_nazwa": "Dąbrowa Górnicza",
        "pkt_numer": "1",
        "pow_nazwa": "Dąbrowa Górnicza",
        "woj_nazwa": "ŚLĄSKIE",
        "gm_idteryt": "2465011",
        "pkt_status": "opracowany",
        "ul_idTERYT": "11937",
        "pow_idteryt": "2465",
        "woj_idteryt": "24",
        "miejsc_nazwa": "Dąbrowa Górnicza",
        "miejsc_idTERYT": "0939473",
        "miejsc_n_nazwa": "Dąbrowa Górnicza",
        "ul_nazwa_czesc": null,
        "pkt_id_wersjaid": null,
        "pkt_kodPocztowy": "41-300",
        "ul_nazwa_glowna": "3 Maja",
        "ul_nazwa_przed1": null,
        "ul_nazwa_przed2": null,
        "pkt_id_lokalnyid": null,
        "pkt_id_przestrzenNazw": null
      },
      "_id": 2720262,
      "_search": {
        "score": 64.118835,
        "res": "pkt",
        "type": "spec_pkt",
        "id": "2720262",
        "name": "3 Maja 1 - Dąbrowa Górnicza",
        "desc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
        "source": "PRGAD"
      }
    },
    {
      "id": "pkt#2716617",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          19.197473635,
          50.326069019
        ]
      },
      "properties": {
        "id": 2716617,
        "loduri": null,
        "ul_typ": null,
        "gm_nazwa": "Dąbrowa Górnicza",
        "pkt_numer": "3",
        "pow_nazwa": "Dąbrowa Górnicza",
        "woj_nazwa": "ŚLĄSKIE",
        "gm_idteryt": "2465011",
        "pkt_status": "opracowany",
        "ul_idTERYT": "11926",
        "pow_idteryt": "2465",
        "woj_idteryt": "24",
        "miejsc_nazwa": "Dąbrowa Górnicza",
        "miejsc_idTERYT": "0939473",
        "miejsc_n_nazwa": "Dąbrowa Górnicza",
        "ul_nazwa_czesc": null,
        "pkt_id_wersjaid": null,
        "pkt_kodPocztowy": "41-300",
        "ul_nazwa_glowna": "1 Maja",
        "ul_nazwa_przed1": null,
        "ul_nazwa_przed2": null,
        "pkt_id_lokalnyid": null,
        "pkt_id_przestrzenNazw": null
      },
      "_id": 2716617,
      "_search": {
        "score": 63.980698,
        "res": "pkt",
        "type": "spec_pkt",
        "id": "2716617",
        "name": "1 Maja 3 - Dąbrowa Górnicza",
        "desc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
        "source": "PRGAD"
      }
    }
  ]
}

3.2.3. Wyszukiwanie najbliższych

GET /api/fts/ref/qn
Opis

Zwraca listę wyników posortowaną wg. trafności i odległości od podanego zasięgu. Wyszukiwanie odbywa się na podstawie podanego tekstu oraz listy identyfikatorów zasobów podlegających wyszukiwaniu.Podany tekst może być pusty - wówczas wyszukiwanie obejmuje wszystkie rekordy. Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów.Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.

Parametry
Typ Nazwa Opis Schemat Domyślnie

Query

bbox
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty)

string

"all"

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

ter
opcjonalne

ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty). NA RAZIE nie filtruje usług zewnętrznych.

string

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Query

useExtSvc
opcjonalne

true - użycie także zewnętrznej usługi (adresy,działki)

boolean

"false"

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

string

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json


Przykład: Treść (URL) zapytania GET
  • Metoda HTTP: GET

  • URL:

https://pdst.gispartner.pl/api/fts/ref/qn/?f=geojson&q=1+maja+3+dabrowa+gornicza&offs=0&cnt=50&idx=pkt&bbox=16.73,44.41,21.26,58.48&bboxm=soft&top=or
Przykład: cURL
curl -X GET 'https://pdst.gispartner.pl/api/fts/ref/qn/?f=geojson&q=1+maja+3+dabrowa+gornicza&offs=0&cnt=50&idx=pkt&bbox=16.73,44.41,21.26,58.48&bboxm=soft&top=or'
Przykład: Odpowiedź
{
  "type": "FeatureCollection",
  "crs": {
    "type": "name",
    "properties": {
      "name": "EPSG:4326"
    }
  },
  "_search": {
    "cntPerRes": {
      "pkt": 2
    },
    "tags": [
      {
        "tag": "Dąbrowa Górnicza",
        "cnt": 2
      },
      {
        "tag": "ŚLĄSKIE",
        "cnt": 2
      }
    ],
    "tagsPerRes": {
      "pkt": [
        {
          "tag": "Dąbrowa Górnicza",
          "cnt": 2
        },
        {
          "tag": "ŚLĄSKIE",
          "cnt": 2
        }
      ]
    },
    "time": 277,
    "total": 2,
    "extraTotal": 0,
    "max_score": 63.91378
  },
  "features": [
    {
      "id": "pkt#2720262",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          19.1838171534987,
          50.3251148653515
        ]
      },
      "properties": {
        "id": 2720262,
        "loduri": null,
        "ul_typ": null,
        "gm_nazwa": "Dąbrowa Górnicza",
        "pkt_numer": "1",
        "pow_nazwa": "Dąbrowa Górnicza",
        "woj_nazwa": "ŚLĄSKIE",
        "gm_idteryt": "2465011",
        "pkt_status": "opracowana",
        "ul_idTERYT": "11937",
        "pow_idteryt": "2465",
        "woj_idteryt": "24",
        "miejsc_nazwa": "Dąbrowa Górnicza",
        "miejsc_idTERYT": "0939473",
        "miejsc_n_nazwa": "Dąbrowa Górnicza",
        "ul_nazwa_czesc": null,
        "pkt_id_wersjaid": null,
        "pkt_kodPocztowy": "41-300",
        "ul_nazwa_glowna": "3 Maja",
        "ul_nazwa_przed1": null,
        "ul_nazwa_przed2": null,
        "pkt_id_lokalnyid": null,
        "pkt_id_przestrzenNazw": null
      },
      "_id": 2720262,
      "_search": {
        "score": 63.91378,
        "res": "pkt",
        "type": "spec_pkt",
        "id": "2720262",
        "name": "3 Maja 1 - Dąbrowa Górnicza",
        "desc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
        "source": "PRGAD"
      }
    },
    {
      "id": "pkt#2716617",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          19.197473634773,
          50.3260690187355
        ]
      },
      "properties": {
        "id": 2716617,
        "loduri": null,
        "ul_typ": null,
        "gm_nazwa": "Dąbrowa Górnicza",
        "pkt_numer": "3",
        "pow_nazwa": "Dąbrowa Górnicza",
        "woj_nazwa": "ŚLĄSKIE",
        "gm_idteryt": "2465011",
        "pkt_status": "opracowana",
        "ul_idTERYT": "11926",
        "pow_idteryt": "2465",
        "woj_idteryt": "24",
        "miejsc_nazwa": "Dąbrowa Górnicza",
        "miejsc_idTERYT": "0939473",
        "miejsc_n_nazwa": "Dąbrowa Górnicza",
        "ul_nazwa_czesc": null,
        "pkt_id_wersjaid": null,
        "pkt_kodPocztowy": "41-300",
        "ul_nazwa_glowna": "1 Maja",
        "ul_nazwa_przed1": null,
        "ul_nazwa_przed2": null,
        "pkt_id_lokalnyid": null,
        "pkt_id_przestrzenNazw": null
      },
      "_id": 2716617,
      "_search": {
        "score": 63.593758,
        "res": "pkt",
        "type": "spec_pkt",
        "id": "2716617",
        "name": "1 Maja 3 - Dąbrowa Górnicza",
        "desc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
        "source": "PRGAD"
      }
    }
  ]
}

3.2.4. Wyszukiwanie pełnotekstowe

GET /api/fts/ref/qq
Opis

Wyszukiwanie na podstawie podanego tekstu wśród danych referencyjnych (wszystkich lub wybranych). Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów. Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.

Parametry
Typ Nazwa Opis Schemat Domyślnie

Query

bbox
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty)

string

"all"

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

ter
opcjonalne

ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty). NA RAZIE nie filtruje usług zewnętrznych.

string

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Query

useExtOnly
opcjonalne

true - użycie tylko zewnętrznej usługi (działki)

boolean

"false"

Query

useExtSvc
opcjonalne

true - użycie także zewnętrznej usługi (adresy,działki)

boolean

"false"

Odpowiedzi
Kod HTTP Opis Schemat

200

OK

string

401

Unauthorized

Bez zawartości

403

Forbidden

Bez zawartości

404

Not Found

Bez zawartości

Konsumuje
  • application/json

Produkuje
  • application/json


Przykład: Treść (URL) zapytania GET
  • Metoda HTTP: GET

  • URL:

https://geo.stat.gov.pl/api/fts/ref/qq?f=geojson&q=1+maja+3+dabrowa+gornicza&offs=0&cnt=50&idx=pkt&&bbox=16.73,44.41,21.26,58.48&bboxm=soft&tag=&top=or&useExtSvc=false
Przykład: cURL
curl -X GET 'https://geo.stat.gov.pl/api/fts/ref/qq?f=geojson&q=1+maja+3+dabrowa+gornicza&offs=0&cnt=50&idx=pkt&&bbox=16.73,44.41,21.26,58.48&bboxm=soft&tag=&top=or&useExtSvc=false'
Przykład: Odpowiedź
{
  "type": "FeatureCollection",
  "crs": {
    "type": "name",
    "properties": {
      "name": "EPSG:4326"
    }
  },
  "_search": {
    "cntPerRes": {},
    "tags": [
      {
        "tag": "Dąbrowa Górnicza",
        "cnt": 2
      },
      {
        "tag": "ŚLĄSKIE",
        "cnt": 2
      }
    ],
    "tagsPerRes": {
      "pkt": [
        {
          "tag": "Dąbrowa Górnicza",
          "cnt": 2
        },
        {
          "tag": "ŚLĄSKIE",
          "cnt": 2
        }
      ]
    },
    "time": 52,
    "total": 2,
    "extraTotal": 0,
    "max_score": 1437.2946
  },
  "features": [
    {
      "id": "pkt#2720262",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          19.183817153,
          50.325114865
        ]
      },
      "properties": {
        "id": 2720262,
        "loduri": null,
        "ul_typ": null,
        "gm_nazwa": "Dąbrowa Górnicza",
        "pkt_numer": "1",
        "pow_nazwa": "Dąbrowa Górnicza",
        "woj_nazwa": "ŚLĄSKIE",
        "gm_idteryt": "2465011",
        "pkt_status": "opracowany",
        "ul_idTERYT": "11937",
        "pow_idteryt": "2465",
        "woj_idteryt": "24",
        "miejsc_nazwa": "Dąbrowa Górnicza",
        "miejsc_idTERYT": "0939473",
        "miejsc_n_nazwa": "Dąbrowa Górnicza",
        "ul_nazwa_czesc": null,
        "pkt_id_wersjaid": null,
        "pkt_kodPocztowy": "41-300",
        "ul_nazwa_glowna": "3 Maja",
        "ul_nazwa_przed1": null,
        "ul_nazwa_przed2": null,
        "pkt_id_lokalnyid": null,
        "pkt_id_przestrzenNazw": null
      },
      "_id": 2720262,
      "_search": {
        "score": 1437.2946,
        "res": "pkt",
        "type": "spec_pkt",
        "id": "2720262",
        "name": "3 Maja 1 - Dąbrowa Górnicza",
        "desc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
        "source": "PRGAD"
      }
    },
    {
      "id": "pkt#2716617",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          19.197473635,
          50.326069019
        ]
      },
      "properties": {
        "id": 2716617,
        "loduri": null,
        "ul_typ": null,
        "gm_nazwa": "Dąbrowa Górnicza",
        "pkt_numer": "3",
        "pow_nazwa": "Dąbrowa Górnicza",
        "woj_nazwa": "ŚLĄSKIE",
        "gm_idteryt": "2465011",
        "pkt_status": "opracowany",
        "ul_idTERYT": "11926",
        "pow_idteryt": "2465",
        "woj_idteryt": "24",
        "miejsc_nazwa": "Dąbrowa Górnicza",
        "miejsc_idTERYT": "0939473",
        "miejsc_n_nazwa": "Dąbrowa Górnicza",
        "ul_nazwa_czesc": null,
        "pkt_id_wersjaid": null,
        "pkt_kodPocztowy": "41-300",
        "ul_nazwa_glowna": "1 Maja",
        "ul_nazwa_przed1": null,
        "ul_nazwa_przed2": null,
        "pkt_id_lokalnyid": null,
        "pkt_id_przestrzenNazw": null
      },
      "_id": 2716617,
      "_search": {
        "score": 1432.6898,
        "res": "pkt",
        "type": "spec_pkt",
        "id": "2716617",
        "name": "1 Maja 3 - Dąbrowa Górnicza",
        "desc": "41-300 gm. Dąbrowa Górnicza pow. Dąbrowa Górnicza woj. ŚLĄSKIE",
        "source": "PRGAD"
      }
    }
  ]
}

4. Definicje

Poniższy rozdział zawiera opisy struktur danych, które są używane jako parametry lub wynik zapytań z rozdziału 3.

Wszystkie poniższe definicje należy rozumieć jako doprecyzowanie struktury i zawartości JSONów używanych / produkowanych przez opisywane usługi.

4.1. GcReqJpa

Struktura zapytania o geokodowanie jednostek podziału administracyjnego / gminy.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSingleJpa > array

4.2. GcReqPkt

Struktura zapytania o geokodowanie punktów adresowych.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista punktów adresowych do zgeokodowania

< GcSinglePkt > array

useExtServiceIfNotFound
opcjonalne

czy użyć zewnętrznych usug w przypadku nie znalezienia w FTS
Przykład : false

boolean

4.3. GcReqPow

Struktura zapytania o geokodowanie powiatu.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSinglePow > array

4.4. GcReqWoj

Struktura zapytania o geokodowanie województwa.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSingleWoj > array

4.5. GcResult

Struktura zwracania wyniku operacji geokodowania.

Nazwa Opis Schemat

distance
opcjonalne

dla odwrotnego geokodowania - odległość

number (double)

extTimeMs
opcjonalne

czas wywołania usług zewnętrznych w ms

integer (int64)

id
opcjonalne

wartość atrybutu id przekazana w wywołaniu zapytania

object

others
opcjonalne

pozostałe, mniej trafne wyniki - jeśli są

< object > array

relevance
opcjonalne

trafność wyniku, liczona dla najlepszego trafienia

number (double)

score
opcjonalne

dla geokodowania - punktacja wyszukiwania

number (double)

single
opcjonalne

najlepsze trafienie będące wynikiem zapytania

object

source
opcjonalne

pochodzenie wyniku wyszukiwania

string

src
opcjonalne

wartość atrybutu src przekazana w wywołaniu zapytania

object

xmessage
opcjonalne

string

4.6. GcSingleJpa

Parametry geokodowania JPA / gminy

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

gm_nazwa
opcjonalne

gmina

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

teryt

string

woj_nazwa
opcjonalne

województwo

string

4.7. GcSinglePkt

Parametry geokodowania punktu adresowego

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

gm_nazwa
opcjonalne

gmina

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

miejsc_n_nazwa
opcjonalne

nazwa miejscowości nadrzędnej

string

miejsc_nazwa
opcjonalne

nazwa miejscowości

string

pkt_kodPocztowy
opcjonalne

kod pocztowy

string

pkt_numer
opcjonalne

numer domu

string

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście adresu, gdy nie są wydzielone jego części

string

simc
opcjonalne

SIMC

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

TERYT

string

ul_nazwa_czesc
opcjonalne

część opcjonalna nazwy ulicy

string

ul_nazwa_glowna
opcjonalne

część główna nazwy ulicy

string

ul_nazwa_przed1
opcjonalne

przedrostek 1 nazwy ulicy

string

ul_nazwa_przed2
opcjonalne

przedrostek 2 nazwy ulicy

string

ul_pelna
opcjonalne

pełny tekst nazwy ulicy (nie rozbity na części)

string

ul_typ
opcjonalne

typ ulicy

string

ulc
opcjonalne

ULC

string

woj_nazwa
opcjonalne

województwo

string

4.8. GcSinglePow

Parametry geokodowania powiatu

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

teryt

string

woj_nazwa
opcjonalne

województwo

string

4.9. GcSingleWoj

Parametry geokodowania województwa

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

teryt

string

woj_nazwa
opcjonalne

województwo

string

4.10. QueryNearestRefRequest

Parametry wyszukiwania najbliższych danych referencyjnch dla wywołania POST.

Nazwa Opis Schemat

bbox
opcjonalne

ekstent w postaci: x1,y1,x2,y2. Nie może być pusty!

string

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

offs
opcjonalne

ofset

integer (int32)

q
opcjonalne

tekst zapytania

string

r
opcjonalne

dane referencyjne zwracane w ramach zapytania: all | pkt,ulc,… | none | (empty)

string

tags
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array

ter
opcjonalne

ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty). NA RAZIE nie filtruje usług zewnętrznych.

string

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array