Reonomy logo

Technical Documentation

API Reference

V2 Property API (https://api.reonomy.com)

get /v2/jobs/file

/​v2/​jobs/​file

Returns information about past batch jobs. For each job, if it completed successfully ("status": "SUCCESS"), the response includes links to download the results.

For property detail jobs (bulk downloads):

  • result_url is a comma-separated string of links for each batch of up to 25,000
  • result_urls is a list of links for each batch of up to 25,000

See Running batch jobs for more information.

Rate limiting

Requests to this endpoint are rate limited to 5 requests per second.

Parameters

Parameters

Query parameters

limit (string)

The number of jobs to return (the default is 100).

offset (string)

By default, the API returns information on the most recent batch jobs. Use offset to specify a different set. For example, setting offset=100 with limit=100 returns the next 100.

Response

200

count (integer)

The total number of batch job requests.

items (array)

List of batch job information objects.

created (string)

The date and time (UTC) the job was submitted.

filename (string)

group_path (string)

The user's group ID.

id (string)

The job ID.

job_type (string)

The job type specified in the POST request.

message (string)

Not used (returns null).

metadata (object)

The job metadata supplied in the POST request (match jobs only).

count (integer)

duplicate (integer)

Number of duplicate rows (match jobs only).

error_decoding_lines (array)

Rows from csv file that could not be decoded to utf-8. Non-decoded rows are not included as unmatched or in resulting file (match jobs only).

headers (array)

Headers specified in the POST request (match jobs only).

labels (array)

Not used.

mapping (object)

Include column mappings for one of the two field combinations: [("latitude", "longitude"), ("address_line_1", "address_city", "address_state", "address_postal")]

address_city (string)

address_line_1 (string)

address_postal (string)

address_state (string)

latitude (string)

longitude (string)

matched (integer)

Number of rows unmatched (match jobs only).

unmatched (integer)

Number of rows unmatched (match jobs only).

modified (string)

The date and time (UTC) the job status was last modified.

progress

Not used (returns null).

result_url (string)

A comma-separated string of links to download each batch of results. Included only when the batch job completes with status SUCCESS.

result_urls (array)

A list of links to download each batch of results. Included only when the batch job completes with status SUCCESS.

status (string)

The job status.

user (string)

The ID of the user that submitted the request.

limit (integer)

The number of batch jobs in the response (default is 100).

next (string)

The URL for the next batch of results (or null).

offset (integer)

The offset (when displaying job information beyond the first 100 jobs).

previous (string)

The URL for the previous batch of results (or null).

remaining (integer)

By default, the API returns information in batches of 100. This displays the number of batch jobs remaining.

route_args (object)

Displays any query parameters specified in the GET request.

search_token (string)

Not used (returns null).

 

post /v2/jobs/file

/​v2/​jobs/​file

The POST /v2/jobs/file endpoint provides an efficient way to execute bulk operations, including:

  • Downloading property data for up to 1 million properties ("property details jobs").
  • Obtaining property IDs for up to 100,000 addresses or geocoded locations ("match jobs").
  • Obtaining property IDs for large numbers of properties that match the specified search criteria ("search jobs").

For detailed usage information, see Running batch jobs.

Property resolution credits

For match jobs, each address or geolocation in the file will consume one property resolution credit. For information on checking credit usage, see API credits.

Rate limiting

Although you can submit up to 5 API requests per second, batch jobs run sequentially and you won't be able to submit another job until the first one either completes or fails. If you submit a batch job while another is in progress, the API returns HTTP status 429.

Parameters

Parameters

Request body (multipart/form-data)

file (file)

The upload file with the job spec (for property-details jobs), the property address or location CSV file (for match jobs), or the search criteria (for search jobs). See Running batch jobs for details.

Note: For match jobs, the CSV file must include a header row with the column names. Use the metadata.mapping object to map your column names to the required parameters.

job_type (string)

Specify the batch job type.

metadata (object)

Used for match jobs only. headers and mapping are both required.

headers (array)

Specify the names of the columns in your CSV file, in the correct order. It's important to include all columns. If you don't, the column headers in the results CSV file won't align with the data.

mapping (object)

Specify a dictionary object with the four required address parameters (address_line_1, address_city, address_state, and address_postal) or the two required location parameters (lat and lon), and the names of the columns they map to in your CSV file.

address_city (string)

The column with the city.

address_line_1 (string)

The column with the street address.

address_postal (string)

The column with the zip code.

address_state (string)

The column with the 2-letter state abbreviation.

latitude (string)

The location's latitude value.

longitude (string)

The location's longitude value.

Response

201

created (string)

The date and time (UTC) the job was submitted.

filename (string)

group_path (string)

The user's group ID.

id (string)

The job ID. Use this with the GET /v2/jobs/file/{job_id} endpoint to check the job status.

job_type (string)

The job type specified in the POST request.

message (string)

Not used (returns null).

metadata (object)

The job metadata supplied in the POST request (match jobs only).

duplicate (integer)

Number of duplicate rows (match jobs only).

error_decoding_lines (array)

Rows from csv file that could not be decoded to utf-8. Non-decoded rows are not included as unmatched or in resulting file (match jobs only).

headers (array)

Headers specified in the POST request (match jobs only).

labels (array)

Not used.

mapping (object)

Include column mappings for one of the two field combinations: [("latitude", "longitude"), ("address_line_1", "address_city", "address_state", "address_postal")]

address_city (string)

address_line_1 (string)

address_postal (string)

address_state (string)

latitude (string)

longitude (string)

matched (integer)

Number of rows unmatched (match jobs only).

unmatched (integer)

Number of rows unmatched (match jobs only).

modified (string)

The date and time (UTC) the job status was last modified. This is always null in the initial POST response.

progress

Not used (returns null).

result_file (string)

result_urls (array)

status (string)

This is always null in the initial POST response. Use GET /v2/jobs/file/{job_id} to check the job status.

user (string)

The ID of the user that submitted the request.

 

get /v2/jobs/file/{job_id}

/​v2/​jobs/​file/​{job_id}

Returns the status of the specified batch job, along with additional information about the job. After submitting a batch job, poll this endpoint to check the job status. If the job completes successfully ("status": "SUCCESS"), the response includes links to download the results.

For property detail jobs (bulk downloads):

  • result_url is a comma-separated string of links for each batch of up to 25,000
  • result_urls is a list of links for each batch of up to 25,000

See Running batch jobs for more information.

Requests to this endpoint are rate limited to 5 requests per second.

Batch job flow

Parameters

Parameters

Path parameters

job_id (string)

The batch job ID. This is returned by POST /v2/jobs/file when you create the batch job. You can use GET /v2/jobs/file to get the batch job ID and the status of all jobs associated with your access token.

Response

200

created (string)

The date and time (UTC) the job was submitted.

filename (string)

group_path (string)

The user's group ID.

id (string)

The job ID.

job_type (string)

The job type specified in the POST request.

message (string)

Not used (returns null).

metadata (object)

The job metadata supplied in the POST request (match jobs only).

count (integer)

duplicate (integer)

Number of duplicate rows (match jobs only).

error_decoding_lines (array)

Rows from csv file that could not be decoded to utf-8. Non-decoded rows are not included as unmatched or in resulting file (match jobs only).

headers (array)

Headers specified in the POST request (match jobs only).

labels (array)

Not used.

mapping (object)

Include column mappings for one of the two field combinations: [("latitude", "longitude"), ("address_line_1", "address_city", "address_state", "address_postal")]

address_city (string)

address_line_1 (string)

address_postal (string)

address_state (string)

latitude (string)

longitude (string)

matched (integer)

Number of rows unmatched (match jobs only).

unmatched (integer)

Number of rows unmatched (match jobs only).

modified (string)

The date and time (UTC) the job status was last modified.

progress

Not used (returns null).

result_file (string)

result_url (string)

result_urls (array)

status (string)

The current job status.

user (string)

The ID of the user that submitted the request.

 

post /v2/property/bulk

/​v2/​property/​bulk

Returns information for the property IDs specified in the request body. You can specify up to 250 Reonomy property IDs and as many of the available detail types as you want (basic, taxes, sales, etc.). See the response definition below for information about what is returned.

To download data for more than 250 properties, or to download bulk property data asynchronously, use the API's batch job capability, which lets you specify up to 1 million properties in a single API request.

Rate limiting

Requests to POST /v2/property/bulk are rate limited. See Getting property details for more information.

Parameters

Parameters

Request body (application/json)

detail_type (array)

One or more property detail types. Valid types are basic, mortgages, ownership, reported_owner, sales, taxes, and tenants.

filter_pii (boolean)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII for each property detail type, see the Data dictionary.

property_ids (array)

A list of up to 250 Reonomy property IDs.

Response

200

active (boolean)

True if the property record is active.

address_line1 (string)

The first line of the property address. This field is a concatenation of house_nbr, direction_left, street, mode, and direction_right.

alternative_addresses (array)

Alternative addresses for properties in NYC.

address_line1 (string)

city (string)

direction_left (string)

direction_right (string)

house_nbr (string)

mode (string)

state (string)

street (string)

zip5 (string)

apn (string)

Assessor's Parcel Number (APN) in formatted form, typically using dashes and periods to split the APN into logical components (for example, 101-32-021.A).

asset_category (string)

The asset category (Office, Retail, etc.). See std_land_use_code_description for the more detailed asset type.

bins (array)

One or more New York City building identification numbers associated with the property.

block_id (string)

A city block ID.

borough_id (integer)

The New York City borough ID (1: Manhattan, 2: Bronx, 3: Brooklyn, 4: Queens, 5: Staten Island).

building_area (number)

The total square footage of all structures on the tax lot.

building_class (string)

One or more building class codes.

building_update_time (string)

The date the property's building information was last updated (YYYY-MM-DD).

census_tract (string)

The ID of the census tract where the property is located.

city (string)

The city where the property is located.

commercial_overlay_1 (string)

A commercial overlay code.

commercial_overlay_2 (string)

A commercial overlay code.

commercial_units (integer)

The number of commercial units across all structures on the tax lot.

commercial_usable_area (number)

The square footage associated with all commercial components of the property.

contacts (array)

Contact data for this property.

company (object)

Information about the company.

addresses (array)

One or more mailing addresses associated with the company.

city (string)

The city name.

country_code (string)

The country code.

display (string)

The full address.

line1 (string)

The building number and street name.

line2 (string)

The floor, suite, or apartment number.

po_box (string)

The post office box number.

postal_code (string)

The zip code.

state_code (string)

The 2-letter state abbreviation.

type (string)

The address type.

unit (string)

The address unit number.

dba_name (string)

The company's DBA ("doing business as") name.

emails (array)

One or more email addresses (4 maximum) associated with the company.

address (string)

The email address.

employees_total (integer)

Number of employees at the company.

id (string)

The unique Reonomy identifier associated with this company.

location_type (string)

Single location, headquarters, or branch.

match_score (integer)

The confidence that this is a true match.

name (string)

The company name.

parent_id (string)

The unique Reonomy ID associated with the parent company.

phones (array)

One or more phone numbers (4 maximum) associated with the company.

country_code (string)

The country code.

extensions (string)

The internal extension number.

number (string)

The phone number (unformatted), including area code.

type (string)

The phone type (residential, etc.).

sales_volume (integer)

Annual sales volume (in thousand dollars).

state_code (string)

The 2-letter state abbreviation.

type (string)

urls (array)

One or more website URLs associated with the company.

type (string)

URL type.

url (string)

URL for this entity.

year_founded (integer)

The year the company was founded.

contact_type (string)

Whether this contact is a company or an individual.

is_green_match (boolean)

True if there's a high probability this company or individual is an owner of the property.

is_signatory (boolean)

True if this contact is the signatory on the mortgage.

match_score (integer)

Indicates the confidence that this company or individual is the true owner.

persons (array)

For contact_type: "individual", this provides the person's name and contact information. For contact_type: "company", this provides the name and contact information for each known person associated with the company.

addresses (array)

One or more mailing addresses associated with the person.

city (string)

The city name.

country_code (string)

The country code.

display (string)

The full address.

line1 (string)

The building number and street name.

line2 (string)

The floor, suite, or apartment number.

po_box (string)

The post office box number.

postal_code (string)

The zip code.

state_code (string)

The 2-letter state abbreviation.

type (string)

The address type.

unit (string)

The address unit number.

display (string)

The person's full name.

emails (array)

One or more email addresses (4 maximum) associated with the person.

address (string)

The email address.

first_name (string)

The person's first name.

id (string)

The unique Reonomy identifier associated with this person.

jobs (array)

One or more job titles associated with the person.

is_company_owner (boolean)

Is person a company owner

organization (string)

The organization name.

title (string)

The job title.

type (string)

The job type.

last_name (string)

The person's last name.

match_score (integer)

The confidence that this is a true match.

name (string)

The person's full name.

phones (array)

One or more phone numbers (4 maximum) associated with the person.

country_code (string)

The country code.

extensions (string)

The internal extension number.

number (string)

The phone number (unformatted), including area code.

type (string)

The phone type (residential, etc.).

urls (array)

One or more website URLs associated with the person.

type (string)

URL type.

url (string)

URL for this entity.

deprecation_date (string)

The date the property record became inactive.

depth (number)

The depth of the lot (front to back) in feet. For non-NYC properties, this is reported as the lot_size_depth_feet.

direction_left (string)

The address direction to the left of the street name.

direction_right (string)

The address direction to the right of the street name.

existing_far (number)

The floor area ratio (the total building area divided by the lot area) provided by NYC records.

existing_floor_area_ratio (number)

The floor area ratio (the total building area divided by the lot area) provided by the property's most recent sale document.

existing_square_footage (number)

Actual square footage of the property. This can be used to calculate if the property has been overbuilt based on the zoning district and FAR. The formula is as follows: lot area * FAR - Existing SF = Indicative SF.

factory_usable_area (number)

The square footage associated with the factory component of the property.

financials (array)

Financial information.

gross (number)

Gross revenue earned through the operation of the property.

noi (number)

Net operating income provided by the Department of Finance.

opex (number)

Estimate of operating expenses, not including the tax amount, from the Department of Finance.

re_taxes (number)

Real estate taxes, from the Department of Finance.

total_opex (number)

Estimate of operating expenses, including the tax amount, from the Department of Finance.

year (integer)

Year of financials reported.

fips (string)

The 5-digit FIPS code of the county where the property is located.

fips_county (string)

The name of the county associated with the FIPS code where the property is located.

first_owner_name (string)

The first contact name associated with the property.

floors (integer)

Number of floors in the building.

foreclosure (object)

active (boolean)

true foreclosure proceedings are actively ongoing.

auction_date (string)

The foreclosure auction date.

auction_time (string)

The foreclosure aution time.

city_of_auction_call (string)

The city where the auction is occurring.

deed_category (string)

The foreclosure deed category code (see Foreclosure deed categories for a full list).

deed_category_text (string)

The foreclosure deed category name (see Foreclosure deed categories for a full list).

document_type (string)

The foreclosure document type code code (see Foreclosure document types for a full list).

document_type_text (string)

The foreclosure document type name (see Foreclosure document types for a full list).

document_year (integer)

Year the document relating to the pre-foreclosure proceedings was recorded.

final_judgement_amount (string)

The total amount owed in the foreclosure.

first_defendant_borrower_owner_company_name (string)

The borrower company in the pre-foreclosure proceedings.

first_defendant_borrower_owner_first_name (string)

The borrower first name in the pre-foreclosure proceedings.

first_defendant_borrower_owner_last_name (string)

The borrower last name in the pre-foreclosure proceedings.

original_loan_date (string)

The origination date of the initial loan.

original_loan_recording_date (string)

The recording date of the initial loan.

plaintiff_1 (string)

The plaintiff (lender) in the pre-foreclosure proceedings.

recording_date (string)

The date the document relating to the pre-foreclosure proceedings was recorded.

source_date (string)

The date the foreclosure information was pulled from the source document.

state_of_auction_call (string)

2-letter state abbreviation of the state where the auction is occurring.

street_address_of_auction_call (string)

The street address where the auction is occurring.

trustee_city (string)

The city where the trustee is registered.

trustee_mailing_address (string)

The trustee's mailing address.

trustee_name (string)

The trustee's name.

trustee_phone (string)

The trustee's phone number.

trustee_state (string)

2-letter abbreviation of the state where the trustee is registered.

trustee_zip (string)

The trustee's zip code.

use_code (string)

The parcel's asset or lot use code (see Asset types for a full list).

frontage (number)

Linear feet across the front of the lot. This may be reported as the lot_size_frontage_feet attribute.

garage_usable_area (number)

The square footage associated with the garage component of the property.

has_cmbs (boolean)

True if the property has CMBS information.

historic_district (string)

NYC properties within historic districts only: The name of the historic district.

house_nbr (string)

The building number portion of the street address.

id (string)

landmark (string)

NYC properties with designated landmark status only: The landmark name.

legal_description (string)

Legal location description of the property.

likely_to_sell (string)

An indicator that identifies which properties are most likely to sell. Read more about Likely to Sell here.

location (object)

The latitude and longitude of the point at the center of the parcel.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

lot_id (integer)

The New York City lot ID.

lot_size_acres (number)

The size of the lot in acres.

lot_size_depth_feet (integer)

The depth of the lot (front to back) in feet. This may be reported as the depth attribute.

lot_size_frontage_feet (number)

Linear feet across the front of the lot. This may be reported as the frontage attribute.

lot_size_sqft (integer)

The size of the lot in square feet.

master_update_time (string)

The date the property's information was last updated (YYYY-MM-DD).

max_floor_plate (number)

Maximum leasable square footage for an individual floor.

mcd_name (string)

The legally defined county subdivision (minor civil division) where the property is located. This may be reported as the municipality.

mode (string)

The street type, found to the right of the street name (DR, AVE, etc.).

mortgages (array)

Mortgage data for this property.

active_loan (boolean)

true if this mortgage is actively encumbering the property, null otherwise. null for all mortgages outside of NYC.

actual_balance (number)

Outstanding actual balance of the loan as of the determination date. This figure represents the legal remaining outstanding principal balance related to the borrower's mortgage note.

actual_balance_date (string)

The determination date of the outstanding actual balance.

arm_gross_margin (number)

A variable rate loan's gross margin: net margin plus servicing fees.

arm_index (string)

The index on which a variable rate loan is based.

book_page (string)

Page of the mortgage document at the local land records registry.

borrower_full_name (string)

The mortgage borrower name.

cash_mortgage_purchase (string)

Yes if this is a cash mortgage purchase; No otherwise.

construction_loan (string)

Yes if this is a construction loan; No otherwise.

crfn_id (string)

The City Register File Number.

document_number (string)

The mortgage document number from the local land records registry.

document_type (string)

The document type (AGREEMENT OF SALE, GRANT DEED, etc.).

due_date (string)

The mortgage maturity date (YYYY-MM-DD).

executed_date (string)

The date the mortgage was executed.

foreclosure (string)

Y if the property is foreclosed; N otherwise.

is_balloon (string)

The type of loan terms: full amortizing (Amort), interest only, non-extendable (Non-Amort), lump-sum payment of principal at maturity (Balloon).

is_cmbs_loan (boolean)

Indicates if the document is a CMBS loan.

lender_entity_type (string)

The lender type (business entity or person).

lender_name (string)

The mortgage lender name.

mortgage_amount (number)

The mortgage principal amount at time of origination.

mortgage_id (string)

The mortgage ID from the local land records.

mortgage_interest_rate_type (string)

The interest rate type (FIXED, FHA, etc.).

mortgage_type (string)

The type of mortgage.

note_holder (array)

The most recent company or private party to own the loan on the property. This may or may not be the bank that originated the loan.

original_ltv (number)

The property's Loan-To-Value ratio at loan origination, calculated by dividing the original loan balance by the property value at loan origination. Zero represents unavailable data.

other_properties (array)

List of other properties secured by the same mortgage.

formatted_apn (string)

The APN of the other property in the sale. Assessor's Parcel Number or Parcel Identification Number. An arbitrary parcel identifier assigned by the county Assessor to simplify identification and expedite the locating of parcels.

parcel_id (string)

Reonomy ID of the other property in the sale.

other_properties_count (integer)

The total number of properties in this mortgage.

paid (string)

The PAID flag that identifies a loan that has paid down.

paid_through (string)

The date of the loan's scheduled principal and interest is paid through as of the determination date.

payoff_date (string)

If the loan has paid down, the date of the actual final payment.

paystatus_current_status_60 (string)

Paystatus of the loan over the past 60 months. Values are Always performing, Re-performing, or Non-performing, where a loan is performing if it is 60 days or less delinquent.

paystatus_worst_60 (string)

Worst delinquency status over the past 60 months

prep_penalty (number)

Pursuant to the loan documents, an amount received from a borrower during the collection period in exchange for allowing a borrower to pay off a loan prior to the maturity or anticipated repayment date.

rate (string)

Interest rate of the mortgage.

recording_date (string)

Date the mortgage document was recorded with the local land records registry (YYYY-MM-DD).

refi_flag (string)

Yes if this mortgage is a refinance; null if not or unknown.

seller_carry_back (string)

Yes if this is a seller carry back mortgage where the seller loans the buyer a portion of the sales price and retains a percentage ownership; No otherwise.

signatory1 (string)

Name of signatory 1.

signatory1_title (string)

Job title of signatory 1.

signatory2 (string)

Name of signatory 2.

signatory2_title (string)

Job title of signatory 2.

source_doc (string)

The direct link to ACRIS for a given mortgage document.

status (string)

CMSA loan status codes populated in the following order of priority (top priority listed first): 6 - 121+ Days Delinquent; 5 - Non Performing Matured Balloon; 4 - Performing Matured Balloon; 3 - 90+ Days Delinquent; 2 - 60-89 Days Delinquent; 1 - 30-59 Days Delinquent; 0 - Current; B - Late Payment But Less Than 30 days Delinquent; A - Payment Not Received But Still In Grace Period or Not Yet Due

term_months (integer)

The mortgage term length (in months).

transaction_type (string)

The transaction type (Arms Length, REFINANCE, etc.).

uw_appraisal_value (number)

The valuation amount of the property as of the Valuation Date at Contribution.

uw_appraisal_value_date (string)

The date the Valuation Amount at Contribution was determined.

watch_comment (string)

The comments regarding the asset's watch list status as reported by the trustee.

watch_comment_date (string)

The determination date of the Watch List Report Comment.

watchlist_end_date (string)

Date Removed from Watchlist ( only applicable if AI_WATCHLIST_DATE_START is populated )

watchlist_start_date (string)

Date Added to Watchlist

watchlist_translation (string)

Translation of On the Watchlist field

most_recent_dscr (number)

A ratio of net operating income (NOI) to debt service for the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_dscr_date (string)

The determination date of the Most Recent DSCR.

most_recent_end_date (string)

The last day of the period for the most recent, hard copy operating statement (e.g. year to date or trailing 12 months) after the preceding fiscal year end statement.

most_recent_ncf (number)

The total revenues less total operating expenses and capital items but before debt service per the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_ncf_date (string)

The determination date of the Most Recent NCF.

most_recent_noi (number)

The total revenues less total operating expenses before capital items and debt service per the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_noi_date (string)

The determination date of the Most Recent NOI.

most_recent_occupancy_pct (number)

The percentage of rentable space occupied as of the most recent fiscal year end operating statement available.

most_recent_occupancy_pct_date (string)

The determination date of the Occupancy Percent

most_recent_operating_expenses (number)

The total operating expenses for the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement. Included are real estate taxes, insurance, management fees, utilities, repairs and maintenance. Excluded are capital expenditures, tenant improvements, and leasing commissions.

most_recent_operating_expenses_date (string)

The determination date of the Most Recent Operating Expenses.

most_recent_revenue (number)

The total revenues for the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_revenue_date (string)

The determination date of the Most Recent Revenue.

msa_name (string)

The metropolitan statistical areas (MSAs) where the property is located.

mtg_update_time (string)

The date the property's mortage information was last updated (YYYY-MM-DD).

municipality (string)

The name of the municipality where the property is located. This may be reported as the mcd_name attribute.

neighborhood_name (string)

The neighborhood where the property is located.

office_usable_area (number)

The square footage associated with the office component of the property.

opp_zone (boolean)

True if the property is located within an opportunity zone.

other_usable_area (number)

The square footage associated with any components of the property not classified as office, garage, storage, factory, retail, or residential.

owner_names_count (integer)

The number of contacts associated with the property.

owner_update_time (string)

The date the property's ownership information was last updated (YYYY-MM-DD).

ownership (object)

Information indicating whether contact information exists for this property. To obtain the contact information, use the ownership detail type.

green_matches_count (integer)

The number of known people and companies who are likely property owners.

grey_matches_count (integer)

The number of known people and companies with connections to the property.

has_green_addresses (boolean)

true if Reonomy can provide a mailing address for the likely property owner.

has_green_emails (boolean)

true if Reonomy can provide an email address for the likely property owner.

has_green_phones (boolean)

true if Reonomy can provide a phone number for the likely property owner.

has_grey_addresses (boolean)

true if Reonomy can provide a mailing address for a person or company connected to the property.

has_grey_emails (boolean)

true if Reonomy can provide an email address for a person or company connected to the property.

has_grey_phones (boolean)

true if Reonomy can provide a phone number for a person or company connected to the property.

id (string)

p2_dscr (number)

A ratio of net operating income (NOI) to debt service for the first consecutive year end prior to the preceding fiscal year end statement as reported by the servicer.

p2_dscr_date (string)

The determination date of the Second Preceding FY DSCR calculated with NOI.

p2_fin_date (string)

The determination date of the financial operating statement as of the first consecutive year end prior to the preceding fiscal year end.

p2_ncf (number)

The total revenues less total operating expenses and capital items normalized, and annualized as applicable, but before debt service for the first consecutive year end prior to the preceding fiscal year end statement.

p2_ncf_date (string)

The determination date of the Second Preceding FY NCF.

p2_noi (number)

The total revenues less total operating expenses normalized, and annualized as applicable, before capital items and debt service for the first consecutive year end prior to the preceding fiscal year end statement.

p2_noi_date (string)

The determination date of the Second Preceding FY NOI.

p2_occupancy_pct (number)

The percentage of rentable space occupied as of the first consecutive year end prior to the preceding fiscal year end.

p2_occupancy_pct_date (string)

The determination date of the Second Preceding FY Occupancy percent

p2_operating_expenses (number)

The total operating expenses normalized, and annualized as applicable, for the first consecutive year end prior to the preceding fiscal year end statement. Included are real estate taxes, insurance, management fees, utilities, and repairs and maintenance. Excluded are capital expenditures, tenant improvements, and leasing commissions.

p2_operating_expenses_date (string)

The determination date of the Second Preceding FY Operating Expenses.

p2_revenue (number)

Total revenues normalized, and annualized as applicable, for the first consecutive year end prior to the preceding fiscal year end statement.

p2_revenue_date (string)

The determination date of the Second Preceding FY Revenue.

parcel_shape_ids (array)

One or more numeric strings that identify shape files with parcel geometry and metadata for the property. Use POST /v2/search/property-shapes to retrieve the shape file for a given parcel ID.

property_id (string)

records (object)

Information that can be used to pull building records from the NYC Department of Buildings using the building's BIN number (Building Identification Number).

bins (array)

One or more New York City building identification numbers associated with the property.

block_id (string)

A city block ID.

borough_id (integer)

The New York City borough ID (1: Manhattan, 2: Bronx, 3: Brooklyn, 4: Queens, 5: Staten Island).

lot_id (integer)

The New York City lot ID.

rent_history (array)

The number of units that are stabilized or regulated by year.

units (integer)

The number of units regulated in a given year.

year (integer)

Corresponding year of count of regulated units.

rent_regulation (object)

Rent regulation details (see Rent regulated definitions for additional information).

a_units (integer)

Count of units that include a kitchen and bathroom.

b_units (integer)

Count of units that do not include a kitchen and bathroom.

closed_litigation (integer)

Prior litigation.

outstanding_litigation (integer)

Open litigation.

registration_date (string)

Date that the property was registered with NYC Department of Housing Preservation and Developments.

registration_expiration (string)

Date that the property's registration with the NYC Department of Housing Preservation and Developments expires.

regulated_units (integer)

The total number of rent regulated units in the building (a_units + b_units).

status_1 (string)

The building status. See Rent regulated definitions for details.

status_2 (string)

Additional building status. See Rent regulated definitions for details.

status_3 (string)

Additional building status. See Rent regulated definitions for details.

reported_owner_address_line1 (string)

The first line of the property address. This field is a concatenation of house_nbr, direction_left, street, mode, direction_right, unit_type, and unit_number.

reported_owner_city (string)

The city name.

reported_owner_direction_left (string)

The address direction to the left of the street name.

reported_owner_direction_right (string)

The address direction to the right of the street name.

reported_owner_house_number (string)

The building number portion of the street address.

reported_owner_id (string)

reported_owner_mode (string)

The street type, found to the right of the street name (DR, AVE, etc.).

reported_owner_owner_instate (boolean)

true if the owner lives in the state where the property is located; false otherwise.

reported_owner_owner_occupied (boolean)

true if the owner lives in the state where the property is located; false otherwise.

reported_owner_state (string)

The 2-letter state abbreviation.

reported_owner_street (string)

The street name.

reported_owner_unit_number (string)

The unit number.

reported_owner_unit_type (string)

The unit type.

reported_owner_zip_code (string)

The zip code.

reported_owner_zip_code4 (string)

The "plus 4" zip code extension.

reported_owners (array)

Information about the reported owners of this property.

entity_type (string)

Specifies whether the reported owner is a "person" or "business entity".

name (string)

The name of the reported owner of the property.

residential_units (integer)

The total number of residential units across all structures on the tax lot.

residential_usable_area (number)

The square footage associated with the residential component of the property.

retail_usable_area (number)

The square footage associated with the retail component of the property.

sale_update_time (string)

The date the property's sale information was last updated (YYYY-MM-DD).

sales (array)

Sales data for the given property.

acris_id (string)

The property's Automated City Register Information System (ACRIS) ID.

book_page (string)

Page of the sale document at the local land records registry.

buyers (array)

List of buyers of record (from the deed).

buyers_formatted (array)

List of buyers of record (from the deed).

name (string)

The full name of the person or company.

type (string)

The entity type (for example, business entity or person).

cash_mortgage_purchase (string)

Yes if a cash mortgage purchase; No otherwise.

document_number (string)

Sales document number from local land records registry associated with the deed.

document_type (string)

The sale document type (Agreement of Sale, Deed, etc.).

foreclosed (boolean)

true if this is a foreclosure sale; false otherwise.

multi_properties_sale_flag (boolean)

true if this sale includes other properties; false otherwise.

other_properties (array)

List of other properties conveyed in same deed.

formatted_apn (string)

The Assessor's Parcel Number or Parcel Identification Number of the other property.

parcel_id (string)

The Reonomy ID of the other property.

other_properties_count (integer)

Sales data for the given property.

per_residential_unit (number)

The total sale amount divided by the number of residential units. For multi-property transactions, the building area is totaled across all the properties.

percent_transferred (number)

Percent of ownership interest conveyed from seller to buyer stated in the deed.

price_per_building_area (number)

Price per square foot of the building area. For multi-property transactions, the building area is totaled across all the properties.

recording_date (string)

Date the document was recorded with the local land records registry (YYYY-MM-DD).

sale_amount (number)

The sale amount stated in the deed.

sale_date (string)

Date the transaction was executed per the deed (YYYY-MM-DD).

sales_id (string)

The Reonomy ID of this sale record.

sellers (array)

List of the sellers of record (from the deed).

sellers_formatted (array)

List of the sellers of record (from the deed).

name (string)

The full name of the person or company.

type (string)

The entity type (for example, business entity or person).

sf_of_building_area (number)

Square footage of the building.

sf_of_lot_area (number)

Square footage of the lot.

transaction_type (string)

The transaction type (Arms Length, Refinance, etc.).

sanborn_map_number (string)

The Sanborn fire insurance map number.

sf_of_building_area (number)

The total square footage of all structures on the tax lot. This field is not used. Please use sum_building_sqft to obtain the total square footage of all structures on the tax lot.

shape_update_time (string)

The date the property's shape information was last updated (YYYY-MM-DD).

special_purpose_district (string)

The name of the special purpose district where the property is located (if applicable).

split_boundary (boolean)

True if the lot is located in two or more zoning districts and divided by a zoning district boundary.

state (string)

The 2-letter state abbreviation.

std_land_use_code (string)

The lot use code associated with the asset type.

std_land_use_code_description (string)

The asset type. See asset_category for the broader asset category.

storage_usable_area (number)

The square footage associated with the storage component of the property.

street (string)

The street name (without the mode and direction attributes).

subway_entrances_and_distances (array)

Information about nearest subway entrances and their distances from the property.

distance (number)

lines (array)

sum_building_sqft (number)

The total square footage of all structures on the tax lot.

sum_buildings_nbr (integer)

Number of buildings on the lot.

tax_update_time (string)

The date the property's tax information was last updated (YYYY-MM-DD).

taxes (array)

Tax data for this property.

amount (number)

Property taxes owed for the specified assessment year.

assessed_improvement_value (number)

The assessed improvement value provided by the county or local taxing/assessment authority for the specified assessment year.

assessed_land_value (number)

The assessed land value provided by the county or local taxing/assessment authority for the specified assessment year.

assessment_roll_link (string)

URL for the assessment roll.

billable_assessed_value (number)

The total assessed value minus exemptions.

exemptions_and_abatements (number)

The total tax amount reduction due to exemptions (these reduce the property's assessed value) and abatements (these are applied after tax calculation to reduce the tax bill).

gross_tax_amount (number)

The tax amount for a property before exemptions and abatements

gross_tax_rate (number)

The tax rate for a property before factoring in exemptions and abatements

improvement_market_value (number)

The market improvement value as provided by the county or local taxing/assessment authority for the specified assessment year.

land_market_value (number)

The market land value as provided by the county or local taxing/assessment authority for the specified assessment year.

tax_bill (number)

The total property tax bill for the specified assessment year.

tax_bill_link (string)

URL for the latest tax bill.

tax_change_percentage (number)

The percentage change in the total tax bill from the previous year.

tax_rate (number)

The net tax rate on a property, calculated as tax amount less exemptions and abatenments divided by assessed value.

total_assessed_value (number)

The total assessed value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the specified assessment year.

total_market_value (number)

The total market value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the specified assessment year.

transitional_assessed_value (number)

The transitional assessed value reflecting changes being phased in over 5 years.

transitional_exemption_value (number)

The transitional exemption value reflecting changes being phased in over 5 years.

year (integer)

The year for which this tax record applies.

tenants (array)

A list of known occupants at this property.

business_name (string)

Name of the occupant.

ceo_full_name (string)

The name of the CEO for the given occupant.

ceo_title (string)

The CEO's title.

city (string)

The occupant location's city.

contacts (array)

city (string)

The contact's city.

country_code (string)

The contact's country code.

email (string)

The contact's email address.

first_name (string)

The contact's first name.

job_title (string)

The contact's job title.

last_name (string)

The contact's last name.

primary_phone (string)

The contact's primary phone number.

secondary_phone (string)

The contact's secondary phone number.

state (string)

The contact's 2-letter state abbreviation.

street (string)

The contact's street address.

zip_code (string)

The contact's 5-digit zip code.

duns (string)

A nine-digit number assigned by Dun & Bradstreet to identify unique business establishments.

employee_total (integer)

Estimated number of employees.

mailing_city (string)

The occupant's mailing city.

mailing_state (string)

The occupant's mailing state.

mailing_street_address (string)

The occupant's mailing address.

mailing_zip_code (string)

The occupant's mailing 5 digit zip code.

mailing_zip_code4 (string)

The occupant's mailing "plus 4" zip code extension.

naics (string)

The occupant's primary North American Industry Classification System (NAICS) code.

naics2 (string)

The occupant's secondary North American Industry Classification System (NAICS) code.

naics2_description (string)

The occupant's secondary North American Industry Classification System (NAICS) code description.

naics_description (string)

The occupant's primary North American Industry Classification System (NAICS) code description.

sales_volume (integer)

The occupant's sales volume.

sic (string)

The occupant's primary Standard Industrial Classification (SIC) code.

sic2 (string)

The occupants's secondary Standard Industrial Classification (SIC) code.

sic2_description (string)

The occupant's secondary Standard Industrial Classification (SIC) code description.

sic_description (string)

The occupant's primary Standard Industrial Classification (SIC) code description.

state (string)

The occupant location's state.

street_address (string)

The occupant location's street address.

telephone_number (string)

The phone number associated with the occupant.

tradestyle_name (string)

The occupant's "Doing Business As" (DBA) name.

type_of_location (string)

The location type (Single Location or Branch).

website (string)

The occupant's website URL.

year_started (integer)

The year the business was founded.

zip_code (string)

The occupant location's 5 digit zip code.

zip_code4 (string)

The occupant location's "plus 4" zip code extension.

total_units (integer)

Total number of units across all structures on tax lot.

year_built (integer)

The year the building was originally constructed.

year_renovated (integer)

The year the building was last renovated.

zip4 (string)

The "plus 4" zip code extension.

zip5 (string)

The 5-digit zip code.

zoning (string)

The zoning district in which the property is located.

zoning_district_1 (string)

The parcel's primary zoning district.

zoning_district_1_far_mapping (array)

Allowable floor area ratio (FAR) within the primary zoning district for each applicable far_category_id.

far_category_id (integer)

1: Residential, 2: Community Facility, 3: Commercial, 4: Commercial, 5: Manufacturing, 6: With Attic.

high_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

is_commercial_overlay (boolean)

true if the parcel is within a commercial overlay district.

low_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

subdistrict_code (string)

The parcel's primary (or secondary) zoning district.

zoning_district_2 (string)

The parcel's secondary zoning district.

zoning_district_2_far_mapping (array)

Allowable floor area ratio (FAR) within the secondary zoning district for each applicable far_category_id.

far_category_id (integer)

1: Residential, 2: Community Facility, 3: Commercial, 4: Commercial, 5: Manufacturing, 6: With Attic.

high_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

is_commercial_overlay (boolean)

true if the parcel is within a commercial overlay district.

low_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

subdistrict_code (string)

The parcel's primary (or secondary) zoning district.

zoning_map_number (string)

The number of the zoning map for the property.

 

get /v2/property/{property_id}

/​v2/​property/​{property_id}

Returns information about the specified property. See the response definition below for information about exactly what is returned.

See Searching for properties for information about locating property IDs for specific properties based on filter criteria or property location.

Rate limiting

Requests to this endpoint are rate limited. See Getting property details for more information.

Parameters

Parameters

Path parameters

property_id (string)

The property's Reonomy ID (its 8-4-4-4-12 format unique identifier).

Query parameters

detail_type (string)

The property detail type (optional). By default, the response includes "basic" property data. Use this parameter to obtain a different detail type. Valid detail types are basic, mortgages, ownership, reported-owners, sales, taxes, and tenants.

Note: You can specify multiple instances of this parameter in the query string. For occupant information, use tenants.

filter_pii (boolean)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII for each property detail type, see the Data dictionary.

Response

200

active (boolean)

True if the property record is active.

address_line1 (string)

The first line of the property address. This field is a concatenation of house_nbr, direction_left, street, mode, and direction_right.

alternative_addresses (array)

Alternative addresses for properties in NYC.

address_line1 (string)

city (string)

direction_left (string)

direction_right (string)

house_nbr (string)

mode (string)

state (string)

street (string)

zip5 (string)

apn (string)

Assessor's Parcel Number (APN) in formatted form, typically using dashes and periods to split the APN into logical components (for example, 101-32-021.A).

asset_category (string)

The asset category (Office, Retail, etc.). See std_land_use_code_description for the more detailed asset type.

bins (array)

One or more New York City building identification numbers associated with the property.

block_id (string)

A city block ID.

borough_id (integer)

The New York City borough ID (1: Manhattan, 2: Bronx, 3: Brooklyn, 4: Queens, 5: Staten Island).

building_area (number)

The total square footage of all structures on the tax lot.

building_class (string)

One or more building class codes.

building_update_time (string)

The date the property's building information was last updated (YYYY-MM-DD).

census_tract (string)

A concatentation of the 2-digit state code, the 3-digit county code, the 6-digit census tract code, and a 3- or 4-digit census block code.

city (string)

The city where the property is located.

commercial_overlay_1 (string)

A commercial overlay code.

commercial_overlay_2 (string)

A commercial overlay code.

commercial_units (integer)

The number of commercial units across all structures on the tax lot.

commercial_usable_area (number)

The square footage associated with all commercial components of the property.

contacts (array)

Contact data for this property.

company (object)

Information about the company.

addresses (array)

One or more mailing addresses associated with the company.

city (string)

The city name.

country_code (string)

The country code.

display (string)

The full address.

line1 (string)

The building number and street name.

line2 (string)

The floor, suite, or apartment number.

po_box (string)

The post office box number.

postal_code (string)

The zip code.

state_code (string)

The 2-letter state abbreviation.

type (string)

The address type.

unit (string)

The address unit number.

dba_name (string)

The company's DBA ("doing business as") name.

emails (array)

One or more email addresses (4 maximum) associated with the company.

address (string)

The email address.

employees_total (integer)

Number of employees at the company.

id (string)

The unique Reonomy identifier associated with this company.

location_type (string)

Single location, headquarters, or branch.

match_score (integer)

The confidence that this is a true match.

name (string)

The company name.

parent_id (string)

The unique Reonomy ID associated with the parent company.

phones (array)

One or more phone numbers (4 maximum) associated with the company.

country_code (string)

The country code.

extensions (string)

The internal extension number.

number (string)

The phone number (unformatted), including area code.

type (string)

The phone type (residential, etc.).

sales_volume (integer)

Annual sales volume (in thousand dollars).

state_code (string)

The 2-letter state abbreviation.

type (string)

urls (array)

One or more website URLs associated with the company.

type (string)

URL type.

url (string)

URL for this entity.

year_founded (integer)

The year the company was founded.

contact_type (string)

Whether this contact is a company or an individual.

is_green_match (boolean)

True if there's a high probability this company or individual is an owner of the property.

is_signatory (boolean)

True if this contact is the signatory on the mortgage.

match_score (integer)

Indicates the confidence that this company or individual is the true owner.

persons (array)

For contact_type: "individual", this provides the person's name and contact information. For contact_type: "company", this provides the name and contact information for each known person associated with the company.

addresses (array)

One or more mailing addresses associated with the person.

city (string)

The city name.

country_code (string)

The country code.

display (string)

The full address.

line1 (string)

The building number and street name.

line2 (string)

The floor, suite, or apartment number.

po_box (string)

The post office box number.

postal_code (string)

The zip code.

state_code (string)

The 2-letter state abbreviation.

type (string)

The address type.

unit (string)

The address unit number.

display (string)

The person's full name.

emails (array)

One or more email addresses (4 maximum) associated with the person.

address (string)

The email address.

first_name (string)

The person's first name.

id (string)

The unique Reonomy identifier associated with this person.

jobs (array)

One or more job titles associated with the person.

is_company_owner (boolean)

Is person a company owner

organization (string)

The organization name.

title (string)

The job title.

type (string)

The job type.

last_name (string)

The person's last name.

match_score (integer)

The confidence that this is a true match.

name (string)

The person's full name.

phones (array)

One or more phone numbers (4 maximum) associated with the person.

country_code (string)

The country code.

extensions (string)

The internal extension number.

number (string)

The phone number (unformatted), including area code.

type (string)

The phone type (residential, etc.).

urls (array)

One or more website URLs associated with the person.

type (string)

URL type.

url (string)

URL for this entity.

deprecation_date (string)

The date the property record became inactive.

depth (number)

The depth of the lot (front to back) in feet. For non-NYC properties, this is reported as the lot_size_depth_feet.

direction_left (string)

The address direction to the left of the street name.

direction_right (string)

The address direction to the right of the street name.

existing_far (number)

The floor area ratio (the total building area divided by the lot area) provided by NYC records.

existing_floor_area_ratio (number)

The floor area ratio (the total building area divided by the lot area) provided by the property's most recent sale document.

existing_square_footage (number)

Actual square footage of the property. This can be used to calculate if the property has been overbuilt based on the zoning district and FAR. The formula is as follows: lot area * FAR - Existing SF = Indicative SF.

factory_usable_area (number)

The square footage associated with the factory component of the property.

financials (array)

Financial information.

gross (number)

Gross revenue earned through the operation of the property.

noi (number)

Net operating income provided by the Department of Finance.

opex (number)

Estimate of operating expenses, not including the tax amount, from the Department of Finance.

re_taxes (number)

Real estate taxes, from the Department of Finance.

total_opex (number)

Estimate of operating expenses, including the tax amount, from the Department of Finance.

year (integer)

Year of financials reported.

fips (string)

The 5-digit FIPS code of the county where the property is located.

fips_county (string)

The name of the county associated with the FIPS code where the property is located.

first_owner_name (string)

The first contact name associated with the property.

floors (integer)

Number of floors in the building.

foreclosure (object)

active (boolean)

true foreclosure proceedings are actively ongoing.

auction_date (string)

The foreclosure auction date.

auction_time (string)

The foreclosure aution time.

city_of_auction_call (string)

The city where the auction is occurring.

deed_category (string)

The foreclosure deed category code (see Foreclosure deed categories for a full list).

deed_category_text (string)

The foreclosure deed category name (see Foreclosure deed categories for a full list).

document_type (string)

The foreclosure document type code code (see Foreclosure document types for a full list).

document_type_text (string)

The foreclosure document type name (see Foreclosure document types for a full list).

document_year (integer)

Year the document relating to the pre-foreclosure proceedings was recorded.

final_judgement_amount (string)

The total amount owed in the foreclosure.

first_defendant_borrower_owner_company_name (string)

The borrower company in the pre-foreclosure proceedings.

first_defendant_borrower_owner_first_name (string)

The borrower first name in the pre-foreclosure proceedings.

first_defendant_borrower_owner_last_name (string)

The borrower last name in the pre-foreclosure proceedings.

original_loan_date (string)

The origination date of the initial loan.

original_loan_recording_date (string)

The recording date of the initial loan.

plaintiff_1 (string)

The plaintiff (lender) in the pre-foreclosure proceedings.

recording_date (string)

The date the document relating to the pre-foreclosure proceedings was recorded.

source_date (string)

The date the foreclosure information was pulled from the source document.

state_of_auction_call (string)

2-letter state abbreviation of the state where the auction is occurring.

street_address_of_auction_call (string)

The street address where the auction is occurring.

trustee_city (string)

The city where the trustee is registered.

trustee_mailing_address (string)

The trustee's mailing address.

trustee_name (string)

The trustee's name.

trustee_phone (string)

The trustee's phone number.

trustee_state (string)

2-letter abbreviation of the state where the trustee is registered.

trustee_zip (string)

The trustee's zip code.

use_code (string)

The parcel's asset or lot use code (see Asset types for a full list).

frontage (number)

Linear feet across the front of the lot. This may be reported as the lot_size_frontage_feet attribute.

garage_usable_area (number)

The square footage associated with the garage component of the property.

has_cmbs (boolean)

True if the property has CMBS information.

historic_district (string)

NYC properties within historic districts only: The name of the historic district.

house_nbr (string)

The building number portion of the street address.

landmark (string)

NYC properties with designated landmark status only: The landmark name.

legal_description (string)

Legal location description of the property.

likely_to_sell (string)

An indicator that identifies which properties are most likely to sell. Read more about Likely to Sell here.

location (object)

The latitude and longitude of the point at the center of the parcel.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

lot_id (integer)

The New York City lot ID.

lot_size_acres (number)

The size of the lot in acres.

lot_size_depth_feet (integer)

The depth of the lot (front to back) in feet. This may be reported as the depth attribute.

lot_size_frontage_feet (number)

Linear feet across the front of the lot. This may be reported as the frontage attribute.

lot_size_sqft (integer)

The size of the lot in square feet.

master_update_time (string)

The date the property's information was last updated (YYYY-MM-DD).

max_floor_plate (number)

Maximum leasable square footage for an individual floor.

mcd_name (string)

The legally defined county subdivision (minor civil division) where the property is located. This may be reported as the municipality.

mode (string)

The street type, found to the right of the street name (DR, AVE, etc.).

mortgages (array)

Mortgage data for this property.

active_loan (boolean)

true if this mortgage is actively encumbering the property, null otherwise. null for all mortgages outside of NYC.

actual_balance (number)

Outstanding actual balance of the loan as of the determination date. This figure represents the legal remaining outstanding principal balance related to the borrower's mortgage note.

actual_balance_date (string)

The determination date of the outstanding actual balance.

arm_gross_margin (number)

A variable rate loan's gross margin: net margin plus servicing fees.

arm_index (string)

The index on which a variable rate loan is based.

book_page (string)

Page of the mortgage document at the local land records registry.

borrower_full_name (string)

The mortgage borrower name.

cash_mortgage_purchase (string)

Yes if this is a cash mortgage purchase; No otherwise.

construction_loan (string)

Yes if this is a construction loan; No otherwise.

crfn_id (string)

The City Register File Number.

document_number (string)

The mortgage document number from the local land records registry.

document_type (string)

The document type (AGREEMENT OF SALE, GRANT DEED, etc.).

due_date (string)

The mortgage maturity date (YYYY-MM-DD).

executed_date (string)

The date the mortgage was executed.

foreclosure (string)

Y if the property is foreclosed; N otherwise.

is_balloon (string)

The type of loan terms: full amortizing (Amort), interest only, non-extendable (Non-Amort), lump-sum payment of principal at maturity (Balloon).

is_cmbs_loan (boolean)

Indicates if the document is a CMBS loan.

lender_entity_type (string)

The lender type (business entity or person).

lender_name (string)

The mortgage lender name.

mortgage_amount (number)

The mortgage principal amount at time of origination.

mortgage_id (string)

The mortgage ID from the local land records.

mortgage_interest_rate_type (string)

The interest rate type (FIXED, FHA, etc.).

mortgage_type (string)

The type of mortgage.

note_holder (array)

The most recent company or private party to own the loan on the property. This may or may not be the bank that originated the loan.

original_ltv (number)

The property's Loan-To-Value ratio at loan origination, calculated by dividing the original loan balance by the property value at loan origination. Zero represents unavailable data.

other_properties (array)

List of other properties secured by the same mortgage.

formatted_apn (string)

The APN of the other property in the sale. Assessor's Parcel Number or Parcel Identification Number. An arbitrary parcel identifier assigned by the county Assessor to simplify identification and expedite the locating of parcels.

parcel_id (string)

Reonomy ID of the other property in the sale.

other_properties_count (integer)

The total number of properties in this mortgage.

paid (string)

The PAID flag that identifies a loan that has paid down.

paid_through (string)

The date of the loan's scheduled principal and interest is paid through as of the determination date.

payoff_date (string)

If the loan has paid down, the date of the actual final payment.

paystatus_current_status_60 (string)

Paystatus of the loan over the past 60 months. Values are Always performing, Re-performing, or Non-performing, where a loan is performing if it is 60 days or less delinquent.

paystatus_worst_60 (string)

Worst delinquency status over the past 60 months

prep_penalty (number)

Pursuant to the loan documents, an amount received from a borrower during the collection period in exchange for allowing a borrower to pay off a loan prior to the maturity or anticipated repayment date.

rate (string)

Interest rate of the mortgage.

recording_date (string)

Date the mortgage document was recorded with the local land records registry (YYYY-MM-DD).

refi_flag (string)

Yes if this mortgage is a refinance; null if not or unknown.

seller_carry_back (string)

Yes if this is a seller carry back mortgage where the seller loans the buyer a portion of the sales price and retains a percentage ownership; No otherwise.

signatory1 (string)

Name of signatory 1.

signatory1_title (string)

Job title of signatory 1.

signatory2 (string)

Name of signatory 2.

signatory2_title (string)

Job title of signatory 2.

source_doc (string)

The direct link to ACRIS for a given mortgage document.

status (string)

CMSA loan status codes populated in the following order of priority (top priority listed first): 6 - 121+ Days Delinquent; 5 - Non Performing Matured Balloon; 4 - Performing Matured Balloon; 3 - 90+ Days Delinquent; 2 - 60-89 Days Delinquent; 1 - 30-59 Days Delinquent; 0 - Current; B - Late Payment But Less Than 30 days Delinquent; A - Payment Not Received But Still In Grace Period or Not Yet Due

term_months (integer)

The mortgage term length (in months).

transaction_type (string)

The transaction type (Arms Length, REFINANCE, etc.).

uw_appraisal_value (number)

The valuation amount of the property as of the Valuation Date at Contribution.

uw_appraisal_value_date (string)

The date the Valuation Amount at Contribution was determined.

watch_comment (string)

The comments regarding the asset's watch list status as reported by the trustee.

watch_comment_date (string)

The determination date of the Watch List Report Comment.

watchlist_end_date (string)

Date Removed from Watchlist ( only applicable if AI_WATCHLIST_DATE_START is populated )

watchlist_start_date (string)

Date Added to Watchlist

watchlist_translation (string)

Translation of On the Watchlist field

most_recent_dscr (number)

A ratio of net operating income (NOI) to debt service for the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_dscr_date (string)

The determination date of the Most Recent DSCR.

most_recent_end_date (string)

The last day of the period for the most recent, hard copy operating statement (e.g. year to date or trailing 12 months) after the preceding fiscal year end statement.

most_recent_ncf (number)

The total revenues less total operating expenses and capital items but before debt service per the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_ncf_date (string)

The determination date of the Most Recent NCF.

most_recent_noi (number)

The total revenues less total operating expenses before capital items and debt service per the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_noi_date (string)

The determination date of the Most Recent NOI.

most_recent_occupancy_pct (number)

The percentage of rentable space occupied as of the most recent fiscal year end operating statement available.

most_recent_occupancy_pct_date (string)

The determination date of the Occupancy Percent

most_recent_operating_expenses (number)

The total operating expenses for the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement. Included are real estate taxes, insurance, management fees, utilities, repairs and maintenance. Excluded are capital expenditures, tenant improvements, and leasing commissions.

most_recent_operating_expenses_date (string)

The determination date of the Most Recent Operating Expenses.

most_recent_revenue (number)

The total revenues for the most recent operating statement reported by the servicer (e.g. year to date, year to date annualized, or trailing 12 months, but all normalized) after the preceding fiscal year end statement.

most_recent_revenue_date (string)

The determination date of the Most Recent Revenue.

msa_name (string)

The metropolitan statistical areas (MSAs) where the property is located.

mtg_update_time (string)

The date the property's mortage information was last updated (YYYY-MM-DD).

municipality (string)

The name of the municipality where the property is located. This may be reported as the mcd_name attribute.

neighborhood_name (string)

The neighborhood where the property is located.

office_usable_area (number)

The square footage associated with the office component of the property.

opp_zone (boolean)

True if the property is located within an opportunity zone.

other_usable_area (number)

The square footage associated with any components of the property not classified as office, garage, storage, factory, retail, or residential.

owner_names_count (integer)

The total number of contacts associated with this property.

owner_update_time (string)

The date the property's ownership information was last updated (YYYY-MM-DD).

ownership (object)

Information indicating whether contact information exists for this property. To obtain the contact information, use the ownership detail type.

green_matches_count (integer)

The number of known people and companies who are likely property owners.

grey_matches_count (integer)

The number of known people and companies with connections to the property.

has_green_addresses (boolean)

true if Reonomy can provide a mailing address for the likely property owner.

has_green_emails (boolean)

true if Reonomy can provide an email address for the likely property owner.

has_green_phones (boolean)

true if Reonomy can provide a phone number for the likely property owner.

has_grey_addresses (boolean)

true if Reonomy can provide a mailing address for a person or company connected to the property.

has_grey_emails (boolean)

true if Reonomy can provide an email address for a person or company connected to the property.

has_grey_phones (boolean)

true if Reonomy can provide a phone number for a person or company connected to the property.

p2_dscr (number)

A ratio of net operating income (NOI) to debt service for the first consecutive year end prior to the preceding fiscal year end statement as reported by the servicer.

p2_dscr_date (string)

The determination date of the Second Preceding FY DSCR calculated with NOI.

p2_fin_date (string)

The determination date of the financial operating statement as of the first consecutive year end prior to the preceding fiscal year end.

p2_ncf (number)

The total revenues less total operating expenses and capital items normalized, and annualized as applicable, but before debt service for the first consecutive year end prior to the preceding fiscal year end statement.

p2_ncf_date (string)

The determination date of the Second Preceding FY NCF.

p2_noi (number)

The total revenues less total operating expenses normalized, and annualized as applicable, before capital items and debt service for the first consecutive year end prior to the preceding fiscal year end statement.

p2_noi_date (string)

The determination date of the Second Preceding FY NOI.

p2_occupancy_pct (number)

The percentage of rentable space occupied as of the first consecutive year end prior to the preceding fiscal year end.

p2_occupancy_pct_date (string)

The determination date of the Second Preceding FY Occupancy percent

p2_operating_expenses (number)

The total operating expenses normalized, and annualized as applicable, for the first consecutive year end prior to the preceding fiscal year end statement. Included are real estate taxes, insurance, management fees, utilities, and repairs and maintenance. Excluded are capital expenditures, tenant improvements, and leasing commissions.

p2_operating_expenses_date (string)

The determination date of the Second Preceding FY Operating Expenses.

p2_revenue (number)

Total revenues normalized, and annualized as applicable, for the first consecutive year end prior to the preceding fiscal year end statement.

p2_revenue_date (string)

The determination date of the Second Preceding FY Revenue.

parcel_shape_ids (array)

One or more numeric strings that identify shape files with parcel geometry and metadata for the property. Use POST /v2/search/property-shapes to retrieve the shape file for a given parcel ID.

property_id (string)

records (object)

Information that can be used to pull building records from the NYC Department of Buildings using the building's BIN number (Building Identification Number).

bins (array)

One or more New York City building identification numbers associated with the property.

block_id (string)

A city block ID.

borough_id (integer)

The New York City borough ID (1: Manhattan, 2: Bronx, 3: Brooklyn, 4: Queens, 5: Staten Island).

lot_id (integer)

The New York City lot ID.

rent_history (array)

The number of units that are stabilized or regulated by year.

units (integer)

The number of units regulated in a given year.

year (integer)

Corresponding year of count of regulated units.

rent_regulation (object)

Rent regulation details (see Rent regulated definitions for additional information).

a_units (integer)

Count of units that include a kitchen and bathroom.

b_units (integer)

Count of units that do not include a kitchen and bathroom.

closed_litigation (integer)

Prior litigation.

outstanding_litigation (integer)

Open litigation.

registration_date (string)

Date that the property was registered with NYC Department of Housing Preservation and Developments.

registration_expiration (string)

Date that the property's registration with the NYC Department of Housing Preservation and Developments expires.

regulated_units (integer)

The total number of rent regulated units in the building (a_units + b_units).

status_1 (string)

The building status. See Rent regulated definitions for details.

status_2 (string)

Additional building status. See Rent regulated definitions for details.

status_3 (string)

Additional building status. See Rent regulated definitions for details.

reported_owner_address_line1 (string)

The first line of the property address. This field is a concatenation of house_nbr, direction_left, street, mode, direction_right, unit_type, and unit_number.

reported_owner_city (string)

The city name.

reported_owner_direction_left (string)

The address direction to the left of the street name.

reported_owner_direction_right (string)

The address direction to the right of the street name.

reported_owner_house_number (string)

The building number portion of the street address.

reported_owner_id (string)

reported_owner_mode (string)

The street type, found to the right of the street name (DR, AVE, etc.).

reported_owner_owner_instate (boolean)

true if the owner lives in the state where the property is located; false otherwise.

reported_owner_owner_occupied (boolean)

true if the owner lives in the state where the property is located; false otherwise.

reported_owner_state (string)

The 2-letter state abbreviation.

reported_owner_street (string)

The street name.

reported_owner_unit_number (string)

The unit number.

reported_owner_unit_type (string)

The unit type.

reported_owner_zip_code (string)

The zip code.

reported_owner_zip_code4 (string)

The "plus 4" zip code extension.

reported_owners (array)

Information about the reported owners of this property.

entity_type (string)

Specifies whether the reported owner is a "person" or "business entity".

name (string)

The name of the reported owner of the property.

residential_units (integer)

The total number of residential units across all structures on the tax lot.

residential_usable_area (number)

The square footage associated with the residential component of the property.

retail_usable_area (number)

The square footage associated with the retail component of the property.

sale_update_time (string)

The date the property's sale information was last updated (YYYY-MM-DD).

sales (array)

Sales data for the given property.

acris_id (string)

The property's Automated City Register Information System (ACRIS) ID.

book_page (string)

Page of the sale document at the local land records registry.

buyers (array)

List of buyers of record (from the deed).

buyers_formatted (array)

List of buyers of record (from the deed).

name (string)

The full name of the person or company.

type (string)

The entity type (for example, business entity or person).

cash_mortgage_purchase (string)

Yes if a cash mortgage purchase; No otherwise.

document_number (string)

Sales document number from local land records registry associated with the deed.

document_type (string)

The sale document type (Agreement of Sale, Deed, etc.).

foreclosed (boolean)

true if this is a foreclosure sale; false otherwise.

multi_properties_sale_flag (boolean)

true if this sale includes other properties; false otherwise.

other_properties (array)

List of other properties conveyed in same deed.

formatted_apn (string)

The Assessor's Parcel Number or Parcel Identification Number of the other property.

parcel_id (string)

The Reonomy ID of the other property.

other_properties_count (integer)

Sales data for the given property.

per_residential_unit (number)

The total sale amount divided by the number of residential units. For multi-property transactions, the building area is totaled across all the properties.

percent_transferred (number)

Percent of ownership interest conveyed from seller to buyer stated in the deed.

price_per_building_area (number)

Price per square foot of the building area. For multi-property transactions, the building area is totaled across all the properties.

recording_date (string)

Date the document was recorded with the local land records registry (YYYY-MM-DD).

sale_amount (number)

The sale amount stated in the deed.

sale_date (string)

Date the transaction was executed per the deed (YYYY-MM-DD).

sales_id (string)

The Reonomy ID of this sale record.

sellers (array)

List of the sellers of record (from the deed).

sellers_formatted (array)

List of the sellers of record (from the deed).

name (string)

The full name of the person or company.

type (string)

The entity type (for example, business entity or person).

sf_of_building_area (number)

Square footage of the building.

sf_of_lot_area (number)

Square footage of the lot.

transaction_type (string)

The transaction type (Arms Length, Refinance, etc.).

sanborn_map_number (string)

The Sanborn fire insurance map number.

sf_of_building_area (number)

The total square footage of all structures on the tax lot. This field is not used. Please use sum_building_sqft to obtain the total square footage of all structures on the tax lot.

shape_update_time (string)

The date the property's shape information was last updated (YYYY-MM-DD).

special_purpose_district (string)

The name of the special purpose district where the property is located (if applicable).

split_boundary (boolean)

True if the lot is located in two or more zoning districts and divided by a zoning district boundary.

state (string)

The 2-letter state abbreviation.

std_land_use_code (string)

The lot use code associated with the asset type.

std_land_use_code_description (string)

The asset type. See asset_category for the broader asset category.

storage_usable_area (number)

The square footage associated with the storage component of the property.

street (string)

The street name (without the mode and direction attributes).

subway_entrances_and_distances (array)

Information about nearest subway entrances and their distances from the property.

distance (number)

lines (array)

sum_building_sqft (number)

The total square footage of all structures on the tax lot.

sum_buildings_nbr (integer)

Number of buildings on the lot.

tax_update_time (string)

The date the property's tax information was last updated (YYYY-MM-DD).

taxes (array)

Tax data for this property.

amount (number)

Property taxes owed for the specified assessment year.

assessed_improvement_value (number)

The assessed improvement value provided by the county or local taxing/assessment authority for the specified assessment year.

assessed_land_value (number)

The assessed land value provided by the county or local taxing/assessment authority for the specified assessment year.

assessment_roll_link (string)

URL for the assessment roll.

billable_assessed_value (number)

The total assessed value minus exemptions.

exemptions_and_abatements (number)

The total tax amount reduction due to exemptions (these reduce the property's assessed value) and abatements (these are applied after tax calculation to reduce the tax bill).

gross_tax_amount (number)

The tax amount for a property before exemptions and abatements

gross_tax_rate (number)

The tax rate for a property before factoring in exemptions and abatements

improvement_market_value (number)

The market improvement value as provided by the county or local taxing/assessment authority for the specified assessment year.

land_market_value (number)

The market land value as provided by the county or local taxing/assessment authority for the specified assessment year.

tax_bill (number)

The total property tax bill for the specified assessment year.

tax_bill_link (string)

URL for the latest tax bill.

tax_change_percentage (number)

The percentage change in the total tax bill from the previous year.

tax_rate (number)

The net tax rate on a property, calculated as tax amount less exemptions and abatenments divided by assessed value.

total_assessed_value (number)

The total assessed value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the specified assessment year.

total_market_value (number)

The total market value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the specified assessment year.

transitional_assessed_value (number)

The transitional assessed value reflecting changes being phased in over 5 years.

transitional_exemption_value (number)

The transitional exemption value reflecting changes being phased in over 5 years.

year (integer)

The year for which this tax record applies.

tenants (array)

A list of known occupants at this property.

business_name (string)

Name of the occupant.

ceo_full_name (string)

The name of the CEO for the given occupant.

ceo_title (string)

The CEO's title.

city (string)

The occupant location's city.

contacts (array)

List of contacts at the specified tenant business.

city (string)

The contact's city.

country_code (string)

The contact's country code.

email (string)

The contact's email address.

first_name (string)

The contact's first name.

job_title (string)

The contact's job title.

last_name (string)

The contact's last name.

primary_phone (string)

The contact's primary phone number.

secondary_phone (string)

The contact's secondary phone number.

state (string)

The contact's 2-letter state abbreviation.

street (string)

The contact's street address.

zip_code (string)

The contact's 5-digit zip code.

duns (string)

A nine-digit number assigned by Dun & Bradstreet to identify unique business establishments.

employee_total (integer)

Estimated number of employees.

mailing_city (string)

The occupant's mailing city.

mailing_state (string)

The occupant's mailing state.

mailing_street_address (string)

The occupant's mailing address.

mailing_zip_code (string)

The occupant's mailing 5 digit zip code.

mailing_zip_code4 (string)

The occupant's mailing "plus 4" zip code extension.

naics (string)

The occupant's primary North American Industry Classification System (NAICS) code.

naics2 (string)

The occupant's secondary North American Industry Classification System (NAICS) code.

naics2_description (string)

The occupant's secondary North American Industry Classification System (NAICS) code description.

naics_description (string)

The occupant's primary North American Industry Classification System (NAICS) code description.

sales_volume (integer)

The occupant's sales volume.

sic (string)

The occupant's primary Standard Industrial Classification (SIC) code.

sic2 (string)

The occupants's secondary Standard Industrial Classification (SIC) code.

sic2_description (string)

The occupant's secondary Standard Industrial Classification (SIC) code description.

sic_description (string)

The occupant's primary Standard Industrial Classification (SIC) code description.

state (string)

The occupant location's state.

street_address (string)

The occupant location's street address.

telephone_number (string)

The phone number associated with the occupant.

tradestyle_name (string)

The occupant's "Doing Business As" (DBA) name.

type_of_location (string)

The location type (Single Location or Branch).

website (string)

The occupant's website URL.

year_started (integer)

The year the business was founded.

zip_code (string)

The occupant location's 5 digit zip code.

zip_code4 (string)

The occupant location's "plus 4" zip code extension.

total_units (integer)

Total number of units across all structures on tax lot.

year_built (integer)

The year the building was originally constructed.

year_renovated (integer)

The year the building was last renovated.

zip4 (string)

The "plus 4" zip code extension.

zip5 (string)

The 5-digit zip code.

zoning (string)

The zoning district in which the property is located.

zoning_district_1 (string)

The parcel's primary zoning district.

zoning_district_1_far_mapping (array)

Allowable floor area ratio (FAR) within the primary zoning district for each applicable far_category_id.

far_category_id (integer)

1: Residential, 2: Community Facility, 3: Commercial, 4: Commercial, 5: Manufacturing, 6: With Attic.

high_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

is_commercial_overlay (boolean)

true if the parcel is within a commercial overlay district.

low_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

subdistrict_code (string)

The parcel's primary (or secondary) zoning district.

zoning_district_2 (string)

The parcel's secondary zoning district.

zoning_district_2_far_mapping (array)

Allowable floor area ratio (FAR) within the secondary zoning district for each applicable far_category_id.

far_category_id (integer)

1: Residential, 2: Community Facility, 3: Commercial, 4: Commercial, 5: Manufacturing, 6: With Attic.

high_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

is_commercial_overlay (boolean)

true if the parcel is within a commercial overlay district.

low_max_allowable_far (number)

The maximum floor area ratio (FAR) permitted in this zoning district.

subdistrict_code (string)

The parcel's primary (or secondary) zoning district.

zoning_map_number (string)

The number of the zoning map for the property.

 

post /v2/resolve/property

/​v2/​resolve/​property

If you have the address, geolocation, or name of a specific property, you can use the POST /v2/resolve/property endpoint to locate a matching Reonomy property ID.

See the Examples tab below for an example of each search type. For detailed usage information, see Property resolution.

Property resolution credits

Each call to POST /v2/resolve/property uses one property resolution credit. For information on checking credit usage, see API credits.

Rate limiting

Requests to this endpoint are rate limited. See Searching for properties for details.

If you're searching for property IDs for a large number of properties, you can submit a CSV file with property addresses as a batch job. See Match jobs for more information.

Parameters

Parameters

Request body (application/json)

params (object)

Specify an address, a location, or a place.

address (object)

To search by address, you must include at least the line1 and state attributes, plus the city or postal_code.

city (string)

The city name.

line1 (string)

The building number and street name.

line2 (string)

The floor, room, suite, etc.

postal_code (string)

The 5-digit zip code.

state (string)

The 2-letter state abbreviation.

location (object)

To search by location, specify the latitude and longitude.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

place (object)

To search by place, you must include the building name (for example, "name": "Empire State Building").

city (string)

The city name.

name (string)

The place name.

postal_code (string)

The 5-digit zip code.

state (string)

2-letter state abbreviation

street (string)

The street name.

Response

200

assemblage_id (string)

member_ids (array)

params (object)

The params object included in the POST request.

address (object)

The address specified in the POST request.

city (string)

The city name.

line1 (string)

The building number and street name.

line2 (string)

The floor, room, suite, etc.

postal_code (string)

The 5-digit zip code.

state (string)

The 2-letter state abbreviation.

location (object)

The location specified in the POST request.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

place (object)

The place specified in the POST request.

city (string)

The city name.

name (string)

The place name.

postal_code (string)

The 5-digit zip code.

state (string)

2-letter state abbreviation

street (string)

The street name.

primary_address (object)

address_line1 (string)

The first line of the property address. This field is a concatenation of house_nbr, direction_left, street, mode, and direction_right.

city (string)

The city where the property is located.

direction_left (string)

The address direction to the left of the street name.

direction_right (string)

The address direction to the right of the street name.

house_nbr (string)

The building number portion of the street address.

mode (string)

The street type, found to the right of the street name (DR, AVE, etc.).

state (string)

The 2-letter state abbreviation.

street (string)

The street name (without the mode and direction attributes).

zip5 (string)

The 5-digit zip code.

property_id (string)

The property's Reonomy ID (the 8-4-4-4-12 character unique identifier).

secondary_addresses (array)

address_line1 (string)

The first line of the property address. This field is a concatenation of house_nbr, direction_left, street, mode, and direction_right.

city (string)

The city where the property is located.

direction_left (string)

The address direction to the left of the street name.

direction_right (string)

The address direction to the right of the street name.

house_nbr (string)

The building number portion of the street address.

mode (string)

The street type, found to the right of the street name (DR, AVE, etc.).

state (string)

The 2-letter state abbreviation.

street (string)

The street name (without the mode and direction attributes).

zip5 (string)

The 5-digit zip code.

shape_id (string)

Not used (returns null).

status (string)

OK: A commercial property was found at the specified address or location.
PARTIAL (for address search only): The supplied address was ambiguous. The returned property ID represents the best match available.
MISS: No matching commercial property found. See status_code for additional information.

status_code (string)

SFR: The property at this address or location is categorized as a single family residence (SFR), therefore no data is available.
Condo Property (SFR): The property at this address or location is categorized as a residential condominium, therefore no data is available.
MISSING: No known property at the supplied address or location.
Unrecognized address: Unable to match the supplied address or location for a reason other than those specified above.
null: No additional information.

 

post /v2/search/summaries

/​v2/​search/​summaries

The POST /v2/search/summaries endpoint returns the property IDs and coordinates of properties that meet certain criteria, for example, properties in New York City of at least 100,000 square feet.

For detailed usage information, see Filtered search.

Rate limiting

Requests to this endpoint are rate limited. See Searching for properties for details.

Parameters

Parameters

Query parameters

search_token (string)

If a search returns more than 10 items (or the limit specified in the POST request), re-run the request specifying the search_token from the response to obtain the next batch of results.

Request body (application/json)

bounding_box (object)

The top left and bottom right corners (as lat lon coordinates) of a box defining a geographic search area. The API returns all properties with centers located within the bounding box.

bottom_right (object)

Coordinates of the bottom right corner of the bounding box.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

top_left (object)

Coordinates of the top left corner of the bounding box.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

limit (integer)

You can request up to 10,000 matching items. The default is 10. If the search yields more properties than the limit, the API returns a search_token you can use to request additional matching items (re-run the request with the search_token as a query parameter). See "Pagination" in Searching for properties for more information.

settings (object)

Specify any of the available search parameters to locate properties of interest. You must include at least one parameter. The API returns metadata for properties that meet all the specified search criteria (logical AND).

assessed_improvement_value (object)

The assessed improvement value provided by the county or local taxing/assessment authority for the most recent assessment year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

assessed_land_value (object)

The assessed land value provided by the county or local taxing/assessment authority for the most recent assessment year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

asset_category (array)

One or more land use or asset categories (see Asset types).

block_id (string)

The property's block ID.

borough (string)

The property's borough name (must be lowercase).

building_area (object)

The building area, in square feet.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

building_classes (array)

One or more building class codes.

building_update_time (object)

When the building information was last updated.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

buyer_name (string)

The name of the buyer.

city (array)

One or more city names.

cmbs_loan (string)

Use this to identify properties that have a current (current) or a historical (historical cmbs loan

commercial_overlays (array)

One or more commercial overlay codes (C1-1 through C1-5 and C2-1 through C2-5).

county (array)

One or more county names.

fips (array)

One or more FIPS codes (Federal Information Processing Standards codes used to identify a specific county or political jurisdiction).

foreclosure_auction_date (object)

The foreclosure auction date.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

foreclosure_deed_category (array)

One or more foreclosure deed category codes (see Foreclosure deed categories).

foreclosure_proceedings (boolean)

has_export (boolean)

improvement_market_value (object)

The market improvement value as provided by the county or local taxing/assessment authority for the most recent assessment year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

in_state_owner (boolean)

true for properties where the owner resides in the state where the property is located.

is_assemblage (boolean)

true for properties that are part of an assemblage. This field is in beta and may not be available for all users.

land_market_value (object)

The market land value as provided by the county or local taxing/assessment authority for the most recent assessment year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

land_use_code_description (array)

One or more land use or asset types (see Asset types).

lender_entity_type (string)

The lender entity type (business entity or person).

lender_name (string)

The name of the mortgage lender.

likely_to_sell (boolean)

true to return properties Reonomy has determined are likely to sell. Reonomy's machine learning algorithm considers various attributes including historical transactions, current property data, and market-level trends to predict which properties are most likely to sell.

list_ids (array)

list_name (array)

locations (array)

Specify up to five geographic locations to search. This provides a more flexible way to search across multiple location types than the individual neighborhood, city, etc. fields.

kind (string)

Specify the location type (neighborhood, city, county, zip_code, msa, or state).

state (string)

For neighborhood, city, and county, specify the 2-letter abbreviation (in uppercase) of the state where the neighborhood, city, or county you want to search is located. The state is required for these location types (you cannot, for example, search all cities named "Boston" by omitting the state). Do not specify the state if using zip code, MSA, or state.

text (string)

Specify the name of the neighborhood, city, county, zip code, MSA, or state to search. This must be an exact match except for uppercase/lowercase differences with the names in the location database. This means, for example, "Hells Kitchen" does not match "Hell's Kitchen", but "hell's kitchen" does match "Hell's Kitchen".

lot_id (integer)

The property's lot ID.

lot_size_acres (object)

The lot size, in acres.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

lot_size_sqft (object)

The lot size, in square feet.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

map_filters (object)

Specify a geographic search area by defining one or more circles or polygons. The API returns properties wholly contained within the specified search area.

circles (array)

Define one or more circles by specifying the coordinates of the center and the circle radius.

coordinates (object)

The location of the circle's center.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

distance_unit (string)

Use this to specify the search radius units.

radius (number)

Use this to specify the search radius value.

polygons (array)

Define one or more polygons by specifying the coordinates of each vertex, in order, where the first and last points are the same.

coordinates (array)

The location of each of the polygon's vertices.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

master_update_time (object)

When the master information was last updated.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

mortgage_amount (object)

The mortgage amount.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

mortgage_maturity_date (object)

The date when the final mortgage payment is due.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

mortgage_origination_date (object)

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

mortgage_recording_date (object)

The date the mortgage was recorded.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

msa (array)

One or more (10 max) metropolitan statistical areas (MSAs). The API uses partial matching so, for example, New York maps to New York-Newark-Jersey City, NY-NJ-PA MSA.

mtg_update_time (object)

When the mortgage information was last updated.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

multi_parcel_sales (boolean)

true for properties that were part of a multi-property sale.

neighborhood (array)

One or more neighborhood names.

occupant_name (string)

The business name of the occupant.

occupant_search_type (string)

Specify occupants.naics1_description to search by NAICS description or occupants.sic1_description to search by SIC description. Enter the description using the occupant_type field.

occupant_type (string)

Specify the occupant's NAICS description or SIC description. You must also specify occupants.naics1_description or occupants.sic1_description in the occupant_search_type field.

occupant_website (string)

The website address of the occupant.

on_watchlist (string)

Use this to identify properties that are on watchlist currently (current) or previously (previous

opportunity_zone (boolean)

true for properties located within a designated opportunity zone.

owner_contact_information (array)

Specify has_green_phones, has_green_emails, or has_green_addresses to return properties where Reonomy has owner contact information of the specified type (phone, email, or address).

owner_email (string)

The email address of an individual owner or contact

owner_id (array)

ID of an person or company to filter for ownership

owner_keyword (string)

The name of the reported owner or signatory (must be an exact match).

owner_mailing_address (string)

The address of the reported owner.

owner_name (string)

The name of the reported owner (must be an exact match).

owner_occupied (boolean)

true for properties that are owner occupied.

owner_phone (string)

The phone number of an individual owner or contact

owner_type (string)

Type of owner, individual or company

owner_update_time (object)

When the ownership information was last updated.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

portfolio_assessed_value (object)

The assessed total value in USD

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

portfolio_market_value (object)

The market total value in USD

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

portfolio_properties_count (object)

The total number of properties in the portfolio

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

property_ids (array)

One or more Reonomy property IDs in 8-4-4-4-12 format.

property_viewed_date (object)

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

reported_owning_entity (string)

The name of the reported owner (must be an exact match).

sale_update_time (object)

When the sale information was last updated.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

sales_date (object)

The date of the most recent sale.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

sales_price (object)

The amount of the most recent sale.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

sales_price_per_sqft_of_building_area (object)

The amount of the most recent sale divided by the total square footage.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

seller_name (string)

The name of the seller.

shape_update_time (object)

When the shape information was last updated.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

sort (array)

How to sort the search results.

location (object)

If you specify location as the sort field and specify a point in the location field, results are returned based on the distance from the specified point.

lat (number)

The location's latitude.

lon (number)

The location's longitude.

name (string)

The field by which to sort the results (for example, lot_size_acres).

order (string)

asc (ascending) or desc (descending).

state (array)

One or more 2-letter state abbreviations.

street (string)

The street name.

tax_amount (object)

Property taxes owed for the most recent assessment year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

tax_change_pct (object)

The percentage change in the total tax bill from the previous year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

tax_rate (object)

The net tax rate on a property, calculated as tax amount less exemptions and abatenments divided by assessed value for the most recent tax year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

tax_update_time (object)

When the tax information was last updated.

inclusive (boolean)

Used when specifying a range. If true (the default), the API returns properties with dates within the range; If false, the API returns properties with dates outside the range

max (string)

Use this to specify the latest date (YYYY-MM-DD).

min (string)

Use this to specify the earliest date (YYYY-MM-DD).

relative_max (integer)

Use this to specify the latest date relative to today. For example, relative_max: -30 means older than 30 days.

relative_min (integer)

Use this to specify the earliest date relative to today. For example, relative_min: -30 means within the last 30 days.

total_assessed_value (object)

The total assessed value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the most recent assessment year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

total_market_value (object)

The total market value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the most recent assessment year.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

total_units (object)

The total number of units within the building.

eq (number)

Use this to specify an exact value. If you specify a value, the min and max parameters are ignored.

is_null (boolean)

Specify true to locate properties where the value of this field is undefined (null). The default is false. If you specify is_null: true, the eq, min, and max parameters are ignored.

max (number)

Use this to specify a maximum value.

min (number)

Use this to specify a minimum value.

year_built (object)

The year the building was originally constructed.

max (number)

Use this to specify the latest year (inclusive).

min (number)

Use this to specify the earliest year (inclusive).

year_renovated (object)

The year the building was last renovated.

max (number)

Use this to specify the latest year (inclusive).

min (number)

Use this to specify the earliest year (inclusive).

zip_code (array)

One or more zip codes.

zoning (array)

One or more zoning codes (for example, C1, C2, etc.). Zoning codes are location specific.

Response

200

count (integer)

The total number of matching items.

items (array)

A list of matching properties, with the property ID and last update times for each. To obtain data for a property, use one of the GET /v2/property/{property_id} endpoints, or submit a property details batch job using POST /v2/jobs/file.

building_update_time (string)

The date the property's building information was last updated (YYYY-MM-DD).

id (string)

The Reonomy property ID. Use this as the path parameter in any GET /v2/property/{property_id} endpoint to get information about the property.

master_update_time (string)

The date the property's information was last updated (YYYY-MM-DD).

mtg_update_time (string)

The date the property's mortage information was last updated (YYYY-MM-DD).

other_properties_in_this_mtg (array)

Crossed-Debt Parcels

formatted_apn (string)

parcel_id (string)

other_properties_in_this_sale (array)

Construction Loan

formatted_apn (string)

parcel_id (string)

owner_update_time (string)

The date the property's ownership information was last updated (YYYY-MM-DD).

sale_update_time (string)

The date the property's sales information was last updated (YYYY-MM-DD).

shape_update_time (string)

The date the property's shape information was last updated (YYYY-MM-DD).

tax_update_time (string)

The date the property's tax information was last updated (YYYY-MM-DD).

limit (integer)

Not used (returns null).

next (string)

The API endpoint URL.

offset (integer)

Not used (returns null).

previous (string)

Not used (returns null).

remaining (integer)

Not used (returns null).

route_args (object)

Not used (returns null).

search_token (string)

If the search returns more than 10 items (or the limit specified in the POST request), re-run the request specifying the search_token as a query parameter to obtain the next batch of results.

 
V2 Property API — Deprecated endpoints

get /v2/property/{property_id}/mortgages

/​v2/​property/​{property_id}/​mortgages

DEPRECATED ⓘ

Returns mortgage and foreclosure information for the specified property. See the response definition below for information about exactly what is returned.

Rate limiting

Requests to this endpoint are rate limited. See Getting property details for more information.

Parameters

Parameters

Path parameters

property_id (string)

The property's Reonomy ID (its 8-4-4-4-12 format unique identifier).

Query parameters

filter_pii (boolean)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII, see the Data dictionary.

Response

200

foreclosure (object)

Any foreclosure associated with the property.

active (boolean)

true foreclosure proceedings are actively ongoing.

auction_date (string)

The foreclosure auction date.

auction_time (string)

The foreclosure aution time.

city_of_auction_call (string)

The city where the auction is occurring.

deed_category (string)

The foreclosure deed category code (see Foreclosure deed categories for a full list).

deed_category_text (string)

The foreclosure deed category name (see Foreclosure deed categories for a full list).

document_type (string)

The foreclosure document type code code (see Foreclosure document types for a full list).

document_type_text (string)

The foreclosure document type name (see Foreclosure document types for a full list).

document_year (integer)

Year the document relating to the pre-foreclosure proceedings was recorded.

final_judgement_amount (string)

The total amount owed in the foreclosure.

first_defendant_borrower_owner_company_name (string)

The borrower company in the pre-foreclosure proceedings.

first_defendant_borrower_owner_first_name (string)

The borrower first name in the pre-foreclosure proceedings.

first_defendant_borrower_owner_last_name (string)

The borrower last name in the pre-foreclosure proceedings.

original_loan_date (string)

The origination date of the initial loan.

original_loan_recording_date (string)

The recording date of the initial loan.

plaintiff_1 (string)

The plaintiff (lender) in the pre-foreclosure proceedings.

recording_date (string)

The date the document relating to the pre-foreclosure proceedings was recorded.

source_date (string)

The date the foreclosure information was pulled from the source document.

state_of_auction_call (string)

2-letter state abbreviation of the state where the auction is occurring.

street_address_of_auction_call (string)

The street address where the auction is occurring.

trustee_city (string)

The city where the trustee is registered.

trustee_mailing_address (string)

The trustee's mailing address.

trustee_name (string)

The trustee's name.

trustee_phone (string)

The trustee's phone number.

trustee_state (string)

2-letter abbreviation of the state where the trustee is registered.

trustee_zip (string)

The trustee's zip code.

use_code (string)

The parcel's asset or lot use code (see Asset types for a full list).

mortgages (array)

Mortgage data for this property.

active_loan (boolean)

true if this mortgage is actively encumbering the property, null otherwise. null for all mortgages outside of NYC.

actual_balance (number)

Outstanding actual balance of the loan as of the determination date. This figure represents the legal remaining outstanding principal balance related to the borrower's mortgage note.

actual_balance_date (string)

The determination date of the outstanding actual balance.

arm_gross_margin (number)

A variable rate loan's gross margin: net margin plus servicing fees.

arm_index (string)

The index on which a variable rate loan is based.

book_page (string)

Page of the mortgage document at the local land records registry.

borrower_full_name (string)

The mortgage borrower name.

cash_mortgage_purchase (string)

Yes if this is a cash mortgage purchase; No otherwise.

construction_loan (string)

Yes if this is a construction loan; No otherwise.

crfn_id (string)

The City Register File Number.

document_number (string)

The mortgage document number from the local land records registry.

document_type (string)

The document type (AGREEMENT OF SALE, GRANT DEED, etc.).

due_date (string)

The mortgage maturity date (YYYY-MM-DD).

executed_date (string)

The date the mortgage was executed.

foreclosure (string)

Y if the property is foreclosed; N otherwise.

is_balloon (string)

The type of loan terms: full amortizing (Amort), interest only, non-extendable (Non-Amort), lump-sum payment of principal at maturity (Balloon).

is_cmbs_loan (boolean)

Indicates if the document is a CMBS loan.

lender_entity_type (string)

The lender type (business entity or person).

lender_name (string)

The mortgage lender name.

mortgage_amount (number)

The mortgage principal amount at time of origination.

mortgage_id (string)

The mortgage ID from the local land records.

mortgage_interest_rate_type (string)

The interest rate type (FIXED, FHA, etc.).

mortgage_type (string)

The type of mortgage.

note_holder (array)

The most recent company or private party to own the loan on the property. This may or may not be the bank that originated the loan.

original_ltv (number)

The property's Loan-To-Value ratio at loan origination, calculated by dividing the original loan balance by the property value at loan origination. Zero represents unavailable data.

other_properties (array)

List of other properties secured by the same mortgage.

formatted_apn (string)

The APN of the other property in the sale. Assessor's Parcel Number or Parcel Identification Number. An arbitrary parcel identifier assigned by the county Assessor to simplify identification and expedite the locating of parcels.

parcel_id (string)

Reonomy ID of the other property in the sale.

other_properties_count (integer)

The total number of properties in this mortgage.

paid (string)

The PAID flag that identifies a loan that has paid down.

paid_through (string)

The date of the loan's scheduled principal and interest is paid through as of the determination date.

payoff_date (string)

If the loan has paid down, the date of the actual final payment.

paystatus_current_status_60 (string)

Paystatus of the loan over the past 60 months. Values are Always performing, Re-performing, or Non-performing, where a loan is performing if it is 60 days or less delinquent.

paystatus_worst_60 (string)

Worst delinquency status over the past 60 months

prep_penalty (number)

Pursuant to the loan documents, an amount received from a borrower during the collection period in exchange for allowing a borrower to pay off a loan prior to the maturity or anticipated repayment date.

rate (string)

Interest rate of the mortgage.

recording_date (string)

Date the mortgage document was recorded with the local land records registry (YYYY-MM-DD).

refi_flag (string)

Yes if this mortgage is a refinance; null if not or unknown.

seller_carry_back (string)

Yes if this is a seller carry back mortgage where the seller loans the buyer a portion of the sales price and retains a percentage ownership; No otherwise.

signatory1 (string)

Name of signatory 1.

signatory1_title (string)

Job title of signatory 1.

signatory2 (string)

Name of signatory 2.

signatory2_title (string)

Job title of signatory 2.

source_doc (string)

The direct link to ACRIS for a given mortgage document.

status (string)

CMSA loan status codes populated in the following order of priority (top priority listed first): 6 - 121+ Days Delinquent; 5 - Non Performing Matured Balloon; 4 - Performing Matured Balloon; 3 - 90+ Days Delinquent; 2 - 60-89 Days Delinquent; 1 - 30-59 Days Delinquent; 0 - Current; B - Late Payment But Less Than 30 days Delinquent; A - Payment Not Received But Still In Grace Period or Not Yet Due

term_months (integer)

The mortgage term length (in months).

transaction_type (string)

The transaction type (Arms Length, REFINANCE, etc.).

uw_appraisal_value (number)

The valuation amount of the property as of the Valuation Date at Contribution.

uw_appraisal_value_date (string)

The date the Valuation Amount at Contribution was determined.

watch_comment (string)

The comments regarding the asset's watch list status as reported by the trustee.

watch_comment_date (string)

The determination date of the Watch List Report Comment.

watchlist_end_date (string)

Date Removed from Watchlist ( only applicable if AI_WATCHLIST_DATE_START is populated )

watchlist_start_date (string)

Date Added to Watchlist

watchlist_translation (string)

Translation of On the Watchlist field

mtg_update_time (string)

The date the property's mortage information was last updated (YYYY-MM-DD).

 

get /v2/property/{property_id}/ownership

/​v2/​property/​{property_id}/​ownership

DEPRECATED ⓘ

Returns ownership information for the specified property. For more information, including details on interpreting the response structure, see Obtaining ownership information.

Rate limiting

Requests to this endpoint are rate limited. See Getting property details for more information.

Gray matches

Unlike the Reonomy web app, the API does not return "gray matches" (companies and individuals that may have a connection to the property). All contacts in the API response will have is_green_match: true.

Parameters

Parameters

Path parameters

property_id (string)

The property's Reonomy ID (its 8-4-4-4-12 format unique identifier).

Query parameters

filter_pii (boolean)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII, see the Data dictionary.

Response

200

items (array)

The data node below maps to the contacts node in the API response.

contacts (array)

Contact data for this property.

company (object)

Information about the company.

addresses (array)

One or more mailing addresses associated with the company.

city (string)

The city name.

country_code (string)

The country code.

display (string)

The full address.

line1 (string)

The building number and street name.

line2 (string)

The floor, suite, or apartment number.

po_box (string)

The post office box number.

postal_code (string)

The zip code.

state_code (string)

The 2-letter state abbreviation.

type (string)

The address type.

unit (string)

The address unit number.

dba_name (string)

The company's DBA ("doing business as") name.

emails (array)

One or more email addresses (4 maximum) associated with the company.

address (string)

The email address.

employees_total (integer)

Number of employees at the company.

id (string)

The unique Reonomy identifier associated with this company.

location_type (string)

Single location, headquarters, or branch.

match_score (integer)

The confidence that this is a true match.

name (string)

The company name.

parent_id (string)

The unique Reonomy ID associated with the parent company.

phones (array)

One or more phone numbers (4 maximum) associated with the company.

country_code (string)

The country code.

extensions (string)

The internal extension number.

number (string)

The phone number (unformatted), including area code.

type (string)

The phone type (residential, etc.).

sales_volume (integer)

Annual sales volume (in thousand dollars).

state_code (string)

The 2-letter state abbreviation.

type (string)

urls (array)

One or more website URLs associated with the company.

type (string)

URL type.

url (string)

URL for this entity.

year_founded (integer)

The year the company was founded.

contact_type (string)

Whether this contact is a company or an individual.

is_green_match (boolean)

True if there's a high probability this company or individual is an owner of the property.

is_signatory (boolean)

True if this contact is the signatory on the mortgage.

match_score (integer)

Indicates the confidence that this company or individual is the true owner.

persons (array)

For contact_type: "individual", this provides the person's name and contact information. For contact_type: "company", this provides the name and contact information for each known person associated with the company.

addresses (array)

One or more mailing addresses associated with the person.

city (string)

The city name.

country_code (string)

The country code.

display (string)

The full address.

line1 (string)

The building number and street name.

line2 (string)

The floor, suite, or apartment number.

po_box (string)

The post office box number.

postal_code (string)

The zip code.

state_code (string)

The 2-letter state abbreviation.

type (string)

The address type.

unit (string)

The address unit number.

display (string)

The person's full name.

emails (array)

One or more email addresses (4 maximum) associated with the person.

address (string)

The email address.

first_name (string)

The person's first name.

id (string)

The unique Reonomy identifier associated with this person.

jobs (array)

One or more job titles associated with the person.

is_company_owner (boolean)

Is person a company owner

organization (string)

The organization name.

title (string)

The job title.

type (string)

The job type.

last_name (string)

The person's last name.

match_score (integer)

The confidence that this is a true match.

name (string)

The person's full name.

phones (array)

One or more phone numbers (4 maximum) associated with the person.

country_code (string)

The country code.

extensions (string)

The internal extension number.

number (string)

The phone number (unformatted), including area code.

type (string)

The phone type (residential, etc.).

urls (array)

One or more website URLs associated with the person.

type (string)

URL type.

url (string)

URL for this entity.

id (string)

owner_update_time (string)

The date the property's ownership information was last updated (YYYY-MM-DD).

property_id (string)

The Reonomy property ID specified in the request.

limit (integer)

next (string)

offset (integer)

previous (string)

remaining (integer)

route_args (object)

search_token (string)

 

get /v2/property/{property_id}/reported-owners

/​v2/​property/​{property_id}/​reported-owners

DEPRECATED ⓘ

Returns information about the reported owner of the specified property. See the response definition below for information about exactly what is returned.

Rate limiting

Requests to this endpoint are rate limited. See Getting property details for more information.

Parameters

Parameters

Path parameters

property_id (string)

The property's Reonomy ID (its 8-4-4-4-12 format unique identifier).

Query parameters

filter_pii (boolean)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII, see the Data dictionary.

Response

200

address_line1 (string)

The first line of the property address. This field is a concatenation of house_nbr, direction_left, street, mode, direction_right, unit_type, and unit_number.

city (string)

The city name.

direction_left (string)

The address direction to the left of the street name.

direction_right (string)

The address direction to the right of the street name.

house_number (string)

The building number portion of the street address.

mode (string)

The street type, found to the right of the street name (DR, AVE, etc.).

owner_instate (boolean)

true if the owner lives in the state where the property is located; false otherwise.

owner_occupied (boolean)

true if the owner lives in the state where the property is located; false otherwise.

owner_update_time (string)

The date the property's ownership information was last updated (YYYY-MM-DD).

reported_owners (array)

List of reported owners.

entity_type (string)

Specifies whether the reported owner is a "person" or "business entity".

name (string)

The reported owner's name.

state (string)

The 2-letter state abbreviation.

street (string)

The street name.

unit_number (string)

The unit number.

unit_type (string)

The unit type.

zip_code (string)

The zip code.

zip_code4 (string)

The "plus 4" zip code extension.

 

get /v2/property/{property_id}/sales

/​v2/​property/​{property_id}/​sales

DEPRECATED ⓘ

Returns sales information for the specified property. See the response definition below for information about exactly what is returned.

Rate limiting

Requests to this endpoint are rate limited. See Getting property details for more information.

Parameters

Parameters

Path parameters

property_id (string)

The property's Reonomy ID (its 8-4-4-4-12 format unique identifier).

Query parameters

filter_pii (boolean)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII, see the Data dictionary.

Response

200

sale_update_time (string)

The date the property's sale information was last updated (YYYY-MM-DD).

sales (array)

Sales data for the given property.

acris_id (string)

The property's Automated City Register Information System (ACRIS) ID.

book_page (string)

Page of the sale document at the local land records registry.

buyers (array)

List of buyers of record (from the deed).

buyers_formatted (array)

List of buyers of record (from the deed).

name (string)

The full name of the person or company.

type (string)

The entity type (for example, business entity or person).

cash_mortgage_purchase (string)

Yes if a cash mortgage purchase; No otherwise.

document_number (string)

Sales document number from local land records registry associated with the deed.

document_type (string)

The sale document type (Agreement of Sale, Deed, etc.).

foreclosed (boolean)

true if this is a foreclosure sale; false otherwise.

multi_properties_sale_flag (boolean)

true if this sale includes other properties; false otherwise.

other_properties (array)

List of other properties conveyed in same deed.

formatted_apn (string)

The Assessor's Parcel Number or Parcel Identification Number of the other property.

parcel_id (string)

The Reonomy ID of the other property.

other_properties_count (integer)

Sales data for the given property.

per_residential_unit (number)

The total sale amount divided by the number of residential units. For multi-property transactions, the building area is totaled across all the properties.

percent_transferred (number)

Percent of ownership interest conveyed from seller to buyer stated in the deed.

price_per_building_area (number)

Price per square foot of the building area. For multi-property transactions, the building area is totaled across all the properties.

recording_date (string)

Date the document was recorded with the local land records registry (YYYY-MM-DD).

sale_amount (number)

The sale amount stated in the deed.

sale_date (string)

Date the transaction was executed per the deed (YYYY-MM-DD).

sales_id (string)

The Reonomy ID of this sale record.

sellers (array)

List of the sellers of record (from the deed).

sellers_formatted (array)

List of the sellers of record (from the deed).

name (string)

The full name of the person or company.

type (string)

The entity type (for example, business entity or person).

sf_of_building_area (number)

Square footage of the building.

sf_of_lot_area (number)

Square footage of the lot.

transaction_type (string)

The transaction type (Arms Length, Refinance, etc.).

 

get /v2/property/{property_id}/taxes

/​v2/​property/​{property_id}/​taxes

DEPRECATED ⓘ

Returns tax information for the specified property. See the response definition below for information about exactly what is returned.

Rate limiting

Requests to this endpoint are rate limited. See Getting property details for more information.

Parameters

Parameters

Path parameters

property_id (string)

The property's Reonomy ID (its 8-4-4-4-12 format unique identifier).

Query parameters

filter_pii (string)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII, see the Data dictionary.

Response

200

tax_update_time (string)

The date the property's tax information was last updated (YYYY-MM-DD).

taxes (array)

Tax data for this property.

amount (number)

Property taxes owed for the specified assessment year.

assessed_improvement_value (number)

The assessed improvement value provided by the county or local taxing/assessment authority for the specified assessment year.

assessed_land_value (number)

The assessed land value provided by the county or local taxing/assessment authority for the specified assessment year.

assessment_roll_link (string)

URL for the assessment roll.

billable_assessed_value (number)

The total assessed value minus exemptions.

exemptions_and_abatements (number)

The total tax amount reduction due to exemptions (these reduce the property's assessed value) and abatements (these are applied after tax calculation to reduce the tax bill).

gross_tax_amount (number)

The tax amount for a property before exemptions and abatements

gross_tax_rate (number)

The tax rate for a property before factoring in exemptions and abatements

improvement_market_value (number)

The market improvement value as provided by the county or local taxing/assessment authority for the specified assessment year.

land_market_value (number)

The market land value as provided by the county or local taxing/assessment authority for the specified assessment year.

tax_bill (number)

The total property tax bill for the specified assessment year.

tax_bill_link (string)

URL for the latest tax bill.

tax_change_percentage (number)

The percentage change in the total tax bill from the previous year.

tax_rate (number)

The net tax rate on a property, calculated as tax amount less exemptions and abatenments divided by assessed value.

total_assessed_value (number)

The total assessed value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the specified assessment year.

total_market_value (number)

The total market value of the parcel's land and improvement values as provided by the county or local taxing/assessment authority for the specified assessment year.

transitional_assessed_value (number)

The transitional assessed value reflecting changes being phased in over 5 years.

transitional_exemption_value (number)

The transitional exemption value reflecting changes being phased in over 5 years.

year (integer)

The year for which this tax record applies.

 

get /v2/property/{property_id}/tenants

/​v2/​property/​{property_id}/​tenants

DEPRECATED ⓘ

Returns occupant information for the specified property. See the response definition below for information about exactly what is returned.

Rate limiting

Requests to this endpoint are rate limited. See Getting property details for more information.

Parameters

Parameters

Path parameters

property_id (string)

The property's Reonomy ID (its 8-4-4-4-12 format unique identifier).

Query parameters

filter_pii (boolean)

Specify true to exclude all fields tagged as PII (personally identifiable information) from the results. To see which fields are considered PII, see the Data dictionary.

Response

200

tenants (array)

List of occupant businesses.

business_name (string)

Name of the occupant.

ceo_full_name (string)

The name of the CEO for the given occupant.

ceo_title (string)

The CEO's title.

city (string)

The occupant location's city.

contacts (array)

List of contacts at the specified occupant business.

city (string)

The contact's city.

country_code (string)

The contact's country code.

email (string)

The contact's email address.

first_name (string)

The contact's first name.

job_title (string)

The contact's job title.

last_name (string)

The contact's last name.

primary_phone (string)

The contact's primary phone number.

secondary_phone (string)

The contact's secondary phone number.

state (string)

The contact's 2-letter state abbreviation.

street (string)

The contact's street address.

zip_code (string)

The contact's zip code.

duns (string)

A nine-digit number assigned by Dun & Bradstreet to identify unique business establishments.

employee_total (integer)

Estimated number of employees.

mailing_city (string)

The occupant's mailing city.

mailing_state (string)

The occupant's mailing state.

mailing_street_address (string)

The occupant's mailing address.

mailing_zip_code (string)

The occupant's mailing 5 digit zip code.

mailing_zip_code4 (string)

The occupant's mailing "plus 4" zip code extension.

naics (string)

The occupant's primary North American Industry Classification System (NAICS) code.

naics2 (string)

The occupant's secondary North American Industry Classification System (NAICS) code.

naics2_description (string)

The occupant's secondary North American Industry Classification System (NAICS) code description.

naics_description (string)

The occupant's primary North American Industry Classification System (NAICS) code description.

sales_volume (integer)

The occupant's sales volume.

sic (string)

The occupant's primary Standard Industrial Classification (SIC) code.

sic2 (string)

The occupants's secondary Standard Industrial Classification (SIC) code.

sic2_description (string)

The occupant's secondary Standard Industrial Classification (SIC) code description.

sic_description (string)

The occupant's primary Standard Industrial Classification (SIC) code description.

state (string)

The occupant location's state.

street_address (string)

The occupant location's street address.

telephone_number (string)

The phone number associated with the occupant.

tradestyle_name (string)

The occupant's "Doing Business As" (DBA) name.

type_of_location (string)

The location type (Single Location or Branch).

website (string)

The occupant's website URL.

year_started (integer)

The year the business was founded.

zip_code (string)

The occupant location's 5 digit zip code.

zip_code4 (string)

The occupant location's "plus 4" zip code extension.

 

Copyright © 2022 Reonomy® All rights reserved.

Return to reonomy.com