Quick Start

import { Vepler } from 'vepler-sdk';

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

// Get property by ID
const response = await vepler.property.get('p_0x000123456789');

// The response includes a data wrapper
console.log(response.data);
// { id: 'p_0x000123456789', address: '...', ... }

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

{
  "data": {
    "id": "p_0x000123456789",
    "address": "10 Downing Street, Westminster, London SW1A 2AA",
    "postcode": "SW1A 2AA",
    "latitude": 51.503363,
    "longitude": -0.127625,
    "propertyType": "Terraced",
    "yearBuilt": 1684,
    "titleNumber": "NGL123456",
    "councilTaxBand": "H",
    "currentUse": "Residential",
    "totalFloorArea": 550,
    "numberOfRooms": 100,
    "geometry": {
      "type": "Point",
      "coordinates": [-0.127625, 51.503363]
    },
    "location": {
      "ward": "St. James's",
      "constituency": "Cities of London and Westminster",
      "localAuthority": "Westminster City Council",
      "region": "Greater London"
    },
    "ownership": {
      "tenure": "Freehold",
      "registered": true
    },
    "planning": {
      "conservationArea": true,
      "listedBuilding": "Grade I"
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-03-20T14:45:00.000Z"
  }
}