# Get Location Data

Access a wide range of public information about specific location

## Required inputs

### Country ID

By an international system of **<https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>**

| State | ISO 3166-1 alpha-2 |
| --- | --- |
| Czech Republic | CZ |
| Poland | PL |
| Slovakia | SK |

### Location ID

| State | Internal or External ID |
| --- | --- |
| Czech Republic | RÚIAN - Registru územní identifikace adres a nemovitostí |
| Poland | Government data |
| Slovakia | - Does not use external IDs |

## What can you set?

| Data scope | Content |
| --- | --- |
| Empty | The setting will be set to the default state, which in this case means 'Full'. |
| Basic | Retrieves the address associated with a specific ID. You can obtain the address in several different formats, depending on your needs. |
| Full | The full data scope provides the same information as the basic version but with additional details. For example, it includes the region, the name of the district, whether it has external IDs, and its GPS coordinates. The availability of data varies depending on the state. For information about availability, refer to [Location datasopes](https://foxentry.dev/api/location/datascopes). |

| Data source | Content |
| --- | --- |
| CZ | Addresses and locations from the Czech Republic. |
| PL | Addresses and locations from Poland. |
| SK | Addresses and locations from Slovakia. |

| ZIP format | Content |
| --- | --- |
| Yes | This option determines the format in which the ZIP is returned - 130 00. |
| No | This option determines the format in which the ZIP is returned - 13000. |
| Empty | The setting will be set to the default state, which in this case means 'No'. |

| City format | Content |
| --- | --- |
| Yes | The setting will be set to the default state, which in this case means ''. |
| Minimal | This option determines the format in which the city is returned - Praha. |
| Basic | This option determines the format in which the city is returned - Praha 8. |
| Extended | This option determines the format in which the city is returned - Praha 8 - Karlín. |

## What can you find in the response?

To generate the optimal output for your selected data scope, run the module independently. This allows you to map the API response outputs seamlessly.

### Basic

```json
{
  "status": 200,
  "request": { "endpoint": "location/get", "code": "a7366961-3183-4df8-8927-9e1aa89a1530" },
  "response": {
    "results": [
      {
        "data": {
          "country": "CZ",
          "ids": { "internal": "d2ade877-1e95-4a83-baa6-54...", "external": "22349995" },
          "street": "Thámova",
          "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" },
          "streetWithNumber": "Thámova 137/16",
          "city": "Praha 8",
          "zip": "186 00",
          "full": "Thámova 137/16, 186 00 Praha 8"
        }
      }
    ]
  },
  "errors": []
}
```

### Full data set

```json
{
  "status": 200,
  "request": { "endpoint": "location/get", "code": "02333c36-ad60-47dd-b5ef-4cc3cfa49e0e" },
  "response": {
    "results": [
      {
        "data": {
          "country": "CZ",
          "region": "Hlavní město Praha",
          "district": "území Hlavního města Prahy",
          "cityDistrictSpecial": "Praha 8",
          "cityDistrict": "Praha 8",
          "cityPart": "Karlín",
          "cityAdministrative": "Karlín",
          "cadastralArea": "Karlín",
          "ids": {
            "internal": "d2ade877-1e95-4a83-baa6-543...",
            "external": "22349995",
            "region": "19", "district": "9999", "cityDistrictSpecial": "86",
            "cityDistrict": "500208", "cityPart": "400637", "cadastralArea": "730955",
            "city": "554782", "street": "472093"
          },
          "street": "Thámova",
          "number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" },
          "streetWithNumber": "Thámova 137/16",
          "city": "Praha 8",
          "zip": "186 00",
          "geometry": {
            "gps": { "lat": 50.092002438505844, "lon": 14.452733733747621 },
            "custom": [{ "type": "JTSK", "coordinates": { "x": 1042819.66, "y": 740509.43 } }]
          },
          "postOffice": { "name": "Praha 86", "full": "Thámova 137/16, 186 00 Praha 8" }
        }
      }
    ]
  },
  "errors": []
}
```