How to consume a Source.Immo data package

How to consume a Source.Immo data package

A Source.Immo data package is a JSON file accessible through the API that provides access to a collection of data published to your account.  This file is updated every time new data are published.  The file contains a last modify date and an incremental version that can be verified to detect if data needs to be updated.

This is the simplest way of accessing your real estate data whiteout having to make multiple calls to the Web API to get structured data.

Authentication

To be able to consume and download a data package published by Source.Immo, you will need the following information that you can provide using query string parameters or http headers :

Field
Description
Query string parameter
HTTP header
Account ID
The ID of your Source.Immo account
acc
X-SI-Account
API Key
The API Key dedicated to your application or website
api
X-SI-Api

Those information will be provided to you by our support team.

Query

To get the information you need to call :
  1. HTTP GET https://api-v1.source.immo/api/package/SIPackage/[collection_id]/[culture]/
where
[collection_id]
The collection ID provided to you by our support team.
[culture]
"fr" or "en" or "es"

Example of package data :

  1. {
  2. "dataview_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaa",
  3. "dataview_ver": 123,
  4. "dataview_publish_date": "2026-06-04T18:20:01.2687857Z",
  5. "dictionary": {
  6. "country": {
  7. "CAN": {
  8. "abbr": "Can",
  9. "caption": "Canada",
  10. "src": [
  11. "listing",
  12. "broker",
  13. "office",
  14. "agency"
  15. ],
  16. "src_count": [
  17. 108,
  18. 7204,
  19. 355,
  20. 355
  21. ]
  22. }
  23.                         ...
  24.                 ]
  25.                "listings": [
  26.                     ...
  27. ]
  28.         }
  29. }
The dictionary provides the label mapping of all the codes used in the listing data.

    • Related Articles

    • Source.Immo Distribution API

      Source.Immo offers the flexibility of it's API (Application Programming Interface) in order to interact with the normalized real estate data provided by the application. Click here to access the most recent API Reference

    • Source Immo Templating System

      Source Immo Templating System Overview Source Immo renders its front-end output using PHP view files located inside the plugin directory: /wp-content/plugins/source-immo/views/ Developers can override any of these view files by replicating the exact ...

    • Procedure for activating the transfer of real estate data from REALTOR.ca's DDF service

      To allow Source.Immo, managed by ID-3 Technologies Inc., to receive your Canadian real estate data from the CREA via its Realtor.ca website and its SDD, you must enable data feed transfer by following these steps: Go to the following website: ...

    • How to customize list display to look like Aliquando 3

      What you need moderate to advanced CSS knowledge access to server-side files or somewhere to add custom styles to your site First step: Prepare the list We will add 3 CSS classes to the list's key objects, move some datas around and clean some ...

    • How to customize detail page layout

      Source Immo Detail Page Customization Shortcodes vs Template Overrides Overview Source Immo single detail pages are built from modular template parts located inside: /wp-content/plugins/source-immo/views/single/*_layouts/subs/ Each file inside a ...