@vepler/http-sdk
Version:
The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.
35 lines (34 loc) • 1.17 kB
TypeScript
import { AddressLookupRequest, AddressLookupResponse } from '@vepler/locations-types';
/**
* Address to UPRN matching with LLM-powered parsing
*
* This endpoint provides intelligent address parsing and matching with:
* - Fast-path optimization for well-formatted addresses (95%+ confidence)
* - LLM-powered parsing for complex multi-address inputs
* - Confidence scoring and fallback mechanisms
* - Detailed processing insights
*
* @param params - Address lookup request parameters
* @returns Promise resolving to address matches with metadata
*
* @example
* ```typescript
* import { location } from '@vepler/http-sdk';
*
* // Simple address lookup
* const result = await location.lookup({
* addressString: "10 Downing Street, London SW1A 2AA"
* });
*
* // Complex multi-address with options
* const complexResult = await location.lookup({
* addressString: "37 barley avenue and 42 in pocklington YO442RW",
* options: {
* confidenceThreshold: 60,
* includeProcessingDetails: true,
* maxResults: 10
* }
* });
* ```
*/
export declare function addressLookup(params: AddressLookupRequest): Promise<AddressLookupResponse>;