REINZ API Explorer local

Saved Swagger HTML

API Catalog

Open Explorer
Source
/var/www/html/reinz.austarhq.co.nz/reinz_swagger/swagger.json
Spec URL
https://apis-test.reinz.co.nz/v3.0/documentation/swagger
Detected API base
https://apis-test.reinz.co.nz
Enabled operations
13 / 13
Swagger operations
58
Tags
7
Schemas
10

Schemas

Auction Lease ListingCoordinateSearchRequest NilReturn ResidentialSale RuralSale SaleAndPurchase SalesCoordinateSearchRequest Solicitor Tender

Enabled Operations

GET /v3.0/Address/search Address
Param In Type Required Description
Query query string Yes
GET /v3.0/Avm/delta Avm
Param In Type Required Description
Offset query integer(int32) No For pagination. How many records to skip. Starts from 0
Fetch query integer(int32) No Total records returned. Max 15000 records
POST /v3.0/Listing/coordinate-search Listing

No parameter details were present in the saved HTML for this operation.

GET /v3.0/Property/delta Property
Param In Type Required Description
LastChangeDateFrom query string(date) Yes yyyy-MM-dd
LastChangeDateTo query string(date) Yes yyyy-MM-dd
Offset query integer(int32) No For pagination. How many records to skip. Starts from 0
Fetch query integer(int32) No Total records returned. Max 15000 records
GET /v3.0/Property/search Property
Param In Type Required Description
RafId query integer(int32) Yes
GET /v3.0/Reference/suburbs Reference
Param In Type Required Description
Query query string No
GET /v3.0/Report/census-insights Report
Param In Type Required Description
SuburbId query integer(int32) Yes
GET /v3.0/Report/market-insights Report
Param In Type Required Description
GroupingType query integer(int32) Yes 1 = NZ, 2 = Region, 3 = TA, 4 = Ward, 5 = Suburb
Grouping1 query integer(int32) Yes Refer to v3.0/Reference/suburbs API. For TA, map it to TAID field. For Suburb, map it to SuburbID.
Grouping2 query string Yes "All", "Apt", "Dwg", "Imp", "Sec","Lif","Rlb". All = Apt + Dwg + Sec, Apt = Apartment, Dwg = Dwelling, Imp = Apt + Dwg, Sec = Residential Sections, Lif = Lifestyle Block, Rlb = Apt + Dwg + Sec + Lif
Frequency query integer(int32) Yes 1 = 1 month, 3 = 3 months, 12 = 12 months
DateFrom query string(date) Yes yyyy-MM-dd
DateTo query string(date) Yes yyyy-MM-dd
GET /v3.0/Report/rental-insights Report
Param In Type Required Description
GroupingType query integer(int32) Yes 1 = NZ, 2 = Region, 3 = TA, 4 = Ward, 5 = Suburb
Grouping1 query integer(int32) Yes Refer to v3.0/Reference/suburbs API. For TA, map it to TAID field. For Suburb, map it to SuburbID.
Grouping2 query string Yes Number of Bedrooms. "1", "2", "3", "4", "5", "5+", "ALL", "NA"
Category query string Yes "ALL", "Apartment", "Flat", "House"
Frequency query integer(int32) Yes 3 = 3 months, 6 = 6 months, 12 = 12 months
DateFrom query string(date) Yes yyyy-MM-dd
DateTo query string(date) Yes yyyy-MM-dd
GET /v3.0/Report/ta-suburbs-insights Report
Param In Type Required Description
SuburbId query integer(int32) Yes
DateFrom query string(date) Yes yyyy-MM-dd
DateTo query string(date) Yes yyyy-MM-dd
POST /v3.0/Sale/coordinate-search Sale

No parameter details were present in the saved HTML for this operation.

GET /v3.0/Sale/index Sale
Param In Type Required Description
DateFrom query string(date) Yes Sale Date From (yyyy-MM-dd)
DateTo query string(date) Yes Sale Date To (yyyy-MM-dd)
Offset query integer(int32) No For pagination. How many records to skip. Starts from 0
Fetch query integer(int32) No Total records returned. Max 15000 records
GET /v3.0/Sale/location-search Sale
Param In Type Required Description
LocationType query integer(int32) Yes 1 = NZ, 2 = Region, 3 = TA, 4 = Ward, 5 = Suburb
LocationId query integer(int32) Yes Refer to v3.0/Reference/suburbs API. For TA, map it to TAID field. For Suburb, map it to SuburbID.
DateFrom query string(date) Yes Sale Date From (yyyy-MM-dd)
DateTo query string(date) Yes Sale Date To (yyyy-MM-dd)
Offset query integer(int32) No For pagination. How many records to skip. Starts from 0
Fetch query integer(int32) No Total records returned. Max 15000 records