How to configure an OpenCage Data API key for RealtyPress

Creating the API key

  1. Go to opencagedata.com and click the sign-up button in the top right.
  2. Enter the requested account details , agree to the terms and click the continue button to create your account.
  3. You will receive an account confirmation email before your account is activated for use. Once received click the “Create My Account” button in the email.
  4. Once confirmed you’re ready to login at opencagedata.com.  Click the Log in button in the header.
  5. Enter your credentials and click the “Log In” button.
  6. In the dashboard under the “API Key” section you will see your API key.
  7. Leave this page open and open a new tab in your browser.

Configuring the API key in RealtyPress

  1. Login to your websites WordPress admin in the new tab opened in the last step above.
  2. Go to RealtyPress » General Options » API Keys.
  3. Copy the API key in your Opencage dashboard to the OpenCage API text input displayed on RealtyPress » General Options » API Keys page.
  4. Click “Save Changes”.

Testing the key in RealtyPress

  1. Go to RealtyPress » System » Debug.
  2. Click the “Test Geocoding” button in the top right of the page.
  3. Test results will be displayed upon completion.

If your test fails, review the test output to confirm that the key is being applied. If the key is being applied confirm that the key matches the key in your OpenCage dashboard.

Most failed tests will display the reason for the failure in the test output.

If you’re having trouble configuring your API key submit support ticket through your https://realtypress.ca account.