import {z} from 'zod' export type GetApiMarketsArgs = {zipCode: string, dataType?: ('All' | 'Sale' | 'Rental') | undefined, historyRange?: number | undefined}; export type GetApiMarketsOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiMarketsResponse = z.object({id: z.string().optional(), zipCode: z.string().optional(), saleData: z.object({lastUpdatedDate: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), history: z.object({"2025-06": z.object({date: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional()}).optional(), "2025-07": z.object({date: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional()}).optional(), "2025-08": z.object({date: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averagePrice: z.number().optional(), medianPrice: z.number().optional(), minPrice: z.number().optional(), maxPrice: z.number().optional(), averagePricePerSquareFoot: z.number().optional(), medianPricePerSquareFoot: z.number().optional(), minPricePerSquareFoot: z.number().optional(), maxPricePerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional()}).optional()}).optional()}).optional(), rentalData: z.object({lastUpdatedDate: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), history: z.object({"2025-06": z.object({date: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional()}).optional(), "2025-07": z.object({date: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional()}).optional(), "2025-08": z.object({date: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional(), dataByPropertyType: z.array(z.object({propertyType: z.string().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional(), dataByBedrooms: z.array(z.object({bedrooms: z.number().optional(), averageRent: z.number().optional(), medianRent: z.number().optional(), minRent: z.number().optional(), maxRent: z.number().optional(), averageRentPerSquareFoot: z.number().optional(), medianRentPerSquareFoot: z.number().optional(), minRentPerSquareFoot: z.number().optional(), maxRentPerSquareFoot: z.number().optional(), averageSquareFootage: z.number().optional(), medianSquareFootage: z.number().optional(), minSquareFootage: z.number().optional(), maxSquareFootage: z.number().optional(), averageDaysOnMarket: z.number().optional(), medianDaysOnMarket: z.number().optional(), minDaysOnMarket: z.number().optional(), maxDaysOnMarket: z.number().optional(), newListings: z.number().optional(), totalListings: z.number().optional()})).optional()}).optional()}).optional()}).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Market Statistics * * GET /markets */ export const getApiMarkets = async (args: GetApiMarketsArgs, options?: GetApiMarketsOptions) => { const {baseUrl = "https://api.rentcast.io/v1", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.zipCode != null) query.append("zipCode", String(args.zipCode)) if (args.dataType != null) query.append("dataType", String(args.dataType)) if (args.historyRange != null) query.append("historyRange", String(args.historyRange)) if (ApiKeyAuth !== undefined) headers.set("X-Api-Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/markets${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiMarketsResponse, await res.json()) };