> ## Documentation Index > Fetch the complete documentation index at: https://docs.perceptlayer.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Perceptlayer is a web data API: one key for structured JSON from about 250 websites. Base URL https://api.perceptlayer.com. > Send the key in the X-API-Key header. GET parameters go in the query string; POST parameters in a JSON body. > A successful call costs the credits on its endpoint (X-Credits-Used); failed calls cost nothing. Errors are {"error": {"code", "message", "request_id"}}. > AI agents can use every endpoint through the MCP server at https://api.perceptlayer.com/mcp (tools search_endpoints, get_endpoint, call_endpoint), with Authorization: Bearer . > Get a free key at https://perceptlayer.com/signup. # HotPads: Search > Search from HotPads. Costs 1 credit per successful call. 1 credit per successful call; failed calls are free. See the [HotPads API overview](https://perceptlayer.com/apis/hotpads) for every HotPads endpoint. ## OpenAPI ````yaml /openapi.json get /v1/hotpads/search openapi: 3.1.0 info: title: Perceptlayer API version: 1.0.0 description: >- One API key for structured web data. Each successful call costs the credits shown on its endpoint; failed calls are free. servers: - url: https://api.perceptlayer.com security: - ApiKeyAuth: [] tags: - name: 99acres - name: Agoda - name: Airbnb - name: AliExpress - name: Apartments.com - name: Apple App Store - name: Aramisauto - name: Arbeitsagentur Jobs - name: Argenprop - name: Autohero - name: AutoScout24 - name: AutoTempest - name: AutoTrack.nl - name: Autotrader - name: AutoTrader.ca - name: AutoTrader UK - name: AutoUncle - name: Autovit - name: Baidu - name: Bandcamp - name: Bayut - name: Behance - name: Bien'ici - name: Bilbasen - name: Bilibili - name: Billiger.de - name: Bing - name: Blocket Bil - name: Bluesky - name: Boliga - name: Booking.com - name: Booli - name: Brave Search - name: Bring a Trailer - name: Capterra - name: CarDekho - name: CarGurus - name: CarMax - name: Cars & Bids - name: Cars.com - name: Cars24 - name: Carsales - name: Carvana - name: Carwow - name: Casa.it - name: Centris - name: Coches.net - name: Copart - name: Craigslist - name: Crexi - name: Daft.ie - name: Dailymotion - name: DBA - name: Depop - name: DeviantArt - name: Dice - name: Domain Availability - name: Domain.com.au - name: Dribbble - name: Dubizzle - name: DuckDuckGo - name: eBay - name: Economy Car Rentals - name: Edmunds - name: Eventbrite - name: Expedia - name: Facebook - name: Facebook Ad Library - name: Fincaraiz - name: FINN - name: FINN Bil - name: Flickr - name: FlixBus - name: Fotocasa - name: Geizhals - name: Genius - name: GetYourGuide - name: GitHub - name: Glassdoor - name: Goodreads - name: Google Ads Transparency - name: Google Events - name: Google Finance - name: Google Flights - name: Google Forums - name: Google Hotels - name: Google Images - name: Google Jobs - name: Google Lens - name: Google Local - name: Google Local Services - name: Google Maps - name: Google News - name: Google Patents - name: Google Play - name: Google Related Questions - name: Google Scholar - name: Google Search - name: Google Shopping - name: Google Short Videos - name: Google Translate - name: Google Travel Explore - name: Google Trends - name: Google Videos - name: Gumtree - name: Habitaclia - name: Hacker News - name: Hemnet - name: heycar - name: HolidayCheck - name: Holidu - name: Homegate - name: HomeToGo - name: Hostelworld - name: HotPads - name: IAAI - name: Idealista - name: Idealo - name: Imgur - name: ImmobilienScout24 - name: ImmobilienScout24 Austria - name: ImmoScout24 Switzerland - name: Immoweb - name: Immowelt - name: Imovirtual - name: Impressum Extraction - name: Indeed - name: InfoJobs - name: Inmuebles24 - name: Instagram - name: Jameda - name: Kavak - name: Kayak Flights - name: Kayak - name: Kelley Blue Book - name: Kick - name: Kijiji - name: Kiwi.com - name: Kleinanzeigen - name: kununu - name: Kwai - name: La Centrale - name: Leboncoin Autos - name: Leboncoin Immo - name: Lemmy - name: Letterboxd - name: Link in Bio - name: LinkedIn - name: Linktree - name: LLM Answers - name: LoopNet - name: Madlan - name: MagicBricks - name: Marktplaats - name: Marktplaats Autos - name: Mastodon - name: Medium - name: Mercado Libre - name: Metrocuadrado - name: Milanuncios - name: Mixcloud - name: mobile.de - name: Motors.co.uk - name: MyAnimeList - name: Naukri - name: Naver - name: North Data - name: Odysee - name: OfferUp - name: Ohne-Makler - name: OLX Poland - name: Omio - name: OnTheMarket - name: Otodom - name: Otomoto - name: Patreon - name: Pinterest - name: Private Property - name: Product Hunt - name: Property Finder - name: realestate.com.au - name: Realtor.ca - name: Redfin - name: Reed - name: Rentalcars.com - name: Rentalia - name: Ricardo - name: Rightmove - name: Rumble - name: SEEK - name: SeLoger - name: Semrush - name: Similarweb - name: Skyscanner - name: Snapchat - name: SoundCloud - name: SpareRoom - name: Spotahome - name: Spotify - name: Sreality - name: Standvirtual - name: Startpage - name: Steam - name: StepStone - name: Subito - name: Subito Motori - name: Substack - name: SuperCasa - name: Telegram - name: Threads - name: TikTok - name: Trade Me Property - name: Trainline - name: Tripadvisor - name: Trivago - name: TrueCar - name: Trulia - name: Trusted Shops - name: Trustpilot - name: Truth Social - name: Tumblr - name: tutti.ch - name: Twitch - name: Viator - name: Vimeo - name: Vinted - name: VivaReal - name: VK - name: Vrbo - name: Wallapop - name: Walmart - name: Web Scraper - name: Weibo - name: Welcome to the Jungle - name: WG-Gesucht - name: willhaben - name: wlw - name: X (Twitter) - name: XING Jobs - name: Yad2 - name: Yaencontre - name: Yahoo Search - name: Yelp - name: YouTube - name: Zillow - name: Zonaprop - name: Zoopla - name: Zumper paths: /v1/hotpads/search: get: tags: - HotPads summary: Search description: Search from HotPads. Costs 1 credit per successful call. operationId: hotpads_search parameters: - name: area in: query required: true schema: type: string maxLength: 100 example: albuquerque-nm - name: type in: query required: false schema: type: string enum: - apartments - houses - condos - townhomes example: apartments - name: beds in: query required: false schema: type: integer - name: min_price in: query required: false schema: type: integer - name: max_price in: query required: false schema: type: integer - name: page in: query required: false schema: type: integer responses: '200': description: Success headers: X-Request-Id: $ref: '#/components/headers/RequestId' X-Credits-Used: $ref: '#/components/headers/CreditsUsed' X-Credits-Remaining: $ref: '#/components/headers/CreditsRemaining' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' RateLimit-Policy: $ref: '#/components/headers/RateLimitPolicy' content: application/json: schema: type: object properties: endpoint: type: string params: type: object properties: area: type: string type: type: string response: type: object properties: success: type: boolean data: type: object properties: area: type: object properties: title: type: string url: type: string results: type: array items: type: object properties: id: type: string name: type: string url: type: string listing_id: type: string property_type: type: string listing_type: type: string address: type: object properties: street: type: string city: type: string state: type: string zip: type: string location: type: object properties: latitude: type: number longitude: type: number price: type: object properties: min: type: integer max: type: integer currency: type: string beds: type: object properties: min: type: integer max: type: integer baths: type: object properties: min: type: integer max: type: integer sqft: type: object properties: min: type: integer max: type: integer unit_count: type: integer price_drop_count: type: integer labels: type: array items: type: string photos: type: array items: type: string listed_at: type: string updated_at: type: string special_offer: type: string page: type: integer per_page: type: integer total_pages: type: integer total_results: type: integer has_more: type: boolean meta: type: object properties: endpoint_family: type: string billable: type: boolean description: >- The fields of a recorded response. Other responses can carry more, or leave some out. example: endpoint: hotpads.search params: area: albuquerque-nm type: apartments response: success: true data: area: title: Albuquerque, NM Apartments for Rent url: https://hotpads.com/albuquerque-nm/apartments-for-rent results: - id: 249njun name: Markana Uptown url: >- https://hotpads.com/markana-uptown-albuquerque-nm-87110-249njun/pad listing_id: 2q29a1ud4hqp5 property_type: large listing_type: rental address: street: 6500 Americas Pkwy NE city: Albuquerque state: NM zip: '87110' location: latitude: 35.101585147458174 longitude: -106.57245218753815 price: min: 1732 max: 2529 currency: USD beds: min: 0 max: 2 baths: min: 1 max: 2 sqft: min: 589 max: 1022 unit_count: 12 price_drop_count: 2 labels: - New Today - Special Offer - Price Drop photos: - >- https://photos.zillowstatic.com/fp/a1c71fa224ed5d373f00702513e7ce94-rentals_large_1200_1200.webp - >- https://photos.zillowstatic.com/fp/948e490e4de99ba09290e000be6c2963-rentals_large_1200_1200.webp - >- https://photos.zillowstatic.com/fp/ebe577cd972f71084a7d73c1f31ad2ba-rentals_large_1200_1200.webp listed_at: '2023-10-25T14:34:52Z' updated_at: '2026-10-22T00:55:05Z' - id: 24ujecn name: Allaso Olivine url: >- https://hotpads.com/allaso-olivine-albuquerque-nm-87113-24ujecn/pad listing_id: 4f522xwhsm7ad property_type: large listing_type: rental address: street: 6925 Alameda Blvd NE city: Albuquerque state: NM zip: '87113' location: latitude: 35.185219271148405 longitude: -106.56940519809723 price: min: 1495 max: 2337 currency: USD beds: min: 0 max: 2 baths: min: 1 max: 2 sqft: min: 643 max: 1173 unit_count: 6 price_drop_count: 5 special_offer: $$500 Off labels: - $$500 Off - Price Drop photos: - >- https://photos.zillowstatic.com/fp/5616333195e43fb534575d18c588aba2-rentals_large_1200_1200.webp - >- https://photos.zillowstatic.com/fp/4a61dd6ef988234d0ea26000f70f775f-rentals_large_1200_1200.webp - >- https://photos.zillowstatic.com/fp/9576ee227e694714c8c9c418049b637d-rentals_large_1200_1200.webp listed_at: '2025-08-29T20:47:01Z' updated_at: '2026-10-21T23:58:15Z' - id: 24fd5j2 name: Allaso Vineyards url: >- https://hotpads.com/allaso-vineyards-albuquerque-nm-87122-24fd5j2/pad listing_id: 2c8mre655n0z6 property_type: large listing_type: rental address: street: 8901 Holly Ave NE city: Albuquerque state: NM zip: '87122' location: latitude: 35.17594813075956 longitude: -106.54412806034088 price: min: 1722 max: 2393 currency: USD beds: min: 1 max: 2 baths: min: 1 max: 2 sqft: min: 634 max: 1154 unit_count: 7 price_drop_count: 3 special_offer: 2 Weeks Free labels: - New Today - 2 Weeks Free - Price Drop photos: - >- https://photos.zillowstatic.com/fp/31fd1c7864172098f9c6095072b18a94-rentals_large_1200_1200.webp - >- https://photos.zillowstatic.com/fp/d1508d9e73bec2e49979cfd8a4919c67-rentals_large_1200_1200.webp - >- https://photos.zillowstatic.com/fp/d7d5695ea5d28dcc3454d94279690c8f-rentals_large_1200_1200.webp listed_at: '2024-06-20T19:46:59Z' updated_at: '2026-10-23T17:55:55Z' page: 1 per_page: 40 total_pages: 10 total_results: 3541 has_more: true meta: endpoint_family: search billable: true '401': $ref: '#/components/responses/Error' '402': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' '404': $ref: '#/components/responses/Error' '410': $ref: '#/components/responses/Error' '422': $ref: '#/components/responses/Error' '429': $ref: '#/components/responses/Error' '502': $ref: '#/components/responses/Error' '503': $ref: '#/components/responses/Error' '504': $ref: '#/components/responses/Error' components: headers: RequestId: description: Unique ID for this request; quote it in support requests. schema: type: string CreditsUsed: description: Credits charged for this call (0 when it failed). schema: type: integer CreditsRemaining: description: Your balance after this call. schema: type: integer RateLimitLimit: description: >- Requests a minute your account may make: its rate in requests per second times 60. schema: type: integer RateLimitRemaining: description: Requests left in the current minute, shared by every key on the account. schema: type: integer RateLimitReset: description: Seconds until the current minute's count starts over. schema: type: integer RateLimitPolicy: description: The limit and its window in seconds, for example "300;w=60". schema: type: string responses: Error: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object required: - error properties: error: type: object required: - code - message - request_id properties: code: type: string message: type: string request_id: type: string securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.