Locations

get/{dataset}/v3/locations

Dataset description:

Locations are physical outlets or premises of the company in addition to its HQ.

Availability:

cz, sk

Dataset updates:

Dataset is updated on a quarterly basis.

Selected use cases:

compare your coverage with geographical distribution of your portfolios premises
segment locations by category
enrich your own locations dataset by official address points, GPS coordinates and other address features
see best rated premises at multiple social networks (google, facebook)

Endpoint variables description:

Item commercial name	Path	Item description	Example	Always populated
Location unique ID	data/ data/ uniqueId	BizMachine ID unique across countries	cz-location-BMPCZ00002613	Yes
Address unique ID	data/ data/ address/ uniqueId	BizMachine ID unique across countries	cz-address-other-5f1dd281fe71eeba5bcbfe92d78f4bf3	Yes
Address (text)	data/ data/ address/ text	Full address as a text string	Špitálské náměstí 3517/1a, Ústí nad Labem, okres Ústí nad Labem, Ústecký kraj, Česko	Yes
Address GPS latitude	data/ data/ address/ coordinates/ latitude		50.6628916667	Inherited
Address GPS longitude	data/ data/ address/ coordinates/ longitude		14.0329444444	Inherited
Address street name	data/ data/ address/ streetName		Třeboňská	No
Address street number	data/ data/ address/ streetNumber		1002/91	No
Address city	data/ data/ address/ city		Ústí nad Labem	No
Address ZIP code	data/ data/ address/ postalCode		36005	No
Address locality (code)	data/ data/ address/ locality/ code	Enumeration code for /api/v3/enums/localities	567892	Inherited
Address locality (label)	data/ data/ address/ locality/ name		Ústí nad Labem-město	No
Address Czech specific city part	data/ data/ address/ countrySpecific/ cz/ cityPart		Nové Město	No
Address Czech specific city district	data/ data/ address/ countrySpecific/ cz/ cityDistrict		Praha 2	No
Address Czech specific orientation number	data/ data/ address/ countrySpecific/ cz/ orientationNumber		1	No
Address Czech specific house number	data/ data/ address/ countrySpecific/ cz/ houseNumber		1961	No
Address Czech specific is evidence number	data/ data/ address/ countrySpecific/ cz/ isEvidenceNumber		true	No
Address Czech specific address point number	data/ data/ address/ countrySpecific/ cz/ ruian/ addressPointNumber	Unique ID for each address point in CZ by RUIAN	21735883	No
Address Czech specific building number	data/ data/ address/ countrySpecific/ cz/ ruian/ buildingNumber	Unique ID for each building in CZ by RUIAN	21674825	No
Address Czech specific street number	data/ data/ address/ countrySpecific/ cz/ ruian/ streetNumber		470881	No
Address Czech specific city borough number	data/ data/ address/ countrySpecific/ cz/ ruian/ cityBoroughNumber		27	No
Address Czech specific city district number	data/ data/ address/ countrySpecific/ cz/ ruian/ cityDistrictNumber		27500089	No
Address Czech specific municipality part number	data/ data/ address/ countrySpecific/ cz/ ruian/ municipalityPartNumber		490148	No
Address Czech specific municipality number	data/ data/ address/ countrySpecific/ cz/ ruian/ municipalityNumber		554782	No
Address Czech specific basic settlement unit number	data/ data/ address/ countrySpecific/ cz/ ruian/ basicSettlementUnitNumber		127311	No
Address Czech specific cadaster area number	data/ data/ address/ countrySpecific/ cz/ ruian/ cadasterAreaNumber		727181	No
Address Czech specific cadaster plot number	data/ data/ address/ countrySpecific/ cz/ ruian/ plotNumber			No
Address Czech specific RUIAN URL	data/ data/ address/ countrySpecific/ cz/ ruian/ url		https://vdp.cuzk.cz/vdp/ruian/adresnimista/21735883	No
Address Czech specific building purpose (code)	data/ data/ address/ countrySpecific/ cz/ purposeTypes/ code	Enumeration code for /api/v3/enums/purpose-types	residential	No
Address Czech specific building purpose (label)	data/ data/ address/ countrySpecific/ cz/ purposeTypes/ name	Enumeration name for /api/v3/enums/purpose-types		No
Address Slovak specific building purpose (code)	data/ data/ address/ countrySpecific/ sk/ purposeTypes/ code	Enumeration code for /api/v3/enums/purpose-types	residential	No
Address Slovak specific building purpose (label)	data/ data/ address/ countrySpecific/ sk/ purposeTypes/ name	Enumeration name for /api/v3/enums/purpose-types		No
Location category (code)	data/ data/ categories/ code	Enumeration code for /api/v3/locations/enums/categories	cat00048	Inherited
Location category confidence	data/ data/ categories/ confidence	How certain are we that the location is correctly categorized (0-1)	0.9	Inherited
Location category (label)	data/ data/ categories/ name		Supermarkety	No
Entity residing in the location unique ID	data/ data/ company/ uniqueId	BizMachine ID unique across countries	cz-company-45308314	Inherited
Entity residing in the location national ID	data/ data/ company/ nationalIn		45308314	Inherited
Entity residing in the location name	data/ data/ company/ name		Tesco Stores ČR a.s.	No
Location email	data/ data/ contacts/ emails/ value		info@itesco.cz	No
Location email data source	data/ data/ contacts/ emails/ sources	currently not used	null	No
Location phone number	data/ data/ contacts/ phoneNumbers/ value		00420725337109	No
Location phone number data source	data/ data/ contacts/ phoneNumbers/ sources	currently not used	null	No
Location website	data/ data/ contacts/ websites/ value		https://itesco.cz/prodejny/obchody-tesco/supermarket-chomutov-chomutovka	No
Location website data source	data/ data/ contacts/ websites/ sources	currently not used	null	No
Location established at date	data/ data/ establishedAt		2010-09-30T00:00:00+00:00	No
Location name	data/ data/ name		Tesco	Yes
Location SharpGrid ID	data/ data/ locationIn	SharpGrid unique location ID	BMPCZ00054975	Yes
Location picture URL	data/ data/ pictures/ url		https://d48-a.sdn.cz/d_48/c_img_G_C/ts6veO.jpeg?fl=res,1100,800,1,	Inherited
Last check of the location picture	data/ data/ pictures/ lastCheckedAt			No
Location picture source (code)	data/ data/ pictures/ source/ code	Enumeration code for /api/v3/enums/sources	cz-firmycz	Inherited
Location picture source (label)	data/ data/ pictures/ source/ name		Firmy.cz	No
Location source (code)	data/ data/ sources/ code	Enumeration code for /api/v3/enums/sources	google	Inherited
Location ID on source	data/ data/ sources/ externalId	Original record ID on source (can be used to find the record on the original source)	ChIJRa2d6QsbCkcReN3VCyI74NI	No
Location URL on source	data/ data/ sources/ url		https://www.google.com/maps/place/?q=place_id:ChIJRa2d6QsbCkcReN3VCyI74NI	No
Location rating count on source	data/ data/ sources/ rating/ count		377	Inherited
Location rating value as shown on source	data/ data/ sources/ rating/ text/ value		3.6/5	No
Location rating value on source processed	data/ data/ sources/ rating/ value		3.6	No
Location source (label)	data/ data/ sources/ name	Typically multiple sources from which the location is algorithmically compiled	Google Maps	No
Location type (code)	data/ data/ type/ code	Enumeration code for /api/v3/locations/enums/types	Physical	Inherited
Location type (label)	data/ data/ type/ name	Physical or virtual location	Physical	No

SecurityApiKey

Request

path Parameters

dataset

required

string

query Parameters

Company.NationalIn	string or null
Company.Tag.Uid	string or null <uuid> Unique identifier.
Type.Code	string or null Location type code.
Category.Code	Array of strings or null
IncludeBuildingInformation	boolean Should the return payload contain buildings information?
Updated.From	string or null <date-time> Search data by System.DateTimeOffset starting from this value.
Updated.To	string or null <date-time> Search data by System.DateTimeOffset up to this value.
Offset	integer <int32> Allows to specify offset from where to start streaming results. Default value: 0
Limit	integer <int32> Default: 200 Allows to specify limit of returned data.
SortBy	string or null Sorting order and field to sort by in format sorting-order Valid orders: desc, asc. Example: desc(createdAt)

Responses

200

Success

Response samples

{"paging": {"totalItems": 0,
"totalPages": 0,
"pageSize": 0,
"currentPage": 0,
"maxPageSize": 0
},
"data": [{"data": {"uniqueId": "cz-location-BMPCZ00331552",
"address": {"uniqueId": "cz-address-123456",
"text": "string",
"coordinates": {"latitude": 49.5774191265,
"longitude": 17.2819177995
},
"streetName": "string",
"streetNumber": "string",
"city": "string",
"postalCode": "string",
"locality": {"code": "CZ0712",
"name": "string",
"types": ["string"
],
"parent": { }
},
"countrySpecific": {"cz": {"cityPart": "string",
"cityBorough": "string",
"cityDistrict": "string",
"orientationNumber": "string",
"houseNumber": 0,
"isEvidenceNumber": true,
"ruian": {"addressPointNumber": null,
"buildingNumber": null,
"streetNumber": null,
"cityBoroughNumber": null,
"cityDistrictNumber": null,
"municipalityPartNumber": null,
"municipalityNumber": null,
"basicSettlementUnitNumber": null,
"cadasterAreaNumber": null,
"plotNumber": null,
"url": null
},
"purposeTypes": [null
]
},
"sk": {"purposeTypes": [null
]
}
}
},
"categories": [{"code": "string",
"confidence": 1,
"name": "string"
}
],
"company": {"uniqueId": "string",
"nationalIn": "12345678",
"name": "string"
},
"contacts": {"emails": [{"value": "00420466614056, info@nastarerybarne.cz",
"sources": [null
]
}
],
"phoneNumbers": [{"value": "00420466614056, info@nastarerybarne.cz",
"sources": [null
]
}
],
"websites": [{"value": "00420466614056, info@nastarerybarne.cz",
"sources": [null
]
}
]
},
"establishedAt": "2019-08-24T14:15:22Z",
"name": "string",
"locationIn": "string",
"pictures": [{"url": "https://www.restu.cz/ir/restaurant/727/7274a7dfec44ae61f78351726694590f.jpg",
"lastCheckedAt": "2019-08-24T14:15:22Z",
"source": {"code": "cz-restu",
"name": "string"
}
}
],
"sources": [{"code": "string",
"externalId": "string",
"url": "http://example.com",
"rating": {"count": 2147483647,
"text": {"locales": { },
"value": null
},
"value": 0
},
"name": "string"
}
],
"type": {"code": "cz-restu",
"name": "string"
},
"building": {"uniqueId": "string",
"coordinates": {"latitude": 49.5774191265,
"longitude": 17.2819177995
},
"addresses": [{"uniqueId": "cz-address-123456",
"text": "string",
"coordinates": {"latitude": null,
"longitude": null
},
"streetName": "string",
"streetNumber": "string",
"city": "string",
"postalCode": "string",
"locality": {"code": null,
"name": null,
"types": [ ],
"parent": null
},
"countrySpecific": {"cz": null,
"sk": null
}
}
],
"locality": {"code": "CZ0712",
"name": "string",
"types": ["string"
],
"parent": { }
},
"protectionMethods": [{"code": "0001",
"name": "string"
}
],
"buildingArea": {"unit": "string",
"value": 0
},
"constructionType": {"code": "0001",
"name": "string"
},
"gasConnection": {"code": "0001",
"name": "string"
},
"heatingMethod": {"code": "0001",
"name": "string"
},
"liftEquipment": {"code": "0001",
"name": "string"
},
"meansOfUse": {"code": "0001",
"name": "string"
},
"sewerConnection": {"code": "0001",
"name": "string"
},
"type": {"code": "0001",
"name": "string"
},
"waterSupplyConnection": {"code": "0001",
"name": "string"
},
"completedAt": "2019-08-24",
"enclosedBuildingSpace": {"unit": "string",
"value": 0
},
"flatsCount": 2147483647,
"floorAreaSum": {"unit": "string",
"value": 0
},
"floorsCount": 2147483647,
"validFrom": "2019-08-24",
"validTo": "2019-08-24",
"countrySpecific": {"cz": {"cadasterArea": "string",
"ruian": {"buildingNumber": null,
"cadasterAreaNumber": null,
"cityPartNumber": null,
"municipalityPartNumber": null,
"plotNumber": null,
"url": null
}
}
},
"plot": {"uniqueId": "string"
}
}
},
"meta": {"dataSources": [{"code": "string",
"name": "string",
"externalId": "string",
"url": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"prospector": {"link": "string"
},
"hash": "string"
}
}
]
}

➔ Next to Share