### MLSGrid API v2.0 Initial Import Example Source: https://docs.mlsgrid.com/api-documentation Provides an example of an initial import request for the MLSGrid API v2.0, filtering for active properties ('MlgCanView eq true') from a specific originating system. ```APIDOC Initial Import Example: Request URL: https://api.mlsgrid.com/v2/Property?$filter=OriginatingSystemName%20eq%20%27actris%27%20and%20MlgCanView%20eq%20true Description: This request fetches the first 'page' of data, excluding deleted records by setting MlgCanView to true. ``` -------------------------------- ### MLSGrid API Filtering Examples Source: https://docs.mlsgrid.com/api-documentation Demonstrates how to filter MLSGrid API data using specific fields like OriginatingSystemName, StandardStatus, and PropertyType. Includes examples of constructing API query URLs. ```APIDOC API Endpoint: /v2/Property Functionality: Filtering Properties by Originating System and Status/Type Description: This section details how to query the MLSGrid API for property data, specifically focusing on filtering by the OriginatingSystemName and enumerated fields like StandardStatus and PropertyType. The examples show the correct syntax for constructing filter clauses in API requests. Key Fields: - OriginatingSystemName: Identifies the source MLS system for a record. Values are case-sensitive and typically lowercase. - StandardStatus: Represents the current status of a property listing (e.g., 'Active', 'Pending'). Querying requires using the 'Standard Name' value, which may differ from the display name. - PropertyType: Denotes the type of property (e.g., 'Residential', 'Commercial Sale'). Querying requires using the 'Standard Name' value. OriginatingSystemName Values: - actris: ACTRIS MLS - carolina: Canopy MLS - flinthills: Flint Hills MLS - scranton: Greater Scranton Board of REALTORS® - nira: Northwest Indiana REALTORS® Association (formerly GNIAR) - hmls: Heartland Multiple Listing Service, Inc. - highland: Highland Lakes Association of REALTORS® - lbor: Lawrence Board of REALTORS® - lsar: Lake Superior Area REALTORS® - lascruces: Southern New Mexico MLS - maris: MARIS MLS - maris2: MARIS MLS (NEW) - mfrmls: My Florida Regional MLS DBA Stellar MLS - mibor: MIBOR REALTOR® Association - mlsok: MLSOK - mred: MRED Midwest Real Estate Data - neirbr: Northeast Iowa Regional Board of REALTORS® - nocoast: NoCoast MLS - northstar: NorthstarMLS® - nwmls: Northwest MLS - onekey2: OneKey® MLS - paar: Prescott Area Association of REALTORS® - pikewayne: Pike/Wayne Association of REALTORS® - prairie: Mid-Kansas MLS (Prairie Land REALTORS®) - ranw: REALTOR® Association Northeast Wisconsin - realtrac: RT RealTracs - recolorado: REcolorado - rmlsa: RMLS Alliance - rrar: Reelfoot Regional Association of REALTORS® - sarmls: Spokane Association of REALTORS® - sckansas: South Central Kansas MLS - somo: Southern Missouri Regional MLS (SOMO) - spartanburg: Spartanburg Board of REALTORS® - sunflower: Sunflower MLS StandardStatus Values (Name -> Standard Name): - Active -> Active - ActiveUnderContract -> Active Under Contract - Canceled -> Canceled - Closed -> Closed - ComingSoon -> Coming Soon - Delete -> Delete - Expired -> Expired - Hold -> Hold - Incomplete -> Incomplete - Pending -> Pending - Withdrawn -> Withdrawn PropertyType Values (Name -> Standard Name): - BusinessOpportunity -> Business Opportunity - CommercialLease -> Commercial Lease - Commercial Sale -> Commercial Sale - Farm -> Farm - Land -> Land - ManufacturedInPark -> Manufactured In Park - Residential -> Residential - ResidentialIncome -> Residential Income - ResidentialLease -> Residential Lease Example API Queries: 1. Query by StandardStatus and OriginatingSystemName: Filters for properties from 'actris' with 'Active Under Contract' status. URL: https://api-demo.mlsgrid.com/v2/Property?$filter=StandardStatus eq 'Active Under Contract' and OriginatingSystemName eq 'actris' 2. Query by PropertyType and OriginatingSystemName: Filters for properties from 'actris' with 'Commercial Sale' type. URL: https://api.mlsgrid.com/v2/Property?$filter=OriginatingSystemName%20eq%20%27actris%27%20and%20PropertyType+eq+%27Commercial%20Sale%27 Notes: - Filter values for StandardStatus and PropertyType should use the 'Standard Name' as provided in the tables above (e.g., 'Active Under Contract', 'Commercial Sale'). - URL encoding is applied to spaces and special characters in query parameters. ``` -------------------------------- ### MLSGrid API v2.0 Initial Import Example Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Provides an example of an initial import request for the MLSGrid API v2.0, filtering for active properties ('MlgCanView eq true') from a specific originating system. ```APIDOC Initial Import Example: Request URL: https://api.mlsgrid.com/v2/Property?$filter=OriginatingSystemName%20eq%20%27actris%27%20and%20MlgCanView%20eq%20true Description: This request fetches the first 'page' of data, excluding deleted records by setting MlgCanView to true. ``` -------------------------------- ### Native MLS Property Record Example Source: https://docs.mlsgrid.com/index Example of a raw property record received from an MLS, showing the native date format. ```json { "RECORDMODDATE" : "2018-01-10T21:40:12", // and the rest } ``` -------------------------------- ### MLSGrid API Filtering Examples Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Demonstrates how to filter MLSGrid API data using specific fields like OriginatingSystemName, StandardStatus, and PropertyType. Includes examples of constructing API query URLs. ```APIDOC API Endpoint: /v2/Property Functionality: Filtering Properties by Originating System and Status/Type Description: This section details how to query the MLSGrid API for property data, specifically focusing on filtering by the OriginatingSystemName and enumerated fields like StandardStatus and PropertyType. The examples show the correct syntax for constructing filter clauses in API requests. Key Fields: - OriginatingSystemName: Identifies the source MLS system for a record. Values are case-sensitive and typically lowercase. - StandardStatus: Represents the current status of a property listing (e.g., 'Active', 'Pending'). Querying requires using the 'Standard Name' value, which may differ from the display name. - PropertyType: Denotes the type of property (e.g., 'Residential', 'Commercial Sale'). Querying requires using the 'Standard Name' value. OriginatingSystemName Values: - actris: ACTRIS MLS - carolina: Canopy MLS - flinthills: Flint Hills MLS - scranton: Greater Scranton Board of REALTORS® - nira: Northwest Indiana REALTORS® Association (formerly GNIAR) - hmls: Heartland Multiple Listing Service, Inc. - highland: Highland Lakes Association of REALTORS® - lbor: Lawrence Board of REALTORS® - lsar: Lake Superior Area REALTORS® - lascruces: Southern New Mexico MLS - maris: MARIS MLS - maris2: MARIS MLS (NEW) - mfrmls: My Florida Regional MLS DBA Stellar MLS - mibor: MIBOR REALTOR® Association - mlsok: MLSOK - mred: MRED Midwest Real Estate Data - neirbr: Northeast Iowa Regional Board of REALTORS® - nocoast: NoCoast MLS - northstar: NorthstarMLS® - nwmls: Northwest MLS - onekey2: OneKey® MLS - paar: Prescott Area Association of REALTORS® - pikewayne: Pike/Wayne Association of REALTORS® - prairie: Mid-Kansas MLS (Prairie Land REALTORS®) - ranw: REALTOR® Association Northeast Wisconsin - realtrac: RT RealTracs - recolorado: REcolorado - rmlsa: RMLS Alliance - rrar: Reelfoot Regional Association of REALTORS® - sarmls: Spokane Association of REALTORS® - sckansas: South Central Kansas MLS - somo: Southern Missouri Regional MLS (SOMO) - spartanburg: Spartanburg Board of REALTORS® - sunflower: Sunflower MLS StandardStatus Values (Name -> Standard Name): - Active -> Active - ActiveUnderContract -> Active Under Contract - Canceled -> Canceled - Closed -> Closed - ComingSoon -> Coming Soon - Delete -> Delete - Expired -> Expired - Hold -> Hold - Incomplete -> Incomplete - Pending -> Pending - Withdrawn -> Withdrawn PropertyType Values (Name -> Standard Name): - BusinessOpportunity -> Business Opportunity - CommercialLease -> Commercial Lease - Commercial Sale -> Commercial Sale - Farm -> Farm - Land -> Land - ManufacturedInPark -> Manufactured In Park - Residential -> Residential - ResidentialIncome -> Residential Income - ResidentialLease -> Residential Lease Example API Queries: 1. Query by StandardStatus and OriginatingSystemName: Filters for properties from 'actris' with 'Active Under Contract' status. URL: https://api-demo.mlsgrid.com/v2/Property?$filter=StandardStatus eq 'Active Under Contract' and OriginatingSystemName eq 'actris' 2. Query by PropertyType and OriginatingSystemName: Filters for properties from 'actris' with 'Commercial Sale' type. URL: https://api.mlsgrid.com/v2/Property?$filter=OriginatingSystemName%20eq%20%27actris%27%20and%20PropertyType+eq+%27Commercial%20Sale%27 Notes: - Filter values for StandardStatus and PropertyType should use the 'Standard Name' as provided in the tables above (e.g., 'Active Under Contract', 'Commercial Sale'). - URL encoding is applied to spaces and special characters in query parameters. ``` -------------------------------- ### MLSGrid API v2.0 Access Example Source: https://docs.mlsgrid.com/api-documentation Demonstrates how to access the MLSGrid API v2.0 using a typical OData URI with filter and expand parameters. It also shows the required authorization header. ```APIDOC API Access Example: Request URL: https://api.mlsgrid.com/v2/Property?$filter=OriginatingSystemName%20eq%20%27actris%27%20and%20ModificationTimestamp%20gt%202020-12-30T23:59:59.99Z&$expand=Media,Rooms,UnitTypes Required Header: Header: Authorization Value: Bearer access_token ``` -------------------------------- ### MLSGrid API v2.0 Access Example Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Demonstrates how to access the MLSGrid API v2.0 using a typical OData URI with filter and expand parameters. It also shows the required authorization header. ```APIDOC API Access Example: Request URL: https://api.mlsgrid.com/v2/Property?$filter=OriginatingSystemName%20eq%20%27actris%27%20and%20ModificationTimestamp%20gt%202020-12-30T23:59:59.99Z&$expand=Media,Rooms,UnitTypes Required Header: Header: Authorization Value: Bearer access_token ``` -------------------------------- ### MlgCanUse Field Example for VOW Source: https://docs.mlsgrid.com/api-documentation Shows an example of the MlgCanUse field in JSON format, indicating a record is designated for VOW (Virtual Office Website) use cases. Records with only VOW cannot be used for IDX. ```JSON { "MlgCanUse": [ "VOW" ] } ``` -------------------------------- ### MlgCanUse Field Metadata Example Source: https://docs.mlsgrid.com/api-documentation Provides an example of the MlgCanUse field's metadata definition, likely in an OData or EDM context. It specifies the property type as a collection of strings and includes annotations for documentation links. ```XML ``` -------------------------------- ### Lookup Data Import API Request Source: https://docs.mlsgrid.com/api-documentation/api-version-2 An example API endpoint for requesting initial data import of lookup values for an MLS, filtered by originating system and view permissions. ```APIDOC GET https://api.mlsgrid.com/v2/Lookup?$filter=OriginatingSystemName eq ‘actris’ and MlgCanView eq true - **Endpoint**: /v2/Lookup - **Method**: GET - **Description**: Retrieves lookup values for an MLS. - **Parameters**: - `$filter`: OData filter expression. - `OriginatingSystemName`: Specifies the originating system (e.g., 'actris'). - `MlgCanView`: Boolean indicating if the record can be viewed. - **Purpose**: Used for initial data import and keeping local lookup data up to date. ``` -------------------------------- ### Example Property Record Structure Source: https://docs.mlsgrid.com/api-documentation This JSON object represents a single property record from Actris. It includes detailed information such as accessibility features, appliances, room counts, listing details, property characteristics, and public remarks. ```json { "@odata.id": "https://api-demo.mlsgrid.com/v2/Property('ACT107472571')", "AccessibilityFeatures": [ "Customized Wheelchair Accessible" ], "ACT_ActiveOpenHouseCount": "0", "AdditionalParcelsYN": false, "Appliances": [ "Built-In Gas Oven", "Built-In Gas Range", "Dishwasher", "Microwave" ], "AssociationYN": false, "BathroomsFull": 3, "BathroomsHalf": 0, "BathroomsTotalInteger": 3, "BedroomsTotal": 4, "BuyerAgencyCompensation": "3.000", "BuyerAgencyCompensationType": "%", "BuyerOfficeKey": "ACT1513635", "CoBuyerOfficeKey": "ACT1513635", "CommunityFeatures": [ "None" ], "ConstructionMaterials": [ "HardiPlank Type" ], "Cooling": [ "Ceiling Fan(s)", "Central Air" ], "CountyOrParish": "Williamson", "CoveredSpaces": 0, "DirectionFaces": "East", "Disclosures": [ "Owner/Agent" ], "ACT_ElementaryOther": "Gateway College Prep", "ElementarySchool": "Jo Ann Ford", "ACT_EstimatedTaxes": "4934.00", "ACT_ETJExtraTerritorialJurdn": "No", "ExteriorFeatures": [ "None" ], "ACT_FEMAFloodPlain": "No", "Fencing": [ "Back Yard", "Front Yard" ], "FireplacesTotal": 0, "Flooring": [ "Vinyl" ], "FoundationDetails": [ "Slab" ], "GarageSpaces": 0, "GreenEnergyEfficient": [ "None" ], "GreenSustainability": [ "None" ], "ACT_GuestAccommodatonDesc": "None", "Heating": [ "Central" ], "HighSchool": "East View", "HorseAmenities": [ "None" ], "HorseYN": false, "ACT_IDXOptInYN": "1", "InteriorFeatures": [ "Ceiling Fan(s)", "Beamed Ceilings", "Gas Dryer Hookup", "Kitchen Island", "Multiple Dining Areas", "No Interior Steps", "Open Floorplan", "Primary Bedroom on Main", "Washer Hookup" ], "InternetAddressDisplayYN": true, "InternetAutomatedValuationDisplayYN": false, "InternetConsumerCommentYN": false, "InternetEntireListingDisplayYN": true, "ACT_LastChangeTimestamp": "2020-12-05T15:32:42.710", "ACT_LastChangeType": "Price Decrease", "ACT_LastHumanModificationTimestamp": "2020-12-05T15:41:31.400", "ACT_LaundryLocation": "Main Level", "Levels": [ "One" ], "ListAgentAOR": "Austin Board Of Realtors", "ListAgentDirectPhone": "(512) 400-0188", "ListAgentEmail": "[email\u00a0protected]", "ListAgentFullName": "Michael Villanueva", "ListAgentKey": "ACT31371801", "ListAgentMlsId": "ACT717866", "ListAOR": "Austin Board Of Realtors", "ListingContractDate": "2020-10-10", "ListingId": "ACT1475089", "ListingKey": "ACT107472571", "ListOfficeKey": "ACT1513635", "ListOfficeMlsId": "ACT024R11", "ListOfficeName": "Coldwell Banker Realty", "ListOfficePhone": "(512) 233-4868", "ListPrice": 474800, "LivingArea": 2400, "LivingAreaSource": "Public Records", "LotFeatures": [ "Back Yard", "Trees-Moderate" ], "LotSizeAcres": 0.223, "LotSizeSquareFeet": 9713.88, "MainLevelBedrooms": 4, "MajorChangeTimestamp": "2020-12-05T21:32:42.000Z", "MajorChangeType": "Price Decrease", "MiddleOrJuniorSchool": "James Tippit", "MLSAreaMajor": "GTE", "MlsStatus": "Active", "NewConstructionYN": false, "ACT_NumDining": "1", "ACT_NumLiving": "1", "ACT_OpenHouseCount": "2", "ACT_OpenHousePublicCount": "0", "OriginalEntryTimestamp": "2020-10-10T16:11:01.000Z", "OriginalListPrice": 490000, "OriginatingSystemName": "actris", "OtherStructures": [ "See Remarks" ], "ParcelNumber": "20956500000001", "ParkingFeatures": [ "Carport" ], "ParkingTotal": 4, "PatioAndPorchFeatures": [ "Front Porch" ], "PoolFeatures": [ "None" ], "PoolPrivateYN": false, "PreviousListPrice": 479800, "PropertyCondition": [ "Resale", "Updated/Remodeled" ], "PropertySubType": "Single Family Residence", "PropertyType": "Residential", "PublicRemarks": "Come see this gorgeous remodel in the heart of Georgetown. With so many modern updates, you're sure to feel right at home here. New chef's kitchen with custom maple cabinets and Calacatta quartz countertops. Vinyl plank flooring throughout living room, kitchen and bedrooms. Beautiful spa-like bathrooms. 36\" doorways in main spaces and master bedroom/bathroom. New HVAC and roof. Large curved driveway with a carport for plenty of parking. Extra 1100 sqft building could accommodate yoga studio, office or storage space. Schedule your in person showing today while its still available.", "Roof": [ "Shingle" ], "Sewer": [ "Public Sewer" ] } ``` -------------------------------- ### MlgCanUse Field JSON Examples Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Illustrates the structure and possible values for the MlgCanUse field in JSON format, indicating data subscription types and use cases for MLS records. ```JSON "MlgCanUse": [ "IDX" ] ``` ```JSON "MlgCanUse": [ "VOW" ] ``` ```JSON "MlgCanUse": [ "IDX", "VOW" ] ``` ```JSON "MlgCanUse": [ "BO" ] ``` ```JSON "MlgCanUse": [ "VOW", "BO" ] ``` ```JSON "MlgCanUse": [ "IDX", "VOW", "BO" ] ``` ```JSON "MlgCanUse": [ "PT" ] ``` -------------------------------- ### MLS Grid Processed Property Record Example Source: https://docs.mlsgrid.com/index Example of a property record after being processed by the MLS Grid, showing the standardized 'ModificationTimestamp'. ```json { "ModificationTimestamp": "[time we set]", // and the rest } ``` -------------------------------- ### Example Property Record Structure Source: https://docs.mlsgrid.com/api-documentation/api-version-2 This JSON object represents a single property record from Actris. It includes detailed information such as accessibility features, appliances, room counts, listing details, property characteristics, and public remarks. ```json { "@odata.id": "https://api-demo.mlsgrid.com/v2/Property('ACT107472571')", "AccessibilityFeatures": [ "Customized Wheelchair Accessible" ], "ACT_ActiveOpenHouseCount": "0", "AdditionalParcelsYN": false, "Appliances": [ "Built-In Gas Oven", "Built-In Gas Range", "Dishwasher", "Microwave" ], "AssociationYN": false, "BathroomsFull": 3, "BathroomsHalf": 0, "BathroomsTotalInteger": 3, "BedroomsTotal": 4, "BuyerAgencyCompensation": "3.000", "BuyerAgencyCompensationType": "%", "BuyerOfficeKey": "ACT1513635", "CoBuyerOfficeKey": "ACT1513635", "CommunityFeatures": [ "None" ], "ConstructionMaterials": [ "HardiPlank Type" ], "Cooling": [ "Ceiling Fan(s)", "Central Air" ], "CountyOrParish": "Williamson", "CoveredSpaces": 0, "DirectionFaces": "East", "Disclosures": [ "Owner/Agent" ], "ACT_ElementaryOther": "Gateway College Prep", "ElementarySchool": "Jo Ann Ford", "ACT_EstimatedTaxes": "4934.00", "ACT_ETJExtraTerritorialJurdn": "No", "ExteriorFeatures": [ "None" ], "ACT_FEMAFloodPlain": "No", "Fencing": [ "Back Yard", "Front Yard" ], "FireplacesTotal": 0, "Flooring": [ "Vinyl" ], "FoundationDetails": [ "Slab" ], "GarageSpaces": 0, "GreenEnergyEfficient": [ "None" ], "GreenSustainability": [ "None" ], "ACT_GuestAccommodatonDesc": "None", "Heating": [ "Central" ], "HighSchool": "East View", "HorseAmenities": [ "None" ], "HorseYN": false, "ACT_IDXOptInYN": "1", "InteriorFeatures": [ "Ceiling Fan(s)", "Beamed Ceilings", "Gas Dryer Hookup", "Kitchen Island", "Multiple Dining Areas", "No Interior Steps", "Open Floorplan", "Primary Bedroom on Main", "Washer Hookup" ], "InternetAddressDisplayYN": true, "InternetAutomatedValuationDisplayYN": false, "InternetConsumerCommentYN": false, "InternetEntireListingDisplayYN": true, "ACT_LastChangeTimestamp": "2020-12-05T15:32:42.710", "ACT_LastChangeType": "Price Decrease", "ACT_LastHumanModificationTimestamp": "2020-12-05T15:41:31.400", "ACT_LaundryLocation": "Main Level", "Levels": [ "One" ], "ListAgentAOR": "Austin Board Of Realtors", "ListAgentDirectPhone": "(512) 400-0188", "ListAgentEmail": "[email\u00a0protected]", "ListAgentFullName": "Michael Villanueva", "ListAgentKey": "ACT31371801", "ListAgentMlsId": "ACT717866", "ListAOR": "Austin Board Of Realtors", "ListingContractDate": "2020-10-10", "ListingId": "ACT1475089", "ListingKey": "ACT107472571", "ListOfficeKey": "ACT1513635", "ListOfficeMlsId": "ACT024R11", "ListOfficeName": "Coldwell Banker Realty", "ListOfficePhone": "(512) 233-4868", "ListPrice": 474800, "LivingArea": 2400, "LivingAreaSource": "Public Records", "LotFeatures": [ "Back Yard", "Trees-Moderate" ], "LotSizeAcres": 0.223, "LotSizeSquareFeet": 9713.88, "MainLevelBedrooms": 4, "MajorChangeTimestamp": "2020-12-05T21:32:42.000Z", "MajorChangeType": "Price Decrease", "MiddleOrJuniorSchool": "James Tippit", "MLSAreaMajor": "GTE", "MlsStatus": "Active", "NewConstructionYN": false, "ACT_NumDining": "1", "ACT_NumLiving": "1", "ACT_OpenHouseCount": "2", "ACT_OpenHousePublicCount": "0", "OriginalEntryTimestamp": "2020-10-10T16:11:01.000Z", "OriginalListPrice": 490000, "OriginatingSystemName": "actris", "OtherStructures": [ "See Remarks" ], "ParcelNumber": "20956500000001", "ParkingFeatures": [ "Carport" ], "ParkingTotal": 4, "PatioAndPorchFeatures": [ "Front Porch" ], "PoolFeatures": [ "None" ], "PoolPrivateYN": false, "PreviousListPrice": 479800, "PropertyCondition": [ "Resale", "Updated/Remodeled" ], "PropertySubType": "Single Family Residence", "PropertyType": "Residential", "PublicRemarks": "Come see this gorgeous remodel in the heart of Georgetown. With so many modern updates, you're sure to feel right at home here. New chef's kitchen with custom maple cabinets and Calacatta quartz countertops. Vinyl plank flooring throughout living room, kitchen and bedrooms. Beautiful spa-like bathrooms. 36\" doorways in main spaces and master bedroom/bathroom. New HVAC and roof. Large curved driveway with a carport for plenty of parking. Extra 1100 sqft building could accommodate yoga studio, office or storage space. Schedule your in person showing today while its still available.", "Roof": [ "Shingle" ], "Sewer": [ "Public Sewer" ] } ``` -------------------------------- ### Example: Querying with Prefixed IDs Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Illustrates how to use MLS-specific prefixes when querying data within the MLS Grid. Prefixes are added to identifiers like ListingKey or MlsId for accurate record retrieval. ```APIDOC Scenario: Retrieve a property record using its ListingKey. If a record's ListingKey in the MLS system is '123456' and the MLS prefix is 'ACT': Query in MLS Grid for ListingKey = 'ACT123456' Scenario: Find OpenHouse records by property MlsId. If a property's MlsId is '456789' and the MLS prefix is 'ACT': Query OpenHouse resource for ListingId = 'ACT456789' Scenario: Find a Member record by ListAgentMlsId. If a property record has ListAgentMlsId = 'A10001' and the MLS prefix is 'ACT': Search Member resource for MemberMlsId = 'ACTA10001' Note: When displaying data externally, the prefix should be removed (e.g., 'ACT123456' becomes '123456'). ``` -------------------------------- ### Array of Strings Example Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Illustrates the expected output format for fields defined as 'String List, Multi' in RESO. These fields should be returned as an array of multiple string values. ```JSON "Appliances": [ "Washer Dryer Hookup", "Dishwasher", "Oven", "Refrigerator" ] ``` -------------------------------- ### Array of Strings Example Source: https://docs.mlsgrid.com/api-documentation Illustrates the expected output format for fields defined as 'String List, Multi' in RESO. These fields should be returned as an array of multiple string values. ```JSON "Appliances": [ "Washer Dryer Hookup", "Dishwasher", "Oven", "Refrigerator" ] ``` -------------------------------- ### MlgCanUse Field Example for Back Office (BO) Source: https://docs.mlsgrid.com/api-documentation Presents an example of the MlgCanUse field in JSON format, indicating a record is suitable for Back Office (BO) use cases such as analytics and participant listings. Records with only BO cannot be used for IDX or VOW. ```JSON { "MlgCanUse": [ "BO" ] } ``` -------------------------------- ### MlgCanUse Field Example for IDX and VOW Source: https://docs.mlsgrid.com/api-documentation Demonstrates the MlgCanUse field in JSON format, showing a record qualified for both IDX and VOW use cases. This allows usage in both Internet Data Exchange and Virtual Office Website programs. ```JSON { "MlgCanUse": [ "IDX", "VOW" ] } ``` -------------------------------- ### MLS Grid API Lookup Initial Data Import Request Source: https://docs.mlsgrid.com/api-documentation This is an example API request URL to retrieve initial lookup data from the MLS Grid API. It filters records by originating system name 'actris' and where MlgCanView is true. ```URL https://api.mlsgrid.com/v2/Lookup?$filter=OriginatingSystemName eq ‘actris’ and MlgCanView eq true ``` -------------------------------- ### MlgCanUse Field Example for IDX, VOW, and Back Office (BO) Source: https://docs.mlsgrid.com/api-documentation Illustrates the MlgCanUse field in JSON format, signifying a record is eligible for IDX, VOW, and Back Office (BO) use cases. This provides maximum flexibility across different data subscription types. ```JSON { "MlgCanUse": [ "IDX", "VOW", "BO" ] } ``` -------------------------------- ### MlgCanUse Field Example for IDX Source: https://docs.mlsgrid.com/api-documentation Illustrates the MlgCanUse field in JSON format, specifying that a record is eligible for IDX use cases. This field helps determine data subscription types and qualifying use cases. ```JSON { "MlgCanUse": [ "IDX" ] } ``` -------------------------------- ### MlgCanUse Field Example for VOW and Back Office (BO) Source: https://docs.mlsgrid.com/api-documentation Shows the MlgCanUse field in JSON format, indicating a record is qualified for both VOW and Back Office (BO) use cases. This allows usage in VOW programs and BO analytics. ```JSON { "MlgCanUse": [ "VOW", "BO" ] } ``` -------------------------------- ### MLSGrid Metadata Navigation Properties Source: https://docs.mlsgrid.com/api-documentation Defines navigation properties within the OData metadata, specifying how related resources (like Rooms and UnitTypes) are linked to parent resources (like Property). These definitions guide the expansion of related data. ```APIDOC Description: These XML-like entries from the OData metadata indicate that the 'Property' resource contains collections named 'Rooms' and 'UnitTypes'. The 'Type' attribute specifies the schema for these related collections, enabling clients to understand the structure of expanded data. ``` -------------------------------- ### MlgCanUse Field Example for Broker Only / Participant Data Access (PT) Source: https://docs.mlsgrid.com/api-documentation Displays the MlgCanUse field in JSON format, indicating a record is restricted to Broker Only / Participant Data Access (PT) use cases, specifically Participant Listings Use. ```JSON { "MlgCanUse": [ "PT" ] } ``` -------------------------------- ### MLSGrid API: Get StandardStatus Lookups Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Retrieves a list of available StandardStatus lookup values from the MLSGrid API. This example shows filtering by LookupName and OriginatingSystemName for the 'actris' system. The response includes details for each status, such as LookupKey, LookupValue, and ModificationTimestamp. ```APIDOC GET https://api-demo.mlsgrid.com/v2/Lookup?$filter=LookupName eq 'StandardStatus' and OriginatingSystemName eq 'actris' { "@odata.context": "https://api-demo.mlsgrid.com/v2/$metadata#Lookup", "value": [ { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('ACT61bb679024b9e68b94c17bf8')", "LookupKey": "ACT61bb679024b9e68b94c17bf8", "LookupName": "StandardStatus", "LookupValue": "Canceled", "ModificationTimestamp": "2021-12-16T16:21:36.393Z", "OriginatingSystemName": "actris", "StandardLookupValue": "Canceled", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('ACT61bb679124b9e68b94c180c1')", "LookupKey": "ACT61bb679124b9e68b94c180c1", "LookupName": "StandardStatus", "LookupValue": "Expired", "ModificationTimestamp": "2021-12-16T16:21:37.056Z", "OriginatingSystemName": "actris", "StandardLookupValue": "Expired", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('ACT61bb679124b9e68b94c181b8')", "LookupKey": "ACT61bb679124b9e68b94c181b8", "LookupName": "StandardStatus", "LookupValue": "Delete", "ModificationTimestamp": "2021-12-16T16:21:37.135Z", "OriginatingSystemName": "actris", "StandardLookupValue": "Delete", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('ACT61bb679124b9e68b94c181bf')", "LookupKey": "ACT61bb679124b9e68b94c181bf", "LookupName": "StandardStatus", "LookupValue": "Withdrawn", "ModificationTimestamp": "2021-12-16T16:21:37.135Z", "OriginatingSystemName": "actris", "StandardLookupValue": "Withdrawn", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('ACT61bb679124b9e68b94c18331')", "LookupKey": "ACT61bb679124b9e68b94c18331", "LookupName": "StandardStatus", "LookupValue": "Pending", "ModificationTimestamp": "2021-12-16T16:21:37.286Z", "OriginatingSystemName": "actris", "StandardLookupValue": "Pending", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('ACT61bb679124b9e68b94c1869e')", "LookupKey": "ACT61bb679124b9e68b94c1869e", "LookupName": "StandardStatus", "LookupValue": "Incomplete", "ModificationTimestamp": "2021-12-16T16:21:37.588Z", "OriginatingSystemName": "actris", "StandardLookupValue": "Incomplete", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('ACT61bb679124b9e68b94c187ef')", "LookupKey": "ACT61bb679124b9e68b94c187ef", "LookupName": "StandardStatus", "LookupValue": "Active", "ModificationTimestamp": "2021-12-16T16:21:37.738Z", "OriginatingSystemName": "actris", "StandardLookupValue": "Active", "MlgCanView": true } ] } ``` -------------------------------- ### MLSGrid API: Get BodyType Lookups Source: https://docs.mlsgrid.com/api-documentation/api-version-2 Retrieves a list of available BodyType lookup values from the MLSGrid API. This example demonstrates filtering by LookupName and OriginatingSystemName. The response contains an array of lookup objects, each with details like LookupKey, LookupValue, and ModificationTimestamp. ```APIDOC GET https://api-demo.mlsgrid.com/v2/Lookup?$filter=LookupName eq 'BodyType' and OriginatingSystemName eq 'mfrmls' { "@odata.context": "https://api-demo.mlsgrid.com/v2/$metadata#Lookup", "value": [ { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('MFR61bb678f24b9e68b94c1768e')", "LookupKey": "MFR61bb678f24b9e68b94c1768e", "LookupName": "BodyType", "LookupValue": "Double Wide", "ModificationTimestamp": "2021-12-16T16:21:35.843Z", "OriginatingSystemName": "mfrmls", "StandardLookupValue": "Double Wide", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('MFR61bb679024b9e68b94c178dd')", "LookupKey": "MFR61bb679024b9e68b94c178dd", "LookupName": "BodyType", "LookupValue": "Single Wide", "ModificationTimestamp": "2021-12-16T16:21:36.083Z", "OriginatingSystemName": "mfrmls", "StandardLookupValue": "Single Wide", "MlgCanView": true }, { "@odata.id": "https://api-demo.mlsgrid.com/v2/Lookup('MFR61bb679024b9e68b94c179c3')", "LookupKey": "MFR61bb679024b9e68b94c179c3", "LookupName": "BodyType", "LookupValue": "Triple Wide", "ModificationTimestamp": "2021-12-16T16:21:36.163Z", "OriginatingSystemName": "mfrmls", "StandardLookupValue": "Triple Wide", "MlgCanView": true } ] } ``` -------------------------------- ### MLS Grid API Version 2.0 Reference Source: https://docs.mlsgrid.com/recent-releases/maris-mls-migration-to-new-mls-system-and-new-originatingsystemname This section provides access to the API documentation for Version 2.0 of the MLS Grid API. It details endpoints, methods, request/response formats, and authentication mechanisms for interacting with MLS data. ```APIDOC API Version 2.0: Description: Documentation for the MLS Grid API, version 2.0. Endpoints: - /api/v2/listings: Retrieve real estate listings. - /api/v2/agents: Retrieve agent information. - /api/v2/offices: Retrieve office information. Authentication: - API Key: Required for all requests. - Header: Authorization: Bearer YOUR_API_KEY Rate Limiting: - 100 requests per minute. Common Parameters: - `limit`: Integer, number of results to return (default 25). - `offset`: Integer, number of results to skip. - `filter`: String, applies filters to the results (e.g., `status:active`). Example Request (Get Listings): GET /api/v2/listings?limit=10&filter=status:active Example Response (Listing): { "id": "12345", "address": "123 Main St", "city": "Anytown", "state": "CA", "zip": "90210", "price": 500000, "status": "active" } ```