npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@vepler/sdk

v6.8.0

Published

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@vepler/sdk* API.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

nikicnikic

Keywords

Readme

@vepler/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @vepler/sdk API.

Summary

Vepler Public API: UK property data in one API: addresses and UPRNs, property records, market listings, sold transactions, planning applications, land titles, schools, energy performance, environmental designations and neighbourhood metrics. Every request is authenticated with an API key sent in the x-api-key header. This specification covers the public API only; webhook and administrative endpoints are not included.

Table of Contents

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET>

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Authentication

To use the Vepler SDK, you need an API key. You can obtain one by contacting [email protected].

Once you have your API key, you can initialize the SDK:

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

const sdk = new SDK({
  apiKey: "your-api-key-here",
  // Optional: specify a different server URL
  serverURL: "https://api.vepler.com",
});

For security, we recommend storing your API key in environment variables:

export VEPLER_API_KEY=your-api-key-here
const sdk = new SDK({
  apiKey: process.env.VEPLER_API_KEY,
});

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

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

const sdk = new SDK({
  apiKeyAuth: "vepler_api_YOUR_KEY_HERE",
});

async function run() {
  const result = await sdk.address.bulkLookupPostcodes();

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ------ | ------- | | apiKeyAuth | apiKey | API key |

To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:

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

const sdk = new SDK({
  apiKeyAuth: "vepler_api_YOUR_KEY_HERE",
});

async function run() {
  const result = await sdk.address.bulkLookupPostcodes();

  console.log(result);
}

run();

Available Resources and Operations

Address

Address.Changelog

  • list - List Address API changelog entries

AirQuality

  • point - Get air quality at an exact coordinate
  • query - Query air quality at one or more locations

Areas

Avm

Buildings

Census

Companies

Connectivity

Conservation

  • get - Get one conservation designation
  • query - Query conservation designations near a place
  • snapshots - List conservation data snapshots
  • types - List conservation designation types

Councils

  • get - Get council by provider ID
  • list - List councils

Energy

Epc

FloodRisk

  • point - Assess flood risk at a coordinate

Geography

Heritage

  • get - Get one heritage designation
  • query - Query heritage designations near a place
  • snapshots - List heritage data snapshots
  • types - List heritage designation types

LandConstraint

  • get - Get one land constraint designation
  • query - Query land constraint designations near a place
  • snapshots - List land constraint data snapshots
  • types - List land constraint designation types

Listings

Metrics

Planning

Poi

Property

Prosperity

  • get - Get the Prosperity Index for one or more small areas

Safety

Schools

Schools.Changelog

  • list - List Schools API changelog entries

Schools.CoverageMatrix

  • get - Get the schools coverage matrix

Schools.Frameworks

  • get - Get framework with full metric definitions
  • list - List all framework catalogue entries

SchoolsCatchment

Search

Sites

Streets

System

TitleDeeds

Transactions

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

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

const sdk = new SDK({
  apiKeyAuth: "vepler_api_YOUR_KEY_HERE",
});

async function run() {
  const result = await sdk.address.bulkLookupPostcodes(undefined, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

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

const sdk = new SDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: "vepler_api_YOUR_KEY_HERE",
});

async function run() {
  const result = await sdk.address.bulkLookupPostcodes();

  console.log(result);
}

run();

Error Handling

SDKBaseError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { SDK } from "@vepler/sdk";
import * as errors from "@vepler/sdk/sdk/models/errors";

const sdk = new SDK({
  apiKeyAuth: "vepler_api_YOUR_KEY_HERE",
});

async function run() {
  try {
    const result = await sdk.address.bulkLookupPostcodes();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.SDKBaseError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.BulkLookupPostcodesResponseBody) {
        console.log(error.data$.error); // errors.BulkLookupPostcodesError
      }
    }
  }
}

run();

Error Classes

Primary error:

Network errors:

Inherit from SDKBaseError: