Quick Start

​

Installation

npm install @vepler/sdk

yarn add @vepler/sdk

pnpm add @vepler/sdk

bun add @vepler/sdk

​

Basic Usage

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

const vepler = new SDK({
  apiKey: process.env.VEPLER_API_KEY
});

// Get property by location ID
const response = await vepler.property.getV1PropertyLocationIds({
  locationIds: 'p_0x000123456789'
});

if (response.propertyListResponse) {
  console.log(response.propertyListResponse.result);
}

​

Authentication

curl -X GET "https://api.vepler.com/v1/property/p_0x000123456789" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​

Available Endpoints

​

Property

• GET /v1/property/{locationIds} - Get properties by location IDs
• GET /v1/property/propertyId/{propertyIds} - Get properties by property IDs
• GET /v1/property/sources/{sourceIds} - Get properties by source IDs
• POST /v1/property/properties/by-slugs - Get properties by slugs
• POST /v1/property/query - Query properties with advanced filters

​

Planning

• GET /v1/planning/{applicationIds} - Get planning applications
• GET /v1/planning/sources/{sourceIds} - Get planning by source IDs
• POST /v1/planning/query - Query planning applications

​

Schools

• GET /v1/schools - List schools
• GET /v1/schools/{id} - Get school by ID
• GET /v1/schools/search/nearby - Search nearby schools

​

Safety

• GET /v1/safety/crime - Get crime data by location
• GET /v1/safety/crime/stats - Get aggregated crime statistics

​

Address

• POST /v1/address/resolve - Resolve an address
• GET /v1/address/postcodes/{postcode} - Lookup a postcode
• GET /v1/address/uprn/{uprn} - Lookup by UPRN

​

AVM

• POST /v1/avm/predict - Predict property value
• POST /v1/avm/analysis - Run valuation analysis

​

Listings

• GET /v1/listings/{id} - Get a listing
• POST /v1/listings/query - Query listings

​

Next Steps

• API Reference - Full endpoint documentation
• TypeScript SDK - SDK documentation
• Authentication - Authentication details