Vepler API Documentation

1. Create an API key

Sign in at app.vepler.com and create a key under API keys. The key is shown once, when you create it, so copy it then. It starts with vpr_live_.

2. Make a request

Look up the addresses at a postcode:

curl "https://api.vepler.com/v1/address/postcodes/SW1A2AA" \
  -H "x-api-key: $VEPLER_API_KEY"

The response lists every address at the postcode, up to 50 per page.

3. Or use the TypeScript SDK

npm install @vepler/sdk

import { SDK } from "@vepler/sdk";

const sdk = new SDK({ apiKeyAuth: process.env.VEPLER_API_KEY });

async function run() {
  const result = await sdk.address.lookupPostcode({ postcode: "SW1A2AA" });
  console.log(result);
}

run();

If the request fails

Status	Meaning
`401`	The `x-api-key` header is missing, or the key is wrong, expired or revoked.
`402`	Your account has no credit left for the request.
`403`	Your account does not include this product.
`429`	A rate limit or your daily credit limit was reached. Wait for the seconds in `Retry-After`; after the daily limit, that is until midnight UTC.

Errors covers every status and the error body.

Next

Find the endpoint you need in the API reference. Introduction lists what each section covers.
Read Versions to see how the API changes and how to keep up.