Ratemyplace - Food Safety Star Rating Scheme for Staffordshire

API

API

Build your stuff with our stuff!

If you are a web developer, you can access Ratemyplace data programatically in a variety of ways, allowing you to plug Ratemyplace data into your own website.

You can use this data however you want, but we ask (but don't require) that you add a 'Powered by Ratemyplace' logo to your site. It would also be cool if you could let us know how you are using our data.

API Documentation

Search Results

This returns basic information about all premises that fit the search criteria, including the Name of the premises, link to the premises page, the town or village the premises is in, the local authority and a star rating image in 24-bit png format. An ID number is also included for use with the second method below.

All variables in curly braces are optional, but at least one must be included

http://www.ratemyplace.org.uk/api/api.php?method=search&{name=[name to search]}&{authority=[Local Authority ID]}&{town=[town / village to search]}&{type=[premises keywords]}&{rating=[star rating]}

View example...

View premises details

This returns more detailed information about a premises, including the full address, coordinates (for use with Google Maps etc), opening times, contact details and full inspection details and accepts the ID number of the premises.

http://www.ratemyplace.org.uk/api/api.php?method=view&id=[premises id]

View example...

Find my nearest

This accepts three variables - a postcode, the distance you want to search (in miles) and a rating. It returns the name of the premises, the town / village it is in, the star rating, the distance from the postcode (in miles) and the ID number of the premises.

The distance and star ratings are optional, if left out, the API returns a distance of 5 miles and a star rating of zero

http://www.ratemyplace.org.uk/api/api.php?method=nearest&postcode=[UK Postcode]{distance=[Distance in miles]}&{rating=[star rating]}

View example...

RSS Feed

This returns an RSS Feed in GeoRSS format of all premises that fit the search criteria.

All variables in curly braces are optional, but at least one must be included

http://www.ratemyplace.org.uk/api/api.php?method=rss&{name=[name to search]}&{authority=[Local Authority ID]}&{town=[town / village to search]}&{type=[premises keywords]}&{rating=[star rating]}

View example...

Creative Commons LicenseAll data delivered by the API is licensed under the Creative Commons CC0 1.0 Universal Licence.

Local Authority IDs

X

Local Authorities participating in the Ratemyplace scheme are referred to in the API by a unique ID number. ID numbers are as follows:

Lichfield District Council
1
Stafford Borough Council
2
Cannock Chase District Council
3
East Staffordshire District Council
4
South Staffordshire Council
5
Tamworth Borough Council
6

Powered by Logo

X

Powered by Ratemyplace