API and Embedding
We created our embed module to help website owners add great content to their website, and best of all it's completely free. You can find an example here: https://embed-example.mappedby.com/preview-example?id=1
Why embed a MappedBy report on your website?
Industry professionals such as realtors, property managers and really anyone dealing with property addresses want to provide a great user experience. For most of your website visitors this will mean providing insight and data that stands out and works to build their trust, and by adding our embed module you are doing just that.
​
If you would like a free custom integration, control the branding of our embedded widget or change the data shown in your embed please contact us to setup a time to learn more about your needs.
We do all customizations for free and would love to enhance your website with our data so do not hesitate to reach out.
​
If you're looking to use our RESTful API please visit our gitbook documentation.
How to embed our reports on your website
You don't need to be a programmer to embed our reports on your website, by following this simple walkthrough anyone can get started with MappedBy reporting on their website in no time at all.
​
1. Register for a free MappedBy.com account by visiting: https://app.mappedby.com/register
2. After logging in, in the top right hand menu click "Embed / API access"
3. Review the page and learn about embeddings, then copy and paste the embed code and place it on your website anywhere you would like to render a report.
4. Customize the input data for the embed code
In order to show the intended report details, modify the url of the embed to match the property. There are 2 inputs you can configure:
​
elementId (required)
This will tell us where you want this data to render. Be sure to apply the class "mappedby-embed" as is shown in the example or you might find the embedded content does not render correctly.
​
address (required)
The full address of the property (or as much of it as you have). If you do not have the full address this may result in us returning the incorrect report data. You should urlencode this data.
​
coordinates (optional)
If you do not provide these details, we will extrapolate them from the address on your behalf. If you provide invalid coordinates, or coordinates that are not precise enough, we will ignore your inputs. While we strongly recommend providing coordinates, if you do not know the correct coordinates we do not encourage you to provide this data unless you are confident they are accurate as it may result in unexpected results.
In some cases addresses will not geocode to the intended locations, in these rare instances providing the coordinates via this means will resolve the issue. You should still provide the correct address in these cases as we use it for other purposes throughout the report.
5. Verify it is working
​
You should now be able to see our widget on your website. The expected result should look similar to the following. If you want to customize the embed or have any questions at all, please reach out!