import {z} from 'zod' export type GetApiV1ZillowAgentArgs = {username?: string | undefined, url?: string | undefined}; export type GetApiV1ZillowAgentOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const agentLicense = z.object({state: z.string().nullable().optional(), license_type: z.string().nullable().optional(), license_number: z.string().nullable().optional(), status: z.string().nullable().optional(), expiration: z.string().nullable().optional()}); export const agentReview = z.object({rating: z.number().int().nullable().optional(), comment: z.string().nullable().optional(), date: z.string().nullable().optional(), date_utc: z.number().nullable().optional(), date_at: z.string().nullable().optional(), work_description: z.string().nullable().optional(), reviewer_name: z.string().nullable().optional(), rebuttal: z.string().nullable().optional(), sub_ratings: z.array(z.record(z.string(), z.unknown())).optional()}); export const pastSale = z.object({zpid: z.string().nullable().optional(), street_address: z.string().nullable().optional(), city_state_zip: z.string().nullable().optional(), price: z.number().int().nullable().optional(), sold_date: z.string().nullable().optional(), sold_date_utc: z.number().nullable().optional(), sold_date_at: z.string().nullable().optional(), bedrooms: z.number().nullable().optional(), bathrooms: z.number().nullable().optional(), living_area: z.number().int().nullable().optional(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional(), represented: z.string().nullable().optional(), image_url: z.string().nullable().optional(), url: z.string().nullable().optional()}); export const listing = z.object({position: z.number().int(), zpid: z.string().nullable().optional(), id: z.string().nullable().optional(), detail_url: z.string().nullable().optional(), home_type: z.string().nullable().optional(), home_status: z.string().nullable().optional(), status_text: z.string().nullable().optional(), status_type: z.string().nullable().optional(), marketing_status: z.string().nullable().optional(), contingent_listing_type: z.string().nullable().optional(), price: z.number().int().nullable().optional(), price_raw: z.string().nullable().optional(), currency: z.string().nullable().optional(), price_change: z.number().int().nullable().optional(), date_price_changed_utc: z.number().nullable().optional(), date_price_changed_at: z.string().nullable().optional(), price_reduction: z.string().nullable().optional(), flex_field_text: z.string().nullable().optional(), zestimate: z.number().int().nullable().optional(), rent_zestimate: z.number().int().nullable().optional(), tax_assessed_value: z.number().int().nullable().optional(), beds: z.number().nullable().optional(), baths: z.number().nullable().optional(), living_area: z.number().int().nullable().optional(), lot_area_value: z.number().nullable().optional(), lot_area_unit: z.string().nullable().optional(), address: z.string().nullable().optional(), street_address: z.string().nullable().optional(), unit: z.string().nullable().optional(), city: z.string().nullable().optional(), state: z.string().nullable().optional(), zipcode: z.string().nullable().optional(), country: z.string().nullable().optional(), is_undisclosed_address: z.boolean().nullable().optional(), latitude: z.number().nullable().optional(), longitude: z.number().nullable().optional(), broker_name: z.string().nullable().optional(), provider_listing_id: z.string().nullable().optional(), days_on_zillow: z.number().int().nullable().optional(), is_zillow_owned: z.boolean().nullable().optional(), is_featured: z.boolean().nullable().optional(), is_showcase: z.boolean().nullable().optional(), is_fsba: z.boolean().nullable().optional(), is_new_construction: z.boolean().nullable().optional(), is_premier_builder: z.boolean().nullable().optional(), is_preforeclosure_auction: z.boolean().nullable().optional(), is_non_owner_occupied: z.boolean().nullable().optional(), img_src: z.string().nullable().optional(), has_image: z.boolean().nullable().optional(), has_video: z.boolean().nullable().optional(), has_3d_model: z.boolean().nullable().optional(), has_open_house: z.boolean().nullable().optional(), open_house_start: z.string().nullable().optional(), open_house_end: z.string().nullable().optional(), photos: z.array(z.string()).optional()}); export const agent = z.object({username: z.string().nullable().optional(), encoded_zuid: z.string().nullable().optional(), name: z.string().nullable().optional(), url: z.string().nullable().optional(), profile_photo: z.string().nullable().optional(), phone: z.string().nullable().optional(), email: z.string().nullable().optional(), business_name: z.string().nullable().optional(), business_address: z.string().nullable().optional(), broker_name: z.string().nullable().optional(), bio: z.string().nullable().optional(), rating: z.number().nullable().optional(), review_count: z.number().int().nullable().optional(), recent_sales_count: z.number().int().nullable().optional(), total_sales_last_year: z.number().int().nullable().optional(), for_sale_count: z.number().int().nullable().optional(), for_rent_count: z.number().int().nullable().optional(), past_sales_count: z.number().int().nullable().optional(), years_experience: z.number().int().nullable().optional(), is_top_agent: z.boolean().nullable().optional(), is_team_lead: z.boolean().nullable().optional(), license_number: z.string().nullable().optional(), license_state: z.string().nullable().optional(), website_url: z.string().nullable().optional(), facebook_url: z.string().nullable().optional(), linkedin_url: z.string().nullable().optional(), x_url: z.string().nullable().optional(), video_url: z.string().nullable().optional(), specialties: z.array(z.string()).optional(), service_areas: z.array(z.string()).optional(), languages: z.array(z.string()).optional(), licenses: z.array(agentLicense).optional(), professional_information: z.array(z.record(z.string(), z.unknown())).optional(), reviews: z.array(agentReview).optional(), past_sales: z.array(pastSale).optional(), listings: z.array(listing).optional(), scraped_utc: z.number().nullable().optional(), scraped_at: z.string().nullable().optional()}); export const getApiV1ZillowAgentResponse = z.object({agent: agent.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 }; /** * Get Agent Profile * * GET /v1/zillow/agent */ export const getApiV1ZillowAgent = async (args: GetApiV1ZillowAgentArgs, options?: GetApiV1ZillowAgentOptions) => { const {baseUrl = "https://scrapebadger.com", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.username != null) query.append("username", String(args.username)) if (args.url != null) query.append("url", String(args.url)) if (apiKey !== undefined) headers.set("x-api-key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/zillow/agent${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(getApiV1ZillowAgentResponse, await res.json()) };