> ## 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. # SpareRoom: Search > Search from SpareRoom. Costs 1 credit per successful call. 1 credit per successful call; failed calls are free. See the [SpareRoom API overview](https://perceptlayer.com/apis/spareroom) for every SpareRoom endpoint. ## OpenAPI ````yaml /openapi.json get /v1/spareroom/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/spareroom/search: get: tags: - SpareRoom summary: Search description: Search from SpareRoom. Costs 1 credit per successful call. operationId: spareroom_search parameters: - name: where in: query required: true schema: type: string maxLength: 100 - name: page in: query required: false schema: type: integer - name: sort in: query required: false schema: type: string enum: - relevance - newest - last_updated - price_low_to_high - price_high_to_low - name: min_rent in: query required: false schema: type: integer - name: max_rent in: query required: false schema: type: integer - name: rent_period in: query required: false schema: type: string enum: - pcm - pw - name: bills_included in: query required: false schema: type: string enum: - 'true' - 'false' - '1' - '0' - name: available_from in: query required: false schema: type: string - name: types in: query required: false schema: type: string - name: room_types in: query required: false schema: type: string enum: - double - single - name: ensuite in: query required: false schema: type: string enum: - 'Y' - name: furnished in: query required: false schema: type: string enum: - 'Y' - 'N' - name: rooms_for in: query required: false schema: type: string enum: - males - females - couples - name: share_type in: query required: false schema: type: string enum: - P - S - name: genderfilter in: query required: false schema: type: string enum: - males - females - mixed - name: gayshare in: query required: false schema: type: string enum: - 'Y' - name: vegetarians in: query required: false schema: type: string enum: - 'Y' - name: disabled_access in: query required: false schema: type: string enum: - 'Y' - name: living_room in: query required: false schema: type: string enum: - shared - name: parking in: query required: false schema: type: string enum: - 'Y' - name: smoking in: query required: false schema: type: string enum: - 'Y' - 'N' - name: pets_req in: query required: false schema: type: string enum: - 'Y' - name: days_of_wk_available in: query required: false schema: type: string enum: - Mon to Fri only - 7 days a week - name: short_lets_considered in: query required: false schema: type: string enum: - 'Y' - name: posted_by in: query required: false schema: type: string enum: - private_landlords - flatmates - agents - co_live - name: landlord in: query required: false schema: type: string enum: - live_in - live_out - name: photoadsonly in: query required: false schema: type: string enum: - 'Y' - name: free_to_contact in: query required: false schema: type: string enum: - 'Y' - name: no_deposit in: query required: false schema: type: string enum: - 'Y' - name: verified_users in: query required: false schema: type: string enum: - 'Y' - name: min_term in: query required: false schema: type: integer - name: max_term in: query required: false schema: type: integer - name: no_of_rooms in: query required: false schema: type: integer - name: min_age_req in: query required: false schema: type: integer - name: max_age_req in: query required: false schema: type: integer - name: min_beds in: query required: false schema: type: integer - name: max_beds 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: where: type: string response: type: object properties: success: type: boolean data: type: object properties: type: type: string where: type: string page: type: integer page_size: type: integer page_count: type: integer has_next_page: type: boolean result_count: type: integer total_pool: type: integer rows_reachable: type: integer truncated: type: boolean total_rooms_available: type: integer location: type: object properties: latitude: type: number longitude: type: number latitude_delta: type: number longitude_delta: type: number areas: type: array items: type: object properties: id: type: integer name: type: string filter_options: type: array items: type: object properties: group: type: string options: type: array items: type: object properties: label: type: string count: type: integer params: type: string results: type: array items: type: object properties: id: type: integer url: type: string title: type: string excerpt: type: string ad_type: type: string accommodation_type: type: string property_type: type: string status: type: string rooms_in_property: type: integer rooms_for_rent: type: integer double_rooms: type: integer rent: type: object properties: min: type: integer period: type: string rent_options: type: string currency: type: string rooms: type: array items: type: object properties: type: type: string price: type: integer period: type: string security_deposit: type: integer status: type: string furnishings: type: string security_deposit: type: integer availability: type: object properties: from: type: string from_iso: type: string days_per_week: type: string couples_allowed: type: boolean location: type: object properties: postcode: type: string neighbourhood: type: string latitude: type: number longitude: type: number nearest_station: type: object properties: name: type: string zone: type: string images: type: object properties: tiny: type: string thumb: type: string standard: type: string large: type: string square: type: string advertiser: type: object properties: id: type: integer uuid: type: string name: type: string type: type: string type_code: type: string verified: type: boolean photo_checks: type: array items: type: string additional_checks: type: array items: type: string profile_photo: type: string promotion: type: object properties: label: type: string featured: type: boolean bold: type: boolean has_video: type: boolean early_bird_required: type: boolean expires_at: type: string bills_included: type: string meta: type: object properties: endpoint_family: type: string billable: type: boolean retryable: type: boolean duration_ms: type: integer description: >- The fields of a recorded response. Other responses can carry more, or leave some out. example: endpoint: spareroom.search params: where: London response: success: true data: type: results where: London page: 1 page_size: 100 page_count: 10 has_next_page: true result_count: 100 total_pool: 12891 rows_reachable: 1000 truncated: true total_rooms_available: 16127 location: latitude: 51.51648767499999 longitude: -0.10976950833333333 latitude_delta: 0.291945783904339 longitude_delta: 0.47141769068993 areas: - id: 1 name: The East End - id: 2 name: Outer East End / Newham - id: 3 name: Docklands filter_options: - group: Price options: - label: Up to £900pcm count: 4906 params: … - label: £901 to £1,300pcm count: 5965 params: … - label: £1,301pcm plus count: 2588 params: … - group: Types options: - label: Rooms in existing shares count: 11036 params: … - label: Studios / 1 Beds count: 1071 params: … - label: Whole properties (suitable for sharing) count: 777 params: … - group: Rooms options: - label: Double rooms count: 11856 params: … - label: Single rooms count: 1315 params: … - label: Rooms with en-suite count: 2572 params: … results: - id: 18472716 url: https://www.spareroom.co.uk/18472716 title: 1-Bed penthouse flat near Canary Wharf excerpt: >- Modern 1-bed flat with wrap-around terrace. Furnished Perfectly located between Canary Wharf and the City. Between Limehouse and Westferry DLR stations, m. ad_type: offered accommodation_type: 1 bed flat or studio property_type: Flat status: Available rooms_in_property: 1 rooms_for_rent: 1 double_rooms: 1 rent: min: 2500 period: pcm rent_options: whole currency: GBP rooms: - type: double price: 2500 period: pcm status: available furnishings: unfurnished security_deposit: 2500 availability: from: '2026-11-23' from_iso: '2026-11-23T12:00:00Z' days_per_week: 7 days a week couples_allowed: true location: postcode: E14 neighbourhood: Westferry latitude: 51.513191 longitude: -0.0292769 images: tiny: >- https://photos2.spareroom.co.uk/images/flatshare/listings/tiny/10/19/101956202.jpg thumb: >- https://photos2.spareroom.co.uk/images/flatshare/listings/thumbs/10/19/101956202.jpg standard: >- https://photos2.spareroom.co.uk/images/flatshare/listings/10/19/101956202.jpg large: >- https://photos2.spareroom.co.uk/images/flatshare/listings/large/10/19/101956202.jpg square: >- https://photos2.spareroom.co.uk/images/flatshare/listings/square/10/19/101956202.jpg advertiser: id: 25592173 uuid: bhDJ9wMYovyCnpiwL2NZMA name: Quentin type: live out landlord type_code: live_out_landlord verified: true photo_checks: - name - date_of_birth additional_checks: - phone - email promotion: label: New Today featured: false bold: true has_video: false early_bird_required: false expires_at: '2026-11-20T20:45:36Z' - id: 17985606 url: https://www.spareroom.co.uk/17985606 title: Stylish Double Room in Stoke Newington 🏡+Garden excerpt: >- ***Men preferred property***Spacious double room available in a beautifully kept Victorian garden flat on a quiet residential street in Stoke Newington. This is not your typical house share — it’s a calm, well-maintained home with a premiu… ad_type: offered accommodation_type: Double room property_type: Flat status: Available rooms_in_property: 3 rooms_for_rent: 1 double_rooms: 1 rent: min: 950 period: pcm rent_options: room currency: GBP rooms: - type: double price: 950 period: pcm security_deposit: 950 status: available ensuite: false furnishings: furnished bills_included: 'yes' security_deposit: 950 availability: from: '2026-12-03' from_iso: '2026-12-03T12:00:00Z' days_per_week: 7 days a week couples_allowed: true location: postcode: N16 neighbourhood: Stoke Newington latitude: 51.560814 longitude: -0.0682005 images: tiny: >- https://photos2.spareroom.co.uk/images/flatshare/listings/tiny/10/19/101955949.jpg thumb: >- https://photos2.spareroom.co.uk/images/flatshare/listings/thumbs/10/19/101955949.jpg standard: >- https://photos2.spareroom.co.uk/images/flatshare/listings/10/19/101955949.jpg large: >- https://photos2.spareroom.co.uk/images/flatshare/listings/large/10/19/101955949.jpg square: >- https://photos2.spareroom.co.uk/images/flatshare/listings/square/10/19/101955949.jpg advertiser: id: 24351788 uuid: llFabfb4so8eWG9xVlXzZw name: Ricco&Nicholas type: live in landlord type_code: live_in_landlord verified: true photo_checks: - name - date_of_birth additional_checks: - phone - email profile_photo: >- https://photos2.spareroom.co.uk/images/flatshare/listings/large/10/19/101956055.jpg promotion: label: New Today featured: false bold: true has_video: false early_bird_required: false expires_at: '2026-11-20T19:57:01Z' - id: 16746915 url: https://www.spareroom.co.uk/16746915 title: Spacious Double Room in Abbey Wood excerpt: "Hi,\r\nSpacious double room, available to let in a friendly 3-bed house share. The room is furnished with built in wardrobes and beautifully decorated with a 'homey' feel. 15 min walk from the Abbey Wood station!\r\nWould best suit professional…" ad_type: offered accommodation_type: Double room property_type: House status: Available rooms_in_property: 3 rooms_for_rent: 1 double_rooms: 1 rent: min: 700 period: pcm rent_options: room currency: GBP rooms: - type: double price: 700 period: pcm security_deposit: 700 status: available furnishings: furnished bills_included: 'yes' security_deposit: 700 availability: from: '2026-10-25' from_iso: '2026-10-25T12:00:00Z' days_per_week: 7 days a week couples_allowed: false location: postcode: SE2 neighbourhood: Abbey Wood latitude: 51.495941 longitude: 0.1081477 nearest_station: name: Abbey Wood zone: '4' images: tiny: >- https://photos2.spareroom.co.uk/images/flatshare/listings/tiny/88/06/88064039.jpg thumb: >- https://photos2.spareroom.co.uk/images/flatshare/listings/thumbs/88/06/88064039.jpg standard: >- https://photos2.spareroom.co.uk/images/flatshare/listings/88/06/88064039.jpg large: >- https://photos2.spareroom.co.uk/images/flatshare/listings/large/88/06/88064039.jpg square: >- https://photos2.spareroom.co.uk/images/flatshare/listings/square/88/06/88064039.jpg advertiser: id: 3909246 uuid: eEgM4EdNQuSJypBZZA0R5Q name: Edyta type: live in landlord type_code: live_in_landlord verified: true photo_checks: - name - date_of_birth additional_checks: - phone - email profile_photo: >- https://photos2.spareroom.co.uk/images/flatshare/listings/large/98/98/98987510.jpg promotion: label: New Today featured: false bold: true has_video: false early_bird_required: false expires_at: '2026-11-20T19:35:14Z' meta: endpoint_family: spareroom.search billable: true retryable: false duration_ms: 642 '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.