Technical Documentation
New York City (NYC) and National property data have been merged to provide consistent data and unified search across all properties. As a consequence, the Reonomy IDs of NYC properties have changed. See ID mappings for information on updating your scripts.
For Reonomy API users, the key benefits of this change are:
null
now return data if it is available for the selected property. POST /v2/search/summaries
endpoint to search for NYC properties using those NYC-only attributes. See NYC-only search attributes for details and an example.What: Use the ID mappings below to update any scripts that reference Reonomy IDs for NYC properties, as these IDs have changed.
When: The change went into effect on April 17.
The error message below indicates that you used an invalid property ID.
{
"err_name": "ESResultNotFound",
"message": "No result found for query.",
}
If you have scripts that reference Reonomy IDs for properties located within NYC, you must update your scripts to use the new IDs. Use the lookup tables below (CSV or JSON) to map old IDs to new IDs.
For example, if you use the batch API endpoint to download property data for specific properties, you must update the IDs in the property details file spec. You can do this as follows:
get id mappings json
open job spec file
for each id in job spec file:
if id is in map file:
replace old id with new id
A sample Python implementation is shown on the right.
# Update property IDs in batch job file spec
import json, requests
nyc_map = requests.get('https://reonomy-viserion.s3.amazonaws.com/nyc-mappings/v2-id-mappings-nyc.json').json()
with open('old_bulk_job.json') as job_file:
job_contents = json.load(job_file)
job_contents['property_ids'] = [nyc_map[id] if id in nyc_map \
else id for id in job_contents['property_ids']]
with open('new_bulk_job.json', 'w') as job_file:
json.dump(job_contents, job_file)
A CSV file with the ID mappings is available (first 10 rows displayed below). Use the button to download the complete file to your local machine.
Download CSV fileOld Reonomy ID | New Reonomy ID |
---|---|
00099615-4c7a-58b0-9702-5e92337aebc4 | 6097479c-6c29-5b98-9807-b758c6bf4e94 |
001467b7-6e0c-563c-89c7-262f062b46e3 | 47f122d5-bc92-5f57-b9a1-2857dd563cce |
001eed8d-a912-5ba0-a1ad-018e2faf65ea | aaa6985d-2da9-56f0-b2e5-c0e8bdc4bfe8 |
0023d865-8fe5-501d-a642-9e12b4fa4427 | e9375a80-3724-52e5-be5b-a9b1bd010b3f |
002c86f9-b6c5-59a0-a653-de3322557fb1 | f51b4a42-3960-5151-921a-a410690b413d |
0076181c-05ae-5949-836b-8becc63b4568 | 77a5038c-24fa-56b6-961b-fb9e0aace2de |
009726b9-4550-5a1b-87b9-1ef451c06957 | cdc25a1c-72a9-5705-889f-9d19e52c0298 |
00a9d098-c68a-5ef5-ae76-700b76139240 | 67b12090-1dc9-5b0f-9578-332b342a84cb |
00bca00e-9d49-5b2f-afb6-d6ead91bfbd7 | 45ea21e4-8efe-5037-8a18-e22b23730d44 |
00bde07c-8275-5522-9b32-04696098c778 | 3ab0cdbc-d3e0-58c4-ba09-256c4625440d |
A JSON file with the mappings (old: new
) is available by making a GET
request to https://reonomy-viserion.s3.amazonaws.com/nyc-mappings/v2-id-mappings-nyc.json
.
{
"00099615-4c7a-58b0-9702-5e92337aebc4": "6097479c-6c29-5b98-9807-b758c6bf4e94",
"001467b7-6e0c-563c-89c7-262f062b46e3": "47f122d5-bc92-5f57-b9a1-2857dd563cce",
"001eed8d-a912-5ba0-a1ad-018e2faf65ea": "aaa6985d-2da9-56f0-b2e5-c0e8bdc4bfe8",
"0023d865-8fe5-501d-a642-9e12b4fa4427": "e9375a80-3724-52e5-be5b-a9b1bd010b3f",
"002c86f9-b6c5-59a0-a653-de3322557fb1": "f51b4a42-3960-5151-921a-a410690b413d",
"0076181c-05ae-5949-836b-8becc63b4568": "77a5038c-24fa-56b6-961b-fb9e0aace2de",
"009726b9-4550-5a1b-87b9-1ef451c06957": "cdc25a1c-72a9-5705-889f-9d19e52c0298",
"00a9d098-c68a-5ef5-ae76-700b76139240": "67b12090-1dc9-5b0f-9578-332b342a84cb",
"00bca00e-9d49-5b2f-afb6-d6ead91bfbd7": "45ea21e4-8efe-5037-8a18-e22b23730d44",
"00bde07c-8275-5522-9b32-04696098c778": "3ab0cdbc-d3e0-58c4-ba09-256c4625440d"
}
The POST /search/summaries endpoint includes a number of NYC-specific attributes you can search on. If you include any of these attributes in a search using this endpoint, the API will return only NYC properties.
The NYC-specific attributes are shown below (enter values to see a sample code snippet). If you've entered your API access token (use the button at the top right of the page), you can use the ► RUN button to run your request against the Reonomy API and see the response.
To view all of the available search attributes, see POST /search/summaries.
The default response includes the count of properties that match the search criteria, as well as the property ID and update information for the first 10 items.
If you run the query and get an AuthorizationException
, use the Access Token button in the top navigation bar to set your API access token.