Skip to content
Scrappa Get API key
ViewIt API 1 credit/request

ViewIt Listing Details API Documentation

GET https://scrappa.co/api/viewit/listing?id=3844

Scrappa's GET /api/viewit/listing returns the full record of one ViewIt rental.

What you get

price (CAD), price_from, utilities_note, address, city, province, postal_code, neighbourhood, latitude, longitude, bedrooms, bathrooms, description, amenities (15 yes/no flags such as air conditioning, parking, laundry, pets and dishwasher), every photo in images, floor_plans, videos, published_at, modified_at, company_name and contact_name. Fields a listing does not show are null. Studio and bachelor units have 0 bedrooms.

How to find a listing

Pass the listing_id of a search item as id. Pass its detail_path as path as well when you have it. The phone number, email, deposit and floor area are not public, so this API has none of them.

ViewIt Listing Details API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/viewit/listing?id=3844
Auth header
x-api-key
Cost
1 credit/request
id = 3844
Response preview
200 OK
{
    "success": true,
    "data": {
        "url": "https://www.viewit.ca/468470SummerhillAve-Toronto-2bdrm-VIT=3844",
        "listing_id": 3844,
        "title": "For Rent: 468, 470 Summerhill A Toronto, 2 Bdrm Viewit |3844",
        "price": 2200,
        "price_from": false,
        "currency": "CAD",
        "utilities_note": "Utilities Incl.",
        "address": "468, 470 Summerhill Ave",
        "city": "Toronto",
        "province": "ON",
        "postal_code": null,
...

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.

1 optional filter available.

id integer Required

listing_id from search, for example 3844.

Example value 3844
path string Optional

Optional detail_path of the search item, for example 468470SummerhillAve-Toronto-2bdrm-VIT=3844.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/viewit/listing?id=3844",
    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
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/viewit/listing?id=3844');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/viewit/listing?id=3844', 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));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/viewit/listing?id=3844',
    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);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/viewit/listing?id=3844")
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
Python
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/listing?id=3844", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/viewit/listing?id=3844', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
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/listing?id=3844")
        .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());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/viewit/listing?id=3844", 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))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/viewit/listing?id=3844"
C#
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/listing?id=3844"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/viewit/listing?id=3844',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
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/listing?id=3844")
        .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
JSON Response
200 OK
{
    "success": true,
    "data": {
        "url": "https://www.viewit.ca/468470SummerhillAve-Toronto-2bdrm-VIT=3844",
        "listing_id": 3844,
        "title": "For Rent: 468, 470 Summerhill A Toronto, 2 Bdrm Viewit |3844",
        "price": 2200,
        "price_from": false,
        "currency": "CAD",
        "utilities_note": "Utilities Incl.",
        "address": "468, 470 Summerhill Ave",
        "city": "Toronto",
        "province": "ON",
        "postal_code": null,
        "neighbourhood": "ST.CLAIR-MT. PLEASANT",
        "latitude": 43.686504,
        "longitude": -79.374658,
        "bedrooms_label": "2 Bedroom",
        "bedrooms": 2,
        "bathrooms": 1,
        "description": "Available immediately\nBeautiful Rosedale. Totally renovated 2 bedroom with dishwasher.",
        "amenities": {
            "air_conditioning": false,
            "fridge_stove": true,
            "parking": true,
            "furnished": false,
            "laundry": true,
            "pets_allowed": false,
            "dishwasher": true
        },
        "images": [
            "https://images.viewit.ca/3844/Image058.jpg"
        ],
        "floor_plans": [],
        "videos": [],
        "published_at": "2003-09-19T14:33:00-04:00",
        "modified_at": "2026-09-26T00:00:00-04:00",
        "company_name": "Law Property",
        "contact_name": null
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": true,
        "attempts": 1
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

404

Not Found

ViewIt has no listing with this id, or it is no longer available (`NOT_FOUND`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
422

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."
}
503

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": "listing"
    },
    "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.