@parcl-finance/product-sdk/dist/cjs/realEstateData.d.ts

TypeScript SDK for interacting with Parcl's product APIs

import { AbsorptionRateInfo, CurrentInventory, Env, Financials, ListingsInfo, ParclId, ParclInfo, PriceFeed, PriceFeedStats, PriceFeedWindow, SalesInfo } from "./types";
import { TimeFrameOption } from "./types/timeframeOption";
export declare class RealEstateData {
    baseUrl: string;
    private headers;
    private client;
    private expressClient;
    constructor(baseUrl: string, accessToken?: string, env?: Env);
    getParclIds(): Promise<number[]>;
    getParclInfo(id: ParclId): Promise<ParclInfo>;
    getParclInfos(ids: ParclId[]): Promise<ParclInfo[]>;
    getPriceFeed(id: ParclId, window: PriceFeedWindow): Promise<PriceFeed>;
    getPriceFeedBySymbol(symbol: string, window: TimeFrameOption): Promise<PriceFeed>;
    getPriceFeedStatsBySymbol(symbol: string): Promise<PriceFeedStats>;
    getFinancialsBySymbol(symbol: string): Promise<Financials>;
    getAbsorptionRateHistoryBySymbol(symbol: string, window: TimeFrameOption): Promise<AbsorptionRateInfo[]>;
    getSalesHistoryBySymbol(symbol: string, window: TimeFrameOption): Promise<SalesInfo[]>;
    getListingsHistoryBySymbol(symbol: string, window: TimeFrameOption): Promise<ListingsInfo[]>;
    getCurrentInventoryBySymbol(symbol: string): Promise<CurrentInventory>;
    getDemographicsBySymbol(symbol: string): Promise<DemographicInfo>;
}
export type DemographicInfo = {
    totalPop: number;
    medianAge: number;
    medianIncome: number;
    totalArea: number;
};
//# sourceMappingURL=realEstateData.d.ts.map