Scrappa's GET /api/viewit/search returns the ViewIt rentals of one Canadian city, with filters and paging.
What you get
items, each with listing_id, detail_path, url, address, bedrooms_label, bedrooms, unit_type (apartment, bachelor or room), price (CAD, null when the listing says "Call"), price_from (true for "from" prices), latitude, longitude, photo, description, sponsored and has_video. The pagination object holds page, per_page, total, total_pages, range_from, range_to and has_next_page.
Limits
ViewIt lists rentals only. There is no sale mode. A page holds 5 listings and there is no sort: the order is the order of the site. page is 1 to 20, so one query reaches 100 results. Narrow the filters to reach the rest; pagination.capped says when a query has more.
Filters are honoured
Every filter is applied by ViewIt and checked again on each item. A sponsored card ignores filters on the site, so a filtered search removes sponsored cards. A rental with no price ("Call") is removed when a price filter is set. Removed items are counted in items_dropped, and total_includes_dropped says when pagination.total contains them. A page the site did not serve is never relabelled: a page past the last page returns 422 PAGE_OUT_OF_RANGE.
Bedrooms
bedrooms is a comma list of room, bachelor, 1, 2 and 3plus (three or more). Example: bedrooms=1,2.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
9 optional filters available.
integer
Required
City id from the autocomplete endpoint, for example 14 (Toronto) or 34 (Ottawa).
14
string
Optional
Comma list of room, bachelor, 1, 2 and 3plus (three or more). Example: 1,2.
2
integer
Optional
Minimum monthly rent in CAD. Checked again on every item.
10
integer
Optional
Maximum monthly rent in CAD. Checked again on every item.
2500
string
Optional
Word the listing text must contain, for example parking, downtown or university.
running shoes
boolean
Optional
Send true to see furnished rentals only.
true
boolean
Optional
Send true to see lofts only.
true
boolean
Optional
Send true to see retirement residences only.
true
boolean
Optional
Send true to see short term rentals only.
true
integer
Optional
Result page, 1 to 20. A page holds up to 5 listings.
1
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: YOUR_API_KEY_HERE"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
<?php
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500', options)
.then(response => {
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
return response.text();
})
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500',
headers: {
x-api-key: 'YOUR_API_KEY_HERE',
}
};
try {
const response = await axios(options);
console.log(response.data);
} catch (error) {
console.error('Error:', error.message);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'
begin
response = http.request(request)
puts response.body
rescue => e
puts "Error: #{e.message}"
end
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/viewit/search?city_id=14&bedrooms=2&price_max=2500", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
public class ApiExample {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500")
.addHeader("x-api-key", "YOUR_API_KEY_HERE")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Error: " + response.code());
}
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500", nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error making request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500"
using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");
try
{
var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
use reqwest::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.get("https://scrappa.co/api/viewit/search?city_id=14&bedrooms=2&price_max=2500")
.header("x-api-key", "YOUR_API_KEY_HERE")
.send()
.await?;
println!("{}", response.text().await?);
Ok(())
}
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
success
data
meta
{
"success": true,
"data": {
"items": [
{
"listing_id": 3844,
"detail_path": "468470SummerhillAve-Toronto-2bdrm-VIT=3844",
"url": "https://www.viewit.ca/468470SummerhillAve-Toronto-2bdrm-VIT=3844",
"address": "468, 470 Summerhill Ave",
"bedrooms_label": "2 bds",
"bedrooms": 2,
"unit_type": "apartment",
"price": 2200,
"price_from": false,
"currency": "CAD",
"latitude": 43.686504,
"longitude": -79.374658,
"photo": "https://images.viewit.ca/3844/Image058.jpg",
"description": "Available immediately. Beautiful Rosedale. Totally renovated 2 bedroom with dishwasher.",
"sponsored": false,
"has_video": true
}
],
"pagination": {
"page": 1,
"per_page": 5,
"total": 27,
"total_pages": 6,
"max_pages": 20,
"capped": false,
"range_from": 1,
"range_to": 5,
"has_next_page": true
},
"items_dropped": 0,
"total_includes_dropped": true,
"applied_filters": {
"city_id": 14,
"bedrooms": "2",
"price_max": 2500
}
},
"meta": {
"endpoint_family": "search",
"billable": true,
"attempts": 1,
"items_dropped": 0
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected, never ignored. Non-billable.
{
"errors": {
"page": [
"The page field must not be greater than 20."
]
},
"message": "The page field must not be greater than 20."
}Page Out of Range
The page is past the last page of results (`PAGE_OUT_OF_RANGE`). ViewIt serves at most 20 pages (100 results) per query: narrow the filters, for example with a price band. Non-billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "search"
},
"error": {
"code": "PAGE_OUT_OF_RANGE",
"message": "That page is past the last page of results. Use a lower page or narrow the filters."
},
"success": false
}Upstream Unavailable
ViewIt could not be reached, refused the request or answered with a page this API could not read (`UPSTREAM_UNAVAILABLE`). Retryable and never billed. Clients are never rate limited.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "search"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "ViewIt could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.