@vepler/http-sdk/dist/services/connectivity/routes/get-connectivity-scores.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 GetConnectivityScoresParams {
    geographicCodes: string;
    includeBreakdown?: boolean;
    includeAreaInfo?: boolean;
    dataPeriod?: string;
    startPeriod?: string;
    endPeriod?: string;
    includePeriodHistory?: boolean;
    periodLimit?: number;
    format?: 'basic' | 'detailed';
    limit?: number;
}
export interface ConnectivityScore {
    code: string;
    name?: string;
    type?: string;
    score: number;
    breakdown?: {
        [key: string]: number;
    };
    periodHistory?: {
        period: string;
        score: number;
    }[];
}
export interface GetConnectivityScoresResponse {
    result: ConnectivityScore[];
    success: boolean;
    metadata?: {
        totalCount: number;
        periodRange?: {
            start: string;
            end: string;
        };
    };
}
export declare function getConnectivityScores(params: GetConnectivityScoresParams): Promise<GetConnectivityScoresResponse>;