# PadMapper Rental Search Searches PadMapper rentals (rent only, PadMapper has no sale listings) in the US and Canada. Pass a location slug from autocomplete and filter by rent, bedrooms, bathrooms, pets, category, and photos. Each listing carries address, coordinates, rent range, beds, baths, pets, amenities, image ids and links, building, and agent name, brokerage, and phone. Agent email is never returned. total is the number of matches PadMapper reports for the filters. Every returned row obeys them: with a price filter, listings without a rent are left out and counted in excluded, and total still counts them. - **Documentation:** [https://scrappa.co/docs/padmapper-api/padmapper_search](https://scrappa.co/docs/padmapper-api/padmapper_search) - **API group:** PadMapper API - **Endpoint:** `GET https://scrappa.co/api/padmapper/search` ## Authentication Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key. ## Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `location` | string | Yes | Location slug from autocomplete: city and state or province code, optionally with a neighborhood or ZIP, for example toronto-on, new-york-ny/chelsea or houston-tx/77002. | | `min_price` | integer | No | Lowest monthly rent. A building matches when any of its units falls in the price window, so read min_price and max_price on each row. | | `max_price` | integer | No | Highest monthly rent. Same range rule as min_price. | | `bedrooms[]` | array | No | Bedroom counts to include, 0 for a studio. Repeat the parameter. | | `min_bathrooms` | integer | No | Lowest bathroom count. | | `max_bathrooms` | integer | No | Highest bathroom count. | | `pets[]` | array | No | Pet policies to require: cat, small_dog, large_dog. Allowed: cat, small_dog, large_dog. | | `categories[]` | array | No | Property categories to include: apartment, house, room, other. Allowed: apartment, house, room, other. | | `has_images` | boolean | No | Only return listings that have photos. | | `sort` | string | No | Sort by the lowest unit rent (min_price) of each row: price (low first) or -price (high first). Omit for the default PadMapper order. Allowed: price, -price. | | `page` | integer | No | Page number, starting at 1. Page n returns the rows from (n - 1) x limit. | | `limit` | integer | No | Page size, 1 to 100. Default 20. | ## Example response ```json { "data": { "page": 1, "limit": 20, "total": 2157, "nearby": null, "offset": 0, "filters": { "pets": null, "user_id": null, "bedrooms": [ 0, 1, 2 ], "max_price": null, "min_price": null, "price_basis": null }, "excluded": 0, "featured": null, "has_more": true, "listings": [ { "tz": "America/Toronto", "lat": 43.66408935560209, "lng": -79.41092795579786, "url": "/buildings/p1113084/mirvish-village-apartments-at-748-bathurst-st-toronto-on-m5s-2r6", "city": "Toronto", "pets": [ 3, 2, 1 ], "pb_id": 1113084, "phone": null, "pl_id": null, "state": "ON", "title": "571 1 Bedroom 1 Bathroom B2", "is_pad": false, "pa_url": "748-bathurst-st-toronto-on-m5s-2r6-can", "pb_url": "mirvish-village-south-annex-toronto-on", "pl_url": null, "rating": null, "address": "748 Bathurst St", "zipcode": "M5S 2R6", "agent_id": 15994679, "external": 0, "features": [ 72, 22, 93 ], "group_id": -2058520, "has_fees": true, "viewings": null, "zappable": 0, "amenities": [ 8, 16, 2 ], "feed_name": "llws_mits41_bundle", "image_ids": [ 917895854, 921861420, 889765019 ], "listed_on": 1792961897, "max_price": 4300, "min_price": 2030, "agent_name": "Mirvish Village", "city_state": "toronto-on", "created_on": 1788179671, "fee_uplift": null, "image_urls": [ "https://img.zumpercdn.com/917895854/1280x960", "https://img.zumpercdn.com/921861420/1280x960", "https://img.zumpercdn.com/889765019/1280x960" ], "lease_type": 1, "listing_id": 65223975, "building_id": 2058520, "leasing_fee": null, "modified_on": 1792880146, "price_state": 3, "amenity_json": "{\"Air Conditioning\":{\"level\":2,\"group\":2,\"parent_display\":null},\"On-Site Management\":{\"level\":1,\"group\":5,\"parent_display\":null},\"Fitness Center\":{\"level\":1,\"group\":3,\"parent_display\":null},\"Outdoor Space\":{\"level\":1,\"group\":4,\"parent_display\":null},\"Microwave\":{\"level\":2,\"group\":1,\"parent_display\":null},\"Window Coverings\":{\"level\":2,\"group\":2,\"parent_display\":null},\"View\":{\"level\":2,\"group\":2,\"pa", "amenity_tags": [ "Air Conditioning", "Dishwasher", "Balcony" ], "brokerage_id": 1212064, "is_filter_ad": null, "listing_type": 1, "max_bedrooms": 3, "min_bedrooms": 0, "provider_url": null, "building_name": "Mirvish Village", "max_bathrooms": 2, "min_bathrooms": 1, "property_type": 4, "base_max_price": 4300, "base_min_price": 2030, "brokerage_name": "Peterson Rentals", "date_available": null, "is_messageable": true, "listing_status": 1, "max_lease_days": 365, "min_lease_days": 365, "previous_price": null, "promotion_type": 5, "floorplan_count": 38, "neighborhood_id": 43819, "pa_should_index": null, "pet_policy_json": null, "neighborhood_url": "/apartments/toronto-on/south-annex", "max_all_bathrooms": [ 2, 0 ], "min_all_bathrooms": [ 1, 0 ], "neighborhood_name": "South Annex", "short_description": null, "building_amenities": [ 11, 5, 16 ], "building_amenity_tags": [ "Air Conditioning", "On-Site Management", "Fitness Center" ], "min_price_lease_duration": null }, { "tz": "America/Toronto", "lat": 43.66951605739867, "lng": -79.44766573079183, "url": "/buildings/p1624543/the-diamond-apartments-at-950-lansdowne-ave-toronto-on-m6h-0e6", "city": "Toronto", "pets": [ 3, 2, 1 ], "pb_id": 1624543, "phone": null, "pl_id": null, "state": "ON", "title": "Diamond 2 - Plan A", "is_pad": false, "pa_url": "950-lansdowne-ave-toronto-on-m6h-0e6-can", "pb_url": "the-diamond-davenport-toronto-on", "pl_url": null, "rating": null, "address": "950 Lansdowne Ave", "zipcode": "M6H 0E6", "agent_id": 14980790, "external": 0, "features": [ 48, 72, 22 ], "group_id": -1818981, "has_fees": false, "viewings": null, "zappable": 0, "amenities": [ 1, 16, 2 ], "feed_name": "llws_mits41_bundle", "image_ids": [ 882548237, 882548238, 882548239 ], "listed_on": 1792918805, "max_price": 3809, "min_price": 2099, "agent_name": "The Diamond", "city_state": "toronto-on", "created_on": 1741897375, "fee_uplift": null, "image_urls": [ "https://img.zumpercdn.com/882548237/1280x960", "https://img.zumpercdn.com/882548238/1280x960", "https://img.zumpercdn.com/882548239/1280x960" ], "lease_type": 1, "listing_id": 60865974, "building_id": 1818981, "leasing_fee": null, "modified_on": 1792880145, "price_state": 3, "amenity_json": "{\"Onsite Laundry\":{\"level\":1,\"group\":3,\"parent_display\":null},\"Dishwasher\":{\"level\":2,\"group\":1,\"parent_display\":null},\"Central Heat\":{\"level\":2,\"group\":2,\"parent_display\":null},\"In-Unit Laundry\":{\"level\":2,\"group\":1,\"parent_display\":null},\"On-Site Management\":{\"level\":1,\"group\":5,\"parent_display\":null},\"Concierge Service\":{\"level\":1,\"group\":5,\"parent_display\":null},\"Fitness Center\":{\"level\":1,\"gr", "amenity_tags": [ "Onsite Laundry", "Air Conditioning", "Dishwasher" ], "brokerage_id": 1239359, "is_filter_ad": null, "listing_type": 1, "max_bedrooms": 3, "min_bedrooms": 1, "provider_url": null, "building_name": "The Diamond", "max_bathrooms": 2, "min_bathrooms": 1, "property_type": 4, "base_max_price": 3809, "base_min_price": 2099, "brokerage_name": "The Diamond", "date_available": null, "is_messageable": true, "listing_status": 1, "max_lease_days": 365, "min_lease_days": 365, "previous_price": null, "promotion_type": 5, "floorplan_count": 29, "neighborhood_id": 43812, "pa_should_index": null, "pet_policy_json": null, "neighborhood_url": "/apartments/toronto-on/davenport", "max_all_bathrooms": [ 2, 1 ], "min_all_bathrooms": [ 1, 0 ], "neighborhood_name": "Davenport", "short_description": null, "building_amenities": [ 4, 9, 1 ], "building_amenity_tags": [ "Onsite Laundry", "Dishwasher", "Central Heat" ], "min_price_lease_duration": null }, { "tz": "America/Toronto", "lat": 43.668075737714176, "lng": -79.4534049704803, "url": "/buildings/p1590938/the-spoke-apartments-at-485-perth-ave-toronto-on-m6n-0b9", "city": "Toronto", "pets": [ 3, 2, 1 ], "pb_id": 1590938, "phone": null, "pl_id": null, "state": "ON", "title": "A01 One Bedroom", "is_pad": false, "pa_url": "485-perth-ave-toronto-on-m6n-0b9-can", "pb_url": "the-spoke-carleton-village-toronto-on", "pl_url": null, "rating": null, "address": "485 Perth Ave", "zipcode": "M6N 0B9", "agent_id": 16033758, "external": 0, "features": [ 72, 22, 20 ], "group_id": -2064966, "has_fees": true, "viewings": null, "zappable": 0, "amenities": [ 1, 16, 2 ], "feed_name": "llws_mits41_bundle", "image_ids": [ 925277110, 892853309, 925277111 ], "listed_on": 1792961853, "max_price": 3767, "min_price": 2271, "agent_name": "The Spoke", "city_state": "toronto-on", "created_on": 1776473381, "fee_uplift": null, "image_urls": [ "https://img.zumpercdn.com/925277110/1280x960", "https://img.zumpercdn.com/892853309/1280x960", "https://img.zumpercdn.com/925277111/1280x960" ], "lease_type": 1, "listing_id": 64141570, "building_id": 2064966, "leasing_fee": null, "modified_on": 1792945089, "price_state": 3, "amenity_json": "{\"Onsite Laundry\":{\"level\":1,\"group\":3,\"parent_display\":null},\"Dishwasher\":{\"level\":2,\"group\":1,\"parent_display\":null},\"Balcony\":{\"level\":2,\"group\":2,\"parent_display\":null},\"Furnished\":{\"level\":2,\"group\":2,\"parent_display\":null},\"Central Heat\":{\"level\":2,\"group\":2,\"parent_display\":null},\"Walk-in Closet\":{\"level\":2,\"group\":2,\"parent_display\":null},\"In-Unit Laundry\":{\"level\":2,\"group\":1,\"parent_disp", "amenity_tags": [ "Onsite Laundry", "Air Conditioning", "Dishwasher" ], "brokerage_id": 930884, "is_filter_ad": null, "listing_type": 1, "max_bedrooms": 3, "min_bedrooms": 1, "provider_url": null, "building_name": "The Spoke", "max_bathrooms": 2, "min_bathrooms": 1, "property_type": 4, "base_max_price": 3767, "base_min_price": 2271, "brokerage_name": "TLR Property Management LP", "date_available": null, "is_messageable": true, "listing_status": 1, "max_lease_days": 365, "min_lease_days": 365, "previous_price": null, "promotion_type": 5, "floorplan_count": 54, "neighborhood_id": 43977, "pa_should_index": null, "pet_policy_json": null, "neighborhood_url": "/apartments/toronto-on/carleton-village", "max_all_bathrooms": [ 2, 0 ], "min_all_bathrooms": [ 1, 0 ], "neighborhood_name": "Carleton Village", "short_description": null, "building_amenities": [ 5, 4, 16 ], "building_amenity_tags": [ "Onsite Laundry", "Dishwasher", "Balcony" ], "min_price_lease_duration": null } ], "matching": 2157, "returned": 3, "counts_by": null, "listing_count": null }, "meta": { "duration_ms": 640, "upstream_calls": 1, "endpoint_family": "search" }, "success": true } ``` ## Errors | Status | Error | Description | | --- | --- | --- | | 404 | Not Found | The requested listing, building, agent, or city was not found. Rent reports exist for US cities only. This response is not billable. | | 422 | Validation Error | A required public parameter is missing or invalid. This response is not billable. | | 503 | Service Unavailable | The service could not obtain a complete result. This response is not billable. | ## More Scrappa resources - [API documentation](https://scrappa.co/docs) - [Full LLM-readable API reference](https://scrappa.co/llms-full.txt) - [OpenAPI specification](https://scrappa.co/docs/api.json) - [Pricing](https://scrappa.co/pricing)