Grocery stores
UK
gethttps://crystalroof.co.uk/customer-api/amenities/closest-grocery-stores/v1/{location}
Description
This method returns the closest supermarkets and convenience stores.
Parameters
Name | Description |
---|---|
location path string | Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format. Postcode with or without space. This argument is case-insensitive. |
businessType query array | What types of establishments the method should return |
rating query array | Food Hygiene Rating according to Food Standards Agency. |
limit query enum | Number of elements to be returned by the method. The returned number of elements may be less than the requested amount if fewer elements are found based on your criteria (in very rare cases). The maximum value is 20. To retrieve only the metadata, use the value 0. |
api_key query enum | Your API key.
|
Request URL:
https://crystalroof.co.uk/customer-api/amenities/closest-grocery-stores/v1/W60WW?api_key=DEMO
Possible responses with examples
Code
Description
200
Success
{
"data": [
{
"fhrsId": 489890,
"localAuthorityBusinessId": "10371",
"businessName": "Shell Hammersmith",
"businessType": "Retailers - other",
"businessTypeId": 4613,
"address": "372 Goldhawk Road, London",
"postcode": "W6 0XF",
"ratingValue": "Exempt",
"ratingDate": "2017-02-13",
"scoreHygiene": null,
"scoreStructural": null,
"scoreConfidenceInManagement": null,
"newRatingPending": false,
"latitude": 51.496003,
"longitude": -0.244716,
"distance": 125.1
},
{
"fhrsId": 345212,
"localAuthorityBusinessId": "02214/0366/1/000",
"businessName": "Hammersmith Local",
"businessType": "Retailers - other",
"businessTypeId": 4613,
"address": "366 King Street, London",
"postcode": "W6 0RX",
"ratingValue": "5",
"ratingDate": "2022-02-23",
"scoreHygiene": 5,
"scoreStructural": 0,
"scoreConfidenceInManagement": 5,
"newRatingPending": false,
"latitude": 51.493618,
"longitude": -0.244311,
"distance": 293.1
},
{
"fhrsId": 345214,
"localAuthorityBusinessId": "02214/0371/1/000",
"businessName": "Mikael's Delicatessen",
"businessType": "Retailers - other",
"businessTypeId": 4613,
"address": "371 King Street, London",
"postcode": "W6 9NJ",
"ratingValue": "5",
"ratingDate": "2022-01-12",
"scoreHygiene": 5,
"scoreStructural": 5,
"scoreConfidenceInManagement": 5,
"newRatingPending": false,
"latitude": 51.493321,
"longitude": -0.243717,
"distance": 314.6
},
{
"fhrsId": 610582,
"localAuthorityBusinessId": "2013/00146/COMB",
"businessName": "Sainsbury's Local",
"businessType": "Retailers - supermarkets/hypermarkets",
"businessTypeId": 7840,
"address": "383 King Street, London",
"postcode": "W6 9NJ",
"ratingValue": "5",
"ratingDate": "2018-01-17",
"scoreHygiene": 0,
"scoreStructural": 5,
"scoreConfidenceInManagement": 0,
"newRatingPending": false,
"latitude": 51.493321,
"longitude": -0.243717,
"distance": 314.6
},
{
"fhrsId": 1014931,
"localAuthorityBusinessId": "2017/00328/COMB",
"businessName": "La Librairie Ltd",
"businessType": "Retailers - other",
"businessTypeId": 4613,
"address": "377 King Street, London",
"postcode": "W6 9NJ",
"ratingValue": "5",
"ratingDate": "2018-03-23",
"scoreHygiene": 0,
"scoreStructural": 0,
"scoreConfidenceInManagement": 0,
"newRatingPending": false,
"latitude": 51.493321,
"longitude": -0.243717,
"distance": 314.6
}
],
"dataDate": "2024-01-10",
"refreshedDate": "2024-01-10"
}
401
Unauthorized
{
"error": "No such API key or it is not valid anymore."
}
402
Payment Required
{
"error": "You have exhausted the available calls provided by your package."
}
403
Forbidden
{
"error": "API key is invalid for the given action."
}
404
Not Found
{
"error": "Can't find such location."
}
429
Too Many Requests
{
"error": "Too many requests have been sent in one second."
}
500
Internal Server Error
{
"error": "We have already started working on a resolution!"
}