@vepler/http-sdk/dist/services/property/routes/query-property.d.ts

The definitive TypeScript SDK for UK property technology. Access comprehensive property data, school metrics, demographics, planning applications, and more through a single, powerful API.

export interface QueryPropertyResult {
    result: object[];
    size: number;
    totalSize: number;
    success: boolean;
}
export interface GetPropertyBySourceParams {
    sourceIds?: string[];
    limit?: number;
    offset?: number;
    area?: Array<{
        type: 'point';
        radius: number;
        coordinates: [number, number];
    } | {
        type: 'polygon';
        coordinates: [number, number][];
    } | {
        type: 'multipolygon';
        coordinates: [number, number][][];
    } | {
        type: 'postcode';
        value: string;
    } | {
        type: 'outcode';
        value: string;
    } | {
        locationId: string;
    }>;
    attributes?: string[];
    query?: Array<{
        operator: 'AND' | 'OR';
        groups: Array<{
            conditions: Array<{
                field: string;
                comparator: string;
                value: string | number | boolean | Array<string | number | boolean>;
            }>;
        }>;
    }>;
}
export declare function queryProperty(params: GetPropertyBySourceParams): Promise<QueryPropertyResult>;