You can choose the scope of data that is returned in the response. Basic datascope is returned as default, Usually a different pricing is used for individual datascopes.
Basic datascope
| Name | Description | Example | CZ | SK | PL |
|---|---|---|---|---|---|
| country | Country code in format ISO-3166-1 alpha-2. | CZ | ✅ | ✅ | ✅ |
| street | Street name. | Saská | ✅ | ✅ | ✅ |
| number | Street number divided into sections. | 520/3 | ✅ | ✅ | ✅ |
| streetWithNumber | Street with number. | Saská 520/3 | ✅ | ✅ | ✅ |
| zip | ZIP code. | 11800 | ✅ | ✅ | ✅ |
| full | Full address. | Saská 520/3, 11800 Praha 1 | ✅ | ✅ | ✅ |
| internal ID | Internal Foxentry ID. | 41571067-dd29-4851-bebf-75780e197a64 | ✅ | ✅ | ✅ |
Full datascope
Basic datascope included plus:
| Name | Description | Example | CZ | SK | PL |
|---|---|---|---|---|---|
| postOffice | In what post office jurisdiction the address falls under. Název pošty. | Praha 011 | ✅ | ✅ | ❌ |
| gps | GPS location GPS souřadnice. | 50.086927302342, 14.407320860056 | ✅ | ✅ | ✅ |
| custom coordinate system | May vary for every country. Jiný souřadnicový systém. | JTSK (x,y) | ✅ | ❌ | ✅ |
| region | Region. Kraj. | Hlavní město Praha | ✅ | ✅ | ✅ |
| district | District. Okres. | Území Hlavního města Prahy | ✅ | ✅ | ✅ |
| cityDistrict | City district. Městský obvod/městská část. | Praha 1 | ✅ | ❌ | ❌ |
| cityDistrictSpecial | Special types of city districts. Used only in Prague (CZ) at the moment. Správní obvod v hlavním městě Praze (CZ). | Praha 1 | ✅ | ❌ | ❌ |
| cityPart | City part. Část obce. | Malá Strana | ✅ | ✅ | ❌ |
| cityAdministrative | City administrative area. Správní obec | - | ❌ | ❌ | ✅ |
| cadastralArea | Cadastral area. Katastrální území. | Malá Strana | ✅ | ❌ | ❌ |
| external ID | External address ID. May vary for every supported country. CZ = RUIAN, PL = Government data, SK = no external ID. | 21700133 | ✅ | ❌ | ✅ |
| region ID | Region ID. | 19 | ✅ | ❌ | ❌ |
| district ID | District ID. | 9999 | ✅ | ❌ | ❌ |
| cityDistrict ID | City district ID. | 500054 | ✅ | ❌ | ❌ |
| cityDistrictSpecial ID | City district special ID. | 19 | ✅ | ❌ | ❌ |
| cityPart ID | City part ID. | 490121 | ✅ | ❌ | ❌ |
| cadastralArea ID | Cadastral area ID. | 727091 | ✅ | ❌ | ❌ |
| city ID | City ID. | 554782 | ✅ | ❌ | ❌ |
| street ID | Street ID. | 468576 | ✅ | ❌ | ❌ |