Deep Linking

Summary: Deep Linking allows an MLS, CIE or Broker to link directly to a "deep" interior page of RPR. An example is a link on a listing input form that takes the MLS subscriber to an RPR Property Details page to view public records data and other information for the listing. Another scenario is a 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 want 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 RPR branding. 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:
    • ApMode (determines whether RPR displays residential or commercial data and functionality)
      • Residential (default)
      • Commercial
    • Action
      • Search
    • SearchType
      • 1 = All Properties search results
      • 2 = For Sale search results
      • 3 = Neighborhood search results
    • ResultType
      • 1 = List View
      • 2 = Map View
    • Query
      • City, State and/or ZIP
      • Neighborhood, City, State and/or ZIP
      • Street Name, 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.
    • Owner (last name | last name, first name | first name last name)
    • Examples:


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:
    • Great:
    • Good:,+Naples,+FL 34105
    • OK: Tall Pine Ln %232106, Naples, FL 34105
    • Bad: Tall Pine Ln #2106, 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 includes only 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 Support account representative for assistance with implementing deep linking.