SDK examples

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

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

const postcode = await sdk.address.lookupPostcode({ postcode: "SW1A 2AA" });

for (const address of postcode.data) {
  console.log(address.uprn, address.formatted);
}

const suggestions = await sdk.search.searchSuggest({ q: "10 downing street", source: "address" });
const match = suggestions.data.find((suggestion) => suggestion.uprn !== undefined);

if (match?.uprn) {
  const address = await sdk.address.lookupUprn({ uprn: match.uprn });
  console.log(address.formatted);
}

import type { PropertyDataApi } from "@vepler/sdk/sdk/models/shared";

async function getProperties(uprns: string[]): Promise<PropertyDataApi[]> {
  const properties: PropertyDataApi[] = [];

  for (let i = 0; i < uprns.length; i += 100) {
    const batch = uprns.slice(i, i + 100);
    const page = await sdk.property.getPropertiesByLocation({
      locationIds: batch.join(","),
      limit: String(batch.length),
    });
    properties.push(...page.data);
  }

  return properties;
}

const nearby = await sdk.property.searchProperties({
  area: [{ type: "point", coordinates: [-0.1276, 51.5034], radius: 500 }],
  query: [
    {
      operator: "AND",
      groups: [{ conditions: [{ field: "roomDetails.beds", comparator: "gte", value: 3 }] }],
    },
  ],
  sort: [{ field: "roomDetails.beds", order: "desc" }],
  attributes: ["address", "roomDetails.beds"],
  limit: 50,
});

for (const property of nearby.data) {
  console.log(property.roomDetails?.beds, property.address?.displayAddress);
}

const planning = await sdk.planning.searchPlanningApplications({
  query: {
    near: { lat: 51.5034, lng: -0.1276, radiusM: 500 },
    receivedDateFrom: "2025-01-01",
  },
  limit: 50,
});

for (const application of planning.data) {
  console.log(application.receivedDate, application.status, application.distance, application.description);
}

const history = await sdk.transactions.getTransactionsByUprn({ uprn: "100023336956", limit: 100 });

for (const sale of history.data) {
  console.log(sale.date?.toISOString().slice(0, 10), (sale.price?.amount ?? 0) / 100);
}