Loan Type Codes Reference Page
Created new documentation page listing all loan type codes with descriptions. This reference helps you understand mortgage and financing classifications in property records.
Changelog
Follow new updates and improvements to RealEstateAPI.
Property Use Codes Reference Page
Created new documentation page listing all property use codes with descriptions. This reference helps you understand property classifications and use appropriate codes when filtering or interpreting property data.
Enhanced Documentation for Sale Filters
Added comprehensive documentation for sale-related filter parameters in Property Search API, including examples and use cases for filtering by sale dates, sale prices, arms-length transactions, and other sale-related criteria.
Earlier updates
- Response Fields & Types in API DocumentationResponse schema fields and their types are now documented under the "Responses" section with 200 status code for all main API reference pages. This includes field names, data types, and string enumerations. Swagger docs remain available and will stay most up-to-date until documentation automation is complete.Documentation
- MLS Search API - New Documentation DesignMLS Search API documentation has a new look and feel with improved navigation and readability. The updated design makes it easier to find endpoint information, parameters, and response examples.Documentation
- Property Search API - New Documentation DesignProperty Search API documentation has a new look and feel with improved navigation and readability. The updated design makes it easier to find endpoint information, parameters, and response examples.Documentation
- Swagger Docs - response fields & types addedPreviously, the swagger docs found here only had the request fields & types Now supports response fields and types, updated on every push from our codebase so it’s dynamic and you won’t have to wait for release notes/documentation updates: https://staging.realestateapi.com/swaggerDocumentation
- OpenAPI 3.0 MigrationWe have updated our API documentation and configuration (Swagger) from OpenAPI 2.0 to OpenAPI 3.0, improving our API documentation and making it more maintainable. To view our Swagger docs, please visit: https://api.realestateapi.com/swagger Impact This update is backward compatible and requires no changes from API consumers. The changes are solely documentation-related and improve discoverability and usability. Key Changes Documentation Structure Migrated from the Swagger 2.0 to the OpenAPI 3.0 format Created standardized response schemas for 200, 400, 401, 403, 404, 500 responses API Endpoint Improvements Enhanced endpoint descriptions across all v2 and v3 APIs Updated version numbers in the API documentation Response Standardization Implemented a consistent response structure across all endpoints Added standardized HTTP status codes (200, 400, 401, 403, 404, 500) Enhanced error response descriptions for better error handlingDocumentation