This collection provides helpful examples for queries to the MLS Router™ API.
MLS Router™ API suite is a RESO certified Web API for MLS data distribution.
This endpoint is used to obtain an authentication token for accessing protected resources in the MLS Router. By providing valid credentials, clients can receive a token that must be included in subsequent requests to authenticate the user.
\nclient_id=your_client_id\nclient_secret=your_client_secret\n\nSign up on Realtyfeed Dashboard to aquire client_id and client_secret:
\n\n\nMLS Data Vendors can acquire the API access through a different dashboard (invitation-based only)
\n
Upon a successful request, the server will respond with a JSON object containing the authentication token and other relevant information. The structure of the response typically includes:
\naccess_token (string): The token that can be used for authenticating subsequent API requests.
\ntoken_type (string): The type of token issued (e.g., Bearer).
\nexpires_in (integer): The duration in seconds for which the token is valid.
\n{\n \"access_token\": \"your_access_token\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}\n\nEnsure that the client_id and client_secret are kept confidential and not exposed in public repositories or client-side code.
The token received from this endpoint should be included in the Authorization header of subsequent API requests to access protected resources.
Rate limt is 1 Request per second.
\nTo access the API, authentication is required. The API uses the OAuth2 Client Credentials flow for authentication
\n","_postman_id":"243bdfbd-71da-439a-b3d3-711749fb9fc8","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint retrieves the metadata for the MLS Router OData service. The metadata provides a comprehensive description of the data model, including entity types, relationships, and the structure of the data that can be queried through the API.
\nMethod: GET
\nURL: https://api.realtyfeed.com/reso/odata/$metadata
Request Body: No request body is required for this GET request.
\nThe response will contain XML formatted metadata that describes the following:
\nThis metadata is essential for developers to understand how to interact with the API effectively and to construct valid queries.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint retrieves a list of lookup values from the API. It is commonly used to obtain standardized data such as property types, statuses, and other relevant categories that can be utilized in real estate applications.
\nLookupName is equal to 'StandardStatus'.The response is returned in JSON format with a status code of 200 indicating a successful request. The structure of the response is as follows:
\n{\n \"value\": [\n {\n \"@odata.id\": \"\",\n \"LookupKey\": \"\",\n \"LookupName\": \"\",\n \"LookupValue\": \"\",\n \"OriginatingSystemName\": null,\n \"StandardLookupValue\": \"\",\n \"ModificationTimestamp\": \"\",\n \"DisplayNames\": [\n {\n \"Locale\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ]\n}\n\nOnce you've authenticated, the next step for building a client is finding out what data you can get out of the API.
\n","_postman_id":"e8a46527-0d0b-4181-ba9a-d3ac68bd9a81","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint retrieves detailed information about a specific member identified by their unique MemberKey
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This request retrieves a list of members along with their associated images. Please note that media availability depends on MLS policies and may not be supported by all feeds.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"This endpoint retrieves member records from the API. It is used to access member details that may include various attributes related to real estate professionals.
\n","_postman_id":"1fdf4629-bc0c-4652-a362-60595b54f38f","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"Method: GET
\nURL: https://api.realtyfeed.com/reso/odata/Office
The response may include a @odata.nextLink field, which provides a URL to fetch the next set of results if available.
This endpoint retrieves detailed information about a specific office from the API using OfficeKey. The request is made via an HTTP GET method to the URL https://api.realtyfeed.com/reso/odata/Office('3219'), where '3219' is the OfficeKey
The response may contain null or empty values for certain fields if the information is not available.
\nEnsure that the Office ID used in the request is valid to receive accurate data.
\nThis request retrieves a list of active offices from the API. It allows users to filter the results based on the office status and select specific fields to return.
\n{\n \"value\": [\n {\n \"OfficeMlsId\": \"\",\n \"OfficeKey\": \"\",\n \"OriginatingSystemName\": \"\",\n \"@odata.id\": \"\"\n }\n ],\n \"@odata.nextLink\": \"\"\n}\n\nThis endpoint retrieves a list of office information from the API. It is particularly useful for applications that need to display or process details about real estate offices.
\n","_postman_id":"1c5493f0-90f9-4a84-b615-0f55d49ba7b2","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"