Piloterr

Centris Search

GET
/v2/centris/search

Search Centris listings by city or by a full results URL. Use the English or French path. Page through properties for sale.

Credit cost: 1 credit per call

Authorization

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Query Parameters

query*string

Place name or a full Centris results URL.

A place is slugified. English builds /en/propertiesfor-sale{slug}. French builds /fr/proprietea-vendre{slug}. A full URL keeps its path and its filters.

Examples:

montreal
https://www.centris.ca/en/properties~for-sale~montreal
https://www.centris.ca/fr/propriete~a-vendre~montreal
page?number

Page number, starting at 1. Default is 1.

Page 2 of Montreal returns different listing ids from page 1. When this stays at 1, a page value already present in a results URL is kept.

Example:

2
Default"1"
language?string

Results language when query is a place name. Default is en.

en uses the English for-sale path. fr uses the French path. A full Centris URL keeps the language already in its path.

Example:

fr
Default"en"
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Response Body

Successful response

application/json
  1. response
results?array<>
pagination?
Example Request
curl -X GET 'https://api.piloterr.com/v2/centris/search?query=string'
Example Response
{  "results": [    {      "id": "17796540",      "url": "https://www.centris.ca/en/condos~for-sale~montreal-le-sud-ouest/17796540",      "city": "Montréal (Le Sud-Ouest)",      "image": "https://mspublic.centris.ca/media.ashx?id=ADDD250DA2C8CC4DDDDDDDDDD2&t=pi&w=320&h=240&sm=c",      "price": 568000,      "title": "Condo for sale in Montréal (Le Sud-Ouest), Montréal (Island), 2365, Rue Saint-Patrick, apt. 207, 17796540 - Centris.ca",      "address": "2365, Rue Saint-Patrick, apt. 207",      "bedrooms": 1,      "category": "Condo for sale",      "currency": "CAD",      "language": "en",      "latitude": 45.482041,      "bathrooms": 1,      "longitude": -73.569347,      "photo_count": 33,      "price_display": "$568,000"    }  ],  "pagination": {    "next": "https://www.centris.ca/en/properties~for-sale~montreal?page=2",    "page": 1,    "per_page": 20,    "total_pages": 250,    "total_results": 9912  }}