{"openapi":"3.1.0","info":{"title":"Zillow API (Bowmark)","version":"bc1511aab02c","description":"Zillow, the US home listing site: search homes for sale, for rent and sold by city or ZIP, with price, beds, baths, Zestimate and listing agent; look up places, current mortgage rates, and calculate payments and affordability.\n\nEvery function Bowmark has for Zillow (zillow.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/zillow/searchLocations":{"post":{"operationId":"searchLocations","summary":"Turn a place name, ZIP, neighborhood or street address into Zillow regions and addresses (regionId, city, state, coordinates, zpid for an address).","description":"Turn a place name, ZIP, neighborhood or street address into Zillow regions and addresses (regionId, city, state, coordinates, zpid for an address).\n\nCalls `bowmark.providers.zillow.searchLocations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ZillowLocation[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SearchLocationsArgs","description":"TypeScript: `SearchLocationsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/zillow/searchHomes":{"post":{"operationId":"searchHomes","summary":"Find homes, houses, apartments, condos and townhouses for sale, for rent or recently sold in any US city or ZIP, such as Austin, Denver, Seattle, Chicago, Miami, Boston, Phoenix or New York (real esta","description":"Find homes, houses, apartments, condos and townhouses for sale, for rent or recently sold in any US city or ZIP, such as Austin, Denver, Seattle, Chicago, Miami, Boston, Phoenix or New York (real estate listings). Example: { location: 'Austin, TX', listingType: 'sale', maxPrice: 600000, minBeds: 3 }. Each home has address, price, beds, baths, size, Zestimate, days on Zillow and the listing url. Price and bed filters apply to the page's rows (41 per page).\n\nCalls `bowmark.providers.zillow.searchHomes`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ZillowHomeSearch>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SearchHomesArgs","description":"TypeScript: `SearchHomesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/zillow/getMortgageRates":{"post":{"operationId":"getMortgageRates","summary":"Today's average mortgage rates and APRs by program (30-year fixed, 15-year fixed, 5/1 ARM, FHA, VA), optionally for a state and credit-score band.","description":"Today's average mortgage rates and APRs by program (30-year fixed, 15-year fixed, 5/1 ARM, FHA, VA), optionally for a state and credit-score band.\n\nCalls `bowmark.providers.zillow.getMortgageRates`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MortgageRates>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MortgageRatesArgs","description":"TypeScript: `MortgageRatesArgs`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/zillow/calculateMortgagePayment":{"post":{"operationId":"calculateMortgagePayment","summary":"Monthly payment for a price, down payment, rate and term, split into principal and interest, property tax, insurance, HOA and PMI.","description":"Monthly payment for a price, down payment, rate and term, split into principal and interest, property tax, insurance, HOA and PMI. No network.\n\nCalls `bowmark.providers.zillow.calculateMortgagePayment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<MortgagePayment>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MortgagePaymentArgs","description":"TypeScript: `MortgagePaymentArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/zillow/calculateAffordability":{"post":{"operationId":"calculateAffordability","summary":"How much house can I afford: the highest home price a buyer can afford from income, monthly debts, down payment and interest rate, using the 36% debt-to-income rule.","description":"How much house can I afford: the highest home price a buyer can afford from income, monthly debts, down payment and interest rate, using the 36% debt-to-income rule. No network.\n\nCalls `bowmark.providers.zillow.calculateAffordability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<Affordability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/AffordabilityArgs","description":"TypeScript: `AffordabilityArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"AffordabilityArgs":{"type":"object","properties":{"annualIncome":{"type":"number"},"monthlyDebts":{"type":"number"},"downPayment":{"type":"number"},"rate":{"type":"number"},"termYears":{"type":"number"},"propertyTaxRate":{"type":"number"},"insuranceRate":{"type":"number"},"hoaMonthly":{"type":"number"}},"required":["annualIncome","rate"],"additionalProperties":true},"MortgagePaymentArgs":{"type":"object","properties":{"price":{"type":"number"},"downPayment":{"type":"number"},"rate":{"type":"number"},"termYears":{"type":"number"},"propertyTaxRate":{"type":"number"},"insuranceAnnual":{"type":"number"},"hoaMonthly":{"type":"number"}},"required":["price","rate"],"additionalProperties":true},"MortgageRatesArgs":{"type":"object","properties":{"state":{"type":"string"},"creditScore":{"type":"string"}},"additionalProperties":true},"SearchHomesArgs":{"type":"object","properties":{"location":{"anyOf":[{"type":"string"},{"type":"object","properties":{"display":{"type":"string"}},"required":["display"],"additionalProperties":true}]},"listingType":{"type":"string"},"minPrice":{"type":"number"},"maxPrice":{"type":"number"},"minBeds":{"type":"number"},"minBaths":{"type":"number"},"homeType":{"type":"string"},"page":{"type":"number"},"limit":{"type":"number"}},"required":["location"],"additionalProperties":true},"SearchLocationsArgs":{"type":"object","properties":{"query":{"type":"string"},"limit":{"type":"number"}},"required":["query"],"additionalProperties":true}}}}