---
title: "ViewIt API: Search | Perceptlayer"
description: "Search from ViewIt as JSON. 1 credit per successful call."
url: https://perceptlayer.com/apis/viewit/search
---

[APIs](https://perceptlayer.com/apis) / [ViewIt](https://perceptlayer.com/apis/viewit) / Search

# ViewIt: Search

Search from ViewIt as JSON. 1 credit per successful call.

GET `/v1/viewit/search`

## Parameters

Send parameters in the query string.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `city_id` | integer | Required | Any |
| `page` | integer | Optional | Any |
| `bedrooms` | string | Optional | Any |
| `price_min` | integer | Optional | Any |
| `price_max` | integer | Optional | Any |
| `keyword` | string | Optional | Up to 60 characters |
| `furnished` | string | Optional | true, 1 |
| `loft` | string | Optional | true, 1 |
| `retirement` | string | Optional | true, 1 |
| `short_term` | string | Optional | true, 1 |

## Example request

ViewIt

GET /v1/viewit/search?city\_id=14&bedrooms=2&price\_max=2500 

```
{
  "success": true,
  "data": {
    "items": [
      {
        "listing_id": 21302,
        "detail_path": "37OrioleRd-Toronto-2bdrm-VIT=21302",
        "url": "https://www.viewit.ca/37OrioleRd-Toronto-2bdrm-VIT=21302",
        "address": "37 Oriole Rd",
        "bedrooms_label": "2 bds",
        "bedrooms": 2,
        "unit_type": "apartment",
        "price": 2200,
        "price_from": false,
        "currency": "CAD",
        "latitude": 43.688249,
        "longitude": -79.400144,
        "photo": "https://images.viewit.ca/21302/IMG_4927.jpg",
        "description": "Bright, clean, beautiful and well maintained 2 bedroom available Nov 1st. Centrally located in charming neighbourhood. Hardwood floor, quiet buildin...",
        "sponsored": false,
        "has_video": false
      },
      {
        "listing_id": 184238,
        "detail_path": "670ParliamentStreet-Toronto-2bdrm-VIT=184238",
        "url": "https://www.viewit.ca/670ParliamentStreet-Toronto-2bdrm-VIT=184238",
        "address": "670 Parliament Street",
        "bedrooms_label": "2 bds",
        "bedrooms": 2,
        "unit_type": "apartment",
        "price": 2495,
        "price_from": false,
        "currency": "CAD",
        "latitude": 43.670627,
        "longitude": -79.370942,
        "photo": "https://images.viewit.ca/184238/00_hiyyz05j.jpg",
        "description": "Live, work, play. These days it's all about downtown living. Spacious suites set on manicured grounds, the large bachelor, one bedroom and two bedro...",
        "sponsored": false,
        "has_video": false
      },
      {
        "listing_id": 244248,
        "detail_path": "670ParliamentStreet-Toronto-2bdrm-VIT=244248",
        "url": "https://www.viewit.ca/670ParliamentStreet-Toronto-2bdrm-VIT=244248",
        "address": "670 Parliament Street",
        "bedrooms_label": "2 bds",
        "bedrooms": 2,
        "unit_type": "apartment",
        "price": 2495,
        "price_from": false,
        "currency": "CAD",
        "latitude": 43.670636,
        "longitude": -79.371559,
        "photo": "https://images.viewit.ca/244248/00_ocu0rtpc.jpg",
        "description": "Live, work, play. These days it's all about downtown living. Spacious suites set on manicured grounds, the large bachelor, one bedroom and two bedro...",
        "sponsored": false,
        "has_video": false
      }
    ],
    "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": 1,
    "total_includes_dropped": true,
    "applied_filters": {
      "city_id": 14,
      "bedrooms": "2",
      "price_max": "2500"
    }
  },
  "meta": {
    "endpoint_family": "search",
    "attempts": 1,
    "items_dropped": 1,
    "request_id": "req_500dc04b404c4e07b00fea9e9d077ecf",
    "credits_charged": 1,
    "credits_remaining": 1804
  }
}
```

200 OK JSON X-Credits-Used: 1

Recorded from our API and shortened.

[Run this endpoint in the playground](https://perceptlayer.com/apis/viewit?try=search#playground) with your own parameters. 1 credit per successful call; failed calls are free.