Using the PropertyRadar Import API
Overview
The Import API lets you send your own records, such as names, addresses, phones, emails, or APNs, straight from your code or CRM into a PropertyRadar import list. We match each record to our property and owner data, and the matches become a list you can work in the app.
It works the same way as importing a file, without the upload step. The process has three steps:
Create an import list with API as its source.
Send your records to that list.
Review the matches, and fix any that need it.
The Import API is built for developers, since it takes custom code on your side. If you'd rather not write code, our Zapier integration can send records to an import list with no coding.
API Tokens vs OAuth
API tokens are for end users working with their own PropertyRadar account.
If you build software used by PropertyRadar customers, we also offer OAuth so your application can access the API on behalf of our shared customers. Contact us to learn about our partner programs.
Base URL and format
All requests go to this base URL over HTTPS:
https://api.propertyradar.com/v1
The API follows REST conventions: resource-based URLs, standard HTTP methods, and standard HTTP response codes.
Requests and responses are JSON, encoded as UTF-8. Set this header on requests that send a body:
Content-Type: application/json
Responses are always a JSON object.
Authorization
Every request is authorized with your account's API token, sent as a bearer token. You'll find it in Account Settings, and only account owners and admins can see it.
Log in to PropertyRadar, click your profile icon, and choose Account Settings.
Scroll to the bottom and click your API key's Integration Name to reveal the token.
Add this header to every request, replacing YOUR_API_TOKEN with your token:
Authorization: Bearer YOUR_API_TOKEN
Keep your token private, like a password. Don't share it, put it in screenshots, or commit it to a code repository. For more, see Managing account settings.
Step 1: Create an import list
Records can only be sent to an import list whose source is API. You can create one in the app or through the API.
In the app: create a new import list and choose API as the import source. When the list is created, PropertyRadar shows its API Import URL, which includes the list's ID:
https://api.propertyradar.com/v1/lists/{ListID}/import/items
Through the API: call Create a list with ListType set to import and ImportSource set to api:
curl -X POST "https://api.propertyradar.com/v1/lists" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "ListName": "CRM leads - October", "ListType": "import", "ImportSource": "api", "ImportType": "property" }'The response includes the new list's ListID, which you'll use in the next step.
Option | What it does |
| Required. The list's name, up to 50 characters |
|
|
| How closely a record must match a property to count as a match |
| Whether imported names, phones, and emails are added as contacts ( |
| The list group to put the list in, such as |
Step 2: Send your records
Send records to Match and import to list with a POST to /v1/lists/{ListID}/import/items. The body is a JSON array with one object per record. Include as many fields as you have, because more detail gives better matches.
curl -X POST "https://api.propertyradar.com/v1/lists/123456/import/items?Purchase=0" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '[ { "FirstName": "John", "LastName": "Doe", "Address": "120 SE Main St #500", "City": "ANAHEIM", "State": "CA", "ZipFive": "95555" } ]'Field | Example |
|
|
|
|
| " |
|
|
Preview first, then purchase
The Purchase query parameter is required:
Purchase=0Only previews for testing your callPurchase=1(purchase): imports and matches the records. Note: There are no charges for imports
Step 3: Review your matches
Once the import is processed, the list works like any other import list. You can review matches in the app, or use these endpoints:
Endpoint | What it does |
View imported matches | Lists each imported record with its match details |
Update an import match | Changes the match for one imported record |
Remove import match | Removes a match and reverts what it did, such as setting a primary contact |
For testing your calls, tools like Postman work well. You can also try any endpoint in the API Reference: click Try It, then paste your token into Bearer Token on the Security tab.