Deep Linking

Summary: Deep Linking allows an MLS, CIE or Broker to link directly to a "deep" interior page of RPR. An example would be a link on a listing input form that takes the Realtor to an RPR Property Details page to view public records data and other information for the listing. Another would be to link to an RPR report generation page for the property.

This deep linking technology can be used in both Commercial and Residential mode, with branding (an RPR feature that lets CIEs/MLSs/Brokers customize RPR with their own logo), and with Single Sign-On (SSO), which allows MLS users to login to RPR seamlessly, without entering their RPR credentials, when they are already authenticated with the MLS/CIE.

Please note: Deep Linking is available only to RPR users. Since the deep link requires the user to sign into RPR, and since RPR is available to NAR members only, it is not a solution suitable for public-facing websites. Usage is pursuant to the RPR Terms of Use at

Implementing Deep Linking is easy, but does require a developer. The basic steps are as follows:

  1. Decide which RPR pages you would like to link to, and where you want to place those links on your website.
  2. Construct the links you need using the technical guidance below.
  3. Add the links to the website code, in the appropriate places.
  4. Make the link parameters dynamic, so the links use the specific geographical location or address when pointing to RPR.
  5. Test!

Technical Guidance: Constructing the Deep Link

    1. Start with the base link:
    2. Determine if you have an RPR cobrand. If so, you will need to add cbcode=<yourcode> to the querystring.
    3. Determine if you have Single Sign-On (SSO) in place with RPR. If so, add ssocode=<yourcode> to the querystring.
    4. Add additional parameters to the query string to return the specific data you're looking for:
      1. Search Results:
        1. ApMode (determines whether RPR displays residential or commercial data and functionality)
          1. Residential (default)
          2. Commercial
        2. Action
          1. Search
        3. SearchType
          • 1 = All Properties search results
          • 2 = For Sale search results
          • 3 = Neighborhood search results
        4. ResultType
          • 1 = List View
          • 2 = Map View
        5. Query
          • City, State and/or ZIP
          • Neighborhood, City, State and/or ZIP
          • Streetname, City, State and/or ZIP
          • Street Number Range, StreetName, City, State and/or ZIP
          • Full property address is also supported, but we recommend using a PropertyDetails action as noted below.
        6. Owner (last name | last name, first name | first name last name)
        7.  Examples:
          1. Residential Street Range Search: Live Oak, Irvine, CA 92604
          2. Commercial:, CA
          3. If only a single property is found, the detail page for that property will be shown instead of search results.
      2. Property/Listing Details:
        1. ApMode
          1. Residential (default)
          2. Commercial
        2. Action
          1. PropertyDetails
        3. DetailsTab (representing the tab number of the RPR property details page)
          • 1 = Summary
          • 2 = History
          • 3 = Charts & Graphs
          • 4 = Refined Value
          • 5 = Comp Analysis
        4. Query
          • City, State and/or ZIP
          • Neighborhood, City, State and/or ZIP
          • Streetname, City, State and/or ZIP
          • Street Number Range, StreetName, City, State and/or ZIP
          • Preferred: Full property address, of the format: 123 N 53rd St SW #13b, Somewheresville, NY 55555
            • Street Number
            • Street Direction Prefix
            • Street Name
            • Street Type
            • Street Post Direction Suffix
            • Unit Type (typically #, but can be Apt, Unit, etc)
            • Unit Number
            • City
            • State
            • Zip
        5. APN
          • Formatted APN number (i.e. 451-683-01)
          • You must specify a city, state and/or zip in the Query parameter, or specify a StateCountyFIPS in the FIPS parameter, to use APN search.
        6. OrgID
          1. Your RPR implementation specialist can provide you with your OrgID. It typically matches your cbcode/ssocode.
        7. ListingID
          1. The Listing ID of the listing in question.  
          2. Note:  It is important to note that there is some latency between listing entry on the MLS/CIE and availability in RPR.  If you choose to link directly to specific listings, they may not be found in RPR right afterwards. We recommend that you always couple an OrgID/ListingID search with a full property address in the query parameter, so we can fall back to a Property Details page if we cannot find the exact listing.
          3. If you also specified an area in the Query parameter, results will be filtered using both criteria.
        8. Examples:
      3. Reports:
        1. ApMode
          1. Residential (default)
          2. Commercial
        2. Action
          1. Reports
        3. ReportType
          • 1 = Property Report
          • 2 = Market Activity Report
          • 3 = Seller's Report
          • 4 = Mini Property Report
          • 5 = Neighborhood Report
          • 7 = Property Flyer
          • 8 = Commercial Property Report
          • 9 = Commercial Trade Area Report
          • 10 = Commercial Trade Area Analysis
          • 11 = Commercial Best Businesses Report
          • 12 = Valuation Workbook
        4. Query
          • City, State and/or ZIP
          • Neighborhood, City, State and/or ZIP
          • Streetname, City, State and/or ZIP
          • Street Number Range, Streetname, City, State and/or ZIP
          • Full property address, of the format: 123 N 53rd St SW #13b, Somewheresville, NY 55555
        5. Email (specify a valid email address for the recipient, separating up to several email addresses with commas)
        6. Headline (for Property Flyer reports only)
        7. Description (for Property Flyer reports only)
        8. Examples:
          1. Property Report: Live Oak, Irvine, CA
          2. Market Activity Report: Live Oak, Irvine, CA
          3. Seller's Report: Live Oak, Irvine, CA
      4. School Details:
        1. Action
          1. School
        2. Query
          1. City, State (Laguna Niguel, CA)
        3. SchoolName
          1. Name of school (Hidden Hills Elementary)
        4. Example: Search for Hidden Hills Elementary in Laguna Niguel, CA: niguel, ca&schoolname=Hidden Hills Elementary School
    5. School Search Results:
      1. Action
        1. School
      2. Query
      3. City, State (Laguna+Niguel,+CA)
      4. Example: Search for schools in Laguna Niguel, CA:,+ca
    6. School District:

      1. Action

                    1. School

      2. Query

                    1. City, State (Laguna+Niguel,+CA)

      3. Schooldistrict

                    1. District name (Saddleback)

      4. Example: Search for Saddleback School District in Laguna Niguel, CA niguel, ca&schooldistrict=saddleback

    7. Commercial Analysis Features:
      1. Common Parameters (these are used in all the Commercial Analysis examples below
      2. ApMode
        1. NeighborhoodDetails
        2. Maps
        3. Analysis
        1. InDepth
        2. BestLocation
        3. BestBusinesses
        1., NC&detailstab=summary
        1., NC
        1. Quick:, NC
        2. In-depth:, NC
        1., NC
        1., NC
        1. Commercial (default)
        2. Action
        3. AnalysisType
        4. Trade Area Details
        5. Commercial Maps:
        6. Commercial Analysis:
        7. Commercial Best Location Analysis:
        8. Commercial Best Businesses Analysis:


  • All query string values must be URL-encoded, otherwise you may experience very unexpected results.  This is because some common characters in property addresses, namely the # unit symbol, are restricted HTML commands.  You can use a number of internet tools to URLencode/URLdecode your parameters (, but please remember to not URLencode the entire URL (such as the http:// part, unless you're passing that full URL into a redirection mechanism on your website).
    • Examples:
      • Bad: Tall Pine Ln #2106, Naples, FL 34105
      • Great:
      • Good:,+Naples,+FL 34105
      • OK: Tall Pine Ln %232106, Naples, FL 34105
    • Here is a list of characters to encode:
      • space ( ): %20 or + (browsers usually encode this automatically)
      • comma (,): %2C (browsers usually encode this automatically)
      • semicolon (;): %3B
      • question mark (?): %3F
      • slash (/): %2F
      • colon (:): %3A
      • hash (#): %23
      • ampersand (&): %26
      • equals (=): %3D
      • plus (+): %2B
      • US currency ($): %24
      • percent (%): %25
      • less than (<): %3C
      • greater than (>): %3E
      • tilde (~): %7E
  • If you do an APN search, you must also specify a location: an area in the Query parameter or a StateCountyFIPS code in the FIPS parameter.
  • It's best to URLencode the querystring you generate, even though most web browsers do this for you automatically.
  • If you search by property address, it's best to use an address that has been passed through an address standardizer. If that isn't available, make sure the address is as accurate as possible and that it is formatted as closely as possible to USPS standards.
  • If the user is not signed into RPR, they will be prompted to do so (unless SSO is configured), and will then be taken to the requested page.
  • You can open the RPR deep link in the user's existing window, in an entirely new window, or even in an iframe (this can be handled by your developers).
  • An example with cobrand and SSO support would be:, CA 92604&cbcode=<yourcode>&ssocode=<yourcode> (this link will not work without modifying cbcode and ssocode)

Known Issues

When a property address or area is specified but not uniquely identified by RPR, we will display a "Did you mean" dialog box where the user can choose from among several options. This is a feature, and it occurs for legitimate reasons (such as when the Query parameter only include a ZIP code, but that ZIP code matches not only the real ZIP but also a number of other listing IDs across the country).

Terms of Use

Because Deep Linking requires an RPR account, any use is governed by the RPR Terms of Use at


Please contact your MLS account representative for assistance with implementing deep linking.

Have more questions? Submit a request