Skip to content

Authentication

In order to use the PropEco API, you must ensure that your requests are authenticated.

An API key must be given with every request as the following header:

x-api-key: <API KEY>

Requests authenticated with this method resemble the following structure:

curl \
  -X GET \
  --header "x-api-key: <API KEY>" \
  https://api.propeco.io/...

const results = await fetch(`https://api.propeco.io/...`, {
  headers: {
    "x-api-key": API_KEY
  },
});
const data = await results.json();

Any requests made without an API key will be met with a 403 response (access denied).

Test Keys

Test keys can be used to search the Properties, Location, Flood Risk, EPCs and Retrofit endpoints using either:

  • UPRNs 34076006, 906178651 or 10014197137.

  • The following lat / lng coordinates: 51.47 -0.19 | 55.98 -3.19 | 51.45 -3.19.

Request Quotas

Each of our API products is subject to a monthly request quota depending on the tier of subscription.

Check out our available API tiers here.

Request Throttling

All requests made to PropEco API products are throttled to 1 request per second per subcription.