Understanding and Using boardIds in The Repliers API

What are BoardIds?

BoardIds are unique identifiers that Repliers uses to distinguish between different datasets (boards) that you may have access to. As a subscriber, you might be licensed in multiple MLS regions or have access to different types of datasets from the same MLS (such as VOW and IDX separately). Each of these datasets is assigned a unique boardId.

Why are BoardIds Important?

BoardIds are crucial because:

1. The same MLS number can exist in different datasets
2. To accurately retrieve or filter data, the system needs to know which dataset to use
3. They allow you to specifically target searches to particular datasets you're interested in

Viewing Available Boards

To see all the datasets you have access to and their corresponding boardIds, make the following API request:

GET https://api.repliers.io/boards

Example Response:

{
    "boards": [
        {
            "boardId": 97,
            "name": "BCRES",
            "resourceId": 6771,
            "imagesFolder": "rebgv"
        },
        {
            "boardId": 91,
            "name": "TRREB-IDX-RESO",
            "resourceId": 6382,
            "imagesFolder": null
        },
        {
            "boardId": 90,
            "name": "TRREB-VOW-RESO",
            "resourceId": 6381,
            "imagesFolder": null
        }
    ]
}

Using BoardIds in API Requests

1. Searching Listings Across All Datasets

When you make a general search without specifying a boardId, results will include listings from all datasets you have access to:

GET https://api.repliers.io/listings?propertyType=Condo Apartment

Each listing in the response will include its associated boardId:

{
    ...
    "postal": null,
    "country": null
    },
    "boardId": 61
},
{
    "mlsNumber": "CAR4238544",
    "resource": "Property:6008",
    ...
}

2. Retrieving a Specific Listing

When retrieving a specific listing by MLS number, you must include the boardId to ensure you get the correct listing:

GET https://api.repliers.io/listings/CAR4238544?boardId=61

This is necessary because the same MLS number might exist in different datasets. The combination of boardId and mlsNumber creates a unique identifier.

3. Filtering Search Results by Dataset

You can limit your search to a specific dataset by including the boardId parameter:

GET https://api.repliers.io/listings?propertyType=Condo Apartment&boardId=61

This will return only listings from the dataset with boardId 61 that match your search criteria.

Best Practices

1. Include the boardId parameter when making requests for specific listings
2. Use the boards endpoint to get a current list of all datasets you have access to
3. Consider filtering by boardId when you only need results from a specific dataset to improve performance

Troubleshooting

• If you receive a "Listing not found" error when you know the MLS number exists, check that you're using the correct boardId
• If you're getting unexpected results in searches, verify whether you need to filter by boardId
• If you've recently been granted access to new datasets, refresh your list of available boards

For additional assistance with using boardIds in the Repliers API, please contact our support team.

Updated on: 30/03/2025