> ## Documentation Index > Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt > Use this file to discover all available pages before exploring further. # Zillow search API > Call the Zillow search API to get listings and total, as JSON or markdown. 3 credits per 41 items, at least 3 credits. * **Endpoint:** `zillow.search` * **Returns:** `data` has `listings`, `total`. * **Cost:** 3 credits per 41 items, at least 3 credits. Failed calls cost nothing. * **Paging:** Yes. Send the `cursor` from the response to get the next page. See [Paging](/advanced-guide#paging). ## Example ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null} import { Stophy } from "stophy"; const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY }); const result = await stophy.zillow.search({ location: "Austin, TX" }); console.log(result.data.listings); ``` ```python Python icon="python" theme={null} from stophy import Stophy stophy = Stophy() # reads STOPHY_API_KEY result = stophy.zillow.search(location="Austin, TX") print(result["data"]["listings"]) ``` ```bash cURL icon="terminal" theme={null} curl -X POST https://api.stophy.dev/v1/zillow/search \ -H "Authorization: Bearer $STOPHY_API_KEY" \ -H "content-type: application/json" \ -d '{"location":"Austin, TX"}' ``` ```bash CLI icon="square-terminal" theme={null} stophy zillow search --location "Austin, TX" ``` ## OpenAPI ````yaml api-reference/openapi.json POST /v1/zillow/search openapi: 3.1.0 info: title: Stophy API version: '1' description: >- Every endpoint is a POST that takes its input as a JSON object body. Unknown fields are rejected with 400. Send Accept: text/markdown to get markdown instead of JSON. Responses leave out empty values: null, empty strings, empty objects and empty nested lists are not sent. x-credits is what one call costs. When x-per-items is set, a call costs x-credits for every x-per-items items it returns, and at least x-credits. When a response has a cursor, send it back with the same input to get the next page. servers: - url: https://api.stophy.dev security: - apiKey: [] paths: /v1/zillow/search: post: summary: Search homes for sale, for rent or sold description: Costs 3 credits per 41 items. Pages with cursor. operationId: zillowSearch requestBody: required: true content: application/json: schema: type: object properties: location: type: string minLength: 2 maxLength: 200 bounds: type: object properties: west: type: number minimum: -180 maximum: 180 east: type: number minimum: -180 maximum: 180 south: type: number minimum: -90 maximum: 90 north: type: number minimum: -90 maximum: 90 required: - west - east - south - north status: default: forSale type: string enum: - forSale - forRent - sold sort: default: relevance type: string enum: - relevance - newest - priceHigh - priceLow - bedrooms - bathrooms - sqft - lot price: type: object properties: min: type: number minimum: 0 max: type: number minimum: 0 bedrooms: type: object properties: min: type: number minimum: 0 max: type: number minimum: 0 bathrooms: type: object properties: min: type: number minimum: 0 max: type: number minimum: 0 sqft: type: object properties: min: type: number minimum: 0 max: type: number minimum: 0 lotSqft: type: object properties: min: type: number minimum: 0 max: type: number minimum: 0 yearBuilt: type: object properties: min: type: number minimum: 0 max: type: number minimum: 0 hoa: type: object properties: max: type: number minimum: 0 required: - max homeTypes: minItems: 1 type: array items: type: string enum: - house - townhouse - multiFamily - condo - land - apartment - manufactured listingTypes: minItems: 1 type: array items: type: string enum: - agent - owner - newConstruction - comingSoon - auction - foreclosure within: default: all type: string enum: - day - week - twoWeeks - month - threeMonths - sixMonths - year - twoYears - threeYears - all query: type: string minLength: 1 maxLength: 200 features: minItems: 1 type: array items: type: string enum: - garage - pool - airConditioning - waterfront - singleStory - openHouse - tour3d - cityView - parkView - waterView - mountainView - catsAllowed - furnished limit: default: 41 type: integer minimum: 1 maximum: 410 cursor: type: string pattern: ^(?:\d{1,4}~(?:[2-9]|1\d|20)?|(?:[2-9]|1\d|20))$ additionalProperties: false example: location: Austin, TX responses: '200': description: The data, and the credits this call used. headers: X-Request-ID: $ref: '#/components/headers/RequestId' x-credits-used: $ref: '#/components/headers/CreditsUsed' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' content: application/json: schema: type: object required: - success - data - creditsUsed - requestId properties: success: const: true data: type: object additionalProperties: false properties: listings: type: array items: type: object additionalProperties: false properties: id: type: string url: type: string format: uri status: type: string enum: - forSale - forRent - sold - other statusText: type: string price: type: number minimum: 0 currency: type: string pattern: ^[A-Z]{3}$ description: ISO 4217 currency code, e.g. USD. address: type: object additionalProperties: false properties: full: type: string street: type: string city: type: string state: type: string postalCode: type: string country: type: string required: [] location: type: object additionalProperties: false properties: lat: type: number minimum: -90 maximum: 90 lng: type: number minimum: -180 maximum: 180 required: - lat - lng bedrooms: type: number bathrooms: type: number sqft: type: number homeType: type: string daysOnZillow: type: integer minimum: -9007199254740991 maximum: 9007199254740991 lastSoldAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ zestimate: type: number rentZestimate: type: number broker: type: object additionalProperties: false properties: name: type: string required: [] image: type: string format: uri building: type: object additionalProperties: false properties: name: type: string minRent: type: number maxRent: type: number availableUnits: type: integer minimum: -9007199254740991 maximum: 9007199254740991 units: type: array items: type: object additionalProperties: false properties: bedrooms: type: number price: type: number minimum: 0 required: [] required: [] required: - url - status total: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cursor: type: string required: - listings creditsUsed: type: integer requestId: type: string text/markdown: schema: type: string 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: headers: RequestId: description: The request id. Quote it when you report a problem. schema: type: string CreditsUsed: description: Credits this call used. schema: type: integer RateLimitLimit: description: Requests allowed in the current window. schema: type: integer RateLimitRemaining: description: Requests left in the current window. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: The request failed. retryable says whether trying again can help. headers: X-Request-ID: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - success - error properties: success: const: false error: type: object required: - code - message - retryable - requestId properties: code: type: string enum: - cliSessionCompleted - cliSessionExists - cliSessionNotFound - forbidden - insufficientCredits - internalError - invalidCliSession - invalidCliVerifier - invalidRequest - notFound - rateLimited - sourceChanged - sourceRefused - sourceTimeout - sourceUnavailable - tooManyInFlight - unauthorized - unsupportedMediaType message: type: string retryable: type: boolean retryAfterSeconds: type: integer requestId: type: string securitySchemes: apiKey: type: http scheme: bearer ````