Pagination

Several of our API endpoints return large lists of property records or listings in sets (or groups), up to 500 records or listings at a time.

This is done to prevent you from receiving potentially thousands or millions of results all at once, instead giving you control over how many results you receive.

You can retrieve additional sets of results for the same query by using pagination, controlled with the limit and offset query parameters.

Paginated Endpoints

The following API endpoints support bulk queries and return large lists of results in a paginated format:

• /properties
• /listings/sale
• /listings/rental/long-term

📘

See our search queries guide to learn more about bulk queries, and structuring your API requests to retrieve the specific property data you are looking for.

Using the limit Query Parameter

When performing requests to one of the above endpoints, our API will return a maximum of 500 property records or listings at a time.

You can control the number of results returned by these endpoints using the limit query parameter, which can be any number between 1 and 500. It will default to 50 if not provided.

Below is an example request to the /properties endpoint, with the limit query parameter set to 20. It will return a maximum of 20 property records:

curl --request GET \
  --url 'https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=20' \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY'

📘

When using pagination, our API will return an X-Limit response header, containing the value of the limit query parameter that was provided, or the default value that was used.

Using the offset Query Parameter

After receiving an initial set of results, you can perform additional requests with the same search criteria and use the offset query parameter to retrieve additional results.

The offset parameter is the index of the first result that should be returned. It defaults to 0 if not provided, which indicates that our API should return results starting from the first one.

Below is an example request to the /properties endpoint, with the offset query parameter set to 20. It will return property records starting at index 20 and onward:

curl --request GET \
  --url 'https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=20&offset=20' \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY'

The offset query parameter should be a multiple of the limit parameter, and be incremented on each subsequent request. For example, if you are using a limit of 20, the offset should be set to 0 on the first request (or simply omitted), 20 on the second request, 40 on the third, and so on.

📘

When using pagination, our API will return an X-Offset response header, containing the value of the offset query parameter that was provided, or the default value that was used.

Reaching the End of Results

If the number of property records or listings returned by our API is less than the limit parameter in any of the responses, that indicates that you’ve reached the end of the result list and no additional requests are necessary.

Alternatively, you can continue making requests until you receive a response containing an empty array ([]), or use the method below to retrieve the total number of results first, then continue retrieving data until you've received it all.

📘

When using pagination, it is important to keep all other query parameters (except for offset) the same for each subsequent request to make sure you are paginating through the same list of results.

Retrieving the Total Number of Results

Sometimes it is helpful to know the total number of results matching a specific query, for example, to estimate how many API requests are needed to retrieve all data, forecast API costs, or assist with pagination and determining when you have retrieved all available results.

To retrieve the total number of results matching a specific query, provide the includeTotalCount query parameter with a "true" value. When you receive the response from our API, examine the X-Total-Count header, which will contain the total number of matching results.

Below is an example request to the /properties endpoint with the includeTotalCount parameter. It will return an X-Total-Count header in the response:

curl --request GET \
  --url 'https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=20&includeTotalCount=true' \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY'

🚧

Using the includeTotalCount query parameter may significantly increase API response times, and we recommend using it sparingly (for example, just in the first paginated request).