v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB

PropertyRadar

View Properties in Portfolio - Detailed

List property and gnaf id's with details for an existing portfolio, along with market status and last listed information. Results are returned one page at a time, with a default page size of 500000 records. Records are returned in alphabetical order, with Property ID's first followed by GNAF ID's.For PageSize greater than 10000, please don't use Domain Portal UI

get/v1/propertyradar/portfolio/{PortfolioId}/properties

Path parameters

PortfolioIdstring required

Query parameters

Pageinteger

The page of data to return

PageSizeinteger

The number of records per page

Response

List of property and gnaf id's

Example response

{
  "Data": {
    "PortfolioId": "PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1",
    "Properties": {
      "PropertyIds": [
        {
          "PropertyId": "AB-2872-NY",
          "MarketStatus": "on-market",
          "SaleRentFlag": "sale",
          "LastListedDate": "2024-04-20"
        }
      ],
      "GnafIds": [
        {
          "GnafId": "GAVIC419677979",
          "MarketStatus": "off-market"
        }
      ]
    }
  },
  "Pagination": {
    "Total": 560000,
    "Page": 1,
    "PageSize": 100000,
    "TotalPages": 6,
    "NextPage": "/portfolio/PORTFOLIO_7eedc8e01b2942eaaa396de4b512f6a1/properties?page=2"
  }
}